Portal Community

What Are Actions?

Actions transform a passive data-collection form into an interactive workflow participant. Without actions, a form is just fields. With actions, the form can submit data to a workflow, cancel and discard, navigate to a related form, insert preset data rows, and much more.

Actions render in the form's action bar — typically a row of buttons at the bottom of the form. The placement, order, and visibility of each action is fully configurable.

The Eight Built-In Action Types

submit

Triggers form validation and calls the onSubmit callback. The primary completion action for most forms.

cancel

Discards changes after an optional dirty-check confirmation dialog. Returns the user to the previous context.

reset

Resets all fields to their initialValues. Differs from cancel — the user stays on the form.

navigate

Routes the browser to a URL or workflow step without submitting. Used for multi-form flows.

link

Matrix dispatch — opens a child form by looking up a record key. Powers list-to-detail navigation.

addQuickItems

Inserts preset rows into a data-table control with one click. Accelerates repetitive row entry.

deleteSelected

Deletes all checked rows in a data-table control. Pairs with addQuickItems.

custom

Calls a registered custom action handler. Opens Atlas Forms to any business logic.

The actions[] Array

Actions live at the root of the form schema, parallel to controls[] and sections[]:

{
  "version": "1.0.0",
  "metadata": { ... },
  "controls": [ ... ],
  "sections": [ ... ],
  "actions": [
    {
      "type": "submit",
      "label": "Save Changes",
      "variant": "primary",
      "icon": "save"
    },
    {
      "type": "cancel",
      "label": "Discard",
      "variant": "ghost"
    }
  ]
}

Common Action Properties

PropertyTypeRequiredDescription
typestringYesAction type identifier: submit, cancel, reset, navigate, link, addQuickItems, deleteSelected, custom
labelstringYesButton text shown to the user
variantprimary | secondary | ghost | dangerNoVisual style of the button
iconstringNoIcon name (Font Awesome free icon identifier)
disabledbooleanNoStatically disable the button. Use disabledRule for dynamic disabling.
disabledRulestringNoExpression evaluated against current form values. Button disabled when true.
visibilityRulestringNoExpression — action hidden when false.
configobjectVariesAction-type-specific configuration.
ordernumberNoSort order in the action bar. Lower = left-most.

Action Variants

VariantVisualWhen to Use
primarySolid accent colour buttonThe main, positive action (Submit, Save)
secondaryOutlined buttonSecondary actions (Save Draft, Export)
ghostText-only, no borderLow-emphasis actions (Cancel, Back)
dangerRed/destructive stylingDelete, Archive — actions with irreversible effects
Action Order Convention The recommended order is: primary action (rightmost) → secondary actions → cancel/back (leftmost). This matches standard button placement in enterprise UIs and user expectations across Windows and web applications.