InputBoxOptions class

Options to configure the behavior of the input box UI.

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

Constructors

InputBoxOptions({String? title, String? value, (num, num)? valueSelection, String? prompt, String? placeHolder, bool? password, bool? ignoreFocusOut, dynamic validateInput(String)?})
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
ignoreFocusOut ↔ bool?

Available on InputBoxOptions, provided by the InputBoxOptions$Typings extension

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.
getter/setter pair
password ↔ bool?

Available on InputBoxOptions, provided by the InputBoxOptions$Typings extension

Controls if a password input is shown. Password input hides the typed text.
getter/setter pair
placeHolder ↔ String?

Available on InputBoxOptions, provided by the InputBoxOptions$Typings extension

An optional string to show as placeholder in the input box to guide the user what to type.
getter/setter pair
prompt ↔ String?

Available on InputBoxOptions, provided by the InputBoxOptions$Typings extension

The text to display underneath the input box.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
title ↔ String?

Available on InputBoxOptions, provided by the InputBoxOptions$Typings extension

An optional string that represents the title of the input box.
getter/setter pair
validateInput ↔ dynamic Function(String)

Available on InputBoxOptions, provided by the InputBoxOptions$Typings extension

getter/setter pair
value ↔ String?

Available on InputBoxOptions, provided by the InputBoxOptions$Typings extension

The value to pre-fill in the input box.
getter/setter pair
valueSelection ↔ (num, num)?

Available on InputBoxOptions, provided by the InputBoxOptions$Typings extension

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.
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