Skip to main content

Sequential Workflow Designer Events

The Sequential Workflow Designer provides a number of events that can be used to handle various workflow designer actions.

OnReady​

The onReady event is triggered when the designer is ready to be used and fully initialized.

// JS or TS, Angular
designer.onReady.subscribe(() => {
  // ...
});

This event is not available in React package, because the designer is ready to be used when the component is mounted.

OnDefinitionChanged​

The onDefinitionChanged event is triggered when the workflow definition is changed. The event handler receives the new workflow definition.

// JS or TS, Angular
designer.onDefinitionChanged.subscribe((newDefinition) => {
  // ...
});
// React
<SequentialWorkflowDesigner
  onDefinitionChange={(newDefinition) => { /* ... */ }}
  ... />

OnSelectedStepIdChanged​

The onSelectedStepIdChanged event is triggered when the selected step is changed. The event handler receives the new selected step ID or null if no step is selected.

// JS or TS, Angular
designer.onSelectedStepIdChanged.subscribe((stepIdOrNull) => {
  // ...
});
// React
<SequentialWorkflowDesigner
  onSelectedStepIdChanged={(stepIdOrNull) => { /* ... */ }}
  ... />

OnIsToolboxCollapsedChanged​

The onIsToolboxCollapsedChanged event is triggered when the toolbox is collapsed or expanded.

// JS or TS, Angular
designer.onIsToolboxCollapsedChanged.subscribe((isCollapsed) => {
  // ...
});

This event is not available in React package yet.

OnIsEditorCollapsedChanged​

The onIsEditorCollapsedChanged event is triggered when the editor is collapsed or expanded.

// JS or TS, Angular
designer.onIsEditorCollapsedChanged.subscribe((isCollapsed) => {
  // ...
});

This event is not available in React package yet.