Applies mask on element.
((HTMLInputElement | HTMLTextAreaElement | MaskElement))
Element to apply mask
(Object
= {}
)
Custom mask options
InputMask
:
Checks if value is string
(any)
boolean
Direction
Direction
Returns next char index in direction
(number)
(Direction)
number
Returns next char position in direction
(number)
(Direction)
number
(Direction)
Direction
Escapes regular expression control chars
(string)
string
Selection range
Type: {start: number, end: number}
Listens to element events and controls changes between element and Masked
((MaskElement | HTMLInputElement | HTMLTextAreaElement))
(Object)
View element
Type: MaskElement
Typed unmasked value
any
Starts listening to element events
Stops listening to element events
Stores current selection
Syncronizes model value from view
Syncronizes view from model value, fires change events
Updates options with deep equal check, recreates @{link Masked} model if mask type changes
({})
Fires custom events
Aligns cursor to nearest available position
Aligns cursor only if selection is empty
Handles view input event
Handles view change event and commits model value
Unbind view events and removes element reference
Provides details of changing input
Remove direction
Direction
Supported mask type
Type:
(string | String | RegExp | Class<Number> | Class<Date> | Array<any> | $PropertyType<Masked<any>, "validate"
> | Masked<any> | Class<Masked<any>>)
Append flags
Type: {input: boolean?, tail: boolean?, raw: boolean?}
Extract flags
Type: {raw: boolean?}
(boolean?)
Provides common masking stuff
({})
Transforms value before mask processing
Type: function (string, Masked<MaskType>, AppendFlags): string
Validates if value is acceptable
Type: function (string, Masked<MaskType>, AppendFlags): boolean
Does additional processing in the end of editing
Type: function (string, AppendFlags): void
Sets and applies new options
({})
Sets new options
({})
Mask state
any
Resets value
any
Extracts value in range considering flags
string
Extracts tail in range
TailDetails
Stores state before tail
Restores state before tail
Resets state before tail
Appends tail
(TailDetails)
ChangeDetails
Appends char
(string)
(AppendFlags
= {}
)
ChangeDetails
Appends char
ChangeDetails
Appends symbols considering flags
ChangeDetails
ChangeDetails
Calls function and reapplies current value
(function (): T)
T
Prepares string before mask processing
(string)
(AppendFlags
= {}
)
string
Validates if value is acceptable
(AppendFlags)
boolean
Does additional processing in the end of editing
ChangeDetails
Provides details of changing model value
Aggregate changes
(ChangeDetails)
ChangeDetails
:
this
Provides details of extracted tail
Tail value as string
Start position
Pattern mask
Extends Masked
Type: {}
Type: Definitions
MaskedPatternState
((ChunksTailDetails | TailDetails))
ChangeDetails
(string)
(AppendFlags
= {}
)
ChangeDetails
Appends placeholder depending on laziness
(number?)
ChangeDetails
ChangeDetails
Get block by name
(string)
PatternBlock?
Get all blocks by name
(string)
Array<PatternBlock>
Type:
{parent: $PropertyType<PatternInputDefinition, "parent"
>, mask: Mask, isOptional: $PropertyType<PatternInputDefinition, "isOptional"
>, lazy: $PropertyType<PatternInputDefinition, "lazy"
>, placeholderChar: $PropertyType<PatternInputDefinition, "placeholderChar"
>}
($PropertyType<PatternInputDefinition, "parent"
>)
(Mask)
($PropertyType<PatternInputDefinition, "isOptional"
>)
($PropertyType<PatternInputDefinition, "lazy"
>)
($PropertyType<PatternInputDefinition, "placeholderChar"
>)
Type:
{char: $PropertyType<PatternFixedDefinition, "char"
>, isUnmasking: $PropertyType<PatternFixedDefinition, "isUnmasking"
>?}
($PropertyType<PatternFixedDefinition, "char"
>)
($PropertyType<PatternFixedDefinition, "isUnmasking"
>?)
Type: string
Type: string
Type: boolean?
Type: boolean?
Subset of Masked attributes used with pattern
(string)
(string)
(boolean)
(function (number?): ChangeDetails?)
(any)
(function (): void)
(function (fromPos: number, toPos: number): ChangeDetails)
(function (fromPos: number, toPos: number, flags: ExtractFlags): string)
(function (fromPos: number, toPos: number): TailDetails)
(function (tail: TailDetails): ChangeDetails)
(function (str: string, flags: AppendFlags): ChangeDetails)
(function (): void)
Pattern which validates enum values
Extends MaskedPattern
Pattern which accepts ranges
Extends MaskedPattern
Number mask
Extends Masked
(Object)
Name | Description |
---|---|
opts.radix string
|
Single char |
opts.thousandsSeparator string
|
Single char |
opts.mapToRadix Array<string>
|
Array of single chars |
opts.min number
|
|
opts.max number
|
|
opts.scale number
|
Digits after point |
opts.signed boolean
|
Allow negative |
opts.normalizeZeros boolean
|
Flag to remove leading and trailing zeros in the end of editing |
opts.padFractionalZeros boolean
|
Flag to pad trailing zeros after point in the end of editing |
Flag to remove leading and trailing zeros in the end of editing
Type: boolean
Flag to pad trailing zeros after point in the end of editing
Type: boolean
(MaskedNumberOptions)
TailDetails
(string)
(AppendFlags
= {}
)
ChangeDetails
ChangeDetails
(AppendFlags)
Date mask
Extends MaskedPattern
(Object)
Pattern mask for date according to MaskedDate#format
Type: string
(any)
Masking by RegExp
Extends Masked
Masking by custom Function
Extends Masked
Dynamic mask for choosing apropriate mask in run-time
Extends Masked
(Object)
Chooses Masked depending on input value
Type: function (string, Masked<any>, AppendFlags): Masked<any>
(any)
(...any)
ChangeDetails
(string)
(AppendFlags
= {}
)
any
(...any)
ChangeDetails
MaskedDynamicState
(...any)
TailDetails
Get Masked class by mask type
(Mask)
Class<Masked<any>>
Creates new Masked depending on mask type
({mask: Mask})
Masked<any>
Generic element API to use with mask
Bridge between HTMLElement and Masked
Extends MaskElement
((HTMLInputElement | HTMLTextAreaElement))
Mapping between HTMLElement events and mask internal events
Type: {}
HTMLElement to use mask on
Type: (HTMLTextAreaElement | HTMLInputElement)
Binds HTMLElement events to mask internal events
({})
Unbinds HTMLElement events to mask internal events