This feature is not available on mobile when
mobile-card.
To show a data table is very simple, you just need a data and a columns prop.
Table
Tabulated data are sometimes needed, it's even better when it's responsive
ID | First Name | Last Name | Date | Gender |
|---|---|---|---|---|
| 1 | Jesse | Simmons | 2016-10-15 13:43:27 | Male |
| 2 | John | Jacobs | 2016-12-15 06:00:53 | Male |
| 3 | Tina | Gilbert | 2016-04-26 06:26:28 | Female |
| 4 | Clarence | Flores | 2016-04-10 10:28:46 | Male |
| 5 | Anne | Lee | 2016-12-06 14:38:38 | Female |
<template>
<b-table :data="data" :columns="columns"></b-table>
</template>
<script>
export default {
data() {
return {
data: [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016-10-15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016-12-15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016-04-26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016-04-10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016-12-06 14:38:38', 'gender': 'Female' }
],
columns: [
{
field: 'id',
label: 'ID',
width: '40',
numeric: true
},
{
field: 'first_name',
label: 'First Name',
},
{
field: 'last_name',
label: 'Last Name',
},
{
field: 'date',
label: 'Date',
centered: true
},
{
field: 'gender',
label: 'Gender',
}
]
}
}
}
</script>
# Sandbox with custom template
To show a custom row template, you should not use the columns prop, but add it within the scoped slot as a component.
Also you can add an empty named slot to show when there's no data.
ID | First Name | Last Name | Date | Gender |
|---|---|---|---|---|
| 1 | Jesse | Simmons | 10/15/2016 | Male |
| 2 | John | Jacobs | 12/15/2016 | Male |
| 3 | Tina | Gilbert | 4/26/2016 | Female |
| 4 | Clarence | Flores | 4/10/2016 | Male |
| 5 | Anne | Lee | 12/6/2016 | Female |
<template>
<section>
<b-field grouped group-multiline>
<div class="control">
<b-switch v-model="isBordered">Bordered</b-switch>
</div>
<div class="control">
<b-switch v-model="isStriped">Striped</b-switch>
</div>
<div class="control">
<b-switch v-model="isNarrowed">Narrowed</b-switch>
</div>
<div class="control">
<b-switch v-model="isHoverable">Hoverable</b-switch>
</div>
<div class="control">
<b-switch v-model="isFocusable">Focusable</b-switch>
</div>
<div class="control">
<b-switch v-model="isLoading">Loading state</b-switch>
</div>
<div class="control">
<b-switch v-model="isEmpty">Empty</b-switch>
</div>
<div class="control">
<b-switch v-model="hasMobileCards">Mobile cards <small>(collapsed rows)</small></b-switch>
</div>
</b-field>
<b-table
:data="isEmpty ? [] : data"
:bordered="isBordered"
:striped="isStriped"
:narrowed="isNarrowed"
:hoverable="isHoverable"
:loading="isLoading"
:focusable="isFocusable"
:mobile-cards="hasMobileCards">
<template slot-scope="props">
<b-table-column field="id" label="ID" width="40" numeric>
{{ props.row.id }}
</b-table-column>
<b-table-column field="first_name" label="First Name">
{{ props.row.first_name }}
</b-table-column>
<b-table-column field="last_name" label="Last Name">
{{ props.row.last_name }}
</b-table-column>
<b-table-column field="date" label="Date" centered>
<span class="tag is-success">
{{ new Date(props.row.date).toLocaleDateString() }}
</span>
</b-table-column>
<b-table-column label="Gender">
<span>
<b-icon pack="fas"
:icon="props.row.gender === 'Male' ? 'mars' : 'venus'">
</b-icon>
{{ props.row.gender }}
</span>
</b-table-column>
</template>
<template slot="empty">
<section class="section">
<div class="content has-text-grey has-text-centered">
<p>
<b-icon
icon="emoticon-sad"
size="is-large">
</b-icon>
</p>
<p>Nothing here.</p>
</div>
</section>
</template>
</b-table>
</section>
</template>
<script>
export default {
data() {
const data = [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016/10/15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016/12/15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016/04/26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016/04/10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016/12/06 14:38:38', 'gender': 'Female' }
]
return {
data,
isEmpty: false,
isBordered: false,
isStriped: false,
isNarrowed: false,
isHoverable: false,
isFocusable: false,
isLoading: false,
hasMobileCards: true
}
}
}
</script>
# Selection
You can show a single selected row by passing the corresponding object to the selected prop.
Additionally, adding the .sync modifier will make it two-way binding — selected object will mutate if user clicks on row.
Use focusable prop make table to be focused and navigable with a keyboard using arrow keys.
ID | First Name | Last Name | Date | Gender |
|---|---|---|---|---|
| 1 | Jesse | Simmons | 2016-10-15 13:43:27 | Male |
| 2 | John | Jacobs | 2016-12-15 06:00:53 | Male |
| 3 | Tina | Gilbert | 2016-04-26 06:26:28 | Female |
| 4 | Clarence | Flores | 2016-04-10 10:28:46 | Male |
| 5 | Anne | Lee | 2016-12-06 14:38:38 | Female |
<template>
<section>
<button class="button field is-danger" @click="selected = null"
:disabled="!selected">
<b-icon icon="close"></b-icon>
<span>Clear selected</span>
</button>
<b-tabs>
<b-tab-item label="Table">
<b-table
:data="data"
:columns="columns"
:selected.sync="selected"
focusable>
</b-table>
</b-tab-item>
<b-tab-item label="Selected">
<pre>{{ selected }}</pre>
</b-tab-item>
</b-tabs>
</section>
</template>
<script>
export default {
data() {
const data = [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016-10-15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016-12-15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016-04-26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016-04-10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016-12-06 14:38:38', 'gender': 'Female' }
]
return {
data,
selected: data[1],
columns: [
{
field: 'id',
label: 'ID',
width: '40',
numeric: true
},
{
field: 'first_name',
label: 'First Name',
},
{
field: 'last_name',
label: 'Last Name',
},
{
field: 'date',
label: 'Date',
centered: true
},
{
field: 'gender',
label: 'Gender',
}
]
}
}
}
</script>
# Checkable
You can add checkboxes to rows by using the checkable prop.
To show which rows are checked, you have to pass the corresponding object array to the checked-rows prop.
Adding the .sync modifier will make it two-way binding — checked object array will mutate if user clicks on checkboxes.
A slot called bottom-left is available whenever the table is checkable or paginated, you can add anything in there.
ID | First Name | Last Name | Date | Gender | |
|---|---|---|---|---|---|
| 1 | Jesse | Simmons | 2016-10-15 13:43:27 | Male | |
| 2 | John | Jacobs | 2016-12-15 06:00:53 | Male | |
| 3 | Tina | Gilbert | 2016-04-26 06:26:28 | Female | |
| 4 | Clarence | Flores | 2016-04-10 10:28:46 | Male | |
| 5 | Anne | Lee | 2016-12-06 14:38:38 | Female |
Total checked: 2
<template>
<section>
<b-field grouped group-multiline>
<button class="button field is-danger" @click="checkedRows = []"
:disabled="!checkedRows.length">
<b-icon icon="close"></b-icon>
<span>Clear checked</span>
</button>
<b-select v-model="checkboxPosition">
<option value="left">Checkbox at left</option>
<option value="right">Checkbox at right</option>
</b-select>
</b-field>
<b-tabs>
<b-tab-item label="Table">
<b-table
:data="data"
:columns="columns"
:checked-rows.sync="checkedRows"
:is-row-checkable="(row) => row.id !== 3"
checkable
:checkbox-position="checkboxPosition">
<template slot="bottom-left">
<b>Total checked</b>: {{ checkedRows.length }}
</template>
</b-table>
</b-tab-item>
<b-tab-item label="Checked rows">
<pre>{{ checkedRows }}</pre>
</b-tab-item>
</b-tabs>
</section>
</template>
<script>
export default {
data() {
const data = [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016-10-15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016-12-15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016-04-26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016-04-10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016-12-06 14:38:38', 'gender': 'Female' }
]
return {
data,
checkboxPosition: 'left',
checkedRows: [data[1], data[3]],
columns: [
{
field: 'id',
label: 'ID',
width: '40',
numeric: true
},
{
field: 'first_name',
label: 'First Name',
},
{
field: 'last_name',
label: 'Last Name',
},
{
field: 'date',
label: 'Date',
centered: true
},
{
field: 'gender',
label: 'Gender',
}
]
}
}
}
</script>
# Searchable
You can add search filtering to rows by using the searchable prop.
ID | First Name | Last Name | Date | Gender |
|---|---|---|---|---|
| 1 | Jesse | Simmons | 2016-10-15 13:43:27 | Male |
| 2 | John | Jacobs | 2016-12-15 06:00:53 | Male |
| 3 | Tina | Gilbert | 2016-04-26 06:26:28 | Female |
| 4 | Clarence | Flores | 2016-04-10 10:28:46 | Male |
| 5 | Anne | Lee | 2016-12-06 14:38:38 | Female |
<template>
<section>
<b-table
:data="data"
:columns="columns">
</b-table>
</section>
</template>
<script>
export default {
data() {
return {
data: [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016-10-15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016-12-15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016-04-26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016-04-10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016-12-06 14:38:38', 'gender': 'Female' }
],
columns: [
{
field: 'id',
label: 'ID',
width: '100',
numeric: true,
searchable: true,
},
{
field: 'first_name',
label: 'First Name',
searchable: true,
},
{
field: 'last_name',
label: 'Last Name',
searchable: true,
},
{
field: 'date',
label: 'Date',
centered: true
},
{
field: 'gender',
label: 'Gender',
}
]
}
}
}
</script>
# Pagination and sorting
To make a column sortable, add the sortable prop on it and specify a field name.
You can also use the default-sort prop to determine the default sort column and order. The column must be sortable to work.
The default-sort-direction prop can be set to determine the default sort column direction on the first click.
A slot called bottom-left is available whenever the table is checkable or paginated, you can add anything in there.
ID | First Name | Last Name | Date | Gender |
|---|---|---|---|---|
| 30 | Alan | Mendoza | 4/22/2016 | Male |
| 57 | Alan | Edwards | 3/22/2017 | Male |
| 20 | Albert | Mendoza | 8/8/2016 | Male |
| 45 | Andrea | Marshall | 9/4/2016 | Female |
| 8 | Andrew | Greene | 11/20/2016 | Male |
<template>
<section>
<b-field grouped group-multiline>
<b-select v-model="defaultSortDirection">
<option value="asc">Default sort direction: ASC</option>
<option value="desc">Default sort direction: DESC</option>
</b-select>
<b-select v-model="perPage" :disabled="!isPaginated">
<option value="5">5 per page</option>
<option value="10">10 per page</option>
<option value="15">15 per page</option>
<option value="20">20 per page</option>
</b-select>
<div class="control">
<button class="button" @click="currentPage = 2" :disabled="!isPaginated">Set page to 2</button>
</div>
<div class="control is-flex">
<b-switch v-model="isPaginated">Paginated</b-switch>
</div>
<div class="control is-flex">
<b-switch v-model="isPaginationSimple" :disabled="!isPaginated">Simple pagination</b-switch>
</div>
<b-select v-model="paginationPosition" :disabled="!isPaginated">
<option value="bottom">bottom pagination</option>
<option value="top">top pagination</option>
<option value="both">both</option>
</b-select>
<b-select v-model="sortIcon">
<option value="arrow-up">Arrow sort icon</option>
<option value="menu-up">Caret sort icon</option>
<option value="chevron-up">Chevron sort icon </option>
</b-select>
<b-select v-model="sortIconSize">
<option value="is-small">Small sort icon</option>
<option value="">Regular sort icon</option>
<option value="is-medium">Medium sort icon</option>
<option value="is-large">Large sort icon</option>
</b-select>
</b-field>
<b-table
:data="data"
:paginated="isPaginated"
:per-page="perPage"
:current-page.sync="currentPage"
:pagination-simple="isPaginationSimple"
:pagination-position="paginationPosition"
:default-sort-direction="defaultSortDirection"
:sort-icon="sortIcon"
:sort-icon-size="sortIconSize"
default-sort="user.first_name"
aria-next-label="Next page"
aria-previous-label="Previous page"
aria-page-label="Page"
aria-current-label="Current page">
<template slot-scope="props">
<b-table-column field="id" label="ID" width="40" sortable numeric>
{{ props.row.id }}
</b-table-column>
<b-table-column field="user.first_name" label="First Name" sortable>
{{ props.row.user.first_name }}
</b-table-column>
<b-table-column field="user.last_name" label="Last Name" sortable>
{{ props.row.user.last_name }}
</b-table-column>
<b-table-column field="date" label="Date" sortable centered>
<span class="tag is-success">
{{ new Date(props.row.date).toLocaleDateString() }}
</span>
</b-table-column>
<b-table-column label="Gender">
<span>
<b-icon pack="fas"
:icon="props.row.gender === 'Male' ? 'mars' : 'venus'">
</b-icon>
{{ props.row.gender }}
</span>
</b-table-column>
</template>
</b-table>
</section>
</template>
<script>
const data = require('@/data/sample.json')
export default {
data() {
return {
data,
isPaginated: true,
isPaginationSimple: false,
paginationPosition: 'bottom',
defaultSortDirection: 'asc',
sortIcon: 'arrow-up',
sortIconSize: 'is-small',
currentPage: 1,
perPage: 5
}
}
}
</script>
# Detailed rows
You can have detailed rows by adding a detail named scoped slot and the detailed prop.
You can also toggle row detail programmatically using toggleDetails method and :show-detail-icon="false" if you want to hide chevron icon.
<template>
<section>
<b-field grouped group-multiline>
<div class="control">
<b-switch v-model="showDetailIcon">Show detail icon</b-switch>
</div>
</b-field>
<b-table
:data="data"
ref="table"
paginated
per-page="5"
:opened-detailed="defaultOpenedDetails"
detailed
detail-key="id"
@details-open="(row, index) => $buefy.toast.open(`Expanded ${row.user.first_name}`)"
:show-detail-icon="showDetailIcon"
aria-next-label="Next page"
aria-previous-label="Previous page"
aria-page-label="Page"
aria-current-label="Current page">
<template slot-scope="props">
<b-table-column field="id" label="ID" width="40" numeric>
{{ props.row.id }}
</b-table-column>
<b-table-column field="user.first_name" label="First Name" sortable>
<template v-if="showDetailIcon">
{{ props.row.user.first_name }}
</template>
<template v-else>
<a @click="toggle(props.row)">
{{ props.row.user.first_name }}
</a>
</template>
</b-table-column>
<b-table-column field="user.last_name" label="Last Name" sortable>
{{ props.row.user.last_name }}
</b-table-column>
<b-table-column field="date" label="Date" sortable centered>
<span class="tag is-success">
{{ new Date(props.row.date).toLocaleDateString() }}
</span>
</b-table-column>
<b-table-column label="Gender">
<span>
<b-icon pack="fas"
:icon="props.row.gender === 'Male' ? 'mars' : 'venus'">
</b-icon>
{{ props.row.gender }}
</span>
</b-table-column>
</template>
<template slot="detail" slot-scope="props">
<article class="media">
<figure class="media-left">
<p class="image is-64x64">
<img src="/static/img/placeholder-128x128.png">
</p>
</figure>
<div class="media-content">
<div class="content">
<p>
<strong>{{ props.row.user.first_name }} {{ props.row.user.last_name }}</strong>
<small>@{{ props.row.user.first_name }}</small>
<small>31m</small>
<br>
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Proin ornare magna eros, eu pellentesque tortor vestibulum ut.
Maecenas non massa sem. Etiam finibus odio quis feugiat facilisis.
</p>
</div>
</div>
</article>
</template>
</b-table>
</section>
</template>
<script>
const data = require('@/data/sample.json')
export default {
data() {
return {
data,
defaultOpenedDetails: [1],
showDetailIcon: true
}
},
methods: {
toggle(row) {
this.$refs.table.toggleDetails(row)
}
}
}
</script>
# Custom Detailed rows
You can add anything you like into the detail named scoped by providing the customDetailRow prop to the table.
Be cautious when using a custom detailed row and toggling the display of columns,
as you will have to manage either the content within (with
colspan) or the columns themselves dependent on the content displayed.
<template>
<section>
<b-field grouped group-multiline>
<div class="control">
<b-checkbox v-model="showDetailIcon">Detail column</b-checkbox>
</div>
<div v-for="(column, index) in columnsVisible"
:key="index"
class="control">
<b-checkbox v-model="column.display">
{{ column.title }}
</b-checkbox>
</div>
</b-field>
<b-table
:data="data"
ref="table"
detailed
hoverable
custom-detail-row
:opened-detailed="['Board Games']"
:default-sort="['name', 'asc']"
detail-key="name"
@details-open="(row, index) => $buefy.toast.open(`Expanded ${row.name}`)"
:show-detail-icon="showDetailIcon">
<template slot-scope="props">
<b-table-column
field="name"
:visible="columnsVisible['name'].display"
:label="columnsVisible['name'].title"
width="300"
sortable
>
<template v-if="showDetailIcon">
{{ props.row.name }}
</template>
<template v-else>
<a @click="toggle(props.row)">
{{ props.row.name }}
</a>
</template>
</b-table-column>
<b-table-column
field="sold"
:visible="columnsVisible['sold'].display"
:label="columnsVisible['sold'].title"
sortable
centered
>
{{ props.row.sold }}
</b-table-column>
<b-table-column
field="available"
:visible="columnsVisible['available'].display"
:label="columnsVisible['available'].title"
sortable
centered
>
{{ props.row.available }}
</b-table-column>
<b-table-column
:visible="columnsVisible['cleared'].display"
:label="columnsVisible['cleared'].title"
centered
>
<span :class="
[
'tag',
{'is-danger': props.row.sold / props.row.available <= 0.45},
{'is-success': props.row.sold / props.row.available > 0.45}
]">
{{ Math.round((props.row.sold / props.row.available) * 100) }}%
</span>
</b-table-column>
</template>
<template slot="detail" slot-scope="props">
<tr v-for="item in props.row.items" :key="item.name">
<td v-if="showDetailIcon"></td>
<td v-show="columnsVisible['name'].display" > {{ item.name }}</td>
<td v-show="columnsVisible['sold'].display" class="has-text-centered">{{ item.sold }}</td>
<td v-show="columnsVisible['available'].display" class="has-text-centered">{{ item.available }}</td>
<td v-show="columnsVisible['cleared'].display" class="has-text-centered">
<span :class="
[
'tag',
{'is-danger': item.sold / item.available <= 0.45},
{'is-success': item.sold / item.available > 0.45}
]">
{{ Math.round((item.sold / item.available) * 100) }}%
</span>
</td>
</tr>
</template>
</b-table>
</section>
</template>
<script>
export default {
data() {
return {
data: [
{
name: 'Board Games',
sold: 131,
available: 301,
items: [
{
name: 'Monopoly',
sold: 57,
available: 100
},
{
name: 'Scrabble',
sold: 23,
available: 84
},
{
name: 'Chess',
sold: 37,
available: 61
},
{
name: 'Battleships',
sold: 14,
available: 56
}
]
},
{
name: 'Jigsaws & Puzzles',
sold: 88,
available: 167,
items: [
{
name: 'World Map',
sold: 31,
available: 38
},
{
name: 'London',
sold: 23,
available: 29
},
{
name: 'Sharks',
sold: 20,
available: 44
},
{
name: 'Disney',
sold: 14,
available: 56
}
]
},
{
name: 'Books',
sold: 434,
available: 721,
items: [
{
name: 'Hamlet',
sold: 101,
available: 187
},
{
name: 'The Lord Of The Rings',
sold: 85,
available: 156
},
{
name: 'To Kill a Mockingbird',
sold: 78,
available: 131
},
{
name: 'Catch-22',
sold: 73,
available: 98
},
{
name: 'Frankenstein',
sold: 51,
available: 81
},
{
name: 'Alice\'s Adventures In Wonderland',
sold: 46,
available: 68
}
]
}
],
columnsVisible: {
name: { title: 'Name', display: true },
sold: { title: 'Stock Sold', display: true },
available: { title: 'Stock Available', display: true },
cleared: { title: 'Stock Cleared', display: true },
},
showDetailIcon: true
}
},
methods: {
toggle(row) {
this.$refs.table.toggleDetails(row)
}
}
}
</script>
# Row status
Use the row-class prop to return a class name. It's a function that receives row and index parameters.
Note that you have to style the class yourself.
ID | First Name | Last Name | Date | Gender |
|---|---|---|---|---|
| 1 | Jesse | Simmons | 2016-10-15 13:43:27 | Male |
| 2 | John | Jacobs | 2016-12-15 06:00:53 | Male |
| 3 | Tina | Gilbert | 2016-04-26 06:26:28 | Female |
| 4 | Clarence | Flores | 2016-04-10 10:28:46 | Male |
| 5 | Anne | Lee | 2016-12-06 14:38:38 | Female |
<template>
<b-table
:data="data"
:columns="columns"
:row-class="(row, index) => row.id === 1 && 'is-info'">
</b-table>
</template>
<script>
export default {
data() {
return {
data: [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016-10-15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016-12-15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016-04-26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016-04-10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016-12-06 14:38:38', 'gender': 'Female' }
],
columns: [
{
field: 'id',
label: 'ID',
width: '40',
numeric: true
},
{
field: 'first_name',
label: 'First Name',
},
{
field: 'last_name',
label: 'Last Name',
},
{
field: 'date',
label: 'Date',
centered: true
},
{
field: 'gender',
label: 'Gender',
}
]
}
}
}
</script>
<style>
tr.is-info {
background: #167df0;
color: #fff;
}
</style>
# Custom headers
By adding a scoped slot named header in table component you can customize the headers.
Use the meta prop on column to pass anything you may need.
Previous scoped slot named header in table will be deprecated.
ID
|
First Name
|
Last Name
| Date | Gender |
|---|---|---|---|---|
| 1 | Jesse | Simmons | 10/15/2016 | Male |
| 2 | John | Jacobs | 12/15/2016 | Male |
| 3 | Tina | Gilbert | 4/26/2016 | Female |
| 4 | Clarence | Flores | 4/10/2016 | Male |
| 5 | Anne | Lee | 12/6/2016 | Female |
<template>
<b-table :data="data">
<template slot-scope="props">
<b-table-column field="id" label="ID" width="40" numeric>
<template slot="header" slot-scope="{ column }">
<b-tooltip :label="column.label" dashed>
{{ column.label }}
</b-tooltip>
</template>
{{ props.row.id }}
</b-table-column>
<b-table-column field="user.first_name" label="First Name">
<template slot="header" slot-scope="{ column }">
<b-tooltip :label="column.label" dashed>
{{ column.label }}
</b-tooltip>
</template>
{{ props.row.first_name }}
</b-table-column>
<b-table-column field="user.last_name" label="Last Name">
<template slot="header" slot-scope="{ column }">
<b-tooltip :label="column.label" dashed>
{{ column.label }}
</b-tooltip>
</template>
{{ props.row.last_name }}
</b-table-column>
<b-table-column field="date" label="Date" centered>
<span class="tag is-success">
{{ new Date(props.row.date).toLocaleDateString() }}
</span>
</b-table-column>
<b-table-column label="Gender">
<span>
<b-icon pack="fas"
:icon="props.row.gender === 'Male' ? 'mars' : 'venus'">
</b-icon>
{{ props.row.gender }}
</span>
</b-table-column>
</template>
</b-table>
</template>
<script>
export default {
data() {
return {
data: [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016-10-15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016-12-15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016-04-26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016-04-10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016-12-06 14:38:38', 'gender': 'Female' }
]
}
}
}
</script>
# Subheadings
Use the subheading prop on columns to add subheadings. This is particularly useful to display a summary when dealing with long tables.
By adding a scoped slot named subheading in table component you can customize the subheadings.
ID | Contributor | Posts | Comments |
|---|---|---|---|
Total: | 18 | 60 | |
| 1 | Jesse Simmons | 2 | 5 |
| 2 | John Jacobs | 11 | 42 |
| 3 | Tina Gilbert | 0 | 7 |
| 4 | Clarence Flores | 4 | 4 |
| 5 | Anne Lee | 1 | 2 |
<template>
<section>
<b-table
:data="data"
:columns="columns">
</b-table>
</section>
</template>
<script>
export default {
data() {
return {
data: [
{ 'id': 1, 'contributor': 'Jesse Simmons', 'posts': 2, 'comments': 5 },
{ 'id': 2, 'contributor': 'John Jacobs', 'posts': 11, 'comments': 42 },
{ 'id': 3, 'contributor': 'Tina Gilbert', 'posts': 0, 'comments': 7 },
{ 'id': 4, 'contributor': 'Clarence Flores', 'posts': 4, 'comments': 4 },
{ 'id': 5, 'contributor': 'Anne Lee', 'posts': 1, 'comments': 2 }
],
columns: [
{
field: 'id',
label: 'ID',
width: '100',
numeric: true,
subheading: 'Total:'
},
{
field: 'contributor',
label: 'Contributor',
},
{
field: 'posts',
label: 'Posts',
subheading: 18
},
{
field: 'comments',
label: 'Comments',
subheading: 60
}
]
}
}
}
</script>
# Toggle columns
Always use the
visible prop to hide/show columns, and NOT v-if or v-show.
ID | First Name | Last Name | Date | Gender |
|---|---|---|---|---|
| 1 | Jesse | Simmons | 2016-10-15 13:43:27 | Male |
| 2 | John | Jacobs | 2016-12-15 06:00:53 | Male |
| 3 | Tina | Gilbert | 2016-04-26 06:26:28 | Female |
| 4 | Clarence | Flores | 2016-04-10 10:28:46 | Male |
| 5 | Anne | Lee | 2016-12-06 14:38:38 | Female |
<template>
<section>
<b-field grouped group-multiline>
<div v-for="(column, index) in columnsTemplate"
:key="index"
class="control">
<b-checkbox v-model="column.visible">
{{ column.title }}
</b-checkbox>
</div>
</b-field>
<b-table :data="tableDataSimple">
<template slot-scope="props">
<b-table-column v-for="(column, index) in columnsTemplate"
:key="index"
:label="column.title"
:visible="column.visible">
{{ props.row[column.field] }}
</b-table-column>
</template>
</b-table>
</section>
</template>
<script>
export default {
data() {
const tableDataSimple = [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016-10-15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016-12-15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016-04-26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016-04-10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016-12-06 14:38:38', 'gender': 'Female' }
]
return {
tableDataSimple,
columnsTemplate: [
{ title: 'ID', field: 'id', visible: true },
{ title: 'First Name', field: 'first_name', visible: true },
{ title: 'Last Name', field: 'last_name', visible: true },
{ title: 'Date', field: 'date', visible: true },
{ title: 'Gender', field: 'gender', visible: true }
]
}
}
}
</script>
ID | First Name | Last Name | Date | Gender |
|---|---|---|---|---|
| 1 | Jesse | Simmons | 10/15/2016 | Male |
| 2 | John | Jacobs | 12/15/2016 | Male |
| 3 | Tina | Gilbert | 4/26/2016 | Female |
| 4 | Clarence | Flores | 4/10/2016 | Male |
| 5 | Anne | Lee | 12/6/2016 | Female |
Footer
| ||||
<template>
<section>
<b-field grouped group-multiline>
<div class="control">
<b-switch v-model="isCustom">Custom</b-switch>
</div>
</b-field>
<b-table :data="tableDataSimple">
<template slot-scope="props">
<b-table-column label="ID" width="40" numeric>
{{ props.row.id }}
</b-table-column>
<b-table-column label="First Name">
{{ props.row.first_name }}
</b-table-column>
<b-table-column label="Last Name">
{{ props.row.last_name }}
</b-table-column>
<b-table-column label="Date" centered>
{{ new Date(props.row.date).toLocaleDateString() }}
</b-table-column>
<b-table-column label="Gender">
{{ props.row.gender }}
</b-table-column>
</template>
<template slot="footer" v-if="!isCustom">
<div class="has-text-right">
Footer
</div>
</template>
<template slot="footer" v-else>
<th class="is-hidden-mobile" style="width:40px">
<div class="th-wrap is-numeric"> ID </div>
</th>
<th class="is-hidden-mobile">
<div class="th-wrap"> First Name </div>
</th>
<th class="is-hidden-mobile">
<div class="th-wrap"> Last Name </div>
</th>
<th class="is-hidden-mobile">
<div class="th-wrap is-centered"> Date </div>
</th>
<th class="is-hidden-mobile">
<div class="th-wrap"> Gender </div>
</th>
</template>
</b-table>
</section>
</template>
<script>
export default {
data() {
const tableDataSimple = [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016/10/15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016/12/15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016/04/26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016/04/10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016/12/06 14:38:38', 'gender': 'Female' }
]
return {
tableDataSimple,
isCustom: false
}
}
}
</script>
# Async data
Use backend-sorting and backend-pagination props to let those tasks to the backend,
then manage it with page-change and sort events.
API from TMDb.
Title | Vote Average | Vote Count | Release Date | Overview |
|---|---|---|---|---|
| Inception | 8.4 | 37583 | 7/15/2010 | Cobb, a skilled thief who commits corporate espionage by infiltrating the subcon... |
| Interstellar | 8.456 | 37323 | 11/5/2014 | The adventures of a group of explorers who make use of a newly discovered wormho... |
| The Dark Knight | 8.521 | 33984 | 7/16/2008 | Batman raises the stakes in his war on crime. With the help of Lt. Jim Gordon an... |
| Avatar | 7.59 | 32335 | 12/15/2009 | In the 22nd century, a paraplegic Marine is dispatched to the moon Pandora on a ... |
| The Avengers | 7.764 | 32127 | 4/25/2012 | When an unexpected enemy emerges and threatens global safety and security, Nick ... |
| Deadpool | 7.623 | 31681 | 2/9/2016 | The origin story of former Special Forces operative turned mercenary Wade Wilson... |
| Avengers: Infinity War | 8.236 | 30654 | 4/25/2018 | As the Avengers and their allies have continued to protect the world from threat... |
| Fight Club | 8.438 | 30385 | 10/15/1999 | A ticking-time-bomb insomniac and a slippery soap salesman channel primal male a... |
| Pulp Fiction | 8.488 | 28786 | 9/10/1994 | A burger-loving hit man, his philosophical partner, a drug-addled gangster's mol... |
| Guardians of the Galaxy | 7.905 | 28616 | 7/30/2014 | Light years from Earth, 26 years after being abducted, Peter Quill finds himself... |
| The Shawshank Redemption | 8.712 | 28468 | 9/23/1994 | Imprisoned in the 1940s for the double murder of his wife and her lover, upstand... |
| Forrest Gump | 8.468 | 28319 | 6/23/1994 | A man with a low IQ has accomplished great things in his life and been present d... |
| Harry Potter and the Philosopher's Stone | 7.901 | 28301 | 11/16/2001 | Harry Potter has lived under the stairs at his aunt and uncle's house his whole ... |
| Iron Man | 7.652 | 27041 | 4/30/2008 | After being held captive in an Afghan cave, billionaire engineer Tony Stark crea... |
| Django Unchained | 8.183 | 26836 | 12/25/2012 | With the help of a German bounty hunter, a freed slave sets out to rescue his wi... |
| Joker | 8.136 | 26540 | 10/1/2019 | During the 1980s, a failed stand-up comedian is driven insane and turns to a lif... |
| The Matrix | 8.2 | 26488 | 3/31/1999 | Set in the 22nd century, The Matrix tells the story of a computer hacker who joi... |
| Avengers: Endgame | 8.24 | 26445 | 4/24/2019 | After the devastating events of Avengers: Infinity War, the universe is in ruins... |
| Titanic | 7.906 | 26077 | 11/18/1997 | 101-year-old Rose DeWitt Bukater tells the story of her life aboard the Titanic,... |
| The Lord of the Rings: The Fellowship of the Ring | 8.423 | 26071 | 12/18/2001 | Young hobbit Frodo Baggins, after inheriting a mysterious ring from his uncle Bi... |
<template>
<section>
<b-table
:data="data"
:loading="loading"
paginated
backend-pagination
:total="total"
:per-page="perPage"
@page-change="onPageChange"
aria-next-label="Next page"
aria-previous-label="Previous page"
aria-page-label="Page"
aria-current-label="Current page"
backend-sorting
:default-sort-direction="defaultSortOrder"
:default-sort="[sortField, sortOrder]"
@sort="onSort">
<template slot-scope="props">
<b-table-column field="original_title" label="Title" sortable>
{{ props.row.original_title }}
</b-table-column>
<b-table-column field="vote_average" label="Vote Average" numeric sortable>
<span class="tag" :class="type(props.row.vote_average)">
{{ props.row.vote_average }}
</span>
</b-table-column>
<b-table-column field="vote_count" label="Vote Count" numeric sortable>
{{ props.row.vote_count }}
</b-table-column>
<b-table-column field="release_date" label="Release Date" sortable centered>
{{ props.row.release_date ? new Date(props.row.release_date).toLocaleDateString() : '' }}
</b-table-column>
<b-table-column label="Overview" width="500">
{{ props.row.overview | truncate(80) }}
</b-table-column>
</template>
</b-table>
</section>
</template>
<script>
export default {
data() {
return {
data: [],
total: 0,
loading: false,
sortField: 'vote_count',
sortOrder: 'desc',
defaultSortOrder: 'desc',
page: 1,
perPage: 20
}
},
methods: {
/*
* Load async data
*/
loadAsyncData() {
const params = [
'api_key=bb6f51bef07465653c3e553d6ab161a8',
'language=en-US',
'include_adult=false',
'include_video=false',
`sort_by=${this.sortField}.${this.sortOrder}`,
`page=${this.page}`
].join('&')
this.loading = true
this.$http.get(`https://api.themoviedb.org/3/discover/movie?${params}`)
.then(({ data }) => {
// api.themoviedb.org manage max 1000 pages
this.data = []
let currentTotal = data.total_results
if (data.total_results / this.perPage > 1000) {
currentTotal = this.perPage * 1000
}
this.total = currentTotal
data.results.forEach((item) => {
item.release_date = item.release_date.replace(/-/g, '/')
this.data.push(item)
})
this.loading = false
})
.catch((error) => {
this.data = []
this.total = 0
this.loading = false
throw error
})
},
/*
* Handle page-change event
*/
onPageChange(page) {
this.page = page
this.loadAsyncData()
},
/*
* Handle sort event
*/
onSort(field, order) {
this.sortField = field
this.sortOrder = order
this.loadAsyncData()
},
/*
* Type style in relation to the value
*/
type(value) {
const number = parseFloat(value)
if (number < 6) {
return 'is-danger'
} else if (number >= 6 && number < 8) {
return 'is-warning'
} else if (number >= 8) {
return 'is-success'
}
}
},
filters: {
/**
* Filter to truncate string, accepts a length parameter
*/
truncate(value, length) {
return value.length > length
? value.substr(0, length) + '...'
: value
}
},
mounted() {
this.loadAsyncData()
}
}
</script>
# Draggable rows
Use draggable prop to allow rows to be draggable. Manage dragging using dragstart,
dragover and drop events
ID | First Name | Last Name | Date | Gender |
|---|---|---|---|---|
| 1 | Jesse | Simmons | 2016-10-15 13:43:27 | Male |
| 2 | John | Jacobs | 2016-12-15 06:00:53 | Male |
| 3 | Tina | Gilbert | 2016-04-26 06:26:28 | Female |
| 4 | Clarence | Flores | 2016-04-10 10:28:46 | Male |
| 5 | Anne | Lee | 2016-12-06 14:38:38 | Female |
<template>
<div>
<b-table
:data="data"
:columns="columns"
draggable
@dragstart="dragstart"
@drop="drop"
@dragover="dragover"
@dragleave="dragleave">
</b-table>
</div>
</template>
<script>
export default {
data() {
return {
data: [
{ 'id': 1, 'first_name': 'Jesse', 'last_name': 'Simmons', 'date': '2016-10-15 13:43:27', 'gender': 'Male' },
{ 'id': 2, 'first_name': 'John', 'last_name': 'Jacobs', 'date': '2016-12-15 06:00:53', 'gender': 'Male' },
{ 'id': 3, 'first_name': 'Tina', 'last_name': 'Gilbert', 'date': '2016-04-26 06:26:28', 'gender': 'Female' },
{ 'id': 4, 'first_name': 'Clarence', 'last_name': 'Flores', 'date': '2016-04-10 10:28:46', 'gender': 'Male' },
{ 'id': 5, 'first_name': 'Anne', 'last_name': 'Lee', 'date': '2016-12-06 14:38:38', 'gender': 'Female' }
],
columns: [
{
field: 'id',
label: 'ID',
width: '40',
numeric: true
},
{
field: 'first_name',
label: 'First Name',
},
{
field: 'last_name',
label: 'Last Name',
},
{
field: 'date',
label: 'Date',
centered: true
},
{
field: 'gender',
label: 'Gender',
}
],
draggingRow: null,
draggingRowIndex: null
}
},
methods: {
dragstart (payload) {
this.draggingRow = payload.row
this.draggingRowIndex = payload.index
payload.event.dataTransfer.effectAllowed = 'copy'
},
dragover(payload) {
payload.event.dataTransfer.dropEffect = 'copy'
payload.event.target.closest('tr').classList.add('is-selected')
payload.event.preventDefault()
},
dragleave(payload) {
payload.event.target.closest('tr').classList.remove('is-selected')
payload.event.preventDefault()
},
drop(payload) {
payload.event.target.closest('tr').classList.remove('is-selected')
const droppedOnRowIndex = payload.index
this.$buefy.toast.open(`Moved ${this.draggingRow.first_name} from row ${this.draggingRowIndex + 1} to ${droppedOnRowIndex + 1}`)
}
}
}
</script>
# API
Table
Name | Description | Type | Values | Default |
|---|---|---|---|---|
data | Table data | Array<Object> | — | — |
columns | Table columns, you can also add renderHtml: true on each column object | Array<Object> (same as TableColumns props) | — | — |
default-sort | Sets the default sort column and order — e.g. ['first_name', 'desc'] | String, Array | — | order: default-sort-direction prop |
default-sort-direction | Sets the default sort column direction on the first click | String | asc, desc | asc |
sort-icon | Sets the header sorting icon | String | - | arrow-up |
sort-icon-size | Sets the size of the sorting icon | String | is-small, is-medium, is-large | is-small |
bordered | Border to all cells | Boolean | — | false |
striped | Whether table is striped | Boolean | — | false |
narrowed | Makes the cells narrower | Boolean | — | false |
selected | Set which row is selected, use the .sync modifier to make it two-way binding | Object | — | — |
focusable | Table can be focused and user can navigate with keyboard arrows (require selected.sync) and rows are highlighted when hovering | Boolean | — | false |
hoverable | Rows are highlighted when hovering | Boolean | — | false |
checkable | Rows can be checked (multiple), checked rows will have a .is-checked class if you want to style | Boolean | — | false |
checkbox-position | Position of the checkbox (if checkable is true) | String | left or right | left |
checked-rows | Set which rows are checked, use the .sync modifier to make it two-way binding | Array<Object> | — | — |
header-checkable | Show check/uncheck all checkbox in table header when checkable | Boolean | — | true |
mobile-cards | Rows appears as cards on mobile (collapse rows) | Boolean | — | true |
backend-sorting | Columns won't be sorted with Javascript, use with sort event to sort in your backend | Boolean | — | false |
backend-pagination | Rows won't be paginated with Javascript, use with page-change event to paginate in your backend | Boolean | — | false |
total | Total number of table data if backend-pagination is enabled | Number | — | 0 |
current-page | Current page of table data (if paginated), use the .sync modifier to make it two-way binding | Number | — | 1 |
loading | Loading state | Boolean | — | false |
paginated | Adds pagination to the table | Boolean | — | false |
pagination-simple | Simple pagination (if paginated) | Boolean | — | false |
pagination-size | Pagination size (if paginated) | String | is-small, is-medium, is-large | — |
pagination-position | Pagination position (if paginated) | String | bottom, top, both | bottom |
per-page | How many rows per page (if paginated) | Number | — | 20 |
row-class | Add a class to row (<tr> element) based on the return | Function (row: Object, index: Number) | — | — |
detailed | Allow row details (check scoped slots documentation) | Boolean | — | false |
custom-detail-row | Allow a custom detail row | Boolean | — | false |
show-detail-icon | Allow chevron icon and column to be visible | Boolean | — | true |
opened-detailed | Allow pre-defined opened details. Ideal to open details via vue-router. (A unique key is required; check detail-key prop) | Array | — | [] |
has-detailed-visible | Controls the visibility of the trigger that toggles the detailed rows. | Function (row: Object) | — | true |
detail-key | Use a unique key of your data Object when use detailed or opened detailed. (id recommended) | String | — | — |
custom-is-checked | Custom method to verify if row is checked, works when is checkable. Useful for backend pagination | Function (a: Object, b: Object) | — | — |
is-row-checkable | Custom method to verify if a row is disabled, works when is checkable. | Function (row: Object) | — | true |
icon-pack | Icon pack to use | String | mdi, fa, fas, far, fad, fal | mdi |
mobile-sort-placeholder | Text when nothing is selected | String | — | — |
custom-row-key | Use a unique key of your data Object for each row. Useful if your data prop has dynamic indices. (id recommended) | String | - | - |
draggable | Allows rows to be draggable | Boolean | — | false |
aria-next-label | Accessibility label for the next page link (if paginated) | String | — | — |
aria-previous-label | Accessibility label for the previous page link (if paginated) | String | — | — |
aria-page-label | Accessibility label for the page link. If passed, this text will be prepended to the number of the page (if paginated) | String | — | — |
aria-current-label | Accessibility label for the current page link. If passed, this text will be prepended to the current page (if paginated) | String | — | — |
Column
Name | Description | Type | Values | Default |
|---|---|---|---|---|
label | Column header text, also used to identify column if custom-key prop is missing | String | — | — |
custom-key | Unique identifier, use when label is missing or there are duplicate label names | String, Number | — | this.label |
field | Property of the object the column is attributed, used for sorting | String | — | — |
meta | Meta prop to add anything, useful when creating custom headers | Any | — | — |
width | Column fixed width in pixels | Number | — | — |
numeric | Align the cell content to the right, sort icon on left | Boolean | — | false |
centered | Align the cell content to the center | Boolean | — | false |
sortable | Whether the column can be sorted | Boolean | — | false |
visible | Whether the column is visible | Boolean | — | true |
custom-sort | Custom sort method, works when is sortable | Function (a: Object, b: Object, isAsc: Boolean) | — | — |
searchable | Add a input below the header to filter data | Boolean | — | false |
subheading | Column subheading text | String, Number | — | — |
This page is open source. Noticed a typo or something's unclear?