From 80ad5946fda73107e2b7c0ac11803baa61d198bd Mon Sep 17 00:00:00 2001 From: splincode Date: Wed, 27 Dec 2023 09:53:29 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20taiga-fa?= =?UTF-8?q?mily/maskito@a7d9fc28aa028c89d849f8c73cca43831558bcb7=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- addons/phone/API/index.html | 4 ++-- addons/phone/index.html | 10 +++++----- browser-support/index.html | 4 ++-- changelog/index.html | 2 +- core-concepts/element-state/index.html | 2 +- core-concepts/mask-expression/index.html | 2 +- core-concepts/overview/index.html | 2 +- core-concepts/overwrite-mode/index.html | 10 +++++----- core-concepts/plugins/index.html | 8 ++++---- core-concepts/processors/index.html | 6 +++--- core-concepts/transformer/index.html | 6 +++--- cypress/index.html | 4 ++-- frameworks/angular/Setup/index.html | 6 +++--- frameworks/angular/index.html | 16 ++++++++-------- frameworks/react/index.html | 2 +- frameworks/vue/index.html | 2 +- getting-started/maskito-libraries/index.html | 2 +- getting-started/what-is-maskito/index.html | 2 +- index.html | 4 ++-- kit/date-range/API/index.html | 2 +- kit/date-range/index.html | 8 ++++---- kit/date-time/API/index.html | 2 +- kit/date-time/index.html | 4 ++-- kit/date/API/index.html | 4 ++-- kit/date/index.html | 6 +++--- kit/number/API/index.html | 4 ++-- kit/number/index.html | 14 +++++++------- kit/time/API/index.html | 4 ++-- kit/time/index.html | 6 +++--- recipes/card/index.html | 4 ++-- recipes/phone/index.html | 4 ++-- recipes/placeholder/index.html | 6 +++--- recipes/postfix/index.html | 4 ++-- recipes/prefix/index.html | 4 ++-- recipes/textarea/index.html | 6 +++--- stackblitz/index.html | 2 +- 36 files changed, 89 insertions(+), 89 deletions(-) diff --git a/addons/phone/API/index.html b/addons/phone/API/index.html index c173f8950..a7591d843 100644 --- a/addons/phone/API/index.html +++ b/addons/phone/API/index.html @@ -20,9 +20,9 @@ + -

Phone
PHONE

tuiMode:
-
Name and descriptionType Value
[countryIsoCode]
Country ISO-code
string
'RU'
[strict]
If true, it allows to enter only phone number of selected country (see countryIsoCode property). If false, all country phone number is allowed.

Default:true

boolean
[separator]
Separator between groups of numbers in a phone number (excluding country code and area code).

Default:-

string
'-'
+

Phone
PHONE

tuiMode:
-
Name and descriptionType Value
[countryIsoCode]
Country ISO-code
string
'RU'
[strict]
If true, it allows to enter only phone number of selected country (see countryIsoCode property). If false, all country phone number is allowed.

Default:true

boolean
[separator]
Separator between groups of numbers in a phone number (excluding country code and area code).

Default:-

string
'-'
\ No newline at end of file diff --git a/addons/phone/index.html b/addons/phone/index.html index 77ab28eec..e2db5ef08 100644 --- a/addons/phone/index.html +++ b/addons/phone/index.html @@ -20,9 +20,9 @@ + -

Phone
PHONE

This mask is based on the libphonenumber-js package.

Use maskitoPhoneOptionsGenerator to create a mask for phone input.

basic

Kazakhstan phone example

    
+        

Phone
PHONE

This mask is based on the libphonenumber-js package.

Use maskitoPhoneOptionsGenerator to create a mask for phone input.

basic

Kazakhstan phone example

    
     
@@ -52,7 +52,7 @@
-

validation

For validating phone number you can use isValidPhoneNumber , isPossiblePhoneNumber functions from libphonenumber-js package. Read more

Below is an example of a Hungarian phone mask with an angular validator.

    
+

validation

For validating phone number you can use isValidPhoneNumber , isPossiblePhoneNumber functions from libphonenumber-js package. Read more

Below is an example of a Hungarian phone mask with an angular validator.

    
     
@@ -64,7 +64,7 @@
-

Non-strict mask

Setting the strict option to false enables non-strict mask mode and allow user to type any country phone number.

The countryIsoCode option is optional in that case, but if you specify it, the mask will try to add that country's calling code when you try to insert a phone number without a calling code.

    
+

Non-strict mask

Setting the strict option to false enables non-strict mask mode and allow user to type any country phone number.

The countryIsoCode option is optional in that case, but if you specify it, the mask will try to add that country's calling code when you try to insert a phone number without a calling code.

    
     
@@ -76,7 +76,7 @@
-

Lazy metadata

You can load metadata lazily, below is an example of how to do it in Angular.

You can also customize the metadata to reduce metadata size. See instructions here

    
+

Lazy metadata

You can load metadata lazily, below is an example of how to do it in Angular.

You can also customize the metadata to reduce metadata size. See instructions here

    
     
diff --git a/browser-support/index.html b/browser-support/index.html index 3afd8f2e7..8214623aa 100644 --- a/browser-support/index.html +++ b/browser-support/index.html @@ -20,9 +20,9 @@ + -

Browser support

Desktop

BrowserVersion
Google Chrome 74+
Mozilla Firefox 55+
Safari 12.1+
Opera 62+
Edge (Chromium) 74+
Microsoft Internet ExplorerNot supported
Edge (EdgeHTML)Not supported

Mobile

BrowserVersion
Google Chrome90+
Mozilla Firefox99+
Safari12.2+
Opera64+
+

Browser support

Desktop

BrowserVersion
Google Chrome 74+
Mozilla Firefox 55+
Safari 12.1+
Opera 62+
Edge (Chromium) 74+
Microsoft Internet ExplorerNot supported
Edge (EdgeHTML)Not supported

Mobile

BrowserVersion
Google Chrome90+
Mozilla Firefox99+
Safari12.2+
Opera64+
\ No newline at end of file diff --git a/changelog/index.html b/changelog/index.html index dcb706d05..b8ad988eb 100644 --- a/changelog/index.html +++ b/changelog/index.html @@ -23,7 +23,7 @@ -

