Interface: FormField

Represents a single form field.

Properties

caption

• caption: string

The field caption

Defined in

src/sdk/configuration/form-field.ts:8

---

isSecret

• Optional isSecret: boolean

Set this to true if this field contains sensitive information. If this is set to true, the current field value is not getting transferred to the frontend.

Defined in

src/sdk/configuration/form-field.ts:24

---

required

• required: boolean

Mark this field as required.

Defined in

src/sdk/configuration/form-field.ts:18

---

type

• type: "url" | "email" | "text" | "password" | "checkbox" | "hidden"

The field type

Defined in

src/sdk/configuration/form-field.ts:13

---

validator

• Optional validator: (value: any) => string

Type declaration

▸ (value): string

A validator function for this field.

Parameters

Name	Type	Description
value	any	The current field value.

Returns

string

An error message or null if the value is valid.

Defined in

src/sdk/configuration/form-field.ts:31