Documentation
You can see the full documentation in: https://vue-tabulator.netlify.com/.
Getting Started
The vue-tabulator is a wrapper to Tabulator, so you need install the tabulator to use vue-tabulator.
Install vue-tabulator using npm
:
npm install --save vue-tabulator
Or yarn
:
yarn add --dev jest
Note: Vue-tabulator documentation uses npm
commands, but yarn
will also work. You can compare yarn
and npm
commands in the yarn docs, here.
Then, register vue-tabulaor plugin in your app entry point:
import Vue from 'vue';
import VueTabulator from 'vue-tabulator';
Vue.use(VueTabulator);
And import theme scss files:
<style lang='scss'>
@import "~vue-tabulator/dist/scss/bootstrap/tabulator_bootstrap4";
</style>
Note: Import the scss files is not required, but If you import, should configure your project to compile to css.
In your component, you can use the VueTabulator component:
<VueTabulator v-model="data" :options="options" />
The v-model and the options are required and you can use the pass the content of table and the configuration, respectively.
You can see another docs in documetation.
Develop Contributing
See CONTRIBUTING.