InputBox class

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.

Implemented types
Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

InputBox.new({String? value, (num, num)? valueSelection, String? placeholder, bool? password, Event<String>? onDidChangeValue, Event<void>? onDidAccept, List<QuickInputButton>? buttons, Event<QuickInputButton>? onDidTriggerButton, String? prompt, dynamic validationMessage, String? title, num? step, num? totalSteps, bool? enabled, bool? busy, bool? ignoreFocusOut, Event<void>? onDidHide, void show()?, void hide()?, void dispose()?})
factory

Properties

busy ↔ bool

Available on QuickInput, provided by the QuickInput$Typings extension

If the UI should show a progress indicator. Defaults to false.
getter/setter pair
buttons ↔ List<QuickInputButton>

Available on InputBox, provided by the InputBox$Typings extension

Buttons for actions in the UI.
getter/setter pair
dispose ↔ void Function()

Available on QuickInput, provided by the QuickInput$Typings extension

getter/setter pair
enabled ↔ bool

Available on QuickInput, provided by the QuickInput$Typings extension

If the UI should allow for user input. Defaults to true.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hide ↔ void Function()

Available on QuickInput, provided by the QuickInput$Typings extension

getter/setter pair
ignoreFocusOut ↔ bool

Available on QuickInput, provided by the QuickInput$Typings extension

If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.
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
onDidHide ↔ Event<void>

Available on QuickInput, provided by the QuickInput$Typings extension

An event signaling when this input UI is hidden.
getter/setter pair
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
show ↔ void Function()

Available on QuickInput, provided by the QuickInput$Typings extension

getter/setter pair
step ↔ num?

Available on QuickInput, provided by the QuickInput$Typings extension

An optional current step count.
getter/setter pair
title ↔ String?

Available on QuickInput, provided by the QuickInput$Typings extension

An optional title.
getter/setter pair
totalSteps ↔ num?

Available on QuickInput, provided by the QuickInput$Typings extension

An optional total step count.
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

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited