Text Area¶

Description¶

The Text-Area element allows users to write freely across multiple lines, ideal for capturing extensive information or detailed responses.

Use Case¶

Capture intensive feedback information
Open-ended survey questions
Customer support requests
Comment section
Personalized descriptions
Bug reporting

Interactivity¶

Text areas can be linked with APIs or functionalities within your form, like spell-checking, word count indicators, or even live collaboration features.
Enable real-time co-editing of text within the "text-area," empowering teamwork and streamlining brainstorming sessions.
Integrate spell-checking and grammar suggestions.
Word count and character limit indicators.
Conditional content based on keywords.
Social media integration.

API¶

Events¶

Name	Description
`onChange (element)`	The onChange event occurs when the value of a field is changed
`onFocus (element)`	The onfocus event occurs when a field gets focus
`onBlur (element)`	The onblur event occurs when a field loses focus

Methods¶

Name	Description	Parameters
`this.addClassName`	Add style class to a form item	`(fields: String`\|`String[], className: String)`
`this.removeClassName`	Remove style class from a form item	`(fields: String`\|`String[], className: String)`
`this.getComponent`	Returns a component whose id has been passed as a parameter	`(component_ID: String) : Object`
`this.hide`	Hides the field	`(fields: String`\|`String[])`
`this.show`	Displays the field	`(fields: String`\|`String[])`
`this.disable`	Disable text-area field from user interaction	`(fields: String`\|`String[])`
`this.enable`	Enable text-area field from user interaction	`(fields: String`\|`String[])`
`this.setData`	Set the data in the field. The Value object should be of type { componentId: componentValue }	`(Value: Object)`

Info

The show() and hide() methods can also be used to control the visibility of a text-area in response to user input.
Fields refers to a component ID or a list of component IDs. You can fetch the ID from the Component Attribute panel in the Page Builder.
Before using this.show(fields), make sure the component is hidden. This can be done using this.hide(fields) or by enabling the Hidden checkbox in the Component Attribute panel.
Before using this.enable(fields), make sure the component is disabled. This can be done using this.disable(fields) or by enabling the Disabled checkbox in the Component Attribute panel.

Steps to use the methods for the Page Builder components¶

Go to Form Attribute Action Panel Setting (Mounted | refresh | click 'Add action').
Write the method/code as shown in the Example below.
Click on Save.
On the main screen click on Save again.
Click on Preview to see the code in action.

Example

this.addClassName(fields, className)
- Go to Form Attribute Style Sheets add the class
```
.abc{ // abc is the class name
background-color: red;
}
```
- Follow the steps mentioned above, under Steps to use the methods for the Page Builder components
- this.addClassName('textarea_hl6emwsb', 'abc')

this.removeClassName(fields, className)

this.removeClassName('textarea_hl6emwsb', 'abc')

this.hide(fields)

var fields= ['textarea_hl6emwsb']
this.hide(fields)

this.show(fields)

var fields= ['textarea_hl6emwsbi']
this.show(fields)

this.disable(['fields'])
```
this.disable(['textarea_hl6emwsb'])
```
this.enable(['fields'])
```
this.enable(['textarea_hl6emwsb'])
```

this.setData(Value)

this.setData(
 {"textarea_hl6emwsb": "Hi...I am Joe",});

this.getComponent('component_ID')

var textareaname = this.getComponent('textarea_hl6emwsb');
console.log('getComponent', textareaname);

Config¶

Name	Description	Icon
ID	The text-area component's unique identifier
Name	[Optional] The display name of the text-area
Width	[Optional] Width of the field
Label Width	Width of the label associated with an input field. It determines the horizontal space occupied by the label text
Label Wrap	If the label is longer than the allowed width the text will continue on another line
Hide Label	Hides the label on the form
Placeholder	The short hint is displayed in the input field before the user enters a value
Text Prompt	A description to aid the user when completing the field
Max Length	Limit the amount of characters the field supports
Rows	Add more rows for additional information
Autosize	Enable autosize to automatically adjust the element's height to fit the content it holds
Default Value	The default value which is filled in the field before the user changes it
Custom Class	An HTML class attribute which allows further customisation See Form Attribute > Style Sheets
Attribute Action	Enable Data Binding to connect the data to UI. Enable Hidden action to hide the field. Enable Disabled action to make the field unusable. Enable Show Clear button action to make the clear button visible. Enable Show word count action make the word count visible
Action Settings	Click on the drop-down to select the pre-defined methods you wish to apply to your component. In this case, you can choose either mounted or refresh for `onChange`, `onFocus`, or `onBlur`

Validation¶

Form validation is the process of checking the data entered into a form to ensure that it's valid and complete.

This helps to prevent users from submitting forms with invalid data, which can cause problems for the application that's processing the form.

Form validation can be performed using a variety of methods, including:

Name	Description
Required	If enabled, then the field value can't be empty, otherwise an error message is emitted
Regular expressions	Used to match patterns in text. They can be used to validate the format of data, such as email addresses, phone numbers, and dates
Custom Validation Rules	(rule, value, callback) => {
	rule: Verification rule, you can view the verification configuration information through this parameter; rule.field can get the field identifier of the current verification
	value: Value of the current field
	callback: Callback function (must be called) upon completion of validation; callback('Error message')/ callback(new Error('Error message')). These are two ways to return an error message

Info

Regular expressions should be wrapped with //, as in:/^1[3456789]\d{9}$/"
The callback() function is also called to verify success in the custom validation method.

First time User?¶

If you are using the Page Builder components on the ConnexCS platform for the first time, we request you to use our guide on steps to use the Components.