Label
Overview
Constructor
Parameter
Name | Type | Required | Description |
---|---|---|---|
options | Object | No | The object contains params of constructor. |
options.text | String | No | Caption of label. |
options.isRequired | String | No | Display the '*' character at the end of the caption. Default value is false. |
options.isDisabled | Boolean | No | The label will be disabled. Default value: 'false' |
options.isVisible | Boolean | No | The label will be visible. Default value: 'true' |
Sample
React
import { Label } from 'kintone-ui-component';
import React from 'react';
export default class Plugin extends React.Component {
render() {
return (
<Label text='Name' isRequired={true} />
);
}
}
Javascript
var label = new kintoneUIComponent.Label({
text: 'Name',
isRequired: true
});
Methods
render()
Get dom element of component.
Parameter
None
Returns
Dom element
Sample
React
import { Label } from 'kintone-ui-component';
import React from 'react';
export default class Plugin extends React.Component {
render() {
return (
<Label text='Name' isRequired={true} />
);
}
}
Javascript
var label = new kintoneUIComponent.Label({text: 'label'});
var body = document.getElementsByTagName("BODY")[0];
body.appendChild(label.render());
setText(text)
Set the value of text field.
Parameter
Name | Type | Required | Description |
---|---|---|---|
text | String | Yes | Caption of label. If text is undefined, null or true, The label will be displayed blank |
Returns
None
Sample
React
import { Label } from 'kintone-ui-component';
import React from 'react';
export default class Plugin extends React.Component {
render() {
return (
<Label text='Name' isRequired={true} />
);
}
}
Javascript
var label = new kintoneUIComponent.Label({text: 'label'});
var body = document.getElementsByTagName("BODY")[0];
body.appendChild(label.render());
label.setText('Name');
setRequired(required)
Set the required for the label.
Parameter
Name | Type | Required | Description |
---|---|---|---|
required | Boolean | Yes | Required option.
|
Returns
None
Sample
React
import { Label } from 'kintone-ui-component';
import React from 'react';
export default class Plugin extends React.Component {
render() {
return (
<Label text='Name' isRequired={true} />
);
}
}
Javascript
var label = new kintoneUIComponent.Label({text: 'label'});
var body = document.getElementsByTagName("BODY")[0];
body.appendChild(label.render());
label.setRequired(true);
on(eventName, callBack)
Register callback for click event
Parameter
Name | Type | Required | Description |
---|---|---|---|
eventName | String | Yes | Name of event:
|
callback | function | Yes | callback |
Returns
None
Sample
React
import { Label } from 'kintone-ui-component';
import React from 'react';
export default class Plugin extends React.Component {
render() {
return (
<Label text='Name' isRequired={true} onClick={this.handleClick} />
);
}
handleClick(){
console.log('click');
}
}
Javascript
var label = new kintoneUIComponent.Label({text: 'label'});
var body = document.getElementsByTagName("BODY")[0];
body.appendChild(label.render());
label.on('click', function(event) {
console.log('on click');
});
show()
Display the Label.
Parameter
None
Returns
None
Sample
React
import { Label } from 'kintone-ui-component';
import React from 'react';
export default class Plugin extends React.Component {
render() {
return (
<Label text='Name' isRequired={true} isVisible={true} />
);
}
}
Javascript
var label = new kintoneUIComponent.Label({text: 'label'});
var body = document.getElementsByTagName("BODY")[0];
body.appendChild(label.render());
label.show();
hide()
Hide the Label.
Parameter
None
Returns
None
Sample
React
import { Label } from 'kintone-ui-component';
import React from 'react';
export default class Plugin extends React.Component {
render() {
return (
<Label text='Name' isRequired={true} isVisible={false} />
);
}
}
Javascript
var label = new kintoneUIComponent.Label({text: 'label'});
var body = document.getElementsByTagName("BODY")[0];
body.appendChild(label.render());
label.hide();
disable()
Disabled the Label.
Parameter
None
Returns
None
Sample
React
import { Label } from 'kintone-ui-component';
import React from 'react';
export default class Plugin extends React.Component {
render() {
return (
<Label text='Name' isRequired={true} isDisabled={true} />
);
}
}
Javascript
var label = new kintoneUIComponent.Label({text: 'label'});
var body = document.getElementsByTagName("BODY")[0];
body.appendChild(label.render());
label.disable();
enable()
Enabled the Label.
Parameter
None
Returns
None
Sample
React
import { Label } from 'kintone-ui-component';
import React from 'react';
export default class Plugin extends React.Component {
render() {
return (
<Label text='Name' isRequired={true} isDisabled={false} />
);
}
}
Javascript
var label = new kintoneUIComponent.Label({text: 'label'});
var body = document.getElementsByTagName("BODY")[0];
body.appendChild(label.render());
label.enable();