dots.vscode.input-box-options
Options to configure the behavior of the input box UI.
Options to configure the behavior of the input box UI.
ignore-focus-out?cljs
(ignore-focus-out? input-box-options)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.
Returns: boolean | undefined
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. **Returns:** `boolean | undefined`
password?cljs
(password? input-box-options)Controls if a password input is shown. Password input hides the typed text.
Returns: boolean | undefined
Controls if a password input is shown. Password input hides the typed text. **Returns:** `boolean | undefined`
place-holdercljs
(place-holder input-box-options)An optional string to show as placeholder in the input box to guide the user what to type.
Returns: string | undefined
An optional string to show as placeholder in the input box to guide the user what to type. **Returns:** `string | undefined`
promptcljs
(prompt input-box-options)The text to display underneath the input box.
Returns: string | undefined
The text to display underneath the input box. **Returns:** `string | undefined`
set-ignore-focus-out!cljs
(set-ignore-focus-out! input-box-options value)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.
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.
set-password!cljs
(set-password! input-box-options value)Controls if a password input is shown. Password input hides the typed text.
Controls if a password input is shown. Password input hides the typed text.
set-place-holder!cljs
(set-place-holder! input-box-options value)An optional string to show as placeholder in the input box to guide the user what to type.
An optional string to show as placeholder in the input box to guide the user what to type.
set-prompt!cljs
(set-prompt! input-box-options value)The text to display underneath the input box.
The text to display underneath the input box.
set-title!cljs
(set-title! input-box-options value)An optional string that represents the title of the input box.
An optional string that represents the title of the input box.
set-value!cljs
(set-value! input-box-options value)The value to pre-fill in the input box.
The value to pre-fill in the input box.
set-value-selection!cljs
(set-value-selection! input-box-options value)Selection of the pre-filled {@linkcode InputBoxOptions.value 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.
Selection of the pre-filled {@linkcode InputBoxOptions.value 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.titlecljs
(title input-box-options)An optional string that represents the title of the input box.
Returns: string | undefined
An optional string that represents the title of the input box. **Returns:** `string | undefined`
validate-inputcljs
(validate-input input-box-options value)An optional function that will be called to validate input and to give a hint to the user.
Parameters:
value:string- The current value of the input box.
Returns: string | InputBoxValidationMessage | Thenable<string | InputBoxValidationMessage | null | undefined> | null | undefined - Either a human-readable string which is presented as an error message or an {@link InputBoxValidationMessage}which can provide a specific message severity. Return undefined, null, or the empty string when 'value' is valid.
An optional function that will be called to validate input and to give a hint
to the user.
**Parameters:**
- `value`: `string` - The current value of the input box.
**Returns:** `string | InputBoxValidationMessage | Thenable<string | InputBoxValidationMessage | null | undefined> | null | undefined` - Either a human-readable string which is presented as an error message or an {@link InputBoxValidationMessage}which can provide a specific message severity. Return `undefined`, `null`, or the empty string when 'value' is valid.valuecljs
(value input-box-options)The value to pre-fill in the input box.
Returns: string | undefined
The value to pre-fill in the input box. **Returns:** `string | undefined`
value-selectioncljs
(value-selection input-box-options)Selection of the pre-filled {@linkcode InputBoxOptions.value 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.
Returns: [number, number] | undefined
Selection of the pre-filled {@linkcode InputBoxOptions.value 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.
**Returns:** `[number, number] | undefined`cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close