Listens to element events and controls changes between element and Masked
((MaskElement | HTMLInputElement | HTMLTextAreaElement))
(Object)
View element
Type: MaskElement
Typed unmasked value
Type: any
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
(InputEvent)
void
Handles view change event and commits model value
Unbind view events and removes element reference
Checks if value is string
(any)
boolean
Direction
Direction
Type: string
Returns next char index in direction
number
Returns next char position in direction
number
(Direction)
Direction
Escapes regular expression control chars
(string)
string
Selection range
Provides details of changing input
Date mask
Extends MaskedPattern
(Object)
Pattern mask for date according to MaskedDate#format
Type: string
(any)
Pattern mask
Extends Masked
Type: {}
Type: Definitions
Type: MaskedPatternState
MaskedPatternState
ChangeDetails
(string)
(AppendFlags
= {}
)
ChangeDetails
Appends placeholder depending on laziness
(number?)
ChangeDetails
ChangeDetails
Provides details of changing model value
Aggregate changes
(ChangeDetails)
ChangeDetails
:
this
Supported mask type
Type:
(string | String | RegExp | Class<Number> | Class<Date> | Array<any> | $PropertyType<Masked<any>, "validate"
> | Masked<any> | Class<Masked<any>>)
Append flags
Extract flags
(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
Sets and applies new options
({})
Sets new options
({})
Mask state
Type: any
any
Resets value
Type: any
any
Extracts value in range considering flags
string
Appends tail
ChangeDetails
Appends char
(string)
(AppendFlags
= {}
)
ChangeDetails
Appends char
ChangeDetails
Appends optional placeholder at end
ChangeDetails
Appends symbols considering flags
ChangeDetails
ChangeDetails
Calls function and reapplies current value
(function (): T)
T
(function (masked: any): 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
($PropertyType<PatternInputDefinition, "parent"
>)
(Mask)
($PropertyType<PatternInputDefinition, "isOptional"
>)
($PropertyType<PatternInputDefinition, "lazy"
>)
($PropertyType<PatternInputDefinition, "placeholderChar"
>)
($PropertyType<PatternFixedDefinition, "char"
>)
($PropertyType<PatternFixedDefinition, "isUnmasking"
>?)
Type: string
Type: string
Type: boolean?
Type: boolean?
Type: number?
Provides details of continuous extracted tail
Masking by RegExp
Extends Masked
Pattern which accepts ranges
Extends MaskedPattern
Optionally sets max length of pattern.
Used when pattern length is longer then to
param length. Pads zeros at start in this case.
Type: number
(any)
(string)
(AppendFlags
= {}
)
string
Get Masked class by mask type
(Mask)
Class<Masked<any>>
Creates new Masked depending on mask type
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)
Type: HTMLDocument
HTMLDocument
Binds HTMLElement events to mask internal events
({})
Unbinds HTMLElement events to mask internal events
Returns HTMLElement selection start
Type: number
number
Returns HTMLElement selection end
Type: number
number
Sets HTMLElement selection
HTMLElement value
Type: string
string
Applies mask on element.
((HTMLInputElement | HTMLTextAreaElement | MaskElement))
Element to apply mask
(Object
= {}
)
Custom mask options
InputMask
: