dots.vscode.input-box — io.github.dots-cljs/dots-vscode 1.89.0-5

A concrete {@link QuickInput } to let the user input a text value.

Note that in many cases the more convenient {@link window.showInputBox } is easier to use. {@link window.createInputBox } should be used when {@link window.showInputBox } does not offer the required flexibility.

busy? cljs

(busy? input-box)

If the UI should show a progress indicator. Defaults to false.

Change this to true, e.g., while loading more data or validating user input.

buttons cljs

(buttons input-box)

Buttons for actions in the UI.

dispose cljs

(dispose input-box)

Dispose of this input UI and any associated resources. If it is still visible, it is first hidden. After this call the input UI is no longer functional and no additional methods or properties on it should be accessed. Instead a new input UI should be created.

Returns: void

enabled? cljs

(enabled? input-box)

If the UI should allow for user input. Defaults to true.

Change this to false, e.g., while validating user input or loading data for the next step in user input.

hide cljs

(hide input-box)

Hides this input UI. This will also fire an {@link QuickInput.onDidHide } event.

Returns: void

ignore-focus-out? cljs

(ignore-focus-out? input-box)

If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.

on-did-accept cljs

(on-did-accept input-box)

(on-did-accept input-box listener)

(on-did-accept input-box listener this-args)

(on-did-accept input-box listener this-args disposables)

An event signaling when the user indicated acceptance of the input value.

Parameters:

• listener: (e: T) => any - The listener function will be called when the event happens.
• this-args: any - The this-argument which will be used when calling the event listener.
• disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

on-did-change-value cljs

(on-did-change-value input-box)

(on-did-change-value input-box listener)

(on-did-change-value input-box listener this-args)

(on-did-change-value input-box listener this-args disposables)

An event signaling when the value has changed.

Parameters:

• listener: (e: T) => any - The listener function will be called when the event happens.
• this-args: any - The this-argument which will be used when calling the event listener.
• disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

on-did-hide cljs

(on-did-hide input-box)

(on-did-hide input-box listener)

(on-did-hide input-box listener this-args)

(on-did-hide input-box listener this-args disposables)

An event signaling when this input UI is hidden.

There are several reasons why this UI might have to be hidden and the extension will be notified through {@link QuickInput.onDidHide }. (Examples include: an explicit call to {@link QuickInput.hide }, the user pressing Esc, some other input UI opening, etc.)

Parameters:

• listener: (e: T) => any - The listener function will be called when the event happens.
• this-args: any - The this-argument which will be used when calling the event listener.
• disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

on-did-trigger-button cljs

(on-did-trigger-button input-box)

(on-did-trigger-button input-box listener)

(on-did-trigger-button input-box listener this-args)

(on-did-trigger-button input-box listener this-args disposables)

An event signaling when a button was triggered.

Parameters:

• listener: (e: T) => any - The listener function will be called when the event happens.
• this-args: any - The this-argument which will be used when calling the event listener.
• disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

password? cljs

(password? input-box)

If the input value should be hidden. Defaults to false.

placeholder cljs

(placeholder input-box)

Optional placeholder shown when no value has been input.

prompt cljs

(prompt input-box)

An optional prompt text providing some ask or explanation to the user.

set-busy! cljs

(set-busy! input-box value)

If the UI should show a progress indicator. Defaults to false.

Change this to true, e.g., while loading more data or validating user input.

set-buttons! cljs

(set-buttons! input-box value)

Buttons for actions in the UI.

set-enabled! cljs

(set-enabled! input-box value)

If the UI should allow for user input. Defaults to true.

Change this to false, e.g., while validating user input or loading data for the next step in user input.

set-ignore-focus-out! cljs

(set-ignore-focus-out! input-box value)

If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.

set-on-did-hide! cljs

(set-on-did-hide! input-box value)

An event signaling when this input UI is hidden.

There are several reasons why this UI might have to be hidden and the extension will be notified through {@link QuickInput.onDidHide }. (Examples include: an explicit call to {@link QuickInput.hide }, the user pressing Esc, some other input UI opening, etc.)

set-password! cljs

(set-password! input-box value)

If the input value should be hidden. Defaults to false.

set-placeholder! cljs

(set-placeholder! input-box value)

Optional placeholder shown when no value has been input.

set-prompt! cljs

(set-prompt! input-box value)

An optional prompt text providing some ask or explanation to the user.

set-step! cljs

(set-step! input-box value)

An optional current step count.

set-title! cljs

(set-title! input-box value)

An optional title.

set-total-steps! cljs

(set-total-steps! input-box value)

An optional total step count.

set-validation-message! cljs

(set-validation-message! input-box value)

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.

set-value! cljs

(set-value! input-box value)

Current input value.

set-value-selection! cljs

(set-value-selection! input-box value)

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.

This property does not get updated when the user types or makes a selection, but it can be updated by the extension.

show cljs

(show input-box)

Makes the input UI visible in its current configuration. Any other input UI will first fire an {@link QuickInput.onDidHide } event.

Returns: void

step cljs

(step input-box)

An optional current step count.

title cljs

(title input-box)

An optional title.

total-steps cljs

(total-steps input-box)

An optional total step count.

validation-message cljs

(validation-message input-box)

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.

value cljs

(value input-box)

Current input value.

value-selection cljs

(value-selection input-box)

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.

This property does not get updated when the user types or makes a selection, but it can be updated by the extension.