diff --git a/CHANGELOG.md b/CHANGELOG.md index 825c32f..1957be2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1 +1,4 @@ # Changelog + +## [1.0.0] +* Initial release \ No newline at end of file diff --git a/README.md b/README.md index ed91000..a9c8f8e 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ Vue.js v2.x component for [Cleave.js](http://nosir.github.io/cleave.js/) +## Demo on [JSFiddle](https://jsfiddle.net/ankurk91/aza302c7/) + ## Features * Reactive ``v-model`` value - You can change input value programmatically @@ -18,6 +20,7 @@ Vue.js v2.x component for [Cleave.js](http://nosir.github.io/cleave.js/) - Component will watch for any changes and redraw itself - You are suggested to modify config via [Vue.set](https://vuejs.org/v2/api/#Vue-set) * Compatible with [Bootstrap](http://getbootstrap.com/), [Bulma](http://bulma.io/) or any other CSS framework +* Option to disable `raw` mode to get masked value ## Installation ```bash @@ -37,7 +40,7 @@ yarn add vue-cleave-component @@ -59,27 +62,27 @@ yarn add vue-cleave-component ### As plugin ```js import Vue from 'vue'; - import cleave from 'vue-cleave-component'; - Vue.use(cleave); + import Cleave from 'vue-cleave-component'; + Vue.use(Cleave); ``` This will register a global component `` ## Available props The component accepts these props: -| Attribute | Type | Default | Description | -| :--- | :---: | :---: | :--- | -| v-model / value | String / null | `null` | Set or Get input value (required) | -| options | Object | `{}` | Cleave.js [options](https://github.com/nosir/cleave.js/blob/master/doc/options.md) | -| raw | Boolean | `true` | When set to `false` emits formatted value with format pattern and delimiter | -| type | String | `text` | Set input type for eg: `tel` | +| Attribute | Type | Default | Description | +| :--- | :---: | :---: | :--- | +| v-model / value | String / Number / null | `null` | Set or Get input value (required) | +| options | Object | `{}` | Cleave.js [options](https://github.com/nosir/cleave.js/blob/master/doc/options.md) | +| raw | Boolean | `true` | When set to `false`; emits formatted value with format pattern and delimiter | +| type | String | `text` | Set input type; for eg: `tel` | ## Install in non-module environments (without webpack) * Include required files ```html - + - + @@ -90,7 +93,7 @@ The component accepts these props: