Editor¶

Description¶

The Editor allows you to create web content quickly and effortlessly.

Use Case¶

Efficient Web Development
Rapid Prototyping
Content Management System (CMS) Customization
Email Marketing
Static Website Creation

Interactivity¶

Interactivity is the ability of a web page or application to respond to an input.

There are a number of ways to add interactivity to the Editor.

Some of the most common methods include:

Change events: Change events are fired when the value changes. You can use change events to perform a variety of actions, such as:
- Show or hide certain form fields based on the user's selections
- The editor component could be linked to a data source to populate content based on user input
- Collaborative editing

API¶

Events¶

Name	Description
`onChange (element)`	The onChange event occurs when the value of a field is changed

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.getValues`	Gets the current values of all fields	`() : Object`
`this.hide`	Hides the field	`(fields: String`\|`String[])`
`this.show`	Displays the field	`(fields: String`\|`String[])`
`this.disable`	Disable editor field from user interaction	`(fields: String`\|`String[])`
`this.enable`	Enable editor field from user interaction	`(fields: String`\|`String[])`; `(Value: Object){'field-id': 'field-value'}`
`this.getValue`	Get A Value From a component	`(fieldName: 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 the editor component in response to user editor.
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('editor_x1lbj1il', 'abc')

this.removeClassName(fields, className)

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

this.getValue(fieldName)

var editorname = this.getValue('editor_x1lbj1il');
console.log('getValue', editorname);

this.getValues()

var data = this.getValues();
console.log(data);

this.hide(fields)

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

this.show(fields)

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

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

this.setData(Value)

this.setData(
 {"editor_x1lbj1il": "Hello",});

this.getComponent('component_ID')

var editorname = this.getComponent('editor_x1lbj1il');
console.log('getComponent', editorname);

Config¶

Name	Description	Icon
ID	The editor component's unique identifier
Name	[Optional] The display name of the editor field
Width	[Optional] Width of the field
Label Width	Width of the label associated with the editor 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
Text Prompt	A description to aid the user when completing the field
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
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`

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
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.