Changelog

Changelog

+

Changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.9.0 (2023-11-23)

diff --git a/core-concepts/element-state/index.html b/core-concepts/element-state/index.html index 7b1ad5839..1b62e7e0f 100644 --- a/core-concepts/element-state/index.html +++ b/core-concepts/element-state/index.html @@ -22,7 +22,7 @@ -

Element state

Element state is a concept which describes the main properties of the masked element at the certain period of time.

It is an object which implements the following interface:

    
+        

Element state

Element state is a concept which describes the main properties of the masked element at the certain period of time.

It is an object which implements the following interface:

    
     
diff --git a/core-concepts/mask-expression/index.html b/core-concepts/mask-expression/index.html index 19beb4ce8..639d3627e 100644 --- a/core-concepts/mask-expression/index.html +++ b/core-concepts/mask-expression/index.html @@ -22,7 +22,7 @@ -

Mask expression

Mask expression is the the main concept of Maskito core library. It provides the developer with opportunity to predefine format of user's input. For example, you can set mask expression to accept only digits, only Latin letters or you can configure more complex patterns like a date string.

You can set mask expression using mask parameter of MaskitoOptions .

Types of mask expression

  • RegExp mask expression

    The most basic and comprehensible type. The only required knowledge is understanding of native JavaScript Regular expression .

    See the following example:

        
    +        

    Mask expression

    Mask expression is the the main concept of Maskito core library. It provides the developer with opportunity to predefine format of user's input. For example, you can set mask expression to accept only digits, only Latin letters or you can configure more complex patterns like a date string.

    You can set mask expression using mask parameter of MaskitoOptions .

    Types of mask expression

    • RegExp mask expression

      The most basic and comprehensible type. The only required knowledge is understanding of native JavaScript Regular expression .

      See the following example:

          
           
      diff --git a/core-concepts/overview/index.html b/core-concepts/overview/index.html index 6d863912a..9031e1ef6 100644 --- a/core-concepts/overview/index.html +++ b/core-concepts/overview/index.html @@ -22,7 +22,7 @@ -

      Core concepts

      The main entity of Maskito core library is Maskito class which accepts 2 arguments in constructor:

      1. native HTMLInputElement or HTMLTextAreaElement
      2. set of configurable MaskitoOptions
          
      +        

      Core concepts

      The main entity of Maskito core library is Maskito class which accepts 2 arguments in constructor:

      1. native HTMLInputElement or HTMLTextAreaElement
      2. set of configurable MaskitoOptions
          
           
      diff --git a/core-concepts/overwrite-mode/index.html b/core-concepts/overwrite-mode/index.html index 357533844..f2ae7031f 100644 --- a/core-concepts/overwrite-mode/index.html +++ b/core-concepts/overwrite-mode/index.html @@ -20,9 +20,9 @@ + -

      Overwrite mode

      Overwrite mode regulates behaviour of the mask when user inserts a new character somewhere in the middle of text field, overwriting the character at the current index.

      overwriteMode can be of a following type:

      • shift (default)
      • replace
      • function that receives element state as an argument and returns shift or replace

      Shift mode

      The classic mode that everyone is used to. Inserting a new character in the middle of the text field value shifts all following characters to the right.

          
      +        

      Overwrite mode

      Overwrite mode regulates behaviour of the mask when user inserts a new character somewhere in the middle of text field, overwriting the character at the current index.

      overwriteMode can be of a following type:

      • shift (default)
      • replace
      • function that receives element state as an argument and returns shift or replace

      Shift mode

      The classic mode that everyone is used to. Inserting a new character in the middle of the text field value shifts all following characters to the right.

          
           
      @@ -52,7 +52,7 @@
      -

      Replace mode

      All new inserted characters replace the old characters at the same position. No character shifts. The length of the value remains the same after inserting new character somewhere in middle of the text field.

          
      +

      Replace mode

      All new inserted characters replace the old characters at the same position. No character shifts. The length of the value remains the same after inserting new character somewhere in middle of the text field.

          
           
      @@ -82,7 +82,7 @@
      -

      Dynamically detected mode

      Parameter overwriteMode also accepts function that will called before each insertion of new characters. This function has one argument — current element state (read more about it in the "Element state" section). And this function should return one of two possible values: shift or replace .

          
      +

      Dynamically detected mode

      Parameter overwriteMode also accepts function that will called before each insertion of new characters. This function has one argument — current element state (read more about it in the "Element state" section). And this function should return one of two possible values: shift or replace .

          
           
      @@ -112,7 +112,7 @@
      -

      Next steps

      The following sections are recommended to explore core concepts further:

    +

Next steps

The following sections are recommended to explore core concepts further:

\ No newline at end of file diff --git a/core-concepts/plugins/index.html b/core-concepts/plugins/index.html index 8c9cad67f..532787300 100644 --- a/core-concepts/plugins/index.html +++ b/core-concepts/plugins/index.html @@ -21,9 +21,9 @@ + -

Plugins

Plugins are functions that are called with input/textarea element and mask options as arguments upon mask initialization. They can optionally return cleanup logic and allow you to extend mask with arbitrary additional behavior.

Visualize rejected characters

This plugin is available as maskitoRejectEvent in @maskito/kit
    
+        

Plugins

Plugins are functions that are called with input/textarea element and mask options as arguments upon mask initialization. They can optionally return cleanup logic and allow you to extend mask with arbitrary additional behavior.

Visualize rejected characters

This plugin is available as maskitoRejectEvent in @maskito/kit
    
     
@@ -41,7 +41,7 @@
-

Built-in initial calibration plugin

Maskito libraries were created to prevent only user from typing invalid value. However, sometimes you (developer) need to enable mask but you not sure that you programmatically patched textfield with valid value. In this case you can use maskitoTransform or just add maskitoInitialCalibrationPlugin to mask options.

    
+

Built-in initial calibration plugin

