dashboard/components/SortableTable/index.vue

858 lines
21 KiB
Vue

<script>
import { mapState } from 'vuex';
import { dasherize, ucFirst } from '@/utils/string';
import { get, clone } from '@/utils/object';
import { removeObject } from '@/utils/array';
import Checkbox from '@/components/form/Checkbox';
import $ from 'jquery';
import throttle from 'lodash/throttle';
import THead from './THead';
import filtering from './filtering';
import selection from './selection';
import sorting from './sorting';
import paging from './paging';
import grouping from './grouping';
// @TODO:
// Fixed header/scrolling
// Data Flow:
// rows prop
// -> filteredRows (filtering.js)
// -> arrangedRows (sorting.js)
// -> pagedRows (paging.js)
// -> groupedRows (grouping.js)
export default {
name: 'SortableTable',
components: { THead, Checkbox },
mixins: [filtering, sorting, paging, grouping, selection],
props: {
headers: {
// {
// name: Name for the column (goes in query param) and for defaultSortBy
// label: Displayed column header
// sort: string|array[string] Field name(s) to sort by, default: [name, keyField]
// fields can be suffixed with ':desc' to flip the normal sort order
// search: string|array[string] Field name(s) to search in, default: [name]
// width: number
// }
type: Array,
required: true
},
rows: {
// The array of objects to show
type: Array,
required: true
},
keyField: {
// Field that is unique for each row.
type: String,
required: true,
},
groupBy: {
// Field to group rows by, row[groupBy] must be something that can be a map key
type: String,
default: null
},
groupRef: {
// Object to provide as the reference for rendering the grouping row
type: String,
default: null,
},
groupSort: {
// Field to order groups by, defaults to groupBy
type: Array,
default: null
},
defaultSortBy: {
// Default field to sort by if none is specified
// uses name on headers
type: String,
default: null
},
tableActions: {
// Show bulk table actions
type: Boolean,
default: true
},
rowActions: {
// Show action dropdown on the end of each row
type: Boolean,
default: true
},
mangleActionResources: {
type: Function,
default: null,
},
rowActionsWidth: {
// How wide the action dropdown column should be
type: Number,
default: 40
},
search: {
// Show search input to filter rows
type: Boolean,
default: true
},
extraSearchFields: {
// Additional fields that aren't defined in the headers to search in on each row
type: Array,
default: null
},
subRows: {
// If there are sub-rows, your main row must have <tr class="main-row"> to identify it
type: Boolean,
default: false,
},
subExpandable: {
type: Boolean,
default: false,
},
subExpandColumn: {
type: Boolean,
default: false,
},
subSearch: {
// A field containing an array of sub-items to also search in for each row
type: String,
default: null,
},
subFields: {
// Search this list of fields within the items in "subSearch" of each row
type: Array,
default: null,
},
/**
* Show the divider between the thead and tbody.
*/
topDivider: {
type: Boolean,
default: true
},
/**
* Show the dividers between rows
*/
bodyDividers: {
type: Boolean,
default: false
},
/**
* Emphasize the text within tbody to have a brighter color.
*/
emphasizedBody: {
type: Boolean,
default: true
},
/**
* If pagination of the data is enabled or not
*/
paging: {
type: Boolean,
default: false,
},
/**
* What translation key to use for displaying the '1 - 10 of 100 Things' pagination info
*/
pagingLabel: {
type: String,
default: 'sortableTable.paging.generic'
},
/**
* Additional params to pass to the pagingLabel translation
*/
pagingParams: {
type: Object,
default: null,
},
/**
* Allows you to override the default preference of the number of
* items to display per page. This is used by ./paging.js if you're
* looking for a reference.
*/
rowsPerPage: {
type: Number,
default: null, // Default comes from the user preference
},
/**
* Allows you to override the default translation text of no rows view
*/
noRowsKey: {
type: String,
default: 'sortableTable.noRows'
},
/**
* Allows you to hide the no rows messaging.
*/
showNoRows: {
type: Boolean,
default: true
},
/**
* Allows you to override the default translation text of no search data view
*/
noDataKey: {
type: String,
default: 'sortableTable.noData'
},
/**
* Allows you to override showing the THEAD section.
*/
showHeaders: {
type: Boolean,
default: true
}
},
data() {
return { expanded: {} };
},
computed: {
fullColspan() {
let span = 0;
for ( let i = 0 ; i < this.columns.length ; i++ ) {
if (!this.columns[i].hide) {
span++;
}
}
if ( this.tableActions ) {
span++;
}
if ( this.subExpandColumn ) {
span++;
}
if ( this.rowActions ) {
span++;
}
return span;
},
noResults() {
return !!this.searchQuery && this.pagedRows.length === 0;
},
noRows() {
return !this.noResults && (this.rows || []).length === 0;
},
showHeaderRow() {
return this.search || this.tableActions;
},
columns() {
const out = this.headers.slice();
if ( this.groupBy ) {
const entry = out.find(x => x.name === this.groupBy);
if ( entry ) {
removeObject(out, entry);
}
}
// If all columns have a width, try to remove it from a column that can be variable (name)
const missingWidth = out.find(x => !x.width);
if ( !missingWidth ) {
const variable = out.find(x => x.canBeVariable);
if ( variable ) {
const neu = clone(variable);
delete neu.width;
out.splice(out.indexOf(variable), 1, neu);
}
}
return out;
},
// For data-title properties on <td>s
dt() {
const out = {
check: `Select: `,
actions: `Actions: `,
};
this.columns.forEach((col) => {
out[col.name] = `${ (col.label || col.name) }:`;
});
return out;
},
availableActions() {
return this.$store.getters[`${ this.storeName }/forTable`];
},
actionAvailability() {
if (this.tableSelected.length === 0) {
return null;
}
const runnableTotal = this.tableSelected.filter(this.canRunBulkActionOfInterest).length;
const selectionTotal = this.tableSelected.length;
const tableTotal = this.arrangedRows.length;
const allOfSelectionIsActionable = runnableTotal === selectionTotal;
const useTableTotal = !this.actionOfInterest || allOfSelectionIsActionable;
const input = {
actionable: this.actionOfInterest ? runnableTotal : selectionTotal,
total: useTableTotal ? tableTotal : selectionTotal,
};
const someActionable = this.actionOfInterest && !allOfSelectionIsActionable;
const key = someActionable ? 'sortableTable.actionAvailability.some' : 'sortableTable.actionAvailability.selected';
return this.t(key, input);
},
...mapState({
tableSelected(state) {
return state[this.storeName].tableSelected;
},
actionOfInterest(state) {
return state[this.storeName].actionOfInterest;
}
}),
classObject() {
return {
'top-divider': this.topDivider,
'emphasized-body': this.emphasizedBody,
'body-dividers': this.bodyDividers
};
}
},
methods: {
get,
dasherize,
labelFor(col) {
if ( col.labelKey ) {
return this.t(col.labelKey, undefined, true);
} else if ( col.label ) {
return col.label;
}
return ucFirst(col.name);
},
valueFor(row, col) {
const expr = col.value || col.name;
const out = get(row, expr);
if ( out === null || out === undefined ) {
return '';
}
return out;
},
isExpanded(row) {
const key = row[this.keyField];
return !!this.expanded[key];
},
toggleExpand(row) {
const key = row[this.keyField];
const val = !this.expanded[key];
this.expanded[key] = val;
this.expanded = { ...this.expanded };
return val;
},
setBulkActionOfInterest(action) {
this.$store.commit(`${ this.storeName }/setBulkActionOfInterest`, action);
},
canRunBulkActionOfInterest(resource) {
const result = this.$store.getters[`${ this.storeName }/canRunBulkActionOfInterest`](resource);
return result;
},
focusSearch() {
if ( this.$refs.searchQuery ) {
this.$refs.searchQuery.focus();
this.$refs.searchQuery.select();
}
},
focusAdjacent(next = true) {
const all = $('.checkbox-custom', this.$el).toArray();
const $cur = $(document.activeElement).closest('tr.main-row').find('.checkbox-custom');
let idx = -1;
if ( $cur.length ) {
idx = all.indexOf($cur[0]) + (next ? 1 : -1 );
} else if ( next ) {
idx = 1;
} else {
idx = all.length - 1;
}
if ( idx < 1 ) { // Don't go up to the check all button
idx = 1;
}
if ( idx >= all.length ) {
idx = all.length - 1;
}
if ( all[idx] ) {
all[idx].focus();
}
},
focusNext: throttle(function() {
this.focusAdjacent(true);
}, 100),
focusPrevious: throttle(function() {
this.focusAdjacent(false);
}, 100),
}
};
</script>
<template>
<div>
<div class="sortable-table-header">
<div v-if="showHeaderRow" class="fixed-header-actions">
<div v-if="tableActions" class="bulk">
<button
v-for="act in availableActions"
:key="act.action"
type="button"
class="btn role-primary"
:disabled="!act.enabled"
@click="applyTableAction(act, null, $event)"
@mouseover="setBulkActionOfInterest(act)"
@mouseleave="setBulkActionOfInterest(null)"
>
<i v-if="act.icon" :class="act.icon" />
<span v-html="act.label" />
</button>
<span />
<label v-if="actionAvailability" class="action-availability">
{{ actionAvailability }}
</label>
</div>
<div class="middle">
<slot name="header-middle" />
</div>
<div v-if="search" class="search">
<input ref="searchQuery" v-model="searchQuery" type="search" class="input-sm" :placeholder="t('sortableTable.search')">
</div>
</div>
</div>
<table class="sortable-table" :class="classObject" width="100%">
<THead
v-if="showHeaders"
:label-for="labelFor"
:columns="columns"
:table-actions="tableActions"
:row-actions="rowActions"
:sub-expand-column="subExpandColumn"
:row-actions-width="rowActionsWidth"
:how-much-selected="howMuchSelected"
:sort-by="sortBy"
:default-sort-by="_defaultSortBy"
:descending="descending"
@on-toggle-all="onToggleAll"
@on-sort-change="changeSort"
/>
<tbody v-if="noRows">
<slot name="no-rows">
<tr>
<td :colspan="fullColspan" class="no-rows">
<t v-if="showNoRows" :k="noRowsKey" />
</td>
</tr>
</slot>
</tbody>
<tbody v-else-if="noResults">
<slot name="no-results">
<tr>
<td :colspan="fullColspan" class="no-results text-center">
<t :k="noDataKey" />
</td>
</tr>
</slot>
</tbody>
<tbody v-for="group in groupedRows" v-else :key="group.key" :class="{ group: groupBy }">
<slot v-if="groupBy" name="group-row" :group="group" :fullColspan="fullColspan">
<tr class="group-row">
<td :colspan="fullColspan">
<slot name="group-by" :group="group">
<div v-trim-whitespace class="group-tab">
{{ group.ref }}
</div>
</slot>
</td>
</tr>
</slot>
<template v-for="row in group.rows">
<slot name="main-row" :row="row">
<!-- The data-cant-run-bulk-action-of-interest attribute is being used instead of :class because
because our selection.js invokes toggleClass and :class clobbers what was added by toggleClass if
the value of :class changes. -->
<tr :key="get(row,keyField)" class="main-row" :data-node-id="get(row,keyField)" :data-cant-run-bulk-action-of-interest="actionOfInterest && !canRunBulkActionOfInterest(row)">
<td v-if="tableActions" class="row-check" align="middle">
<Checkbox class="selection-checkbox" :data-node-id="get(row,keyField)" :value="tableSelected.includes(row)" />
</td>
<td v-if="subExpandColumn" class="row-expand" align="middle">
<i data-title="Toggle Expand" :class="{icon: true, 'icon-chevron-right': true, 'icon-chevron-down': !!expanded[get(row, keyField)]}" @click.stop="toggleExpand(row)" />
</td>
<template v-for="col in columns">
<slot
:name="'col:' + col.name"
:row="row"
:col="col"
:dt="dt"
:expanded="expanded"
:rowKey="get(row,keyField)"
>
<td
:key="col.name"
:data-title="labelFor(col)"
:align="col.align || 'left'"
:class="{['col-'+dasherize(col.formatter||'')]: !!col.formatter}"
:width="col.width"
>
<slot :name="'cell:' + col.name" :row="row" :col="col" :value="valueFor(row,col)">
<component
:is="col.formatter"
v-if="col.formatter"
:value="valueFor(row,col)"
:row="row"
:col="col"
v-bind="col.formatterOpts"
/>
<template v-else-if="valueFor(row,col) !== ''">
{{ valueFor(row,col) }}
</template>
<template v-else-if="col.dashIfEmpty">
<span class="text-muted">&mdash;</span>
</template>
</slot>
</td>
</slot>
</template>
<td v-if="rowActions" align="middle">
<slot name="row-actions" :row="row">
<button aria-haspopup="true" aria-expanded="false" type="button" class="btn btn-sm role-multi-action actions">
<i class="icon icon-actions" />
</button>
</slot>
</td>
</tr>
</slot>
<slot
v-if="subRows && (!subExpandable || expanded[get(row,keyField)])"
name="sub-row"
:full-colspan="fullColspan"
:row="row"
:sub-matches="subMatches"
/>
</template>
</tbody>
</table>
<div v-if="showPaging" class="paging">
<button
type="button"
class="btn btn-sm role-multi-action"
:disabled="page == 1"
@click="goToPage('first')"
>
<i class="icon icon-chevron-beginning" />
</button>
<button
type="button"
class="btn btn-sm role-multi-action"
:disabled="page == 1"
@click="goToPage('prev')"
>
<i class="icon icon-chevron-left" />
</button>
<span>
{{ pagingDisplay }}
</span>
<button
type="button"
class="btn btn-sm role-multi-action"
:disabled="page == totalPages"
@click="goToPage('next')"
>
<i class="icon icon-chevron-right" />
</button>
<button
type="button"
class="btn btn-sm role-multi-action"
:disabled="page == totalPages"
@click="goToPage('last')"
>
<i class="icon icon-chevron-end" />
</button>
</div>
<button v-shortkey.once="['/']" class="hide" @shortkey="focusSearch()" />
<button v-if="tableActions" v-shortkey="['j']" class="hide" @shortkey="focusNext()" />
<button v-if="tableActions" v-shortkey="['k']" class="hide" @shortkey="focusPrevious()" />
</div>
</template>
<style lang="scss">
//
// Important: Almost all selectors in here need to be ">"-ed together so they
// apply only to the current table, not one nested inside another table.
//
$group-row-height: 40px;
$group-separation: 40px;
$divider-height: 1px;
$separator: 20;
$remove: 75;
$spacing: 10px;
.sortable-table {
border-collapse: collapse;
min-width: 400px;
border-radius: 5px 5px 0 0;
overflow: hidden;
box-shadow: 0 0 20px var(--shadow);
background: var(--sortable-table-accent-bg);
border-radius: 4px;
td {
padding: 12px 5px;
border: 0;
word-break: break-word;
&.row-check {
padding-top: 16px;
LABEL {
margin-right: 1px; /* to make up for the edge border */
}
}
}
tbody {
tr {
border-bottom: 1px solid var(--sortable-table-top-divider);
background-color: var(--body-bg);
&.main-row + .sub-row {
border-bottom: 0;
}
&:last-of-type {
border-bottom: 0;
}
}
td {
&:first-of-type {
border-left: 1px solid var(--sortable-table-accent-bg);
}
&:last-of-type {
/* Not sure why 2 but one doesn't show up.. */
border-right: 2px solid var(--sortable-table-accent-bg);
}
}
tr.active-row {
color: var(--sortable-table-header-bg) !important;
}
tr.row-selected {
background: var(--sortable-table-selected-bg) !important;
}
.no-rows {
padding: 30px 0;
text-align: center;
}
&.group {
&:before {
content: "";
display: block;
height: 20px;
background-color: transparent;
}
}
tr.group-row {
background-color: initial;
&:first-child {
border-bottom: 0;
}
&:not(:first-child) {
margin-top: 20px;
}
td {
padding: 0;
&:first-of-type {
border-left: 1px solid var(--sortable-table-accent-bg);
}
}
.group-tab {
@include clearfix;
height: $group-row-height;
line-height: $group-row-height;
padding: 0 10px;
border-radius: 4px 4px 0px 0px;
background-color: var(--body-bg);
position: relative;
top: 0;
display: inline-block;
z-index: z-index('tableGroup');
min-width: $group-row-height * 1.8;
> SPAN {
color: var(--sortable-table-group-label);
}
}
.group-tab:after {
height: $group-row-height;
width: 70px;
border-radius: 5px 5px 0px 0px;
background-color: var(--body-bg);
content: "";
position: absolute;
right: -15px;
top: 0px;
transform: skewX(40deg);
z-index: -1;
}
}
}
}
.for-inputs{
& TABLE.sortable-table {
width: 100%;
border-collapse: collapse;
margin-bottom: $spacing;
>TBODY>TR>TD, >THEAD>TR>TH {
padding-right: $spacing;
padding-bottom: $spacing;
&:last-of-type {
padding-right: 0;
}
}
>TBODY>TR:first-of-type>TD {
padding-top: $spacing;
}
>TBODY>TR:last-of-type>TD {
padding-bottom: 0;
}
}
&.edit, &.create, &.clone {
TABLE.sortable-table>THEAD>TR>TH {
border-color: transparent;
}
}
}
.sortable-table-header {
position: relative;
z-index: z-index('fixedTableHeader');
}
.fixed-header-actions {
padding: 0 0 20px 0;
width: 100%;
z-index: z-index('fixedTableHeader');
background: transparent;
display: grid;
grid-template-columns: [bulk] auto [middle] min-content [search] minmax(min-content, 200px);
grid-column-gap: 10px;
.bulk {
grid-area: bulk;
align-self: center;
BUTTON:not(:last-child) {
margin-right: 10px;
}
}
.middle {
grid-area: middle;
white-space: nowrap;
align-self: center;
}
.search {
grid-area: search;
}
}
.paging {
margin-top: 10px;
text-align: center;
SPAN {
display: inline-block;
min-width: 200px;
}
}
</style>