Note: Forms can use the principle of data-molds

Slots

The default slot contains the columns to display. header and footer are table-wide headers and footers

Proprieties

The v-model is the current row : the one the user clicked on. One can set it to another row with an affectation or bind to it. (note: the current row is an item from the provided rows)

Vue's magic is that : if v-model is not used, no row will be marked current. If you care about the current row, it will be marked as such. For ui consistency, it is advised to use the attribute selectable on the row that basically just shows :hover and add a dynamic side.

• rows: any[] is the list of items to display (models)
• row-class: (row: any)=> string Gather the classes that apply to row
• id-property: string allows the table to retrieve the id of a row
• body-height: number specifies the height of the body in pixel. Once specified a lot of things happen (in the css) - this is meant to allow a scroll-bar under the column headers - some css/js skill is still needed for the 2-pixel difference between columns.
• row-height: number forces the rows to have the same height. Once body-height and row-height are used, the library will create the tr elements only for the visible rows. Therefore, a massive amount of rows can be given without the risk to update all the tousands of elements on each changes

Events

Columns

Slots

Each column has two slots : header and beside a default, display and input scoped slot whose scope contains:

• model is the object mapped to this row (from table.rows)
• index is the numeric index of the row
• field that gives all informations like the value and the schema If a default slot is specified, it is used all the time. If not, the display will be used until an input is specified and the row is in edit mode. The default slot also has a boolean edition in its scope.

<s-column>
	<template slot="header">My property A</template>
	<template slot-scope="scope">{{scope.model.myPropA}}</template>
</s-column>
<s-column>
	<template slot="header" prop="myPropB">My property B</template>
	<template slot-scope="{field}">{{field.value}}</template>
</s-column>

Proprieties

• prop gives the property of the row this column displays. For now, it is just given to retrieve the value when no cell template is provided.
• header gives the text in the header if no template is provided
• edit specifies that the input is used instead of the display to edit the value

Events

Custom columns

In a custom column type, (a component that just contains a column), the injection table is available and refers to the table the column is in.

A custom column must contain only a ripper and provide two slots (an unscoped header and a scoped default). It should also use the managedColumn mixin from the Table

import {Ripper} from 'vue-ripper'
import {Table} from 'v-semantic'
@Component({
	components: {Ripper},
	mixins: [Table.managedColumn]
})

CheckboxColumn

The checkbox-column can be used for boolean values as well as for selection. There is no "multi-select" in the table, it is achieved by placing a checkbox-column at the begining.

If no header is specified (the same way than with regular columns), a "check-all" checkbox is placed in the header

Slots

The header slot allows to describe a complex header. It has in its scope:

• allSelected a boolean value bound to the select-all situation (true/false/null)
• setSelection is a callback that takes one argument (boolean/array) and behaves exactly like setting the selection does

The default slot allows to replace the checkbox by another component. If used its scope is the following:

• row is the row the cell applies to
• checked is bound to the boolean value (checked or not) for this cell
• select, unselect and toggle are three callbacks that take the row as an argument to (de)select the row.

Properties

• header can be specified if a header slot is not given

• selection is the model (emitting the event selection-change) and can be watched deeply : if the parent doesn't change it, it will remain the same Array that will be modified.

The parent can also set the selection to a non-array value. In this case, the model will be immediately updated to the effective array of selection.

• If set to a falsy value, the selection will become "none" []
• If set to true or to the array table.rows, the selection will become "all"