onAction()
This event handler runs when any form action is triggered.
onAction is a <Feathery.Form> prop and callback function to access and modify form state when actions attached to an element like a button or container are triggered, usually via a click. When multiple actions are associated with a an element, this function will run once per action, after validation logic but before the action itself. 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 Context object that provides form-related state and handlers.import { init, Form } from '@feathery/react';
function App() {
// Initialize Feathery
init('SDKKey', '[email protected]');
// Show the `onboarding` Feathery form
return <Form
formName='onboarding'
// Route to a specific step
onAction={(context) => {
context.goToStep("Custom Step");
}}
/>
}
Key | Type | Description |
|---|---|---|
| Consistently available form state and functions | |
trigger | The info of the custom action trigger. | |
action | string enum | The type of the action that's about to be run. Such as next for the Go To Step action and back for the Go to Previous Step action. |
Key | Type | Description |
|---|---|---|
id | 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.
Last modified 1mo ago