@kkdev92/vscode-ext-kit - v4.1.1
    Preparing search index...

    Interface InputStepConfig<S>

    Configuration accepted by inputStep.

    interface InputStepConfig<S> {
        password?: boolean;
        placeholder?: string;
        prompt?: string;
        validate?: (
            value: string,
            state: Readonly<S>,
        ) => string | Promise<string | undefined> | undefined;
        value?: (state: Readonly<S>) => string;
    }

    Type Parameters

    • S
    Index
    password? placeholder? prompt? validate? value?
    password?: boolean

    Hides typed characters.

    placeholder?: string

    Placeholder text shown when the box is empty.

    prompt?: string

    Instructional text shown below the input box.

    validate?: (
        value: string,
        state: Readonly<S>,
    ) => string | Promise<string | undefined> | undefined

    Validation function. May be asynchronous. Live validation (as the user types) is debounced by 100ms — matching the debounce VS Code applies internally to showInputBox's validateInput — so an async validator isn't invoked on every keystroke. The final value is always re-validated once more, without debouncing, when the user accepts.

    value?: (state: Readonly<S>) => string

    Default value, computed from the accumulated state of previous steps.

    Settings
    Member Visibility

    On This Page
    Properties