Options class

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

Constructors

Options({String? placeholder, Object? optionalmarker, Object? quantifiermarker, Object? groupmarker, String? alternatormarker, String? escapeChar, dynamic mask, String? regex, void oncomplete()?, void onincomplete()?, void oncleared()?, dynamic repeat, bool? greedy, bool? autoUnmask, bool? removeMaskOnSubmit, bool? clearMaskOnLostFocus, bool? insertMode, bool? insertModeVisual, bool? clearIncomplete, String? alias, void onKeyDown(KeyboardEvent, List<String>, dynamic, Options)?, String onBeforeMask(String, Options)?, String onBeforePaste(String, Options)?, CommandObject onBeforeWrite(KeyboardEvent, List<String>, num, Options)?, String onUnMask(String, String)?, bool? showMaskOnFocus, bool? showMaskOnHover, void onKeyValidation(num, bool)?, String? skipOptionalPartCharacter, bool? numericInput, bool? rightAlign, bool? undoOnEscape, String? radixPoint, String? groupSeparator, bool? keepStatic, bool? positionCaretOnTab, bool? tabThrough, List<String>? supportsInputType, List<num>? ignorables, bool isComplete(List<String>, Options)?, Object postValidation(List<String>, num, String, bool, Options, bool, bool, [dynamic])?, Object preValidation(List<String>, num, String, bool, Options, dynamic, bool, [dynamic])?, String? staticDefinitionSymbol, bool? jitMasking, bool? nullable, bool? noValuePatching, PositionCaretOnClick? positionCaretOnClick, Casing? casing, InputMode? inputmode, bool? importDataAttributes, bool? shiftPositions, bool? usePrototypeDefinitions, dynamic min, dynamic max, dynamic digits, bool? digitsOptional, bool? enforceDigitsOnBlur, bool? allowMinus, IInline3? negationSymbol, String? prefix, String? suffix, bool? setMaxOnOverflow, num? step, bool? unmaskAsNumber, InputType? inputType, num roundingFN(num)?, Object? shortcuts, String? inputFormat, String? outputFormat, String? displayFormat, Object? definitions, bool? prefillYear})
factory

Properties

alias ↔ String?

Available on Options, provided by the Options$Typings extension

The alias to use.
getter/setter pair
allowMinus ↔ bool?

Available on Options, provided by the Options$Typings extension

Allow to enter -.
getter/setter pair
alternatormarker ↔ String?

Available on Options, provided by the Options$Typings extension

Definition of the symbols used to indicate an alternator part in the mask.
getter/setter pair
autoUnmask ↔ bool?

Available on Options, provided by the Options$Typings extension

Automatically unmask the value when retrieved.
getter/setter pair
casing ↔ Casing?

Available on Options, provided by the Options$Typings extension

Apply casing at the mask-level.
getter/setter pair
clearIncomplete ↔ bool?

Available on Options, provided by the Options$Typings extension

Clear the incomplete input on blur.
getter/setter pair
clearMaskOnLostFocus ↔ bool?

Available on Options, provided by the Options$Typings extension

Remove the empty mask on blur or when not empty remove the optional trailing part.
getter/setter pair
definitions ↔ Object?

Available on Options, provided by the Options$Typings extension

Add new definitions to this inputmask.
getter/setter pair
digits ↔ dynamic

Available on Options, provided by the Options$Typings extension

Number of fractionalDigits.
getter/setter pair
digitsOptional ↔ bool?

Available on Options, provided by the Options$Typings extension

Specify wheter the digits are optional.
getter/setter pair
displayFormat ↔ String?

Available on Options, provided by the Options$Typings extension

Visual format when the input looses focus
getter/setter pair
enforceDigitsOnBlur ↔ bool?

Available on Options, provided by the Options$Typings extension

Enforces the decimal part when leaving the input field.
getter/setter pair
escapeChar ↔ String?

Available on Options, provided by the Options$Typings extension

Definition of the symbols used to escape a part in the mask.
getter/setter pair
greedy ↔ bool?

Available on Options, provided by the Options$Typings extension

Toggle to allocate as much possible or the opposite. Non-greedy repeat function. With the non-greedy option set to false, you can specify * as repeat. This makes an endless repeat.
getter/setter pair
groupmarker ↔ Object?

Available on Options, provided by the Options$Typings extension

Definition of the symbols used to indicate a group in the mask.
getter/setter pair
groupSeparator ↔ String?

Available on Options, provided by the Options$Typings extension

Define the groupseparator.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
ignorables ↔ List<num>?

Available on Options, provided by the Options$Typings extension

Specify keyCodes which should not be considered in the keypress event, otherwise the preventDefault will stop their default behavior especially in FF.
getter/setter pair
importDataAttributes ↔ bool?

Available on Options, provided by the Options$Typings extension