Maskito libraries were created to prevent only user from typing invalid value. However, sometimes you (developer) need to enable mask but you not sure that you programmatically patched textfield with valid value. In this case you can use maskitoTransform or just add maskitoInitialCalibrationPlugin to mask options.

    
     
@@ -53,7 +53,7 @@
-

Next steps

The following sections are recommended to explore core concepts further:

+

Next steps

The following sections are recommended to explore core concepts further:

\ No newline at end of file diff --git a/core-concepts/processors/index.html b/core-concepts/processors/index.html index 3ca0bd091..adb668742 100644 --- a/core-concepts/processors/index.html +++ b/core-concepts/processors/index.html @@ -20,9 +20,9 @@ + -

Processors

MaskitoOptions have optional parameters preprocessors and postprocessors . Both accept array of pure functions. These functions are triggered on every user's input ( beforeinput and input events). They provide an opportunity to modify value before / after the mask is applied.

Preprocessors and postprocessors accept different types of arguments but they have two important similarities:

  • The first argument always contains object with information that you can change. Object with the same properties and updated values can be returned from the processor. It means that you can keep all properties untouched or you can change any or all of these properties.
  • The rest arguments contain information that can be useful to build some complex logic, but you cannot change it.
Before you learn more about processors, you should learn a single prerequisite — meaning of the term "Element state" .

Preprocessors

Each preprocessor is a function that is called before mask is applied.

For example, if user types a new character, all preprocessors will be called first, and only then final value that they returned will be passed into the mask, and finally the mask will accept or reject new typed character and update actual value of the text field.

Preprocessor accepts two arguments:

  1. Object with two properties: elementState and data . Object of the same interface with updated or unchanged properties can be returned from the preprocessor.
        
    +        

    Processors

    MaskitoOptions have optional parameters preprocessors and postprocessors . Both accept array of pure functions. These functions are triggered on every user's input ( beforeinput and input events). They provide an opportunity to modify value before / after the mask is applied.

    Preprocessors and postprocessors accept different types of arguments but they have two important similarities:

    • The first argument always contains object with information that you can change. Object with the same properties and updated values can be returned from the processor. It means that you can keep all properties untouched or you can change any or all of these properties.
    • The rest arguments contain information that can be useful to build some complex logic, but you cannot change it.
    Before you learn more about processors, you should learn a single prerequisite — meaning of the term "Element state" .

    Preprocessors

    Each preprocessor is a function that is called before mask is applied.

    For example, if user types a new character, all preprocessors will be called first, and only then final value that they returned will be passed into the mask, and finally the mask will accept or reject new typed character and update actual value of the text field.

    Preprocessor accepts two arguments:

    1. Object with two properties: elementState and data . Object of the same interface with updated or unchanged properties can be returned from the preprocessor.
          
           
      @@ -46,7 +46,7 @@
    -
Stacking of multiple processors

The Maskito team likes code decomposition and promotes it! Don't put all complex logic inside a single processor. Both parameters preprocessors and postprocessors accepts array of same type processors. Break your code into the several independent processors so that each processor implements only a single task.

Next steps

The following sections are recommended to explore core concepts further:

+
Stacking of multiple processors

The Maskito team likes code decomposition and promotes it! Don't put all complex logic inside a single processor. Both parameters preprocessors and postprocessors accepts array of same type processors. Break your code into the several independent processors so that each processor implements only a single task.

Next steps

The following sections are recommended to explore core concepts further:

\ No newline at end of file diff --git a/core-concepts/transformer/index.html b/core-concepts/transformer/index.html index 70753af18..6f6d72a09 100644 --- a/core-concepts/transformer/index.html +++ b/core-concepts/transformer/index.html @@ -20,15 +20,15 @@ + -

Transformer
CORE

Maskito libraries were created to prevent user from typing invalid value.
Maskito listens beforeinput and input events. Programmatic (by developer) changes of input's value don't trigger these events!

Maskito is based on the assumption that developer is capable to programmatically patch input with valid value!

If you need to programmatically patch input's value but you are not sure that your value is valid (for example, you get it from the server), you should use maskitoTransform utility .

    
+        

Transformer
CORE

Maskito libraries were created to prevent user from typing invalid value.
Maskito listens beforeinput and input events. Programmatic (by developer) changes of input's value don't trigger these events!

Maskito is based on the assumption that developer is capable to programmatically patch input with valid value!

If you need to programmatically patch input's value but you are not sure that your value is valid (for example, you get it from the server), you should use maskitoTransform utility .

    
     
-

Next steps

The following sections are recommended to explore core concepts further:

+

Next steps

The following sections are recommended to explore core concepts further:

\ No newline at end of file diff --git a/cypress/index.html b/cypress/index.html index 041f2f57a..1342bb44b 100644 --- a/cypress/index.html +++ b/cypress/index.html @@ -20,9 +20,9 @@ + -

Cypress

+

Cypress

\ No newline at end of file diff --git a/frameworks/angular/Setup/index.html b/frameworks/angular/Setup/index.html index 143c1bbea..7a1e96551 100644 --- a/frameworks/angular/Setup/index.html +++ b/frameworks/angular/Setup/index.html @@ -20,16 +20,16 @@ + -

