:warning: VueQuintable version 2.x is for bootstrap 5.x. If you want to use bootstrap 4.x please install latest 1.x VueQuintable version:warning:

:exclamation: The @sensetence/vue-quintable module is the successor of @quintet/vue-quintable. Please note that future development and bug fixes will be provided in the @sensetence/vue-quintable module only. :exclamation:

VueQuintable

VueQuintable is a table wrapper for Vue.js 2.x. It is build with bootstrap 5.x. High configurable, easy to use, flexible and responsive.

Demo

Getting Started

These instructions will get you running VueQuintable for your project for development purposes.

Prerequisites

VueQuintable is a vue.js package and uses bootstrap by default. Please install both before using the package. If you want to use ajax functionalities please install axios as it is used by VueQuintable.

npm:

1npm install --save axios

yarn:

1yarn add axios

Installing

npm:

1npm install --save bootstrap
2npm install --save @popperjs/core
3npm install --save @sensetence/vue-quintable

yarn:

1yarn add bootstrap
2yarn add @popperjs/core
3yarn add @sensetence/vue-quintable

Integration

1import Vue from 'vue'
2
3//use bootstrap
4import 'bootstrap/dist/css/bootstrap.css'
5
6import "@sensetence/vue-quintable/dist/vue-quintable.css"
7import VueTable from '@sensetence/vue-quintable'
8Vue.use(VueTable);

Use directly in browser

You can either install VueQuintable via bower

1bower install --save https://github.com/sensetence/vue-quintable

or just download the source and include the scripts and styles in dist folder to use VueQuintable for your browser page.

1<script type="text/javascript" src="/path/to/vue/dist/vue.min.js"></script>
2
3<script type="text/javascript" src="/path/to/project/dist/vue-quintable.umd.min.js"></script>
4
5<link rel="stylesheet" href="/path/to/project/dist/vue-quintable.css"></link>

1Vue.use(window["vue-quintable"]);

Features

These points will convince you that VueQuintable is the last table plugin you will ever need

• Responsive columns which will be rendered as additional rows
• Pagination
• Sort/Multi-sort
• Search
• Custom Filters
• Recursive filter groups with relations
• Select rows
• Custom search keywords and filter values for rows
• Vue-binded values for columns and rows
• Nested VueQuintables
• Vue components inside tables
• Custom cell formatters

Slots

You can define some slots to customize the table as you want to.

• header | used for content above the table
• before-search | used for content before the search bar
• after-search | used for content after the search bar
• after-search-container | used for content before the search bar container
• footer | used for content below the table
• no-results | used for placeholder if there are no table entries due to filtering etc.
• loading | custom loader
• cell-complete | deprecated
• cell-content | custom content for cells, cell is delivered as slot scope. Used also for generated and sticky cells
• generated-cell-complete | deprecated
• generated-cell-content | custom content for generated cells
• sticky-cell-complete | deprecated
• sticky-cell-content | custom content for sticky cells

1<template v-slot:header>Your HTML-Code</template>
2
3//for content of regular table cells
4<template v-slot:cell-content="{cell}">
5    <button v-if="cell.any_property ==='any_value'" class="cell-content-button">
6        {{cell.any_property}}
7    </button>
8</template>
9
10//for content of responsive generated table cells
11<template v-slot:generated-cell-content="{cell}">
12    <button v-if="cell.any_property ==='any_value'" class="generated-cell-content--button">
13        {{cell.any_property}}
14    </button>
15</template>
16
17//for content of sticky table cells
18<template v-slot:sticky-cell-content="{cell}">
19    <button v-if="cell.any_property ==='any_value'" class="sticky-cell-content-button">
20        {{cell.any_property}}
21    </button>
22</template>
23
24//for same content of regular, responsive generated and sticky table cells
25<template v-for="slotName in ['cell-content','generated-cell-content','sticky-cell-content']" #[slotName]="{cell}">
26    <button v-if="cell.any_property ==='any_value'" :key="`button-${slotName}`" :class="`${slotName}`-cell-button">
27        {{cell.any_property}}
28    </button>
29</template>

Events

Add listeners for the following events to handle them as you want to.

• click:row | passes row as first parameter, triggered when row is clicked

• click:cell | passes cell as first parameter, triggered when cell is clicked

• expand:row | passes row as first parameter, triggered when row is expanded

• collapse:row | passes row as first parameter, triggered when row is collapsed

• filtered:rows | passes filtered rows as first parameter, triggered when filter or search query affect rows

• ajax:rows | passes an object with ajax rows and total count as first parameter, triggered when rows are updated from server

• ajax:error | passes an error as first parameter, triggered when an server error occurs while loading rows via ajax

• update:perPage | passes integer as first parameter, triggered when per page parameter changes

• update:page | passes integer as first parameter, triggered when page is changed

• update:search | passes string as first parameter, triggered when search query is entered

• update:sort | passes object of sort group as first parameter, triggered when sort order is active/changes

• component:event | generic event for passing data from child component

• active:row | fires if active row is updated, the config property enableRowTabIndex has to be set to true

Configuration

The following will give you an overview how to configure the VueQuintable for your needs.

Table Properties

Parameter	Type	Required	Description
config	Object	yes	The table configuration object. See details below.
rows	Array	yes (if no ajax url is set)	Table rows containing all cells. See details below.
preSelectedRows	Array	no	Array of objects{key,value} to set selection of rows from outside. You have to set the key to an unique property of the row e.g. an id and the value to the actual properties' value of the row. If done so, the row will be (pre-) selected. Note: This won't work initially, for initial select use config.defaultSelected or row.selected properties
dynamicConfig	Boolean	no	If set to true the Table wont be re-initialized and re-rendered if some values inside the config property are changed. This is useful to dynamically set config values for columns
filters	Object	no	The active filters for displaying rows. This has to be an object with filter name as key and filter value as value. Additionally a set of operators can be passed. See example below.
filter-groups	Array	no	Filter groups with relations. See example below.
sort-order	Object	no	Set sorting values and order by default or on the fly. See examples below.
axios	Object	no	Pass a configured axios instance to be used for ajax functionalities. Only relevant if ajax is used. Recommendation: set it to the current time using new Date() for update
updated	Boolean|Date	no	Property to trigger reload on current page. Only relevant if ajax is used.
verbose	Boolean	no	Default is false. Set to true to see debug informations on developer tools in your Browser.
identifier	String	no	Default is null, for nested tables default is a random string. Use for slots of nested tables
initialSearchTerm	String	no	Default is null, initial search term if search is enabled
nested	Boolean	no	Default is false, use it if a quintable is nested inside a slot

Property config properties

