vue-table-grid
v1.0.1
Published
simple data table for Vue.js and bootstrap
Downloads
4
Maintainers
mkchemistReadme
Vue Table Grid
Simple data table grid for Vue.js , this package require Bootstrap framework for styling table.
Install
npm i --save-dev vue-table-gridQuick start
Loading component file In browser
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Vue Table Grid</title> </head> <body> <script src="path/to/libs/vue-table-grid.min.js"></script> <script> //register VueTableGrid globally Vue.component('vue-table-grid', VueTableGrid) new Vue({ components: { // register inside component VueTableGrid } }) </script> </body> </html>in single file component
<template> </template> <script> import VueTableGrid from "vue-table-grid"; export default { components: { VueTableGrid } } </script>adding component to your html template
<template> <div> <vue-table-component :columns="columns" :rows="rows" ></vue-table-component> </div> </template> <script> import VueTableGrid from "vue-table-grid"; export default { components: { VueTableGrid }, data() { return { columns: [ { title: 'Name', data:'name', searchable:true, sortable:true }, { title: 'Email', data: 'email', searchable:true } ], rows: [ {id: 1, name: 'Jon Doe', email: '[email protected]'}, {id: 1, name: 'Jane Doe', email: '[email protected]'}, ] } } } </script>
Options
options = {
/**
* is table in server side mode
*
* default :false
*/
serverSide: Boolean,
/**
* ajax configurations
*
*/
ajax: {
/**
* api url
*/
url: String,
/**
* function to return
* total rows count
* to be used in pagination
*
* default: 0
*/
total: Function,
/**
* headers to be sent with
* every api request
*
* e.g
* data => data.total
*
* default : {}
*/
headers: Object,
/**
* query params to be sent
* with every api request
*
* default : {}
*/
params: Object
},
/**
* table columns
*/
columns: [
{
/**
* table column title
*
*/
title:String,
/**
* table column data
*
* e.g
* string => 'name'
* function => (row) => row.name
*/
data: String|Function,
/**
* is column searchable
*
*/
searchable: Boolean,
/**
* is column sortable
*
*/
sortable: Boolean
}
],
/**
* table rows
*
* default: []
*/
rows: Array<Object>,
/**
* table result per page
*
* default: 10
*/
rpp: Number,
/**
* table result per page options
*
* default: [10,20,50,100]
*/
rpp_list:Array<Number>,
/**
* is table responsive
*
*/
responsive: Boolean,
/**
* sort data by
*
* default : null
*/
sortBy: String,
/**
* add checkbox to table
*
* default:false
*/
checkbox:Boolean,
/**
* callback invoked when
* select row
*
* default: null
*/
onSelectRows:Function,
/**
* error message in server side mode
*
* default : Oops! something went wrong
*/
errorMessage: String
}