Tabs
Overview
The Tabs component allows the user to display multiple tabs that can switch displaying contents.
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 | |
value | string | "" | Selected value | value is matched in the items , the tab will be displayed even if it’s disabled
value is not string type |
borderVisible | boolean | true | Show/Hide the border surrounding the content | |
visible | boolean | true | Show/Hide the component | |
items | Array<Item> | [] | List of tabs to display | Will result an error if the value of items is not an array |
Item
Name | Type | Default | Description | Remark |
---|---|---|---|---|
content | string/HTMLElement | "" | Tab content | |
label | string | "" | Tab name | |
value | string | "" | Key of each tab * Required and Unique | Will result an error if the value is duplicated in items or not specified |
disabled | boolean | false | Enable/Disable the tab | |
visible | boolean | true | Show/Hide the tab |
Event
Here is a list of events that can be specified:
Name | Type | Description | Remark |
---|---|---|---|
change | function | Event handler of when selected tab is changed | It will pass the event object as the argument You can receive the following values in event.detail |
Constructor
Tabs(options)
Here is a list of available constructors:
Parameter
Name | Type | Default | Description | Remark |
---|---|---|---|---|
options | object | {} | Object that includes component properties |
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');
// Create each Tab content
const textArea = new Kuc.TextArea({
label: "TextArea",
value: "This is sample."
});
const timePicker = new Kuc.TimePicker({
label: "Time",
value: "11:30"
});
const text = "This is sample.";
const tabs = new Kuc.Tabs({
items: [
{
label: 'A',
content: textArea,
value: 'a',
disabled: false
},
{
label: 'B',
content: timePicker,
value: 'b',
disabled: false
},
{
label: 'C',
content: text,
value: 'c',
disabled: false
}
],
value: 'a',
className: 'options-class',
id: 'options-id',
visible: true,
borderVisible: true
});
space.appendChild(tabs);
tabs.addEventListener('change', event => {
console.log(event);
});