2
0
mirror of https://github.com/tenrok/maska.git synced 2026-05-15 11:59:38 +03:00
Files
maska/docs/v3/vanilla.md
T
2024-06-02 16:49:41 +03:00

1.3 KiB

Usage without a framework

Minimal example

Add to your input element data-maska attribute:

<input data-maska="#-#">

Then import and initialize MaskInput, passing input element(s) or querySelector expression as first argument:

import { MaskInput } from "maska"

// init with query selector
new MaskInput("[data-maska]")

// or with element
const input = document.querySelector('[data-maska]')
new MaskInput(input)

Set mask options

Usually you set mask via data-maska attribute. But you can pass mask and other options via second argument. It will be a default options that can be overriden by data-maska- attributes:

new MaskInput(input, { mask: "#-#" })

Programmatic use

You can use mask function programmatically by importing Mask class. There are three methods available:

  • masked(value) returns masked version of given value
  • unmasked(value) returns unmasked version of given value
  • completed(value) returns true if given value makes mask completed
import { Mask } from "maska"

const mask = new Mask({ mask: "#-#" })

mask.masked("12") // = 1-2
mask.unmasked("12") // = 12
mask.completed("12") // = true

Destroy mask

To destroy mask use destroy() method:

const mask = new MaskInput(input)
mask.destroy()