Interface KeyfilterNamespace<TElement>

The main object of the key filter plugin that contains both the JQuery plugin function as well as some global configuration for the key filter.

Type parameters

TElement = HTMLElement

Hierarchy

KeyfilterNamespace

Callable

KeyfilterNamespace(regExp: RegExp): JQuery<TElement>
KeyfilterNamespace(testFunction: TestFunction): JQuery<TElement>

Enables the key filter on the current input filter. Only text that matches the given regular expression is allowed in the input field.

Parameters
- regExp: RegExp
  Regular expression the value of the input field needs to match.
Returns JQuery<TElement>
this jQuery instance for chaining.
Enables the key filter on the current input filter. An entered character needs to match the given test function to be allowed. If it does not match, the character is blocked and the entered character is discarded.

Parameters
- testFunction: TestFunction
  A function that tests whether an entered character is allowed.
Returns JQuery<TElement>
this jQuery instance for chaining.

Index

Properties

Properties

defaults

defaults: Defaults

Default, global configuration for the key filter.

version

version: number

The version of this plugin.

Generated using TypeDoc