Skip to main content

Button

Execute workflows or navigate between pages with a clickable interaction.

Properties

PropertyTypeDescription
Name (name)stringUnique identifier for the button component
Label (label)stringText displayed on the button
Action Target (handler)ActionHandlerDefines the action when button is clicked
Confirm Modal (confirmModal)booleanWhether to show confirmation modal on click
Disable Component (isDisabled)booleanWhether button is disabled
Hide Component (isHidden)booleanWhether button is hidden in deployed page
Width (display)DisplayHow the button component occupies width
Color (color)ButtonColorButton color style
Variant (variant)ButtonVariantButton variant style

Name (name)

Unique identifier for the button component. Please refer to the component naming rules

Label (label)

Sets the text displayed on the button. (Supports Template Text)

Action Target (handler)

Configures the button's click behavior.

  1. Page Navigation
  • Navigates to selected page
  • Supports variable parameter passing
  1. Workflow Execution
  • Runs specified workflow
  • Supports variable parameter passing
  1. Modal Control
  • Opens or closes specified modal
  • Toggles modal visibility state

Confirm Modal (confirmModal)

Adds confirmation dialog before action execution.
Recommended for destructive or important actions.

When enabled, clicking the button will show a confirmation modal like below.
Consider adding this option for actions that require careful consideration, such as deletion.

Disable Component (isDisabled)

Sets the disabled state of the component.
Can be set through workflow results, direct input.
When enabled, prevents user interaction with the component.

Hide Component (isHidden)

Controls visibility of the component.
When set to true:

  • Hidden in deployed view
  • Visible with reduced opacity in edit mode

Width (display)

Sets how the component occupies width.
Selecting "Block" enables full-width usage.
Selecting "Auto" adjusts width to fit the label content.

Color (color)

Sets the button's color scheme.
Options:

  • neutral: Default color
  • primary: Primary brand color
  • danger: Warning/destructive actions
  • success: Positive actions

Variant (variant)

Sets the button's visual style.
Options:

  • outlined: Border only
  • filled: Solid background
  • soft: Subdued background
  • plain: Text only

States

PropertyTypeDescription
labelstringCurrent text displayed on button

Type Definitions

interface ControlComponentAction {
// Component action type
type: 'controlComponent';
// Component name
name: string;
// Operation type
operation: string;
}

interface NavigateToPageEventAction {
// Page action type
type: 'page';
// Page ID
pageId: string;
// Page variables
variables: Record<string, string>;
}

interface ExecuteWorkflowEventAction {
// Workflow action type
type: 'workflow';
// Workflow ID
workflowId: string;
// Workflow variables
variables: Record<string, string>;
}

type ExecutableEventAction = ExecuteWorkflowEventAction;

type EventAction = ControlComponentAction | NavigateToPageEventAction | ExecutableEventAction;

interface ActionHandler {
// Action type
action?: EventAction;
// Show confirmation modal
confirmModal?: boolean;
}

type ButtonColor = 'neutral' | 'primary';

type ButtonVariant = 'outlined' | 'filled' | 'soft' | 'plain';

type Display = 'inline-block' | 'block';