Table

Overview

The Table component allows the user to display an editable table.

---

Specification

Property

Here is a list of properties that can be used for modifying the component:

Name	Type	Default	Description	Remark
className	string	""	Component class name
id	string	""	Component id name
label	string	""	Label for the component	Label is not displayed if unspecified or empty
actionButton	boolean	true	Show/Hide the add/remove row button
headerVisible	boolean	true	Show/Hide the header
visible	boolean	true	Show/Hide the component
columns	Array<Column>	[]	Column data of the component	Will result an error if the value of columns is not an array
data	Array<object>	[]	Row data of the component	Will result an error if the value of data is not an array

Column

Name	Type	Default	Description	Remark
field	string	null	Key of the column *Required and Unique	It represents the key of the data object The value associated with that key will be rendered in the column Will result an error if the field is duplicated in columns or not specified
title	string	""	Header name of the column
requiredIcon	boolean	false	Show/Hide the required icon
visible	boolean	true	Show/Hide the column
render *1	function function(cellData, rowData, rowIndex) {}	null	Renderer of the cell	The return value should be a DOM Following 3 params provide more information for the function cellData is the data of the current cell rendered rowData is the data of the current row rendered rowIndex is the index number of the current row rendered If render function is not specified, the cell will display with the default text

caution

*1: [Security] Kintone UI Component does NOT sanitize this property value. It is the developer's responsibility to escape any user input when using this option so that XSS attacks would be prevented.

Event

Here is a list of events that can be specified:

Name	Type	Description	Remark
change	function	Event handler when the table data has been changed	It will pass the event object as the argument You can receive the following values in event.detail change-cell (Triggered if the data in cell is changed) event.detail.type: "change-cell" event.detail.rowIndex: Index number of the changed row event.detail.data: All data of table after change event.detail.oldData: All data of table before change event.detail.field: Changed column's field add-row (Triggered if add row button is clicked) event.detail.type: "add-row" event.detail.rowIndex: Index number of the added row event.detail.data: All data of table after change event.detail.oldData: All data of table before change remove-row (Triggered if remove row button is clicked) event.detail.type: "remove-row" event.detail.rowIndex: Index number of the removed row event.detail.data: All data of table after change event.detail.oldData: All data of table before change

Constructor

Table(options)
Here is a list of available constructors:

Parameter

Name	Type	Default	Description	Remark
options	object	{}	Object that includes component properties

Custom CSS

tip

Please check Custom CSS feature guide at first.

Here is a list of properties that can be used for modifying component style:

Property

Name	Description
--kuc-table-header-background-color
--kuc-table-header-color
--kuc-table-header-font-size
--kuc-table-header-height
--kuc-table-header-{index}-width	This property allows you to set the width of certain table columns based on their index values For example, you can use --kuc-table-header-0-width to set the width of the first column Note that the index values start from 0, where 0 corresponds to the first column
--kuc-table-header-width	This property is used to set the width for all columns in a table, it defines a uniform width for every column If you need to set a specific width for a single column, you can use --kuc-table-header-{index}-width property If you want to add the element that will expand/contract as a child component, you may be able to preserve this behavior by setting --kuc-table-header-width: auto

---

Sample Code

tip

Please check the package installation method first.

Here is a sample code when all parameters are specified:

const Kuc = Kucs['1.x.x'];

const space = kintone.app.record.getSpaceElement('space');

const renderAge = dataCell => {
  const spanElement = document.createElement('span');
  spanElement.innerText = `The age is ${dataCell}`;
  return spanElement;
};

const renderName = cellData => {
  const dropdown = new Kuc.Dropdown({
    items: [
      { label: 'John Brown', value: 'john' },
      { label: 'Steven Gerrard', value: 'steven' }
    ],
    value: cellData
  });
  return dropdown;
};

const table = new Kuc.Table({
  label: 'Table',
  columns: [
    {
      title: 'Name',
      field: 'name',
      render: renderName
    },
    {
      title: 'Address',
      field: 'address'
    },
    {
      title: 'Age',
      field: 'age',
      render: renderAge
    }
  ],
  data: [
    {
      name: 'john',
      age: 32,
      address: 'New York No. 1 Lake Park'
    },
    {
      name: 'steven',
      age: 22,
      address: 'New York No. 2 Lake Park'
    }
  ],
  className: 'options-class',
  id: 'options-id',
  actionButton: true,
  headerVisible: true,
  visible: true
});

space.appendChild(table);

table.addEventListener('change', event => {
  console.log(event);
});

---

Related Articles

• Table and ReadOnlyTable customization