@directus-labs/flow-trigger-bundle
v1.0.0
Published
Configure one or more flows to be triggered in the editor or dashboards.
Downloads
418
Readme
Flow Trigger Bundle
The Flow Trigger Bundle enhances manual flow triggers within the Directus Data Studio by providing configurable panels and interfaces for triggering flows directly. This bundle includes a Flows Panel and a Flows Interface, each designed to streamline the execution of manual flows within the Directus environment.
Installation
Refer to the Official Guide for details on installing the extension from the Marketplace or manually.
Usage
Flows Panel
The Flows Panel allows users to configure and run manual flows directly from the panel. Users can select multiple flows with manual triggers, assign custom button labels, and input item IDs. These item IDs can be hardcoded or dynamically sourced from a relational global variable panel within the same dashboard.
The panel automatically filters flows, displaying only those triggered by collections where the user has read permissions. The Flow's internal permissions are respected during execution. Additionally, the panel supports native flow confirmation dialogs and allows manual sorting of flow trigger buttons.
Flows Interface
The Flows Interface enables users to configure and trigger manual flows directly from within a collection interface. Similar to the Flows Panel, users can select and sort multiple manual flows to be triggered from the interface. The configured flows will appear as a button group in the Directus editor.
The interface also supports native flow confirmation dialogs, ensuring that users can safely execute their flows.
Configuration
Flows Panel
- Add the Flows Panel to your dashboard.
- Configure one or more manual flows you wish to trigger.
- Assign custom labels to the buttons.
- Input a hardcoded item IDs or use a dynamic values from a relational global variable panel.
- Arrange the flow trigger buttons in the desired order.
- Save and use the panel to trigger flows based on your configuration.
Flows Interface
- Add the Flows Interface to your collection editor.
- Select one or more manual flows to trigger within this interface.
- Arrange the flow trigger buttons in the desired order.
- Save and trigger the flows directly from the interface.