Static Forms
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.
Field Configuration
More information about the ActionField
type can be found on our API Reference ↗.
Properties
Fields are configurable using the following properties:
Property | Usage | Expected value | Description |
---|---|---|---|
| required |
| Set the type of the field ↗. |
| required | string | Set the label of the field. |
| optional | string | Set the description of the field. |
| optional | boolean | Make the field required (default false). |
| optional | any | Set the default value of the field. |
| optional | boolean | Make the field read-only (default false). |
| required when | array of strings | Change the list of possible values of the field when type is |
| optional | Set the widget to use for the field. More info on the dedicated page. |
References to records
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.
Last updated