Options$Typings extension

on

Properties

alias ↔ String?
The alias to use.
getter/setter pair
allowMinus ↔ bool?
Allow to enter -.
getter/setter pair
alternatormarker ↔ String?
Definition of the symbols used to indicate an alternator part in the mask.
getter/setter pair
autoUnmask ↔ bool?
Automatically unmask the value when retrieved.
getter/setter pair
casing ↔ Casing?
Apply casing at the mask-level.
getter/setter pair
clearIncomplete ↔ bool?
Clear the incomplete input on blur.
getter/setter pair
clearMaskOnLostFocus ↔ bool?
Remove the empty mask on blur or when not empty remove the optional trailing part.
getter/setter pair
definitions ↔ Object?
Add new definitions to this inputmask.
getter/setter pair
digits ↔ dynamic
Number of fractionalDigits.
getter/setter pair
digitsOptional ↔ bool?
Specify wheter the digits are optional.
getter/setter pair
displayFormat ↔ String?
Visual format when the input looses focus
getter/setter pair
enforceDigitsOnBlur ↔ bool?
Enforces the decimal part when leaving the input field.
getter/setter pair
escapeChar ↔ String?
Definition of the symbols used to escape a part in the mask.
getter/setter pair
greedy ↔ bool?
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?
Definition of the symbols used to indicate a group in the mask.
getter/setter pair
groupSeparator ↔ String?
Define the groupseparator.
getter/setter pair
ignorables ↔ List<num>?
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?
Specify to use the data-inputmask attributes or to ignore them.
getter/setter pair
inputFormat ↔ String?
Format used to input a date. This option is only effective for the datetime alias.
getter/setter pair
inputmode ↔ InputMode?
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?
Indicates whether the value passed for initialization is text or a number.
getter/setter pair
insertMode ↔ bool?
Toggle to insert or overwrite input. This option can be altered by pressing the Insert key.
getter/setter pair
insertModeVisual ↔ bool?
Show selected caret when insertMode = false.
getter/setter pair
isComplete ↔ (bool Function(List<String>, Options)?)
With this call-in (hook) you can override the default implementation of the isComplete function.
getter/setter pair
jitMasking ↔ bool?
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?
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
The mask to use.
getter/setter pair
max ↔ dynamic
Maximum value. This needs to be in the same format as the inputFormat when used with the datetime alias.
getter/setter pair
min ↔ dynamic
Minimum value. This needs to be in the same format as the inputFormat when used with the datetime alias.
getter/setter pair
negationSymbol ↔ dynamic
Define your negationSymbol.
getter/setter pair
noValuePatching ↔ bool?
Disable value property patching
getter/setter pair
nullable ↔ bool?
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?
Numeric input direction. Keeps the caret at the end.
getter/setter pair
onBeforeMask ↔ (String Function(String, Options)?)
Executes before masking the initial value to allow preprocessing of the initial value.
getter/setter pair
onBeforePaste ↔ (String Function(String, Options)?)
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)?)
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()?)
Execute a function when the mask is cleared.
getter/setter pair
oncomplete ↔ (void Function()?)
Execute a function when the mask is completed.
getter/setter pair
onincomplete ↔ (void Function()?)
Execute a function when the mask is cleared.
getter/setter pair
onKeyDown ↔ (void Function(KeyboardEvent, List<String>, dynamic, Options)?)
Callback to implement autocomplete on certain keys for example.
getter/setter pair
onKeyValidation ↔ (void Function(num, bool)?)
Callback function is executed on every keyvalidation with the key, result as the parameter.
getter/setter pair
onUnMask ↔ (String Function(String, String)?)
Executes after unmasking to allow post-processing of the unmaskedvalue.
getter/setter pair
optionalmarker ↔ Object?
Definition of the symbols used to indicate an optional part in the mask.
getter/setter pair
outputFormat ↔ String?
Format of the unmasked value. This is only effective when used with the datetime alias.
getter/setter pair
placeholder ↔ String?
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?
Positioning of the caret on click.
getter/setter pair
positionCaretOnTab ↔ bool?
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])?)
Hook to postValidate the result from isValid. Useful for validating the entry as a whole.
getter/setter pair
prefillYear ↔ bool?
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?
Define a prefix.
getter/setter pair
preValidation ↔ (Object Function(List<String>, num, String, bool, Options, dynamic, bool, [dynamic])?)
Hook to preValidate the input. Useful for validating regardless of the definition.
getter/setter pair
quantifiermarker ↔ Object?
Definition of the symbols used to indicate a quantifier in the mask.
getter/setter pair
radixPoint ↔ String?
Define the radixpoint (decimal separator)
getter/setter pair
regex ↔ String?
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?
Remove the mask before submitting the form.
getter/setter pair
repeat ↔ dynamic
Mask repeat function. Repeat the mask definition x-times. * ~ forever, otherwise specify an integer
getter/setter pair
rightAlign ↔ bool?
Align the input to the right
getter/setter pair
roundingFN ↔ (num Function(num)?)
Set the function for rounding the values when set.
getter/setter pair
setMaxOnOverflow ↔ bool?
Set the maximum value when the user types a number which is greater that the value of max.
getter/setter pair
shiftPositions ↔ bool?
Alter the behavior of the char shifting on entry or deletion.
getter/setter pair
shortcuts ↔ Object?
Define shortcuts. This will allow typing 1k => 1000, 2m => 2000000
getter/setter pair
showMaskOnFocus ↔ bool?
Shows the mask when the input gets focus.
getter/setter pair
showMaskOnHover ↔ bool?
Shows the mask when the input is hevered by the mouse cursor.
getter/setter pair
skipOptionalPartCharacter ↔ String?
A character which can be used to skip an optional part of a mask.
getter/setter pair
staticDefinitionSymbol ↔ String?
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?
Define the step the ctrl-up & ctrl-down must take.
getter/setter pair
suffix ↔ String?
Define a suffix.
getter/setter pair
supportsInputType ↔ List<String>?
List with the supported input types
getter/setter pair
tabThrough ↔ bool?
Allows for tabbing through the different parts of the masked field.
getter/setter pair
undoOnEscape ↔ bool?
Make escape behave like undo. (ctrl-Z) Pressing escape reverts the value to the value before focus.
getter/setter pair
unmaskAsNumber ↔ bool?
Make unmasking returning a number instead of a string.
getter/setter pair
usePrototypeDefinitions ↔ bool?
Use the default defined definitions from the prototype.
getter/setter pair