Static Forms
Last updated
Last updated
This is the official documentation of the @forestadmin/agent
Node.js agent.
Very often, you will need to ask for user inputs before triggering the logic behind an action.
For example, you might want to specify a reason if you want to block a user account. Or set the amount to charge a user’s credit card.
More information about the ActionField
type can be found on our API Reference ↗.
Fields are configurable using the following properties:
type
required
Boolean
, Date
, Dateonly
, Enum
, Json
, Number
, NumberList
, EnumList
, String
, StringList
, File
, FileList
and Collection
Set the type of the field ↗.
label
required
string
Set the label of the field.
id
optional
string
Set the id of the field. The is used internally and to access values from the context. If not set the label will be used.
description
optional
string
Set the description of the field.
isRequired
optional
boolean
Make the field required (default false).
defaultValue
optional
any
Set the default value of the field.
isReadOnly
optional
boolean
Make the field read-only (default false).
enumValues
required when type
is Enum
array of strings
Change the list of possible values of the field when type is Enum
.
When using the Collection
type, you can create a reference to a record of any collection.
The value of the field will be the primary key of the selected record.
Note that the value will be stored in an array as the target collection may be using a composite primary key. When not using a composite primary key, the array can be assumed to contain a single value.