# WorkflowProps

Source: /tuil/docs/reference/components/workflow/workflow-props
Locale: en

WorkflowProps component contract.



{/* Generated by tooling/docs/generate-reference.ts. */}

## Type [#type]

```ts
export interface WorkflowProps<TState>
  extends SlottedComponentProps<WorkflowSlots> {
  readonly id?: string;
  readonly workflow: WorkflowRunner<TState>;
  readonly autoStart?: boolean;
  readonly children?: ReactNode;
}
```

## Members [#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`](/tuil/docs/reference/packages/tuil/api/workflow-runner)                                                            |
| `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<&#123; root: import("ink").BoxProps; content: import("ink").BoxProps; &#125;>> \| undefined`    | No       | The `slots` member uses the `Partial<SlotComponents<&#123; root: import("ink").BoxProps; content: import("ink").BoxProps; &#125;>> \| undefined` contract.        | [`BoxProps`](/tuil/docs/reference/packages/ink/api/box-props), [`SlotComponents`](/tuil/docs/reference/packages/theme/api/slot-components) |
| `slotProps` | `Partial<SlotProps<&#123; root: import("ink").BoxProps; content: import("ink").BoxProps; &#125;, object>> \| undefined` | No       | The `slotProps` member uses the `Partial<SlotProps<&#123; root: import("ink").BoxProps; content: import("ink").BoxProps; &#125;, object>> \| undefined` contract. | [`BoxProps`](/tuil/docs/reference/packages/ink/api/box-props), [`SlotProps`](/tuil/docs/reference/packages/theme/api/slot-props)           |
| `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.                                                                                          | —                                                                                                                                |

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/registry/workflows/workflow.tsx)