imaskjs

repository·master·Indexed 26 days ago

https://github.com/unmanner/imaskjs

A lightweight, dependency-free vanilla JavaScript library for input masking. It supports various data types such as numbers, dates, and complex patterns. The project includes official plugins for popular frameworks, including angular-imask, react-imask, solid-imask, @imask/svelte, and vue-imask.

Tokens
8.4K
Snippets
21
Records
73
Agent score
89%

What's inside imaskjs

  1. Overview of imaskjs features and mask types

    master

    imaskjs is a vanilla JavaScript input mask library with no external dependencies. It supports various mask types and advanced formatting features:

    Supported Mask Types

    • RegExp mask: Uses regular expressions.
    • Function mask: Uses a custom function.
    • Number mask: Supports integer and decimal values.
    • Date mask: Supports various formats and an autofix mode.
    • Dynamic/on-the-fly mask: Masks that change based on input.
    • Pattern mask: Advanced pattern matching including:
      • Placeholder visibility control.
      • Unmasked values containing fixed parts.
      • Optional input parts (greedy).
      • Custom definitions and reusable blocks.
      • Secure text entry.
      • Enum and Range masks.
      • Repeating blocks.

    Key Capabilities

    • Easily get and set raw and unmasked values.
    • Supports overwrite mode.
    • Compatible with Web Components and contenteditable elements.
    • Pipe: Convert and format values using a pipe mechanism.
  2. Install vue-imask

    master

    Install the core package using npm:

    npm i vue-imask

    For Vue 2 users: You must also install the Composition API support: npm i -D @vue/composition-api

    For NuxtJS with Vue 2:

    1. Install the Nuxt Composition API module: npm i -D @nuxtjs/composition-api
    2. Add @nuxtjs/composition-api/module to the buildModules option in your nuxt.config.js.
    npm i vue-imask
    
    # For Vue 2
    npm i -D @vue/composition-api
    
    # For NuxtJS with Vue 2
    npm i -D @nuxtjs/composition-api
  3. Install imaskjs via npm or CDN

    master

    You can install imask using npm for module-based projects or include it directly in your HTML via a CDN for vanilla JavaScript environments.

    Using npm: Install the package and import it into your project.

    Using CDN: Include the script tag in your HTML file.

    npm install imask
    <script src="https://unpkg.com/imask"></script>
  4. Use imaskjs with framework plugins

    master

    While imask is a vanilla JavaScript library, there are official plugins available for popular frameworks to simplify integration:

    • Vue: vue-imask
    • Angular: angular-imask
    • React: react-imask
    • React Native: react-native-imask
    • Svelte: @imask/svelte
    • Solid: solid-imask