Key	Type	Required	Pre-condition	Description	Default	Example
columns	Array	yes	-	Contains the configuration for the table columns including headlines.	null	See below
hideEmptyColumns	Boolean	no	-	If set to true columns of visible rows which are empty for each row will be hidden. Will check text, html, component properties	false	true
ignoreSortEmptyColumns	String{"none"|"active"|"all"}	no	hideEmptyColumns enabled	Select if/how columns with sort enabled shall be hidden if they are empty for each row. "none": sorting columns keep always visible. "active": sorting columns will always keep visible if they are active. "all": empty sorting columns will be hidden as well	"none"	"all"
expandedAll	Boolean	no	Breakpoints for columns are set	If set to true, all columns will be expanded by default	false	true
enableRowTabIndex	Boolean	no	-	If set to true, an active row will be set on click and can be navigated by arrow keys	false	true
hoverClass	Boolean|String	no	-	Class for rows on hover	"bg-muted"	"bg-success"
activeClass	Boolean|String	no	-	Class for active row	"bg-muted"	"bg-success"
hideRowToggle	Boolean	no	Breakpoints for columns are set	If set to true, no plus symbols will be displayed for row toggle.	false	true
expandedRowIcon	String	no	Breakpoints for columns are set	Toggle icon for expanded rows. Possible values: "chevron-up", "minus", "caret-up", "eye-slash"	"chevron-up"	"minus"
collapsedRowIcon	String	no	Breakpoints for columns are set	Toggle icon for collapsed rows. Possible values: "chevron-down", "minus", "caret-down", "eye"	"chevron-down"	"plus"
pagination	Boolean|Number	no	-	If set to true, the default page size will be 25.	false	5
numberOfVisibleRowsFillerWord	String	no	pagination is set	Filler word for numbers of visible rows displaying, especially needed for translation (no english tables)	"of"	"von"
pageRange	Number	no	pagination enabled	Displayed page range of pagination.	5	3
rowsSelect	Boolean	no	pagination enabled	If set to true, user will be allowed to set rows per page	false	true
disallowAllOption	Boolean	no	pagination enabled and rows select is enabled	If set to true, "all" option will not be displayed in rows per page select	false	true
rowsPlaceholder	String	no	pagination enabled and rows select is enabled	Text for rows per page selection	"Rows per page:"	"Rows:"
select	Boolean	no	-	If set to true rows can be selected by check boxes. Tables v-model can be used for selected row Array.	false	true
prettySelect	Boolean	no	select is enabled	If set to true, pretty checkboxes library will be used.	false	true
selectPosition	String{"pre"|"post"}	no	select is enabled	Position of the select check boxes, first or last column.	"post"	"pre"
selectAll	Boolean	no	select is enabled	If set to true, additional checkbox will appear to select all rows	false	true
selectAllRows	Boolean	no	select is enabled	If set to true, select all selects all rows allover the pages. Please keep in mind that this won't work with server side pagination.	false	true
defaultSelected	Boolean	no	select is enabled	If set to true, all rows will be selected initially.	false	true
search	Boolean	no	-	If set to true a filter search input will be displayed	false	true
searchLength	Number	no	search is enabled	Minimum length of query that triggers search.	1	3
searchPlaceholder	String	no	search is enabled	Placeholder if no search query is entered	"Search..."	"Search rows..."
searchContainerClass	String	no	search is enabled	CSS class for search container	"row"	"container-class"
searchClass	String	no	search is enabled	CSS class for search input wrapper	"col-12"	"col-md-8"
emptyPlaceholder	String	no	search is enabled or filters are set	Placeholder if filtering rows has no results.	"No rows"	"No results"
filterRelation	String{"OR"|"AND"}	no	filters are set	Filter relation, if no filter group affected	"AND"	"OR"
filterGroupRelation	String{"OR"|"AND"}	no	filters are set	Default relation filter groups to each other	"AND"	"OR"
multiSort	Boolean	no	sort is enabled on at least one column	If set to true multi-key sorting is enabled	false	true
multiSortSelect	Boolean	no	sort is enabled on at least one column	If set to true user will be allowed to enable and disable multi sort	false	true
multiSortPlaceholder	String	no	sort is enabled on at least one column and multi sort select is enabled	Placeholder for multiple sort description	"Multiple sort"	"Toggle multiple"
pageSort	Boolean	no	sort is enabled on at least one column	If set to true sorting on current page enabled	false	true
pageSortSelect	Boolean	no	sort is enabled on at least one column	If set to true user will be allowed to enable and disable page sort	false	true
pageSortPlaceholder	String	no	sort is enabled on at least one column and page sort select is enabled	Placeholder for page sort description	"Page sort"	"Toggle page"
ajaxUrl	String|Boolean	no	-	If set ajax will be used for search/filter/sort/pagination	false	"http://your.server.url/api/endpoint"
requestMethod	String{"GET"|"POST"}	no	ajaxUrl is set	Request method for ajax request	"GET"	"POST"
storeState	Boolean	no	identifier is set	Store table state in local storage to have persistent table when reload page	false	true
ajaxRequestDelay	Integer	no	ajaxUrl is set	Delay for ajax search requests in milliseconds	250	100

Property columns for property config properties

Key	Type	Options/Return	Pre-condition	Description
headline	String	-	-	Headline for column
title	String	-	-	Description, displayed on hover the headline
classes	String	-	-	Space separated css classes string. Will be applied for headlines, cells, generated rows and sticky rows.
hidden	Boolean	true|false	-	If set to true the column will not be displayed in any case. Highly recommended to use only when dynamicConfig is set to to true.
ignoreEmpty	Boolean	true|false	config property hideEmptyColumns enabled	The column will never be hidden automatically due to emptiness
sort	Boolean	true|false	-	If set to true, this column will be sortable
firstSortDirection	String	"ASC"|"DESC"	sort is set	Indicates the first direction of sorting when sort is activated for a column by clicking on the sort header. Default: "ASC"
breakpoint	String	"xs"|"sm"|"md"|"lg"|"xl"|"xxl"|"all"	-	Bootstrap breakpoint from which descending the columns headline will be shown
showHeadlineBreakpoint	String	"xs"|"sm"|"md"|"lg"|"xl"|"xxl"|"all"	headline is set	Bootstrap breakpoint from which descending the columns headline will be shown
hideHeadlineBreakpoint	String	"xs"|"sm"|"md"|"lg"|"xl"|"xxl"|"all"	headline is set	Bootstrap breakpoint from which descending the columns headline will be hidden
align	String	"start"|"end"|"center"	-	Text alignment for whole column
alwaysExpanded	Boolean	true|false	breakpoint is set	If set to true, the additional columns row will be always expanded if the breakpoint is reached
sticky	Boolean	true|false	breakpoint is not set	If set to true, this column will be always displayed as additional row and will be expanded always
cellFormatter	Function	String|Object	-	Function for complex custom cell formatting. The cell will be passed as function parameter. Has to return a string handled as text or an object with String value and String type{"html","text"}

