VS Code API
    Preparing search index...

    Interface InputBoxOptions

    Options to configure the behavior of the input box UI.

    interface InputBoxOptions {
        ignoreFocusOut?: boolean;
        password?: boolean;
        placeHolder?: string;
        prompt?: string;
        title?: string;
        value?: string;
        valueSelection?: [number, number];
        validateInput?(
            value: string,
        ):
            | string
            | InputBoxValidationMessage
            | Thenable<string | InputBoxValidationMessage | null | undefined>
            | null
            | undefined;
    }
    Index

    Properties

    ignoreFocusOut? password? placeHolder? prompt? title? value? valueSelection?

    Methods

    validateInput?

    Properties

    ignoreFocusOut?: boolean

    Set to true to keep the input box open when focus moves to another part of the editor or to another window. This setting is ignored on iPad and is always false.

    password?: boolean

    Controls if a password input is shown. Password input hides the typed text.

    placeHolder?: string

    An optional string to show as placeholder in the input box to guide the user what to type.

    prompt?: string

    The text to display underneath the input box.

    title?: string

    An optional string that represents the title of the input box.

    value?: string

    The value to pre-fill in the input box.

    valueSelection?: [number, number]

    Selection of the pre-filled value. Defined as tuple of two number where the first is the inclusive start index and the second the exclusive end index. When undefined the whole pre-filled value will be selected, when empty (start equals end) only the cursor will be set, otherwise the defined range will be selected.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods