ReferenceComponentsWorkflow UI
WorkflowProps
WorkflowProps component contract.
Type
export interface WorkflowProps<TState>
extends SlottedComponentProps<WorkflowSlots> {
readonly id?: string;
readonly workflow: WorkflowRunner<TState>;
readonly autoStart?: boolean;
readonly children?: ReactNode;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | undefined | No | The id member uses the string | undefined contract. | — |
workflow | WorkflowRunner<TState> | Yes | The workflow member uses the WorkflowRunner<TState> contract. | WorkflowRunner |
autoStart | boolean | undefined | No | The autoStart member uses the boolean | undefined contract. | — |
children | ReactNode | No | The children member uses the ReactNode contract. | — |
slots | Partial<SlotComponents<{ root: import("ink").BoxProps; content: import("ink").BoxProps; }>> | undefined | No | The slots member uses the Partial<SlotComponents<{ root: import("ink").BoxProps; content: import("ink").BoxProps; }>> | undefined contract. | BoxProps, SlotComponents |
slotProps | Partial<SlotProps<{ root: import("ink").BoxProps; content: import("ink").BoxProps; }, object>> | undefined | No | The slotProps member uses the Partial<SlotProps<{ root: import("ink").BoxProps; content: import("ink").BoxProps; }, object>> | undefined contract. | BoxProps, SlotProps |
unstyled | boolean | undefined | No | The unstyled member uses the boolean | undefined contract. | — |
variant | string | undefined | No | The variant member uses the string | undefined contract. | — |
size | "sm" | "md" | "lg" | undefined | No | The size member uses the "sm" | "md" | "lg" | undefined contract. | — |