Specify to use the data-inputmask attributes or to ignore them.
getter/setter pair
inputFormat ↔ String?

Available on Options, provided by the Options$Typings extension

Format used to input a date. This option is only effective for the datetime alias.
getter/setter pair
inputmode ↔ InputMode?

Available on Options, provided by the Options$Typings extension

Specify the inputmode - already in place for when browsers start to support them https://html.spec.whatwg.org/#input-modalities:-the-inputmode-attribute
getter/setter pair
inputType ↔ InputType?

Available on Options, provided by the Options$Typings extension

Indicates whether the value passed for initialization is text or a number.
getter/setter pair
insertMode ↔ bool?

Available on Options, provided by the Options$Typings extension

Toggle to insert or overwrite input. This option can be altered by pressing the Insert key.
getter/setter pair
insertModeVisual ↔ bool?

Available on Options, provided by the Options$Typings extension

Show selected caret when insertMode = false.
getter/setter pair
isComplete ↔ bool Function(List<String>, Options)?

Available on Options, provided by the Options$Typings extension

With this call-in (hook) you can override the default implementation of the isComplete function.
getter/setter pair
jitMasking ↔ bool?

Available on Options, provided by the Options$Typings extension

Just in time masking. With the jitMasking option you can enable jit masking. The mask will only be visible for the user entered characters.
getter/setter pair
keepStatic ↔ bool?

Available on Options, provided by the Options$Typings extension

Use in combination with the alternator syntax Try to keep the mask static while typing. Decisions to alter the mask will be postponed if possible.
getter/setter pair
mask ↔ dynamic

Available on Options, provided by the Options$Typings extension

The mask to use.
getter/setter pair
max ↔ dynamic

Available on Options, provided by the Options$Typings extension

Maximum value. This needs to be in the same format as the inputFormat when used with the datetime alias.
getter/setter pair
min ↔ dynamic

Available on Options, provided by the Options$Typings extension

Minimum value. This needs to be in the same format as the inputFormat when used with the datetime alias.
getter/setter pair
negationSymbol ↔ dynamic

Available on Options, provided by the Options$Typings extension

Define your negationSymbol.
getter/setter pair
noValuePatching ↔ bool?

Available on Options, provided by the Options$Typings extension

Disable value property patching
getter/setter pair
nullable ↔ bool?

Available on Options, provided by the Options$Typings extension

Return nothing from the input value property when the user hasn't entered anything. If this is false, the mask might be returned.
getter/setter pair
numericInput ↔ bool?

Available on Options, provided by the Options$Typings extension

Numeric input direction. Keeps the caret at the end.
getter/setter pair
onBeforeMask ↔ String Function(String, Options)?

Available on Options, provided by the Options$Typings extension

Executes before masking the initial value to allow preprocessing of the initial value.
getter/setter pair
onBeforePaste ↔ String Function(String, Options)?

Available on Options, provided by the Options$Typings extension

This callback allows for preprocessing the pasted value before actually handling the value for masking. This can be useful for stripping away some characters before processing. You can also disable pasting a value by returning false in the onBeforePaste call.
getter/setter pair
onBeforeWrite ↔ CommandObject Function(KeyboardEvent, List<String>, num, Options)?

Available on Options, provided by the Options$Typings extension

Executes before writing to the masked element. Use this to do some extra processing of the input. This can be useful when implementing an alias, ex. decimal alias, autofill the digits when leaving the inputfield.
getter/setter pair
oncleared ↔ void Function()?

Available on Options, provided by the Options$Typings extension

Execute a function when the mask is cleared.
getter/setter pair
oncomplete ↔ void Function()?

Available on Options, provided by the Options$Typings extension

Execute a function when the mask is completed.
getter/setter pair
onincomplete ↔ void Function()?

Available on Options, provided by the Options$Typings extension

Execute a function when the mask is cleared.
getter/setter pair
onKeyDown ↔ void Function(KeyboardEvent, List<String>, dynamic, Options)?

Available on Options, provided by the Options$Typings extension

Callback to implement autocomplete on certain keys for example.
getter/setter pair
onKeyValidation ↔ void Function(num, bool)?

Available on Options, provided by the Options$Typings extension

Callback function is executed on every keyvalidation with the key, result as the parameter.
getter/setter pair
onUnMask ↔ String Function(String, String)?

Available on Options, provided by the Options$Typings extension

Executes after unmasking to allow post-processing of the unmaskedvalue.
getter/setter pair
optionalmarker ↔ Object?

Available on Options, provided by the Options$Typings extension

Definition of the symbols used to indicate an optional part in the mask.
getter/setter pair
outputFormat ↔ String?

Available on Options, provided by the Options$Typings extension

Format of the unmasked value. This is only effective when used with the datetime alias.
getter/setter pair
placeholder ↔ String?

