Interface QuickPick<T>

interface QuickPick<T> {
    activeItems: readonly T[];
    busy: boolean;
    buttons: readonly QuickInputButton[];
    canSelectMany: boolean;
    contextKey: undefined | string;
    description: undefined | string;
    enabled: boolean;
    ignoreFocusOut: boolean;
    items: readonly (QuickPickSeparator | T)[];
    keepScrollPosition: boolean;
    matchOnDescription: boolean;
    matchOnDetail: boolean;
    onDidAccept: Event<undefined | {
        inBackground: boolean;
    }>;
    onDidChangeActive: Event<T[]>;
    onDidChangeSelection: Event<T[]>;
    onDidChangeValue: Event<string>;
    onDidHide: Event<{
        reason: QuickInputHideReason;
    }>;
    onDidTriggerButton: Event<QuickInputButton>;
    onDidTriggerItemButton: Event<QuickPickItemButtonEvent<QuickPickItem>>;
    onDispose: Event<void>;
    placeholder: undefined | string;
    selectedItems: readonly T[];
    step: undefined | number;
    title: undefined | string;
    totalSteps: undefined | number;
    value: string;
    dispose(): void;
    hide(): void;
    show(): void;
}

Type Parameters

Hierarchy (view full)

Properties

activeItems busy buttons canSelectMany contextKey description enabled ignoreFocusOut items keepScrollPosition matchOnDescription matchOnDetail onDidAccept onDidChangeActive onDidChangeSelection onDidChangeValue onDidHide onDidTriggerButton onDidTriggerItemButton onDispose placeholder selectedItems step title totalSteps value

Methods

dispose hide show

Properties

activeItems

activeItems: readonly T[]

busy

busy: boolean

buttons

buttons: readonly QuickInputButton[]

canSelectMany

canSelectMany: boolean

contextKey

contextKey: undefined | string

description

description: undefined | string

enabled

enabled: boolean

ignoreFocusOut

ignoreFocusOut: boolean

items

items: readonly (QuickPickSeparator | T)[]

keepScrollPosition

keepScrollPosition: boolean

matchOnDescription

matchOnDescription: boolean

matchOnDetail

matchOnDetail: boolean

Readonly onDidAccept

onDidAccept: Event<undefined | {
    inBackground: boolean;
}>

Readonly onDidChangeActive

onDidChangeActive: Event<T[]>

Readonly onDidChangeSelection

onDidChangeSelection: Event<T[]>

Readonly onDidChangeValue

onDidChangeValue: Event<string>

Readonly onDidHide

onDidHide: Event<{
    reason: QuickInputHideReason;
}>

Type declaration

Readonly onDidTriggerButton

onDidTriggerButton: Event<QuickInputButton>

Readonly onDidTriggerItemButton

onDidTriggerItemButton: Event<QuickPickItemButtonEvent<QuickPickItem>>

Readonly onDispose

onDispose: Event<void>

placeholder

placeholder: undefined | string

selectedItems

selectedItems: readonly T[]

step

step: undefined | number

title

title: undefined | string

totalSteps

totalSteps: undefined | number

value

value: string

Methods

dispose

hide

show

Settings

Member Visibility

Theme

On This Page

activeItemsbusybuttonscanSelectManycontextKeydescriptionenabledignoreFocusOutitemskeepScrollPositionmatchOnDescriptionmatchOnDetailonDidAcceptonDidChangeActiveonDidChangeSelectiononDidChangeValueonDidHideonDidTriggerButtononDidTriggerItemButtononDisposeplaceholderselectedItemssteptitletotalStepsvaluedisposehideshow