Set the maximum value when the user types a number which is greater that the value of max.
The alias to use.
Allow to enter -.
Definition of the symbols used to indicate an alternator part in the mask.
Automatically unmask the value when retrieved.
When setting this option to true the plugin also expects the initial value from the server to be unmasked.
A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.
Apply casing at the mask-level.
Clear the incomplete input on blur.
Remove the empty mask on blur or when not empty remove the optional trailing part.
Add new definitions to this inputmask.
Number of fractionalDigits.
Possible values:
*2,4. When the quantifier syntax is used, the digitsOptional option is ignoredSpecify wheter the digits are optional.
Visual format when the input looses focus
Enforces the decimal part when leaving the input field.
Definition of the symbols used to escape a part in the mask.
ID of the form to use for AJAX requests.
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.
Define the groupseparator.
Definition of the symbols used to indicate a group in the mask.
The client-side ID of the widget, with all parent naming containers, such as
myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs
multiple container elements (such as Paginator), this may also be an array if IDs.
Specify keyCodes which should not be considered in the keypress event, otherwise the preventDefault will
stop their default behavior especially in FF.
Specify to use the data-inputmask attributes or to ignore them.
If you don't use data attributes you can disable the import by specifying importDataAttributes: false.
Format used to input a date. This option is only effective for the datetime alias.
Supported symbols
d - Day of the month as digits; no leading zero for single-digit days.dd - Day of the month as digits; leading zero for single-digit days.ddd - Day of the week as a three-letter abbreviation.dddd - Day of the week as its full name.m - Month as digits; no leading zero for single-digit months.mm - Month as digits; leading zero for single-digit months.mmm - Month as a three-letter abbreviation.mmmm - Month as its full name.yy - Year as last two digits; leading zero for years less than 10.yyyy - Year as 4 digits.h - Hours; no leading zero for single-digit hours (12-hour clock).hh - Hours; leading zero for single-digit hours (12-hour clock).hx - Hours; no limit; x = number of digits ~ use as h2, h3, ...H - Hours; no leading zero for single-digit hours (24-hour clock).HH - Hours; leading zero for single-digit hours (24-hour clock).Hx - Hours; no limit; x = number of digits ~ use as H2, H3, ...M - Minutes; no leading zero for single-digit minutes. Uppercase M unlike CF timeFormat's m to avoid
conflict with months.MM - Minutes; leading zero for single-digit minutes. Uppercase MM unlike CF timeFormat's mm to avoid
conflict with months.s - Seconds; no leading zero for single-digit seconds.ss - Seconds; leading zero for single-digit seconds.l - Milliseconds. 3 digits.L - Milliseconds. 2 digits.t - Lowercase, single-character time marker string: a or p.tt - Two-character time marker string: am or pm.T - Single-character time marker string: A or P.TT - Two-character time marker string: AM or PM.Z - US timezone abbreviation, e.g. EST or MDT. With non-US timezones or in the Opera browser, the
GMT/UTC offset is returned, e.g. GMT-0500o - GMT/UTC timezone offset, e.g. -0500 or +0230.S - The date's ordinal suffix (st, nd, rd, or th). Works well with d.Indicates whether the value passed for initialization is text or a number.
text - radixpoint should be the same as in the optionsnumber - radixpoint should be a . as the default for a number in jsSpecify the inputmode - already in place for when browsers start to support them https://html.spec.whatwg.org/#input-modalities:-the-inputmode-attribute
Toggle to insert or overwrite input. This option can be altered by pressing the Insert key.
Show selected caret when insertMode = false.
Just in time masking. With the jitMasking option you can enable jit masking. The mask will only be
visible for the user entered characters.
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.
ex. $(selector).inputmask({ mask: ["+55-99-9999-9999", "+55-99-99999-9999", ], keepStatic: true });
typing 1212345123 => should result in +55-12-1234-5123 type extra 4 => switch to +55-12-12345-1234
When the option is not set, it will default to false, except for multiple masks it will default to true!
The mask template to use.
Maximum value. This needs to be in the same format as the inputFormat when used with the datetime alias.
Minimum value. This needs to be in the same format as the inputFormat when used with the datetime alias.
Define your negationSymbol.
Disable value property patching
Return nothing from the input value property when the user hasn't entered anything. If this is false,
the mask might be returned.
Numeric input direction. Keeps the caret at the end.
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.
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.
Callback function is executed on every keyvalidation with the key, result as the parameter.
Executes after unmasking to allow post-processing of the unmaskedvalue.
New unmasked value
Execute a function when the mask is cleared.
Execute a function when the mask is completed.
Execute a function when the mask is cleared.
Definition of the symbols used to indicate an optional part in the mask.
Format of the unmasked value. This is only effective when used with the datetime alias.
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.
Positioning of the caret on click.
Options:
nonelvp - based on the last valid position (default)radixFocus - position caret to radixpoint on initial clickselect - select the whole inputignore - ignore the click and continue the maskWhen enabled the caret position is set after the latest valid position on TAB.
An optional callback that is invoked
after this widget was created successfully, at the end of the init method. This is
usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called
during a refresh (AJAX update).
An optional callback that is invoked after
this widget was refreshed after an AJAX update, at the end of the refresh method.
This is usually specified via the widgetPostRefresh attribute on the JSF component.
Hook to postValidate the result from isValid. Useful for validating the entry as a whole.
An optional callback that is invoked before
this widget is about to be destroyed, e.g., when the component was removed at the end of an AJAX update. This is
called at the beginning of the destroy method. This is usually specified via the
widgetPreDestroy attribute on the JSF component.
Hook to preValidate the input. Useful for validating regardless of the definition.
When returning true, the normal validation kicks in, otherwise, it is skipped.
When returning a command object the actions are executed and further validation is stopped. If you want to
continue further validation, you need to add the rewritePosition action.
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.
Define a prefix.
Definition of the symbols used to indicate a quantifier in the mask.
Define the radixpoint (decimal separator)
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.
Remove the mask before submitting the form.
Mask repeat function. Repeat the mask definition x-times.
* ~ forever, otherwise specify an integer
Align the input to the right
By setting the rightAlign you can specify to right-align an inputmask. This is only applied in combination of
the numericInput option or the dir-attribute.
Set the function for rounding the values when set.
Other examples:
Math.floorfn(x) { // do your own rounding logic // return x; }Alter the behavior of the char shifting on entry or deletion.
In some cases shifting the mask entries or deletion should be more restrictive.
Ex. date masks. Shifting month to day makes no sense
Define shortcuts. This will allow typing 1k => 1000, 2m => 2000000
To disable just pass shortcuts: null as option
Shows the mask when the input gets focus.
Shows the mask when the input is hevered by the mouse cursor.
A character which can be used to skip an optional part of a mask.
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.
Define the step the ctrl-up & ctrl-down must take.
Strip leading zeroes
Substitude the radixpoint to allow , for . and vice versa
Define a suffix.
List with the supported input types
Allows for tabbing through the different parts of the masked field.
Make escape behave like undo. (ctrl-Z) Pressing escape reverts the value to the value before focus.
Make unmasking returning a number instead of a string.
Be warned that using the unmaskAsNumber option together with jQuery.serialize will fail as serialize expects a string. (See issue #1288)
Use the default defined definitions from the prototype.
The name of the widget variables of this widget. The widget variable can be used to
access a widget instance by calling PF("myWidgetVar").
Generated using TypeDoc
The configuration for the InputMask widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.