Property rows properties

Key	Type	Pre-condition	Description	Default
cells	Array	-	List of cells for the row	null
selected	Boolean	select is enabled	If set to true the row will be selected on default	false
disableSelect	Boolean	select is enabled	If set to true this row will be excluded from selection at all	false
expanded	Boolean	breakpoint of at least one column is affected	If set to true the row will be expanded on default	false
keywords	String[]	search is enabled	Additional keywords which will match a search query	null
classes	String	-	Additional CSS classes for row	null
filters	Object	filters are set	Filters with filter name(s) and value(s), which will match selected filter(s)	null
align	String{"start"|"end"|"center"}	-	Text alignment for whole row, this will be overwritten by columns align value	"start"

Property cells for property rows properties

Key	Type	Pre-condition	Description
text	String	non of the following are set: html, component	Content string
html	String	non of the following are set: text, component	HTML content string
component	String	non of the following are set: text, html	Custom component object, see code example below. Should not be used, use slot cell-content instead
classes	String	-	Additional CSS classes for cell
align	String	-	Text alignment for whole column, this will overwrite columns and rows align values
isEmpty	Boolean	non of the following are set: text, html, component	Flag for custom cells (e.g for slot generation). This is checked for hiding empty cells and the flag will overwrite potential content of text and html if set to true
sortValue	String|Number	sort is enabled for the column of the cell	cell value for the sorting of the column, especially useful if the sorting is enabled for formatted or html/component

Lets have a look on an example for rows and cells

1//Table with columns "Name","Age","Birth Place","Job"
2
3[
4    //simple row as array
5    [ 
6        {
7            text:"John Doe"
8        },
9        {
10            text:50
11        },
12        {
13            text:"Trainee"
14        },
15    ],
16    //advances row as object
17    {
18    	cells:[
19            {
20                html:"<b>Max</b> Mustermann",
21                classes:"special-td",
22                align:"end",
23             },
24            {
25                component:{
26                    name:"age-component",
27                    props:{
28                        age:20,
29                    }
30                },
31            },
32            {
33                text:"Trainee"
34            },
35		]
36    }
37]
38
39

Component Definition

To use a custom component inside a VueQuintable you have to define it as the following:

1<template>
2    <div @click="check">
3      Age: {{age}}
4    </div>
5</template>
6
7
8<script>
9
10    export default {
11        props:["age"],
12        methods: {
13            check() {
14                //emit the pre-defined event for component actions
15                //handled from VueQuintable by "component:event"
16                this.$emit("action",
17                    {
18                        age:this.age,
19                    }
20                )
21            }
22        }
23    }
24
25</script>
26

Import and use the Component in your Code:

1import TestComponent from "./components/TestComponent.vue"
2
3Vue.component(
4    "test-component",
5    TestComponent.default || TestComponent
6);

Property filters properties

Key	Type	Required	Description
values	Mixed|Array	Yes	Compare values. Can be single value or array of values which will match the filter values of rows.
operator	String	No	Operator for comparing. The defined operators are: equal, greater, less, greaterEqual, lessEqual, startsWith, endsWith, contains, notContains, matches
compare	Function	No	Custom compare function. See Below.

This example shows selected values for active, printable, first_name, middle_name, and last_name filters. Operators can be:

1{
2   active:true,
3   printable:false,
4   first_name:
5    {
6        operator:"contains",
7        values:["Jo","ja"],   
8    },
9    middle_name:
10    {
11        compare:"matches",
12        values:new RegExp("r.+a","g"),   
13    },
14    last_name:
15    {
16        compare:(value,rowValue)=>{
17        	return rowValue.indexOf(value) === 2;
18        },
19        values:"a",   
20    }
21   
22}

