Vue-Rut

A Vue package to format and validate a chilean rut.

Installation

Run the installation via npm:

npm install vue-rut --save

Run the installation via yarn:

yarn add vue-rut -D

CommonJS

And add in your main.js the require() function before to create a Vue instance, so in your vue object add a empty var into the data property.

// main.js

var vueRut = require('vue-rut');
Vue.use(vueRut);

const app = new Vue({

    el:'#app',
    data:{
        rut: ''
    }
});

...

ES6

// main.js

import vueRut from 'vue-rut'

Vue.use(vueRut);

const app = new Vue({

    el:'#app',
    data:{
        rut: ''
    }
});

...

Basic usage

Link the vue instance whith the html, add the directive v-rut and the v-model into your input.

<div id="app">
  ...
  <input v-rut v-model="rut">
  ...
</div>

This will bind the input with data.rut and format the input to chilean rut.

Validation

To validate the rut this plugin set the vue model to null, when the input value is a valid rut the model change to the input value.

Filter

To use the filter just use it with standard syntax | in your html as the following example:

// main.js

var vueRut = require('vue-rut');
Vue.use(vueRut);

const app = new Vue({

    el:'#app',
    data:{
        rutNumber: '123456789'
    }
});

...

<!-- index.html -->
<div id="app">
  <p> {{ rutNumber | rut }} <\p>
</div>

This will show: 12.345.678-9

Test

Run the following command to run the test:

npm run test