Class InputMask<Opts>

Listens to element events and controls changes between element and Masked

Type Parameters

Opts extends FactoryArg = Record<string, unknown>

Constructors

constructor

new InputMask<Opts>(el, opts): InputMask<Opts>
Type Parameters
- Opts extends FactoryArg = Record<string, unknown>
Parameters
- el: InputMaskElement
- opts: Opts
Returns InputMask<Opts>
- Defined in controls/input.ts:40

Properties

_changingCursorPos

_changingCursorPos: number

`Optional` _cursorChanging

_cursorChanging?: Timeout

`Optional` _historyChanging

_historyChanging?: boolean

`Optional` _inputEvent

_inputEvent?: InputEvent

_listeners

_listeners: Record<string, InputMaskEventListener[]>

_rawInputValue

_rawInputValue: string

_selection

_selection: Selection

_unmaskedValue

_unmaskedValue: string

_value

_value: string

el

el: MaskElement

View element

history

history: default

masked

masked: FactoryReturnMasked<Opts>

Internal Masked model

Accessors

cursorPos

get cursorPos(): number
Current cursor position

Returns number
- Defined in controls/input.ts:184
set cursorPos(pos): void
Parameters
- pos: number
Returns void
- Defined in controls/input.ts:190

displayValue

get displayValue(): string
Display value

Returns string
- Defined in controls/input.ts:144

mask

get mask(): FactoryReturnMasked<Opts>["mask"]
Masked

Returns FactoryReturnMasked<Opts>["mask"]
- Defined in controls/input.ts:77
set mask(mask): void
Parameters
- mask: any
Returns void
- Defined in controls/input.ts:80

rawInputValue

get rawInputValue(): string
Raw input value

Returns string
- Defined in controls/input.ts:119
set rawInputValue(str): void
Parameters
- str: string
Returns void
- Defined in controls/input.ts:123

selectionStart

get selectionStart(): number
Current selection start

Returns number
- Defined in controls/input.ts:176

typedValue

get typedValue(): FactoryReturnMasked<Opts>["typedValue"]
Typed unmasked value

Returns FactoryReturnMasked<Opts>["typedValue"]
- Defined in controls/input.ts:132
set typedValue(val): void
Parameters
- val: FactoryReturnMasked<Opts>["typedValue"]
Returns void
- Defined in controls/input.ts:136

unmaskedValue

get unmaskedValue(): string
Unmasked value

Returns string
- Defined in controls/input.ts:107
set unmaskedValue(str): void
Parameters
- str: string
Returns void
- Defined in controls/input.ts:111

value

get value(): string
Raw value

Returns string
- Defined in controls/input.ts:95
set value(str): void
Parameters
- str: string
Returns void
- Defined in controls/input.ts:99

Methods

_abortUpdateCursor

_abortUpdateCursor(): void
Aborts delayed cursor update

Returns void
- Defined in controls/input.ts:285

_applyHistoryState

_applyHistoryState(state): void
Parameters
- state: undefined | InputHistoryState
Returns void
- Defined in controls/input.ts:395

_bindEvents

_bindEvents(): void
Starts listening to element events

Returns void
- Defined in controls/input.ts:149

_delayUpdateCursor

_delayUpdateCursor(cursorPos): void
Delays cursor update to support mobile browsers
Parameters
- cursorPos: number
Returns void
- Defined in controls/input.ts:268

_fireChangeEvents

_fireChangeEvents(): void
Fires custom events

Returns void
- Defined in controls/input.ts:279

_fireEvent

_fireEvent(ev, e?): void
Fires custom event
Parameters
- ev: string
- Optional e: InputEvent
Returns void
- Defined in controls/input.ts:168

_onChange

_onChange(): void
Handles view change event and commits model value

Returns void
- Defined in controls/input.ts:364

_onClick

_onClick(ev): void
Restore last selection on focus
Parameters
- ev: Event
Returns void
- Defined in controls/input.ts:383

_onDrop

_onDrop(ev): void
Handles view drop event, prevents by default
Parameters
- ev: Event
Returns void
- Defined in controls/input.ts:372

_onFocus

_onFocus(ev): void
Restore last selection on focus
Parameters
- ev: Event
Returns void
- Defined in controls/input.ts:378

_onInput

_onInput(e): void
Handles view input event
Parameters
- e: InputEvent
Returns void
- Defined in controls/input.ts:323

_onRedo

_onRedo(): void
Returns void
- Defined in controls/input.ts:391

_onUndo

_onUndo(): void
Returns void
- Defined in controls/input.ts:387

_saveSelection

_saveSelection(): void
Stores current selection

Returns void
- Defined in controls/input.ts:198

_unbindEvents

_unbindEvents(): void
Stops listening to element events

Returns void
- Defined in controls/input.ts:163

alignCursor

alignCursor(): void
Aligns cursor to nearest available position

Returns void
- Defined in controls/input.ts:293

alignCursorFriendly

alignCursorFriendly(): void
Aligns cursor only if selection is empty

Returns void
- Defined in controls/input.ts:298

destroy

destroy(): void
Unbind view events and removes element reference

Returns void
- Defined in controls/input.ts:406

maskEquals

maskEquals(mask): boolean
Parameters
- mask: any
Returns boolean
- Defined in controls/input.ts:72

off

off(ev, handler): this
Removes custom event listener
Parameters
- ev: string
- handler: InputMaskEventListener
Returns this
- Defined in controls/input.ts:311

on

on(ev, handler): this
Adds listener on custom event
Parameters
- ev: string
- handler: InputMaskEventListener
Returns this
- Defined in controls/input.ts:304

updateControl

updateControl(cursorPos?): void
Syncronizes view from model value, fires change events
Parameters
- Optional cursorPos: number | "auto"
Returns void
- Defined in controls/input.ts:217

updateCursor

updateCursor(cursorPos): void
Updates cursor
Parameters
- cursorPos: number
Returns void
- Defined in controls/input.ts:259

updateOptions

updateOptions(opts): void
Updates options with deep equal check, recreates Masked model if mask type changes
Parameters
- opts: Partial<Opts extends Masked<any>
      ? UpdateInstanceOpts<Opts<Opts>>
      : Opts extends undefined | string | RegExp | DateConstructor | NumberConstructor | ((value, masked) => boolean) | DynamicMaskType
          ? UpdateStaticMaskOpts<Opts<Opts>>
          : Opts extends FactoryStaticOpts
              ? UpdateStaticOpts<Opts<Opts>>
              : Opts extends FactoryInstanceOpts
                  ? UpdateInstanceOpts<Opts<Opts>["mask"]>
                  : Opts extends FactoryConstructorOpts
                      ? UpdateConstructorOpts<Opts<Opts>>
                      : AnyOpts>
Returns void
- Defined in controls/input.ts:246

updateValue

updateValue(): void
Syncronizes model value from view

Returns void
- Defined in controls/input.ts:209