Property filter-groups properties

Key	Type	Description
items	Object[]	List that contains Object of filter names or nested groups related to the group
relation	String{"OR"|"AND"}	Relation between the items

This filter groups example will cause to show rows that have filter matching filter values for selected name OR active filter AND selected printable filter. This groups are infinitely nestable.

1[
2    {
3        items:[
4            {
5                items:[
6                    {
7                        name:"name"
8                    },
9                    {
10                        name:"active"
11                    }
12                ],
13                relation:"OR",
14            },
15            {
16                items:[
17                    {
18                        name:"printable"
19                    }
20                ],
21            }
22        ],
23        relation:"AND"
24    }
25],

Property sort-order properties

These examples depict a sorting ordered second column (index=1) before first column (index=0). You can use Objects to set the ascending or descending order optionally. The Default will be asc=true, column index starts on zero.

1//simple
2[
3   1,0
4]
5
6//advanced
7[
8    {
9        index:1,
10        asc:false
11    },
12    {
13        index:0,
14        asc:true
15    },
16]
17

Basic Example

A simple basic example to show the usage of VueQuintable. More examples are included in the project and can be started with:

1npm run start

1<template>
2	<VueQuintable :config="config" :rows="rows"></VueQuintable>
3</template>
4
5<script>
6
7    import VueQuintable from './components/VueQuintable.vue
8
9    ...
10 
11  	data() {
12        return {
13            config: {
14                columns: [
15                    {
16                        headline: "Name",
17                    }, {
18                        headline: "Age",
19                    }, {
20                        headline: "Birth Place",
21                        breakpoint: "md"
22                    }, {
23                        headline: "Job",
24                        sticky: true,
25                    }
26                ],
27            },
28
29            rows: [
30                [
31                    {
32                        text: "Mia Wong"
33                    },
34                    {
35                        text: 50
36                    },
37                    {
38                        text: "Beijing"
39                    },
40                    {
41                        text: "Trainee"
42                    },
43                ],
44                [
45                    {
46                        text: "Peter Stanbridge"
47                    },
48                    {
49                        text: 18
50                    },
51                    {
52                        text: "London"
53                    },
54                    {
55                        text: "Trainee"
56                    },
57                ],
58                [
59                    {
60                        text: "Natalie Lee-Walsh"
61                    },
62                    {
63                        text: 25
64                    },
65                    {
66                        text: "Dublin"
67                    },
68                    {
69                        text: "Trainee"
70                    },
71                ],
72            ],
73        }
74    }
75          
76  ...
77</script>

AJAX data example

1<template>
2
3...
4
5<VueQuintable :loading="loading" :config="remoteConfig" :rows="remoteRows" />
6
7...
8
9</template>
10
11<script>
12	import axios from 'axios'
13
14	...
15
16  	data(){
17        return {
18            loading:false,
19            remoteConfig:null,
20            remoteRows:null
21  		
22 	...
23 
24    mounted(){
25        this.loading = true;
26        axios.get("http://your.server.url/api/endpoint").then((response)=>{
27            this.remoteRows = response.data.rows;
28            this.remoteConfig = response.data.config;
29            this.loading = false;
30        });
31    }
32...
33
34</script>

The request for the ajax handling on server has got the following structure:

1{
2    //String search query
3    search:"some query",
4    //Object Filters, see above
5    filters:{},
6    //Number etries per page
7    perPage:12,
8    //Number current page, starting at 1
9    page:2,
10    //Object sorting columns and 
11    sort:{
12        //Array of sorting column indexes
13        indexes:this.currentSortIndexes,
14        //Object of column definitions keyed by column index
15        columns:this.sortingColumns,
16    },
17};

The response has to be the following structure:

1{
2	//Array of all rows, structure see above
3	rows:[]
4    //Number of all matching rows, without paging
5    all:240
6}

Good to know

• Links won't trigger expanded rows to collapse. Also you can prevent collapse parent row by define an element with the class "prevent-toggle"
• VueQuintable uses v-model for selected rows, its also possible to use selected.sync (best practice)
• If you use the storeState property, filters have to be updated vie filters.sync

License

VueQuintable is free for everyone to use in any project (MIT License).

Authors

Sensetence UG - Samuel Zeitler