InputBox$Typings extension
Properties
-
buttons
↔ List<QuickInputButton>
-
Buttons for actions in the UI.
getter/setter pair
-
onDidAccept
→ Event<void>
-
An event signaling when the user indicated acceptance of the input value.
no setter
-
onDidChangeValue
→ Event<String>
-
An event signaling when the value has changed.
no setter
-
onDidTriggerButton
→ Event<QuickInputButton>
-
An event signaling when a button was triggered.
no setter
-
password
↔ bool
-
If the input value should be hidden. Defaults to false.
getter/setter pair
-
placeholder
↔ String?
-
Optional placeholder shown when no value has been input.
getter/setter pair
-
prompt
↔ String?
-
An optional prompt text providing some ask or explanation to the user.
getter/setter pair
-
validationMessage
↔ dynamic
-
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
-
Current input value.
getter/setter pair
-
valueSelection
↔ (num, num)?
-
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