Angular

  1. Install libraries

    /your/project/path> +

    Angular

    1. Install libraries

      /your/project/path>

          
           
      -
    2. Import MaskitoDirective to your component / module

      your.component.ts +

    3. Import MaskitoDirective to your component / module

      your.component.ts

          
           

    Angular

    @maskito/angular is a light-weighted library to use Maskito in an Angular-way.
    Prerequisites

    To get the most out of this guide, you should review the topic "Core Concepts" first.

    Write less code

    • No need to query element from DOM. Just pass all required options to [maskito] directive.
    • No need to worry about clean-ups. All created event listeners are automatically removed after element is detached from DOM.

    Basic directive approach

    Use it when you have direct access to native input element.

    your.component.ts +

    Angular

    @maskito/angular is a light-weighted library to use Maskito in an Angular-way.
    Prerequisites

    To get the most out of this guide, you should review the topic "Core Concepts" first.

    Write less code

    • No need to query element from DOM. Just pass all required options to [maskito] directive.
    • No need to worry about clean-ups. All created event listeners are automatically removed after element is detached from DOM.

    Basic directive approach

    Use it when you have direct access to native input element.

    your.component.ts

        
         
    -

    Nested input element

    Pass a predicate to maskito to find input element for you, if you do not have a direct access to it.

    By default maskito will try to find input/textarea by querying its host: host.querySelector('input,textarea') so that might be sufficient. Use custom predicate if you need custom logic.

    your.component.ts +

    Nested input element

    Pass a predicate to maskito to find input element for you, if you do not have a direct access to it.

    By default maskito will try to find input/textarea by querying its host: host.querySelector('input,textarea') so that might be sufficient. Use custom predicate if you need custom logic.

    your.component.ts

        
         
    -

    Custom input

    See querying nested input in action

    Default behavior is enough for Taiga UI inputs
    Custom predicate is required if target input is not the first on in the DOM

    Custom input

    See querying nested input in action

    Default behavior is enough for Taiga UI inputs
    Custom predicate is required if target input is not the first on in the DOM
        
         
    -

    CVA

    When directly on native input/textarea tag, MaskitoCVA formats value set programmatically with Angular forms.

        
    +

    CVA

    When directly on native input/textarea tag, MaskitoCVA formats value set programmatically with Angular forms.

        
         
    @@ -69,7 +69,7 @@
    -

    Pipe

    Format arbitrary value with the same options

    Balance: $12 345.67 +

    Pipe

    Format arbitrary value with the same options

    Balance: $12 345.67
        
         

    React

    @maskito/react is a light-weighted library to use Maskito in an React-way.

    Prerequisites

    To get the most out of this guide, you should review the topic "Core Concepts" first.

    Getting Started

    Install libraries

        
    +        

    React

    @maskito/react is a light-weighted library to use Maskito in an React-way.

    Prerequisites

    To get the most out of this guide, you should review the topic "Core Concepts" first.

    Getting Started

    Install libraries

        
         
    diff --git a/frameworks/vue/index.html b/frameworks/vue/index.html index b9243b513..82e380464 100644 --- a/frameworks/vue/index.html +++ b/frameworks/vue/index.html @@ -22,7 +22,7 @@ -

    Vue

    @maskito/vue is a light-weighted library to use Maskito in as a Vue directive.

    Prerequisites

    To get the most out of this guide, you should review the topic "Core Concepts" first.

    Getting Started

    Install libraries

        
    +        

    Vue

    @maskito/vue is a light-weighted library to use Maskito in as a Vue directive.

    Prerequisites

    To get the most out of this guide, you should review the topic "Core Concepts" first.

    Getting Started

    Install libraries

        
         
    diff --git a/getting-started/maskito-libraries/index.html b/getting-started/maskito-libraries/index.html index ecc95e7f7..08f9213a9 100644 --- a/getting-started/maskito-libraries/index.html +++ b/getting-started/maskito-libraries/index.html @@ -22,7 +22,7 @@ -

    Maskito libraries

    Maskito is a collection of libraries. Explore them and learn how to install and use them.

    • @maskito/core

      It is the main zero-dependency and framework-agnostic package. It can be used alone in vanilla JavaScript project. It listens to beforeinput and input events to validate and calibrate text field value.

      All other Maskito's packages require @maskito/core as peer-dependency.

      /your/project/path> +

      Maskito libraries

      Maskito is a collection of libraries. Explore them and learn how to install and use them.

      • @maskito/core

        It is the main zero-dependency and framework-agnostic package. It can be used alone in vanilla JavaScript project. It listens to beforeinput and input events to validate and calibrate text field value.

        All other Maskito's packages require @maskito/core as peer-dependency.

        /your/project/path>

            
             

      What is Maskito?

      Maskito is a collection of libraries, built with TypeScript. It helps you to create an input mask which ensures that users type values according to predefined format.

      Core concepts of the libraries are simple but they provide flexible API to set any format you wish: numbers, phone, date, credit card number etc.

      Why Maskito?

      • Maskito supports all user’s interactions with text fields: basic typing and deleting via keyboard, pasting, dropping text inside with a pointer, browser autofill, predictive text from mobile native keyboard.
      • Maskito is robust. The whole project is developed with strict TypeScript mode. Our code is covered by hundreds of Cypress tests.
      • Server Side Rendering and Shadow DOM support.
      • You can use it with HTMLInputElement and HTMLTextAreaElement .
      • Maskito core is zero-dependency package. You can mask input in your vanilla JavaScript project. However, we have separate packages for Angular , React and Vue as well.
      • Maskito includes optional framework-agnostic package with configurable ready-to-use masks.

      No textfield with invalid value! Use Maskito. Mask it!

      Learn about Maskito

      +

      What is Maskito?

      Maskito is a collection of libraries, built with TypeScript. It helps you to create an input mask which ensures that users type values according to predefined format.

      Core concepts of the libraries are simple but they provide flexible API to set any format you wish: numbers, phone, date, credit card number etc.

      Why Maskito?

      • Maskito supports all user’s interactions with text fields: basic typing and deleting via keyboard, pasting, dropping text inside with a pointer, browser autofill, predictive text from mobile native keyboard.
      • Maskito is robust. The whole project is developed with strict TypeScript mode. Our code is covered by hundreds of Cypress tests.
      • Server Side Rendering and Shadow DOM support.
      • You can use it with HTMLInputElement and HTMLTextAreaElement .
      • Maskito core is zero-dependency package. You can mask input in your vanilla JavaScript project. However, we have separate packages for Angular , React and Vue as well.
      • Maskito includes optional framework-agnostic package with configurable ready-to-use masks.

      No textfield with invalid value! Use Maskito. Mask it!

      Learn about Maskito

      \ No newline at end of file diff --git a/index.html b/index.html index f1f51f9c5..ddabd667d 100644 --- a/index.html +++ b/index.html @@ -20,9 +20,9 @@ + -

      What is Maskito?

      Maskito is a collection of libraries, built with TypeScript. It helps you to create an input mask which ensures that users type values according to predefined format.

      Core concepts of the libraries are simple but they provide flexible API to set any format you wish: numbers, phone, date, credit card number etc.

      Why Maskito?

      • Maskito supports all user’s interactions with text fields: basic typing and deleting via keyboard, pasting, dropping text inside with a pointer, browser autofill, predictive text from mobile native keyboard.
      • Maskito is robust. The whole project is developed with strict TypeScript mode. Our code is covered by hundreds of Cypress tests.
      • Server Side Rendering and Shadow DOM support.
      • You can use it with HTMLInputElement and HTMLTextAreaElement .
      • Maskito core is zero-dependency package. You can mask input in your vanilla JavaScript project. However, we have separate packages for Angular , React and Vue as well.
      • Maskito includes optional framework-agnostic package with configurable ready-to-use masks.

      No textfield with invalid value! Use Maskito. Mask it!

      Learn about Maskito

      +

      What is Maskito?

      Maskito is a collection of libraries, built with TypeScript. It helps you to create an input mask which ensures that users type values according to predefined format.

      Core concepts of the libraries are simple but they provide flexible API to set any format you wish: numbers, phone, date, credit card number etc.

      Why Maskito?

      • Maskito supports all user’s interactions with text fields: basic typing and deleting via keyboard, pasting, dropping text inside with a pointer, browser autofill, predictive text from mobile native keyboard.
      • Maskito is robust. The whole project is developed with strict TypeScript mode. Our code is covered by hundreds of Cypress tests.
      • Server Side Rendering and Shadow DOM support.
      • You can use it with HTMLInputElement and HTMLTextAreaElement .
      • Maskito core is zero-dependency package. You can mask input in your vanilla JavaScript project. However, we have separate packages for Angular , React and Vue as well.
      • Maskito includes optional framework-agnostic package with configurable ready-to-use masks.

      No textfield with invalid value! Use Maskito. Mask it!

      Learn about Maskito

      \ No newline at end of file diff --git a/kit/date-range/API/index.html b/kit/date-range/API/index.html index d7d6ca80d..685470008 100644 --- a/kit/date-range/API/index.html +++ b/kit/date-range/API/index.html @@ -22,7 +22,7 @@ -

      DateRange
      KIT

      tuiMode:
      -
      Name and descriptionType Value
      [mode]
      Date format mode
      MaskitoDateMode
      'dd/mm/yyyy'
      [dateSeparator]
      Separator between date segments (days, months and years).

      Default:. (dot).

      string
      [rangeSeparator]
      Separator between dates of the date range.

      Default: â€“ 

      string
      [min]
      Earliest date
      Date
      '0001-01-01'
      [max]
      Latest date
      Date
      '9999-12-31'
      [minLength]
      Minimal length of the range
      MaskitoDateSegments<number>
      {}
      [maxLength]
      Maximal length of the range
      MaskitoDateSegments<number>
      {}
      +

      DateRange
      KIT

      tuiMode:
      -
      Name and descriptionType Value
      [mode]
      Date format mode
      MaskitoDateMode
      'dd/mm/yyyy'
      [dateSeparator]
      Separator between date segments (days, months and years).

      Default:. (dot).

      string
      [rangeSeparator]
      Separator between dates of the date range.

      Default: â€“ 

      string
      [min]
      Earliest date
      Date
      '0001-01-01'
      [max]
      Latest date
      Date
      '9999-12-31'
      [minLength]
      Minimal length of the range
      MaskitoDateSegments<number>
      {}
      [maxLength]
      Maximal length of the range
      MaskitoDateSegments<number>
      {}
      \ No newline at end of file diff --git a/kit/date-range/index.html b/kit/date-range/index.html index 539dda676..40e857327 100644 --- a/kit/date-range/index.html +++ b/kit/date-range/index.html @@ -22,7 +22,7 @@ -

      DateRange
      KIT

      Use maskitoDateRangeOptionsGenerator to create a mask to input a range of dates.

      Date localization

      Use mode and dateSeparator parameters to get a mask with a locale specific representation of dates.

          
      +        

      DateRange
      KIT

      Use maskitoDateRangeOptionsGenerator to create a mask to input a range of dates.

      Date localization

      Use mode and dateSeparator parameters to get a mask with a locale specific representation of dates.

          
           
      @@ -52,7 +52,7 @@
      -

      Min and max dates

      Parameters min and max allow you to set the earliest and the latest available dates. They accept native Date .

          
      +

      Min and max dates

      Parameters min and max allow you to set the earliest and the latest available dates. They accept native Date .

          
           
      @@ -82,7 +82,7 @@
      -

    Min and max length of range

    Use minLength and maxLength parameters to set minimal and maximal length of the date range.

        
    +

    Min and max length of range

    Use minLength and maxLength parameters to set minimal and maximal length of the date range.

        
         
    @@ -112,7 +112,7 @@
    -

    Custom range separator

    Use rangeSeparator parameter to customize separator between dates of the date range.

        
    +

    Custom range separator

    Use rangeSeparator parameter to customize separator between dates of the date range.

        
         
    diff --git a/kit/date-time/API/index.html b/kit/date-time/API/index.html index fc3b1e6f6..37c3325cd 100644 --- a/kit/date-time/API/index.html +++ b/kit/date-time/API/index.html @@ -22,7 +22,7 @@ -

    DateTime
    KIT

    tuiMode:
    -
    Name and descriptionType Value
    [dateMode]
    Date format mode
    MaskitoDateMode
    'dd/mm/yyyy'
    [timeMode]
    Time format mode
    MaskitoTimeMode
    'HH:MM'
    [dateSeparator]
    Date separator

    Default:. (dot).

    string
    [min]
    Earliest date
    Date
    '0001-01-01T00:00:00'
    [max]
    Latest date
    Date
    '9999-12-31T23:59:59'
    +

    DateTime
    KIT

    tuiMode:
    -
    Name and descriptionType Value
    [dateMode]
    Date format mode
    MaskitoDateMode
    'dd/mm/yyyy'
    [timeMode]
    Time format mode
    MaskitoTimeMode
    'HH:MM'
    [dateSeparator]
    Date separator

    Default:. (dot).

    string
    [min]
    Earliest date
    Date
    '0001-01-01T00:00:00'
    [max]
    Latest date
    Date
    '9999-12-31T23:59:59'
    \ No newline at end of file diff --git a/kit/date-time/index.html b/kit/date-time/index.html index 7322ac7d3..590e5c028 100644 --- a/kit/date-time/index.html +++ b/kit/date-time/index.html @@ -22,7 +22,7 @@ -

    DateTime
    KIT

    Use maskitoDateTimeOptionsGenerator to create a mask to input both date and time.

    Localization

    Use dateMode , timeMode and dateSeparator parameters to get a mask with a locale specific representation of dates.

        
    +        

    DateTime
    KIT

    Use maskitoDateTimeOptionsGenerator to create a mask to input both date and time.

    Localization

    Use dateMode , timeMode and dateSeparator parameters to get a mask with a locale specific representation of dates.

        
         
    @@ -52,7 +52,7 @@
    -

    Min and max

    Parameters min and max allow to set the earliest and the latest available dates. They accept native Date .

        
    +

    Min and max

    Parameters min and max allow to set the earliest and the latest available dates. They accept native Date .

        
         
    diff --git a/kit/date/API/index.html b/kit/date/API/index.html index a527b0818..b2733c490 100644 --- a/kit/date/API/index.html +++ b/kit/date/API/index.html @@ -20,9 +20,9 @@ + -

    Date
    KIT

    tuiMode:
    -
    Name and descriptionType Value
    [mode]
    Date format mode
    MaskitoDateMode
    'dd/mm/yyyy'
    [separator]
    Symbol for separating date-segments (days, months, years)

    Default:. (dot)

    string
    '.'
    [min]
    Earliest date

    Default:new Date('0001-01-01')

    Date
    '0001-01-01'
    [max]
    Latest date

    Default:new Date('9999-12-31')

    Date
    '9999-12-31'
    +

    Date
    KIT

    tuiMode:
    -
    Name and descriptionType Value
    [mode]
    Date format mode
    MaskitoDateMode
    'dd/mm/yyyy'
    [separator]
    Symbol for separating date-segments (days, months, years)

    Default:. (dot)

    string
    '.'
    [min]
    Earliest date

    Default:new Date('0001-01-01')

    Date
    '0001-01-01'
    [max]
    Latest date

    Default:new Date('9999-12-31')

    Date
    '9999-12-31'
    \ No newline at end of file diff --git a/kit/date/index.html b/kit/date/index.html index 0bd71efe6..f6a0afa81 100644 --- a/kit/date/index.html +++ b/kit/date/index.html @@ -20,9 +20,9 @@ + -

    Date
    KIT

    Use maskitoDateOptionsGenerator to create a mask for date input.

    Date localization

    Use mode and separator properties to get a mask with a locale specific representation of dates.

        
    +        

    Date
    KIT

    Use maskitoDateOptionsGenerator to create a mask for date input.

    Date localization

    Use mode and separator properties to get a mask with a locale specific representation of dates.

        
         
    @@ -52,7 +52,7 @@
    -

    Min/Max

    Properties min and max allow you to set the earliest and the latest available dates. They accept native Date .

        
    +

    Min/Max

    Properties min and max allow you to set the earliest and the latest available dates. They accept native Date .

        
         
    diff --git a/kit/number/API/index.html b/kit/number/API/index.html index ae821f372..0ca7fa876 100644 --- a/kit/number/API/index.html +++ b/kit/number/API/index.html @@ -20,9 +20,9 @@ + -

    Number
    KIT

    tuiMode:
    -
    Name and descriptionType Value
    [precision]
    A number of digits after decimalSeparator .

    Use Infinity for an untouched decimal part.

    Default:0 (decimal part is forbidden).

    number
    0
    [decimalSeparator]
    Symbol for separating fraction.

    Default: dot.

    string
    [decimalPseudoSeparators]
    Symbols to be replaced with decimalSeparator .

    Default:['.', 'ю', 'б'] .

    string[]
    ['.', ',', 'б', 'ю']
    [decimalZeroPadding]
    If number of digits after decimalSeparator is always equal to the precision .

    Default:false (number of digits can be less than precision) .

    boolean
    [thousandSeparator]
    Symbol for separating thousands.

    Default: non-breaking space.

    string
    [min]
    The lowest permitted value.

    Default:Number.MIN_SAFE_INTEGER .

    number
    [max]
    The greatest permitted value.

    Default:Number.MAX_SAFE_INTEGER .

    number
    [prefix]
    A prefix symbol, like currency.

    Default: empty string (no prefix).

    string
    [postfix]
    A postfix symbol, like currency.

    Default: empty string (no postfix).

    string
    +

    Number
    KIT

    tuiMode:
    -
    Name and descriptionType Value
    [precision]
    A number of digits after decimalSeparator .

    Use Infinity for an untouched decimal part.

    Default:0 (decimal part is forbidden).

    number
    0
    [decimalSeparator]
    Symbol for separating fraction.

    Default: dot.

    string
    [decimalPseudoSeparators]
    Symbols to be replaced with decimalSeparator .

    Default:['.', 'ю', 'б'] .

    string[]
    ['.', ',', 'б', 'ю']
    [decimalZeroPadding]
    If number of digits after decimalSeparator is always equal to the precision .

    Default:false (number of digits can be less than precision) .

    boolean
    [thousandSeparator]
    Symbol for separating thousands.

    Default: non-breaking space.

    string
    [min]
    The lowest permitted value.

    Default:Number.MIN_SAFE_INTEGER .

    number
    [max]
    The greatest permitted value.

    Default:Number.MAX_SAFE_INTEGER .

    number
    [prefix]
    A prefix symbol, like currency.

    Default: empty string (no prefix).

    string
    [postfix]
    A postfix symbol, like currency.

    Default: empty string (no postfix).

    string
    \ No newline at end of file diff --git a/kit/number/index.html b/kit/number/index.html index 09aae7c1e..0470171f0 100644 --- a/kit/number/index.html +++ b/kit/number/index.html @@ -20,15 +20,15 @@ + -

    Number
    KIT

    Use maskitoNumberOptionsGenerator to create a mask for entering a formatted number.
    Despite the name of the mask, element's raw value is still string.

    Use maskitoParseNumber to get number-type value.

        
    +        

    Number
    KIT

    Use maskitoNumberOptionsGenerator to create a mask for entering a formatted number.
    Despite the name of the mask, element's raw value is still string.

    Use maskitoParseNumber to get number-type value.

        
         
    -

    High precision

    Use precision parameter to configure the number of digits after decimal separator.

        
    +

    High precision

    Use precision parameter to configure the number of digits after decimal separator.

        
         
    @@ -58,7 +58,7 @@
    -

    Separators

    Use decimalSeparator and thousandSeparator to get mask with locale specific representation of numbers.

    In Germany people use comma as decimal separator and dot for thousands
        
    +

    Separators

    Use decimalSeparator and thousandSeparator to get mask with locale specific representation of numbers.

    In Germany people use comma as decimal separator and dot for thousands
        
         
    @@ -88,7 +88,7 @@
    -

    Postfix

    Use postfix parameter to set non-removable text after the number.
    Additionally you can use maskitoCaretGuard to clamp caret inside allowable range.
    This example also shows how to restrict the greatest permitted value via max parameter.

        
    +

    Postfix

    Use postfix parameter to set non-removable text after the number.
    Additionally you can use maskitoCaretGuard to clamp caret inside allowable range.
    This example also shows how to restrict the greatest permitted value via max parameter.

        
         
    @@ -118,7 +118,7 @@
    -

    Decimal zero padding

    Set decimalZeroPadding: true to always show trailing zeroes.

    Non removable dollar sign is achieved by using prefix parameter.

        
    +

    Decimal zero padding

    Set decimalZeroPadding: true to always show trailing zeroes.

    Non removable dollar sign is achieved by using prefix parameter.

        
         
    @@ -148,7 +148,7 @@
    -

    Dynamic decimal zero padding

    You can change options on the fly to build complex logic.
    This example shows how to initially disable decimalZeroPadding and enable it only after user inserts decimal separator.

        
    +

    Dynamic decimal zero padding

    You can change options on the fly to build complex logic.
    This example shows how to initially disable decimalZeroPadding and enable it only after user inserts decimal separator.

        
         
    diff --git a/kit/time/API/index.html b/kit/time/API/index.html index 8d02bf9de..0b6a6e5b8 100644 --- a/kit/time/API/index.html +++ b/kit/time/API/index.html @@ -20,9 +20,9 @@ + -

    Time
    KIT

    tuiMode:
    -
    Name and descriptionType Value
    [mode]
    Time format mode
    MaskitoTimeMode
    'HH:MM'
    [timeSegmentMaxValues]
    Max value for every time segment
    MaskitoTimeSegments<number>
    {hours: 23, minutes: 59, seconds: 59, milliseconds: 999}
    +

    Time
    KIT

    tuiMode:
    -
    Name and descriptionType Value
    [mode]
    Time format mode
    MaskitoTimeMode
    'HH:MM'
    [timeSegmentMaxValues]
    Max value for every time segment
    MaskitoTimeSegments<number>
    {hours: 23, minutes: 59, seconds: 59, milliseconds: 999}
    \ No newline at end of file diff --git a/kit/time/index.html b/kit/time/index.html index 8da671403..056b4475f 100644 --- a/kit/time/index.html +++ b/kit/time/index.html @@ -20,9 +20,9 @@ + -

    Time
    KIT

    Use maskitoTimeOptionsGenerator to create a mask for time input.

    Mode

    Use mode property to set time format.

    Available options : HH:MM , HH:MM:SS or HH:MM:SS.MSS .

        
    +        

    Time
    KIT

    Use maskitoTimeOptionsGenerator to create a mask for time input.

    Mode

    Use mode property to set time format.

    Available options : HH:MM , HH:MM:SS or HH:MM:SS.MSS .

        
         
    @@ -52,7 +52,7 @@
    -

    12-hours format

    Property timeSegmentMaxValues allows you to set max value for every time segment.

    Time segments are units of the time which form time string. For example, HH:MM consists of two time segments: hours and minutes.

        
    +

    12-hours format

    Property timeSegmentMaxValues allows you to set max value for every time segment.

    Time segments are units of the time which form time string. For example, HH:MM consists of two time segments: hours and minutes.

        
         
    diff --git a/recipes/card/index.html b/recipes/card/index.html index 80474ecd9..88dbfc54c 100644 --- a/recipes/card/index.html +++ b/recipes/card/index.html @@ -20,9 +20,9 @@ + -

    Card
    Recipes

    Creating mask for credit card input requires basic understanding of the following topics:

        
    +        

    Card
    Recipes

    Creating mask for credit card input requires basic understanding of the following topics:

        
         
    diff --git a/recipes/phone/index.html b/recipes/phone/index.html index 890d90910..bd83fdffe 100644 --- a/recipes/phone/index.html +++ b/recipes/phone/index.html @@ -22,7 +22,7 @@ -

    Phone
    Recipes

    Creating mask for a phone number is simple. The only required knowledge is the pattern mask expression with fixed characters . Read more about it in "Mask expression" section.

    This page demonstrates some examples for different countries.

    United States

    Flag of the United States
        
    +        

    Phone
    Recipes

    Creating mask for a phone number is simple. The only required knowledge is the pattern mask expression with fixed characters . Read more about it in "Mask expression" section.

    This page demonstrates some examples for different countries.

    United States

    Flag of the United States
        
         
    @@ -52,7 +52,7 @@
    -

    Kazakhstan

    The following example demonstrates a more complex mask. It shows how to make the country prefix non-removable. It is achieved by built-in postprocessor from @maskito/kit .

    Read more about it in "With prefix" section.

    Flag of Kazakhstan
        
    +

    Kazakhstan

    The following example demonstrates a more complex mask. It shows how to make the country prefix non-removable. It is achieved by built-in postprocessor from @maskito/kit .

    Read more about it in "With prefix" section.

    Flag of Kazakhstan
        
         
    diff --git a/recipes/placeholder/index.html b/recipes/placeholder/index.html index 5f16271ae..a01f17be3 100644 --- a/recipes/placeholder/index.html +++ b/recipes/placeholder/index.html @@ -22,7 +22,7 @@ -

    With placeholder
    Recipes

    maskitoWithPlaceholder helps to show placeholder mask characters. The placeholder character represents the fillable spot in the mask.

    Card Verification Code

    This example is the simplest demonstration how to create masked input with placeholder .

    The only required prerequisite is basic understanding of "Mask expression" concept.

        
    +        

    With placeholder
    Recipes

    maskitoWithPlaceholder helps to show placeholder mask characters. The placeholder character represents the fillable spot in the mask.

    Card Verification Code

    This example is the simplest demonstration how to create masked input with placeholder .

    The only required prerequisite is basic understanding of "Mask expression" concept.

        
         
    @@ -52,7 +52,7 @@
    -

    Phone

    The following example explains return type of maskitoWithPlaceholder utility — an object which partially implements MaskitoOptions interface. It contains its own processor and postprocessor and plugins to keep caret from getting into placeholder part of the value.

    Also, this complex example uses built-in postprocessor maskitoPrefixPostprocessorGenerator from @maskito/kit .

    Flag of the United States
        
    +

    Phone

    The following example explains return type of maskitoWithPlaceholder utility — an object which partially implements MaskitoOptions interface. It contains its own processor and postprocessor and plugins to keep caret from getting into placeholder part of the value.

    Also, this complex example uses built-in postprocessor maskitoPrefixPostprocessorGenerator from @maskito/kit .

    Flag of the United States
        
         
    @@ -64,7 +64,7 @@
    -

    Date

    This last example demonstrates how to integrate maskitoWithPlaceholder with any built-in mask from @maskito/kit .

        
    +

    Date

    This last example demonstrates how to integrate maskitoWithPlaceholder with any built-in mask from @maskito/kit .

        
         
    diff --git a/recipes/postfix/index.html b/recipes/postfix/index.html index 922cc7551..7c5a96053 100644 --- a/recipes/postfix/index.html +++ b/recipes/postfix/index.html @@ -22,7 +22,7 @@ -

    With postfix
    Recipes

    There are two approaches to add postfix for masked input. Every approach has its own behaviour and requires basic understanding of different core concepts.

    By pattern mask expression

    This example demonstrates how to create postfix via dynamic pattern mask expression . Percent symbol is a trailing fixed character, which will be automatically added when user enters the first digit.

        
    +        

    With postfix
    Recipes

    There are two approaches to add postfix for masked input. Every approach has its own behaviour and requires basic understanding of different core concepts.

    By pattern mask expression

    This example demonstrates how to create postfix via dynamic pattern mask expression . Percent symbol is a trailing fixed character, which will be automatically added when user enters the first digit.

        
         
    @@ -52,7 +52,7 @@
    -

    By postprocessor

    This example demonstrates how to create postfix via postprocessor . It provides more flexibility, and you can configure any desired behaviour. You can use built-in maskitoPostfixPostprocessorGenerator or create your own.

    Don't forget that mask property should be compatible with a new prefix / postfix!

        
    +

    By postprocessor

    This example demonstrates how to create postfix via postprocessor . It provides more flexibility, and you can configure any desired behaviour. You can use built-in maskitoPostfixPostprocessorGenerator or create your own.

    Don't forget that mask property should be compatible with a new prefix / postfix!

        
         
    diff --git a/recipes/prefix/index.html b/recipes/prefix/index.html index 0abc15f73..b56f4f99d 100644 --- a/recipes/prefix/index.html +++ b/recipes/prefix/index.html @@ -22,7 +22,7 @@ -

    With prefix
    Recipes

    Use prefixes to indicate things like currencies, area / phone country codes and etc.

    There are two approaches to add prefix for masked input. Every approach has its own behaviour and requires basic understanding of different core concepts.

    By pattern mask expression

    This example demonstrates how to create prefix via dynamic pattern mask expression . Dollar symbol is a fixed character, which will be automatically added when user forgets to type it or deleted when user erase all digits.

        
    +        

    With prefix
    Recipes

    Use prefixes to indicate things like currencies, area / phone country codes and etc.

    There are two approaches to add prefix for masked input. Every approach has its own behaviour and requires basic understanding of different core concepts.

    By pattern mask expression

    This example demonstrates how to create prefix via dynamic pattern mask expression . Dollar symbol is a fixed character, which will be automatically added when user forgets to type it or deleted when user erase all digits.

        
         
    @@ -52,7 +52,7 @@
    -

    By postprocessor

    This example demonstrates how to create prefix via postprocessor . It provides more flexibility, and you can configure any desired behaviour. You can use built-in maskitoPrefixPostprocessorGenerator or create your own.

    Don't forget that mask property should be compatible with a new prefix!

        
    +

    By postprocessor

    This example demonstrates how to create prefix via postprocessor . It provides more flexibility, and you can configure any desired behaviour. You can use built-in maskitoPrefixPostprocessorGenerator or create your own.

    Don't forget that mask property should be compatible with a new prefix!

        
         
    diff --git a/recipes/textarea/index.html b/recipes/textarea/index.html index e3c794a7a..95bbaaed3 100644 --- a/recipes/textarea/index.html +++ b/recipes/textarea/index.html @@ -20,15 +20,15 @@ + -

    Textarea
    Recipes

    You can use Maskito with HTMLTextAreaElement too. API is the same as for HTMLInputElement .

        
    +        

    Textarea
    Recipes

    You can use Maskito with HTMLTextAreaElement too. API is the same as for HTMLInputElement .

        
         
    -

    Learn more in the "Core Concepts" section.

    Latin letters and digits

        
    +

    Learn more in the "Core Concepts" section.

    Latin letters and digits

        
         
    diff --git a/stackblitz/index.html b/stackblitz/index.html index 43aee04c9..b2a3d4109 100644 --- a/stackblitz/index.html +++ b/stackblitz/index.html @@ -22,7 +22,7 @@ -
    Stackblitz loading...
    +
    Stackblitz loading...
    \ No newline at end of file