InputBox$Typings extension

on

Properties

buttons ↔ List<QuickInputButton>

Available on InputBox, provided by the InputBox$Typings extension

Buttons for actions in the UI.
getter/setter pair
onDidAccept → Event<void>

Available on InputBox, provided by the InputBox$Typings extension

An event signaling when the user indicated acceptance of the input value.
no setter
onDidChangeValue → Event<String>

Available on InputBox, provided by the InputBox$Typings extension

An event signaling when the value has changed.
no setter
onDidTriggerButton → Event<QuickInputButton>

Available on InputBox, provided by the InputBox$Typings extension

An event signaling when a button was triggered.
no setter
password ↔ bool

Available on InputBox, provided by the InputBox$Typings extension

If the input value should be hidden. Defaults to false.
getter/setter pair
placeholder ↔ String?

Available on InputBox, provided by the InputBox$Typings extension

Optional placeholder shown when no value has been input.
getter/setter pair
prompt ↔ String?

Available on InputBox, provided by the InputBox$Typings extension

An optional prompt text providing some ask or explanation to the user.
getter/setter pair
validationMessage ↔ dynamic

Available on InputBox, provided by the InputBox$Typings extension

An optional validation message indicating a problem with the current input value. By returning a string, the InputBox will use a default {@link InputBoxValidationSeverity} of Error. Returning undefined clears the validation message.
getter/setter pair
value ↔ String

Available on InputBox, provided by the InputBox$Typings extension

Current input value.
getter/setter pair
valueSelection ↔ (num, num)?

Available on InputBox, provided by the InputBox$Typings extension

Selection range in the input 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.
getter/setter pair