Actions at a Glance
| Action Type | Builder Label | Use When |
| controlModal | Control Modal | Open or close a Modal block |
| controlDrawer | Control Drawer | Open or close a Drawer block |
| showNotification | Show Snackbar | Display a toast/snackbar notification |
| controlBlockMethod | Trigger Component Method | Call a named method on any block (submit form, scroll into view, etc.) |
controlModal — Control Modal
Opens or closes a Modal block on the current page. This is the standard way to trigger modal dialogs from button clicks, row selections, or other events.
Parameters
Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modalId | string | Required | — | The ID of the Modal block to control. The builder picker lists only Modal blocks on the page. If empty, throws |
operation | "show" | "hide" | Required | — |
|
Note: Passing data to modals: This action only shows or hides — it carries no data payload. To display record data in a modal, write the data to a page variable first, then bind the modal's content to that variable. Fire the open action after setting the variable.
Tip: Repeatable rows: When this action fires from inside a Repeatable row, a static modal ID is auto-resolved to that row's runtime instance — so the row's own modal opens, not the template's.
Examples
Open a confirmation dialog
{ "actionType": "controlModal", "payload": { "modalId": "b_confirmDelete", "operation": "show" } }
Close a modal after form submission
{ "actionType": "controlModal", "payload": { "modalId": "b_editRecord", "operation": "hide" } }
Open modal with record data — two sequential actions
// Step 1: Set the variable with the selected row { "actionType": "setPageVariable", "payload": { "variableId": "var_selectedRecord", "operationDetails": { "operation": "SET", "value": "{{ currentRow }}" } } } // Step 2: Open the modal { "actionType": "controlModal", "payload": { "modalId": "b_editModal", "operation": "show" } }
controlDrawer — Control Drawer
Opens or closes a Drawer block on the current page. Drawers slide in from the edge of the screen and are commonly used for side panels, filter panels, and secondary navigation.
Parameters
Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
drawerId | string | Required | — | The ID of the Drawer block to control. The builder picker lists only Drawer blocks. If empty, throws |
operation | "show" | "hide" | Required | — |
|
Warning: Show and hide are not symmetric. Show opens the drawer. Hide closes the drawer and removes its content, so anything the user entered in it and didn't save is lost. If the drawer isn't open, Hide changes nothing you can see.
Examples
Open a filter panel drawer
{ "actionType": "controlDrawer", "payload": { "drawerId": "b_filtersPanel", "operation": "show" } }
Close the drawer after filters are applied
{ "actionType": "controlDrawer", "payload": { "drawerId": "b_filtersPanel", "operation": "hide" } }
showNotification — Show Snackbar
Displays a toast notification (snackbar) over the current interface. Use it to confirm operations, surface warnings, or show transient error messages without navigating away or opening a modal.
Parameters
| Parameter | Type | Required | Default | Description |
| title | string | Optional | — | Main text of the toast. Labeled Message in the builder. Supports bindings and i18n. Non-string values are JSON-stringified. |
| description | string | Optional | — | Secondary line shown below the title. Supports bindings and i18n. |
| type | "info" | "success" | "warning" | "error" | Optional | "success" | Controls the toast color and icon. info renders as the neutral default style (no dedicated info color). |
| autoHideDuration | number (ms) | Optional | 3000 (5000 for warning) | Time in milliseconds before the toast auto-dismisses. Warning toasts default to 5000 ms; all others default to 3000 ms. |
| position | string enum | Optional | top-right (web) | Where the toast appears. Web options: top-left, top-center, top-right, bottom-left, bottom-center, bottom-right. Mobile options: top-center, bottom-center. |
Note: Toasts stack. Firing the action repeatedly queues multiple toasts. At most 5 are shown simultaneously. There is no deduplication — to prevent duplicate toasts, set an Only run when condition on the action (stored as runCondition).
Examples
Success toast after saving
{ "actionType": "showNotification", "payload": { "type": "success", "title": "Changes saved", "description": "Your record was updated successfully.", "position": "bottom-center", "autoHideDuration": 4000 } }
Error toast with dynamic error message
{ "actionType": "showNotification", "payload": { "type": "error", "title": "Save failed", "description": "{{ ds_saveRecord['error'] }}", "position": "top-right" } }
Warning toast for a validation issue
{ "actionType": "showNotification", "payload": { "type": "warning", "title": "Missing required fields", "description": "Please fill in all required fields before submitting." } }
controlBlockMethod — Trigger Component Method
Calls a named control method on a target block — submit a Form, scroll a block into view, export a block, or call any method a block exposes. This is the generic action that underlies the block-specific shortcuts (controlModal, controlDrawer, etc.).
Parameters
| Parameter | Type | Required | Default | Description |
| blockId | string | Required | — | The ID of the block whose method to call. The builder shows a picker of all blocks on the page. Bindings in this field are resolved before the block is looked up. |
| methodName | string | Required | — | The ID of the method to call. Available methods come from the selected block's registered control methods. Each block type exposes its own set. |
| methodPayload | object | Optional | — | Parameters passed directly to the method. Free-form — each method reads its own keys. For example, scrollIntoView reads alignment and smooth. |
Finding a block's methods: In the action form, choose the block in Component. The Method dropdown then lists the methods that block exposes, for example Submit on a Form. Methods differ by block type and can depend on the block's settings. To submit a form, you can also use the Submit Form action, which is this action with the form's submit method already chosen.
Common Methods Available on Every Block (Web)
| Method Name | Label | What It Does | Payload Keys |
| exportBlock | Export Block | Downloads a PNG image of the block (web apps only) | — |
| scrollIntoView | Scroll Into View | Scrolls the block into the viewport | alignment (default: "nearest"), smooth (default: true) |
| copyBlock | Copy Block | Copies the block to the clipboard | — |
For the Export Block setup, see Export & File Actions.
Examples
Submit a form from a toolbar button
{ "actionType": "controlBlockMethod", "payload": { "blockId": "b_createForm", "methodName": "submitForm" } }
Scroll a results section into view smoothly
{ "actionType": "controlBlockMethod", "payload": { "blockId": "b_resultsSection", "methodName": "scrollIntoView", "methodPayload": { "alignment": "start", "smooth": true } } }
Call from a binding expression (script or function)
// Equivalent call from a Run Script action or page function: {{ b_createForm.submitForm() }} {{ b_resultsSection.scrollIntoView({ alignment: 'center', smooth: true }) }}