Interface Static

Hierarchy

Static

Callable

Static(maskOrAlias: string, opts?: default.Options): Instance
Static(opts?: default.Options): Instance

Creates a new Inputmask instance.

Parameters
- maskOrAlias: string
  
  A mask pattern or a reference to a predefined alias.
- Optional opts: default.Options
  
  Mask options.
Returns Instance
Creates a new Inputmask instance.

Parameters
- Optional opts: default.Options
  
  Mask options.
Returns Instance

Index

Constructors

constructor

Methods

Constructors

constructor

new Static(maskOrAlias: string, opts?: default.Options): Instance
new Static(opts?: default.Options): Instance

Creates a new Inputmask instance.

Parameters
- maskOrAlias: string
  
  A mask pattern or a reference to a predefined alias.
- Optional opts: default.Options
  
  Mask options.
Returns Instance
Creates a new Inputmask instance.

Parameters
- Optional opts: default.Options
  
  Mask options.
Returns Instance

Methods

extendAliases

extendAliases(aliases: {}): void

Extends the set of available mask aliases.

Parameters
- aliases: {}
  - [key: string]: default.Options
Returns void

extendDefaults

extendDefaults(opts: default.Options): void

Extends the default inputmask options.

Parameters
- opts: default.Options
Returns void

extendDefinitions

extendDefinitions(definitions: {}): void

Extends the set of available definitions.

Parameters
- definitions: {}
  - [key: string]: Definition
Returns void

format

format(value: string, opts: default.Options): string

Instead of masking an input element it is also possible to use the inputmask for formatting given values. Think of formatting values to show in jqGrid or on other elements then inputs.

Parameters
- value: string
  
  Value to format.
- opts: default.Options
  
  Mask options.
Returns string

isValid

isValid(value: string, opts: default.Options): boolean

Validate a given value against the mask.

Parameters
- value: string
  
  Value to validate.
- opts: default.Options
  
  Mask options.
Returns boolean

remove

remove(selectorOrElement: string | HTMLElement | ArrayLike<HTMLElement>): void

Remove the inputmask.

Parameters
- selectorOrElement: string | HTMLElement | ArrayLike<HTMLElement>
Returns void

setValue

setValue(selectorOrElement: string | HTMLElement | ArrayLike<HTMLElement>, value: string): void

The setvalue functionality is to set a value to the inputmask like you would do with jQuery.val, BUT it will trigger the internal event used by the inputmask always, whatever the case. This is particular usefull when cloning an inputmask with jQuery.clone. Cloning an inputmask is not a fully functional clone. On the first event (mouseenter, focus, ...) the inputmask can detect if it where cloned and can reactivate the masking. However when setting the value with jQuery.val there is none of the events triggered in that case. The setvalue functionality does this for you.

Parameters
- selectorOrElement: string | HTMLElement | ArrayLike<HTMLElement>
- value: string
Returns void

unmask

unmask(value: string, opts: default.Options): string

Unmask a given value against the mask.

Parameters
- value: string
  
  Value to be unmasked.
- opts: default.Options
  
  Mask options.
Returns string

Generated using TypeDoc