FormStack, Form, Field
The three classes you use inside AApplication.getFormStack() to declare the settings forms the Admin UI renders.
import FormStack from '@orchesty/nodejs-sdk/dist/lib/Application/Model/Form/FormStack';
import Form from '@orchesty/nodejs-sdk/dist/lib/Application/Model/Form/Form';
import Field from '@orchesty/nodejs-sdk/dist/lib/Application/Model/Form/Field';
FormStack #
Top-level container. One per Application.
| Method | Purpose |
|---|---|
addForm(form) | Append a Form. |
getForms() | All forms in this stack. |
Form #
A single tab in the Admin UI.
new Form(key: string, publicName: string)
| Method | Purpose |
|---|---|
addField(field) | Append a field. |
getKey() / getPublicName() | Identifiers. |
getFields() | All fields on this form. |
Use CoreFormsEnum.AUTHORIZATION_FORM as the key for the credentials form so the Admin UI shows it in the right place.
Field #
A single input.
new Field(
type: FieldType,
key: string,
label: string,
value?: unknown,
required?: boolean,
)
| Method | Purpose |
|---|---|
setDescription(text) | Help text shown next to the field. |
setReadOnly(true) | Render read-only. |
addChoice(value, label) | For SELECT / RADIO fields. |
See also #
- FieldType
- CoreFormsEnum
- PHP equivalent:
Form