https://github.com/marcelo-ribeiro/smask

Smask - Vanilla JS Mask
https://github.com/marcelo-ribeiro/smask

input-mask js mask vanilla-javascript vanilla-js

Last synced: 3 months ago
JSON representation

Smask - Vanilla JS Mask

• Host: GitHub
• URL: https://github.com/marcelo-ribeiro/smask
• Owner: marcelo-ribeiro
• Created: 2021-05-28T02:53:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-27T13:05:06.000Z (10 months ago)
• Last Synced: 2024-10-06T10:05:32.635Z (4 months ago)
• Topics: input-mask, js, mask, vanilla-javascript, vanilla-js
• Language: TypeScript
• Homepage: https://marcelo-ribeiro.github.io/smask
• Size: 819 KB
• Stars: 11
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# **sMask**

## A Vanilla JS Mask




## Install

```

npm i smask

```




## Usage

```

import * as smask from "smask";

```




# Masking values

## Pattern format

#### Single pattern

```

smask.mask("123456", ["ddd.ddd"]);

// "123.456"

```

#### Multiple patterns

```

smask.mask("123456789", ["ddd.ddd", "ddd.ddd.ddd"]);

// "123.456.789"

```

#### Unmask pattern

```

smask.unmask("123.456", "ddd.ddd");

// "123456"

```




## Number format

#### Get masked number from current locale

```

smask.number(1234.56);

// "1,234.56" if in US English locale

```

#### Get masked number by passing locale

```

smask.number(1234.56, "en-US");

// "1,234.56"

```

#### Get unmasked number by passing locale

```

smask.numberUnformat("1,234.56", "en-US");

// "1234.56"

```




## Currency format

#### Get masked currency from current locale and currency code

```

smask.currency(1234.56);

// "$1,234.56" if in US English locale

```

#### Get masked currency by passing locale and current currency code

```

smask.currency(1234.56, "en-US");

// "$1,234.56"

```

#### Get masked currency by passing the locale and currency code.

```

smask.currency(1234.56, "en-US", "USD");

// "$1,234.56"

```

#### Get unformatted currency by passing locale and currency code

```

smask.currencyUnformat("$1,234.56", "en-US", "USD");

// 1234.56

```




# Masking Inputs

### Numbers

```

smask.input(document.getElementById("phone"), ["ddd"]);

```

### Letters

```

smask.input(document.getElementById("letters"), ["aaa"]);

```

### Letters Uppercase

```

smask.input(document.getElementById("lettersUpper"), ["AAA"]);

```

### Alphanumeric

```

smask.input(document.getElementById("alphanum"), ["www"]);

```

### Alphanumeric Uppercase

```

smask.input(document.getElementById("alphanumUpper"), ["WWW"]);

```

### Date

```

smask.input(document.getElementById("date"), ["date"]);

```

### Currency

```

smask.input(document.getElementById("currency"), ["currency"]);

```

### Single pattern

```

smask.input(document.getElementById("phone"), ["(dd) ddddd-dddd"]);

```

### Multiple patterns

```

smask.input(document.getElementById("phoneOrCellphone"), ["(dd) dddd-dddd", "(dd) ddddd-dddd"]);

```