gui.actions reference

Action shortcuts produce buttons and triggers — they have no path because they don’t read or write form data. Every action just takes a typed props object.

Signature

gui.actions.<shortcut>(props: ActionDecorator, tags?: string[]): GuiActionsShortcut;

A fully-populated example:

gui.actions.button(
  {
    // props — the typed ActionDecorator
    label: 'Save changes',
    icon: 'save',
    iconPosition: 'right',
    disabled: false,
    uid: 'save-btn',
    actionType: 'submit', // renders as <button type="submit">, validates the form on click
    // — or —
    onClick: () => 'saveChanges', // function returning the event name routed through formEvent
    states: {
      // per-state overrides — see /form-definition/states/
      submitting: { label: 'Saving…', disabled: true },
    },
  },
  ['primary'], // tags — addressable groups for selectors
);

actionType: 'submit' makes the button render as <button type="submit">, triggers form-level validation on click, and emits the result through formSubmit (not formEvent). See Events for the full table.

onClick accepts a function that receives the current form data and returns either a string event name (routed through formEvent) or void (for side-effecty callbacks). String literals are not accepted — always use a function.

Shortcuts

Shortcut	Renders	Reference
gui.actions.button	a button (typed ActionDecorator props)	Button
gui.actions.custom	your custom action	Custom Widgets

See also

• Events — wiring onClick, actionType: 'submit', and formSubmit.