Provide a simple efficient webcomponent wrapper around the amazing [imaskjs](https://github.com/uNmAnNeR/imaskjs) library
[](http://components.coffeekraken.io/app/s-input-mask-component)
## Table of content
1. **[Demo](http://components.coffeekraken.io/app/s-input-mask-component)**
2. [Install](#readme-install)
3. [Get Started](#readme-get-started)
4. [Javascript API](doc/js)
5. [Register new masks](#readme-new-masks)
6. [Default masks](#readme-default-masks)
7. [Sugar Web Components Documentation](https://github.com/coffeekraken/sugar/blob/master/doc/webcomponent.md)
8. [Browsers support](#readme-browsers-support)
9. [Code linting](#readme-code-linting)
10. [Contribute](#readme-contribute)
11. [Who are Coffeekraken?](#readme-who-are-coffeekraken)
12. [Licence](#readme-license)
## Install
```
npm install coffeekraken-s-input-mask-component --save
```
## Get Started
First, import the component into your javascript file like so:
```js
import SInputMaskComponent from 'coffeekraken-s-input-mask-component'
```
Then simply use it inside your html like so:
```html
```
## Register new masks
To register a new named mask, here's how to do it:
```js
import SInputMaskComponent from 'coffeekraken-s-input-mask-component'
SInputMaskComponent.registerMask('my-cool-mask', {
// some imaskjs options here...
mask: '(0) 000 000 000',
lazy: false
// etc...
})
```
> See [imaskjs](https://github.com/uNmAnNeR/imaskjs) documentation
Then simply use it like so:
```html
```
## Default available masks
Their's some default masks available. Here's the list:
- `date:yyyy.mm.dd`
- `date:yyyy-mm-dd`
- `date:yyyy/mm/dd`
- `date:dd.mm.yyyy`
- `date:dd-mm-yyyy`
- `date:dd/mm/yyyy`
- `date:mm.dd.yyyy`
- `date:mm-dd-yyyy`
- `date:mm/dd/yyyy`
- `credit-card:number`
- `credit-card:code`
- `credit-card:date`
## Browsers support
| IE / Edge | Firefox | Chrome | Safari |
| --------- | --------- | --------- | --------- |
| IE11+ | last 2 versions| last 2 versions| last 2 versions
> As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.
> The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the [corresponding polyfill](https://www.webcomponents.org/polyfills).
## Code linting
This package uses some code linting rules. Here's the list:
1. [StandardJS](https://standardjs.com/) for javascript files
2. [Stylelint](https://github.com/stylelint/stylelint) with [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard) for `scss` files
> Your commits will not been accepted if the code style is not respected!
## Contribute
This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day.
To do so, you have several possibilities:
1. [Share the love ❤️](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-share-the-love)
2. [Declare issues](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-declare-issues)
3. [Fix issues](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-fix-issues)
4. [Add features](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-add-features)
5. [Build web component](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-build-web-component)
## Who are Coffeekraken
We try to be **some cool guys** that build **some cool tools** to make our (and yours hopefully) **every day life better**.
#### [More on who we are](https://github.com/Coffeekraken/coffeekraken/blob/master/who-are-we.md)
## License
The code is available under the [MIT license](LICENSE.txt). This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to [contribute](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md) instead of sharing your frustrations on social networks like an asshole...
---
_Source: https://npm.io/package/coffeekraken-s-input-mask-component · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
IE / Edge | 
Firefox | 
Chrome | 
Safari |
| --------- | --------- | --------- | --------- |
| IE11+ | last 2 versions| last 2 versions| last 2 versions
> As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.
> The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the [corresponding polyfill](https://www.webcomponents.org/polyfills).
## Code linting
This package uses some code linting rules. Here's the list:
1. [StandardJS](https://standardjs.com/) for javascript files
2. [Stylelint](https://github.com/stylelint/stylelint) with [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard) for `scss` files
> Your commits will not been accepted if the code style is not respected!
## Contribute
This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day.
To do so, you have several possibilities:
1. [Share the love ❤️](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-share-the-love)
2. [Declare issues](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-declare-issues)
3. [Fix issues](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-fix-issues)
4. [Add features](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-add-features)
5. [Build web component](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md#contribute-build-web-component)
## Who are Coffeekraken
We try to be **some cool guys** that build **some cool tools** to make our (and yours hopefully) **every day life better**.
#### [More on who we are](https://github.com/Coffeekraken/coffeekraken/blob/master/who-are-we.md)
## License
The code is available under the [MIT license](LICENSE.txt). This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to [contribute](https://github.com/Coffeekraken/coffeekraken/blob/master/contribute.md) instead of sharing your frustrations on social networks like an asshole...
---
_Source: https://npm.io/package/coffeekraken-s-input-mask-component · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._