Skip to main content
Version: 1.18.0

TextArea

Overview

The TextArea component allows the user to display multiple lines of text element.


Specification

Property

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

NameTypeDefaultDescriptionRemark
classNamestring""Component class name
errorstring""Text to be displayed in errorError will not be displayed if unspecified or left empty
idstring""Component id name
labelstring""Label for the componentLabel will not be displayed if unspecified or is empty
placeholderstring""Placeholder text for entry example
valuestring""Text to be displayed
disabledbooleanfalseEnable/Disable the component
requiredIconbooleanfalseShow/Hide the required icon
visiblebooleantrueShow/Hide the component

Event

Here is a list of events that can be specified:

NameTypeDescriptionRemark
changefunctionEvent handler when the value has been changedIt will pass the event object as the argument

You can receive the following values in event.detail
event.detail.oldValue : Value before the change
event.detail.value : Value after the change
focusfunctionEvent handler for the focused timeIt will pass the event object as the argument

You can receive the following values in event.detail
event.detail.value : Value at the time of focus
inputfunctionEvent handler when the value has been inputtingIt will pass the event object as the argument

You can receive the following values in event.detail
event.detail.data : Value of inserted characters
event.detail.value : Value of target element

*Notes on the value of "event.detail.data"
It is inserted characters when inserting text
It will be "null" when inserting by "Paste" or "Drag and Drop" or pressing "Enter", "Delete", or "Backspace"

Constructor

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

Parameter

NameTypeDefaultDescriptionRemark
optionsobject{}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
--kuc-textarea-input-color
--kuc-textarea-input-font-size
--kuc-textarea-input-height
--kuc-textarea-input-width

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 textarea = new Kuc.TextArea({
label: 'Fruit',
requiredIcon: true,
placeholder: 'Apple',
value: 'Apple',
error: 'Error occurred!',
className: 'options-class',
id: 'options-id',
visible: true,
disabled: false
});
space.appendChild(textarea);

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

textarea.addEventListener('focus', event => {
console.log(event);
});

textarea.addEventListener('input', event => {
console.log(event);
});