Text

A plain text value

Specification

tags

  • Type: String

  • Specifies how to treat HTML tags.

Allowed values:

Value
Specification

strip

Removes HTML tags.

stripall

Removes all HTML tags (including unclosed).

escape

Converts < , > and & to HTML entities.

validate

  • Type: Object

  • Specifies parameter validation.

Available parameters:

Parameter
Type
Specification

max

number

Specifies the maximum length.

min

nNumber

Specifies the minimum length.

pattern

string

Specifies a RegExp pattern that a text parameter should conform to.

In most cases, the pattern has to be wrapped in ^ and $ e.g. ^[a-z]+$ in order to validate the whole input, not just a part.

nested

Available types:

Type
Specification

array

Provides an array of nested parameters that are shown when the value of the parameter is set (value is not empty).

string

Provides the URL address of an RPC to load a list of nested parameters.

object

Provides a detailed specification of nested parameters.

{
    "name": "myText",
    "type": "text",
    "label": "My Text",
    "nested": "rpc://getNestedFields"
}

Examples

Basic text field

A basic text input.

Strip HTML tags

Enable HTML tags stripping or escaping using the tags option.

Validate length

Control the length of the inserted string value by setting validate.max and validate.min .

Validate pattern

Use a regular expression to validate the text input.

Search button

Add an RPC button (also called as a search button) to perform an RPC call inside the field. Usually used to find an ID of a specific item.

Last updated