onAction()
This event handler runs when any form action is triggered.
Last updated
Was this helpful?
This event handler runs when any form action is triggered.
Last updated
Was this helpful?
onAction
is a prop and callback function to access and modify form state when attached to an element like a or are triggered, usually via a click. This handler will run twice, once before the element actions are run and once after the element actions are run.
Default form validation logic, if toggled, will run before either case. If an error is detected, onAction
will not run until the field error is fixed and the element is clicked again. This function can be asynchronous.
You can use onAction
to short-circuit actions, render a custom component, set field values, and more. The function takes a single object that provides form-related state and handlers.
Consistently available form state and functions
trigger
The info of the custom action trigger.
actions
string[]
beforeClickActions
boolean
If onAction
is running before the element click actions have been run, or after.
triggerData
Definitionid
string
The ID of the element that triggered the custom action
text
string
The text displayed on the element that triggered the custom action.
type
string enum
The type of element that triggered the custom action. Can be button
, text
, or field
.
repeatIndex
integer
If the element that triggered the action repeats, this specifies which repetition it is. This value is 0-indexed and equals 0 if the element doesn't repeat.
A promise can be optionally returned from this function if it's asynchronous and you want execution to await.
The being run