ta-good-table

TA Good Table is forked from Vue Good Table. We've made some updates to it to fit our Traction needs, and have been trying to capture the major changes below.

Installation

• Set up Satisfaction locally
• Install package: npm install @technologyadvice/ta-good-table

import Component:

1import VueGoodTable from '@technologyadvice/ta-good-table'

import Styles:

1@import '~ta-good-table/src/styles/style.scss';

Local development

• Clone the repository / pull latest: rr repo pull -fib ta-good-table
• Link the package to one or more applications: rr app package link ta-good-table accounts-portal -b

Publish NPM package

Publishing of NPM packages to the Satisfaction registry happens automatically via the publish GitHub Actions workflow.

---

Filtering

To enable filtering on a column, pass a filterOptions property on the column object with the enabled flag. This will take all column field values and format it into an options dropdown.

1filterOptions: {
2    enabled: true,
3},

Initial filtering

You can set an initial filter value by passing in an object to VueGoodTable. When setting the filter options, ta-good-table will set the field's active property to true.

1:initialFilter="{
2    field: plan_name, // name of the column field
3    value: Free, // value to filter by
4    }"

Multicolumn filters

Use this option if you have multiple columns that may share values and want only one filter dropdown to filter on both columns. Enable the filterOptions on both columns as shown above, and pass the following as a prop. For each set, the first field in the array will have the filter icon/dropdown.

1:multi-column-filter="{
2    enabled: true,
3    columnSets: [
4        [ 'field_one', 'field_two' ],
5    ],
6}"

Static filters

Use this if you have a static list of filter options.

1filterOptions: {
2    enabled: true,
3    type: 'remote',
4    staticFilterOptions: [
5        { id: 1, value: 'testing' },
6        { id: 2, value: 'testing123' },
7    ],
8    promoteActiveOptions: true, //orders the selected options before the the others when the filter is opened- defaults to false for static filters
9    outputFilterIdentifier: 'test_options_selected', //the key of the selected options in the request payload
10},

Multifield columns

Use this option if you have multiple fields in a single column. You will need to add a subFields property to the column object:

1subFields: [ { 
2    field: 'cool-field', 
3    label: 'Cool Field', 
4    filterActive: false, //necessary for reactivity, but not needed if not using filter
5    filterFn: method, // optional
6    type: 'date' // optional - will default to string
7} ],

To enable the filter, just pass the field name into the enableSubFields array (you also need the filterActive property shown above):

1filterOptions: {
2    enableSubFields: [ 'client' ]
3},

Sorting

Sorting is enabled by default. To disable, add sortable: false to the column object. Be sure to pass to pass the correct type for proper sorting.

1:sort-options="{
2    enabled: true,
3    initialSortBy: {
4        field: 'field_name',
5        type: 'asc', // or 'desc'
6    }
7}"

Types

Used for sorting (and possibly filtering in the future):

• boolean
• date
• decimal
• number
• percentage

Pagination

Pagination is enabled by default and has the following options. Note: currently the TA pagination is only setup for position: bottom

1:pagination-options="{
2    enabled: true,
3    perPage: 10,
4    position: 'bottom',
5    setCurrentPage: 1,
6}"

Remote filtering is also possible - check out this confluence document for more information.

Clickable rows

For clickable rows, you may either listen for the on-row-click event (which will have the row in the payload), or you can use the clickable-row-options property for routing. rowProperty is the value the route will use in the query params.

1:clickable-row-options="{
2    url: '/',
3    rowProperty: 'uuid',
4    useVueRouter: true,
5}"

Class name

pass the class-name prop to the VueGoodTable to dynamically generate classes on the table, rows, and headers using the field property on the column object.

class-name: "cool-table" will generate:

• class cool-table on the table root element
• class cool-table__cool-field on the header and cells (if the field is cool-field)
• class cool-table__cool-field--header on the column's header element
• class cool-table__cool-field--cell on the column's cell element
  • when two field names are the same, a tdClass can be passed in to differentiate the columns
  • it will still follow the format of the other class names cool-table__customname-cell

Zero state message

Pass the zero-state-message prop to the VueGoodTable if you want a custom zero state for that implementation of the table. The default message is "No results found" but good UX practices dictate selecting a zero message that is relevant to the content of your table.

Custom headers/rows

• full-row: use v-slot:table-full-row="props"
• row: use v-slot:table-row="props"
• column: use v-slot:table-column="props" (see implementation below)

Selection with remote pagination

When mode="remote" and you have selectOptions.selectAllByPage=false, ta-good-tables uses prop selectedRowsRemote for its selected rows, selectOptions.selectionIdentifier for the row identifier to use when selecting, selectOptions.getAllSelectionItems function to get all selected rows and on-selected-rows-changed to keep the selectedRowsRemote updated.

selectOptions.selectionIdentifier is the unique field for a row, most likely uuid.

selectedRowsRemote is a prop for ta-good-tables that should be a list of your selectOptions.selectionIdentifier for each selected row.

selectOptions.getAllSelectionItems should return a list of all selectable row identifiers. This should take into account the same filtering and searching that the table is using. So if your current table only shows 3 rows and your selectOptions.selectionIdentifier is "uuid" then this function should return a list of the 3 UUIDs.

on-selected-rows-changed returns the current list of selected rows and should replace your selectedRowsRemote prop value.

Example implementation

Table:

1<VueGoodTable
2    :cols="columns"
3    :rows="rows"
4    class-name="cool-table"
5    :clickable-row-options="{
6        url: '/cool',
7        rowProperty: 'uuid',
8        useVueRouter: true,
9    }"
10    :sort-options="{
11        enabled: true,
12        initialSortBy: {
13            field: 'date',
14            type: 'asc'/'desc',
15        }
16    }"
17    :multi-column-filter="{
18        enabled: true,
19        columnSets: [
20            [ 'field_one', 'field_two' ],
21        ],
22    }"
23    :pagination-options="{
24        enabled: true,
25        mode: 'records',
26        perPage: type === 'unresolved' ? 10 : 5,
27        position: 'bottom',
28    }"
29    zero-state-message="Looks like you don't have any rows">
30    <template v-slot:table-full-row="props">
31	// use a custom component for the full row instead of just a single column
32	<td :colspan="columns.length">
33            <CustomRowComponent :item="props.row"></CustomRowComponent>
34	</td>
35    </template>
36
37    <template v-slot:table-row="props">
38        <span v-if="props.column.field == 'field_name'">
39            // Custom Row 
40        </span>
41    </template>
42
43    <template v-slot:table-column="props">
44        <span v-if="props.column.field == 'field_name'">
45            // Custom Header
46        </span>
47    </template>
48</VueGoodTable>

Columns

1const columns = [
2    {
3        label: 'Name',
4        field: 'name',
5        subFields: [ { field: 'client', label: 'Client', filterActive: false } ],
6        filterOptions: {
7            enableSubField: [ 'client' ]
8        },
9    },
10    {
11        label: 'Brand',
12        field: 'brand',
13        filterOptions: {
14            enabled: true,
15        },
16    },
17    {
18        label: 'Date',
19        field: 'date',
20        type: 'date',
21        dateInputFormat: 'yyyy-MM-dd',
22        dateOutputFormat: 'E, MMM dd y',
23    },
24    {
25        label: 'Count',
26        field: 'count',
27        type: 'number',
28    },
29]

Troubleshooting

Columns are blank

A common issue with blank columns happens when there are custom columns on the page

you may see something like this in the table-row slot:

1<template v-if="props.column.field === 'name'">...</template>
2<template v-if="props.column.field === 'date'">...</template>

The above code could cause blank columns. The solution would be every conditional <template> after the initial v-if, should be a v-else-if

1<span v-if="props.column.field === 'name'"></span>
2<span v-else-if="props.column.field === 'date'"></span>