Available on Options, provided by the Options$Typings extension

Change the mask placeholder. Instead of "_", you can change the unfilled characters mask as you like, simply by adding the placeholder option. For example, placeholder: " " will change the default autofill with empty values.
getter/setter pair
positionCaretOnClick ↔ PositionCaretOnClick?

Available on Options, provided by the Options$Typings extension

Positioning of the caret on click.
getter/setter pair
positionCaretOnTab ↔ bool?

Available on Options, provided by the Options$Typings extension

When enabled the caret position is set after the latest valid position on TAB.
getter/setter pair
postValidation ↔ Object Function(List<String>, num, String, bool, Options, bool, bool, [dynamic])?

Available on Options, provided by the Options$Typings extension

Hook to postValidate the result from isValid. Useful for validating the entry as a whole.
getter/setter pair
prefillYear ↔ bool?

Available on Options, provided by the Options$Typings extension

Enable/disable prefilling of the year. Although you can just over type the proposed value without deleting, many seems to see a problem with the year prediction. This options is to disable this feature.
getter/setter pair
prefix ↔ String?

Available on Options, provided by the Options$Typings extension

Define a prefix.
getter/setter pair
preValidation ↔ Object Function(List<String>, num, String, bool, Options, dynamic, bool, [dynamic])?

Available on Options, provided by the Options$Typings extension

Hook to preValidate the input. Useful for validating regardless of the definition.
getter/setter pair
quantifiermarker ↔ Object?

Available on Options, provided by the Options$Typings extension

Definition of the symbols used to indicate a quantifier in the mask.
getter/setter pair
radixPoint ↔ String?

Available on Options, provided by the Options$Typings extension

Define the radixpoint (decimal separator)
getter/setter pair
regex ↔ String?

Available on Options, provided by the Options$Typings extension

Use a regular expression as a mask. When using shorthands be aware that you need to double escape or use String.raw with a string literal.
getter/setter pair
removeMaskOnSubmit ↔ bool?

Available on Options, provided by the Options$Typings extension

Remove the mask before submitting the form.
getter/setter pair
repeat ↔ dynamic

Available on Options, provided by the Options$Typings extension

Mask repeat function. Repeat the mask definition x-times. * ~ forever, otherwise specify an integer
getter/setter pair
rightAlign ↔ bool?

Available on Options, provided by the Options$Typings extension

Align the input to the right
getter/setter pair
roundingFN ↔ num Function(num)?

Available on Options, provided by the Options$Typings extension

Set the function for rounding the values when set.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
setMaxOnOverflow ↔ bool?

Available on Options, provided by the Options$Typings extension

Set the maximum value when the user types a number which is greater that the value of max.
getter/setter pair
shiftPositions ↔ bool?

Available on Options, provided by the Options$Typings extension

Alter the behavior of the char shifting on entry or deletion.
getter/setter pair
shortcuts ↔ Object?

Available on Options, provided by the Options$Typings extension

Define shortcuts. This will allow typing 1k => 1000, 2m => 2000000
getter/setter pair
showMaskOnFocus ↔ bool?

Available on Options, provided by the Options$Typings extension

Shows the mask when the input gets focus.
getter/setter pair
showMaskOnHover ↔ bool?

Available on Options, provided by the Options$Typings extension

Shows the mask when the input is hevered by the mouse cursor.
getter/setter pair
skipOptionalPartCharacter ↔ String?

Available on Options, provided by the Options$Typings extension

A character which can be used to skip an optional part of a mask.
getter/setter pair
staticDefinitionSymbol ↔ String?

Available on Options, provided by the Options$Typings extension

The staticDefinitionSymbol option is used to indicate that the static entries in the mask can match a certain definition. Especially useful with alternators so that static element in the mask can match another alternation.
getter/setter pair
step ↔ num?

Available on Options, provided by the Options$Typings extension

Define the step the ctrl-up & ctrl-down must take.
getter/setter pair
suffix ↔ String?

Available on Options, provided by the Options$Typings extension

Define a suffix.
getter/setter pair
supportsInputType ↔ List<String>?

Available on Options, provided by the Options$Typings extension

List with the supported input types
getter/setter pair
tabThrough ↔ bool?

Available on Options, provided by the Options$Typings extension

Allows for tabbing through the different parts of the masked field.
getter/setter pair
undoOnEscape ↔ bool?

Available on Options, provided by the Options$Typings extension

Make escape behave like undo. (ctrl-Z) Pressing escape reverts the value to the value before focus.
getter/setter pair
unmaskAsNumber ↔ bool?

Available on Options, provided by the Options$Typings extension

Make unmasking returning a number instead of a string.
getter/setter pair
usePrototypeDefinitions ↔ bool?

Available on Options, provided by the Options$Typings extension

Use the default defined definitions from the prototype.
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