TaskCanvasHeader
This component renders the header of task canvas.
Can be themed with Theme.TaskCanvasHeader in Theme.
Component children#
| Key | Component | Condition | Align | Description |
|---|---|---|---|---|
| icon | styled(div) | Visible only when an icon is provided as prop | A wrapper that displays the task icon | |
| header | styled(div) | The main header content. Contains title and activity status | ||
| actions | React component | A wrapper for the possible task actions |
Static Properties#
| Name | Type | Description |
|---|---|---|
| Content | DynamicContentStore<TaskCanvasHeader.TaskCanvasHeaderProps> | Dynamic content store |
| defaultProps | TaskCanvasHeader.TaskCanvasHeaderProps | Default properties |
Component Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| ActionsComponent | React.ComponentType<{task: ITask}> | Represents the actions component. | Yes | |
| icon | string | React.ReactNode | Represents the icon. | Yes | |
| titleTemplateCode | string | Represents title template code. | Yes | |
| titleTemplateContext | any | Represents context for title templete. | Yes | |
| secondLineTemplateCode | string | Represents second line template code. | Yes | |
| secondLineTemplateContext | any | Represents context for second line templete. | Yes | |
| titleTemplate | string | Title template. | No | |
| secondLineTemplate | string | Second line template. | No |
Component Children Properties#
| Name | Type | Description | Optional | Default |
|---|---|---|---|---|
| theme.TaskCanvasHeader | TaskCanvasHeaderThemeProps | Theme | Yes |
Rate this page