vue-ads-table-tree

vue-ads-table-tree

Vue ads table tree is a vue js table component, with a tree functionality.

The default features of a table component like filtering, sorting and paginating are implemented. On top of that, you can add a tree structure: Rows can have child rows, that can be hidden or expanded.

Another cool feature, is the choice to load your rows in advance or via an async call to the backend. You can even load a small part of your data, for example the first page, and then load all the other pages with async calls to the backend.

It uses the handy tailwind css library for styling.

Demo

TODO

Installation

You can install the package via npm or yarn.

NPM

npm install vue-ads-table-tree --save

YARN

yarn add vue-ads-table-tree

Usage

You can add the vue-ads-table-tree component by using the following code in your project. This is the most simple example.

<template>
    <div id="app">
        <table-tree
            :columns="columns"
            :rows="rows"
        >
        </table-tree>
  </div>
</template>

<script>
import TableTree from './components/TableTree';

export default {
    name: 'app',

    components: {
        TableTree,
    },

    data () {
        return {
            columns: [
                {
                    property: 'firstName',
                    title: 'First Name',
                    sortable: true,
                    filterable: true,
                },
                {
                    property: 'lastName',
                    title: 'Last Name',
                    filterable: true,
                    sortable: true,
                },
            ],
            rows: [
                {
                    firstName: 'Albert',
                    lastName: 'Einstein',
                },
                {
                    firstName: 'Barack',
                    lastName: 'Obama',
                },
            ],
        };
    },
};
</script>

Properties

• styling: (type: object) Contains styling classes from the tailwind library. Here you can find all available classes. Combinations are possible by separating them by a space.
  • rowsEven: (type: string, default: 'bg-grey-lightest') Classes to add on the even rows.
  • rowsOdd: (type: string, default: 'bg-white') Classes to add on the odd rows.
  • rowsAll: (type: string, default: 'hover:bg-grey-lighter') Classes to add on all rows.
  • rowsAllExceptLast: (type: string, default: 'border-b') Classes to add on all rows except on the last one.
  • columnsEven: (type: string) Classes to add on the even columns.
  • columnsOdd: (type: string) Classes to add on the odd columns.
  • columnsAll: *(type: string)*Classes to add on all columns.
  • columnsAllExceptLast: (type: string, default: 'border-r') Classes to add on all columns except on the last one.
  • table: (type: string, default: 'border') Classes to add on the whole table.
• columns: (type: array, required) An array containing all the column objects. Each column object can contain the following properties:
  • property: (type: string, required) The corresponding value will be shown in the column of the given row property.
  • title: (type: string) The title that will be shown in the header.
  • filterable: (type: boolean) Filter on this column?
  • sortable: (type: boolean) Is this column sortable?
  • direction: (type: boolean or null) The initial sort direction. If null, the column is not sorted. If true, the sorting is ascending. If false, the sorting is descending.
• rows: (type: array, default: []) An array containing all the row objects. Each row object has his own key value pairs and extra meta data:
  • children: (type: array) An array with child row objects.
  • hasChildren: (type: boolean, default: false) Indicates if this row has children. This property will automatically be set to true if the children attribute is set.
  • showChildren: (type: boolean) Indicates if the children has to be shown on create. If this is true, and hasChildren is true, but no children attribute is found, an async call will be initiated to get the children.
• totalRows: (type: number, default: rows.length) The total number of rows. If this is greater than the current rows length, async calls will be executed if the unknown rows are requested.
• asyncCall: (type: function) The function that is called when making an async request. It takes the following parameters:
  • range: (type: object) The paginated range with a start and end index.
    • start: (type: number) Contains the current zero based start index.
    • end: (type: number) Contains the current zero based end index.
  • filter: (type: string) The filter value.
  • sortColumns: (type: array) A list of all columns that are sortable. The last sorted column is the last column in this list. A column has the following interesting properties for sorting:
    • direction: (type: boolean or null) See columns => direction
  • parent: (type: Row) If the child rows are called. This value is a Row object that contains all the info from the parent row.
• useCache: (type: boolean) Async called rows will be stored in the cache if no sorting or filtering is done and this value is true.
• itemsPerPage: (type: number, default: 10) The max amount of items on one page.
• page: (type: number, default: 0) A zero-based number to set the initial page.
• filter: (type: string) The initial filter value.

Testing

We use the jest framework for testing the table tree component. Run the following command to test it:

npm run test:unit

Changelog

Read the CHANGELOG file to check what has changed.

Issues

If you have any issues (bugs, features, ...) on the current project, add them here.

Contributing

Do you like to contribute to this project? Please, read the CONTRIBUTING file.

Social

• Follow me on

Donate

Want to make a donation? That would be highly appreciated!

Make a donation via PayPal.

Changelog

v1.0.0 - 15/08/2018

• Initial release.