Actions
Action Types
Regular Actions
showModal** ** - Renders a modal dialog
hideModal** ** - Hides a modal that is non-blocking
showAlert** ** - Renders a toaster style alert
path** -** redirects the user to a new page ****
debounce - Delay running actions until a period of inactivity happens
throttle** -** Limit how frequent actions can run
runUtilityHook** ** - runs the
onUtility
hook passing it paramsrunOnCompleteHook** ** - runs the
onComplete
hookclipboard** ** - runs
clipboard
action allowing interaction with the clipboardcookie** ** - Allows setting of browser side cookies
wait - Waits for specified time or event
emit - Vue event bus message emit
scrollTo - Scrolls to an element
namedAction - Runs a named action. Also requires the
name
key.function - Runs JavaScript
Authentication Actions
These special actions allow you to create custom login and registration pages. See this page for more:
Usage
Actions can be injected in many places:
Most hook scripts
Navigation Menu Items
Page elements (buttons)
Named Actions
*_actions
schema keys (where supported)
Wherever you see an actions
key in BetterForms, it can be either an object (for running a single action), or an array of objects (to run a series of actions).
$$BF_Actions - Actions Array
The $$BF_Actions
JSON array is surfaced in all of the developer hooks that are applicable to executing actions.
To add an action simply add the action object as an array element. There are FileMaker custom functions that make this easy.
Actions are executed sequentially starting at the beginning of the array.
Other places you can use actions
actionsBeforeComplete can be added to the schema.form
object and BetterForms will run the actions array if present.
The Action Object
Actions Options
Functions
All actions object can also have a function
key. If defined, the JS code within this key will be executed. The result is not used, so it is expected that your code will mutate the environment.
The main difference between the function action and using actions with an added function
key is that there is no additional action associated with it.
For additional information see the Function Action
Calling Named Actions
Triggering Actions on Field Changes
All field element types support an onChanged_actions
key. This key can contain actions that will be run when the elements data model changes.
Clearing Actions
Actions can be cleared programmatically in a function
action or function
key by calling the following internal BF command: `
The following JS code will stop any subsequent actions from running if the isRegistered
flag is false.
Last updated