Interface InputBox

interface InputBox {
    busy: boolean;
    buttons: readonly QuickInputButton[];
    contextKey: undefined | string;
    description: undefined | string;
    enabled: boolean;
    ignoreFocusOut: boolean;
    onDidAccept: Event<void>;
    onDidChangeValue: Event<string>;
    onDidHide: Event<{
        reason: QuickInputHideReason;
    }>;
    onDidTriggerButton: Event<QuickInputButton>;
    onDispose: Event<void>;
    password: boolean;
    placeholder: undefined | string;
    prompt: undefined | string;
    step: undefined | number;
    title: undefined | string;
    totalSteps: undefined | number;
    validationMessage: undefined | string;
    value: undefined | string;
    valueSelection: undefined | readonly [number, number];
    dispose(): void;
    hide(): void;
    show(): void;
}

Hierarchy (view full)

Properties

busy buttons contextKey description enabled ignoreFocusOut onDidAccept onDidChangeValue onDidHide onDidTriggerButton onDispose password placeholder prompt step title totalSteps validationMessage value valueSelection

Methods

dispose hide show

Properties

busy

busy: boolean

buttons

buttons: readonly QuickInputButton[]

contextKey

contextKey: undefined | string

description

description: undefined | string

enabled

enabled: boolean

ignoreFocusOut

ignoreFocusOut: boolean

Readonly onDidAccept

onDidAccept: Event<void>

Readonly onDidChangeValue

onDidChangeValue: Event<string>

Readonly onDidHide

onDidHide: Event<{
    reason: QuickInputHideReason;
}>

Type declaration

Readonly onDidTriggerButton

onDidTriggerButton: Event<QuickInputButton>

Readonly onDispose

onDispose: Event<void>

password

password: boolean

placeholder

placeholder: undefined | string

prompt

prompt: undefined | string

step

step: undefined | number

title

title: undefined | string

totalSteps

totalSteps: undefined | number

validationMessage

validationMessage: undefined | string

value

value: undefined | string

valueSelection

valueSelection: undefined | readonly [number, number]

Methods

dispose

hide

show

Settings

Member Visibility

Theme

On This Page

busybuttonscontextKeydescriptionenabledignoreFocusOutonDidAcceptonDidChangeValueonDidHideonDidTriggerButtononDisposepasswordplaceholderpromptsteptitletotalStepsvalidationMessagevaluevalueSelectiondisposehideshow