ontario-task-list

Use a task list to show the user activities they have completed and what they have left to do.

Usage guidance

Please refer to the Ontario Design System for current documentation guidance for task list.

Prerequisites

Before using the ontario-task-list component, ensure the following:

1. The Ontario Design System Component Library is installed in your project. Refer to the installation instructions for guidance.
2. The component library is properly configured in your project (e.g., included in your build process if using a framework like React or Angular).

Examples

Example of a task-list component with tasks inside.

<ontario-task-list language="en">
	<ontario-task
		label="Task 1"
		task-id="Task-1-unique-id"
		hint-text="A hint for task 1"
		task-status="completed"
		link="https://example.com"
	></ontario-task>
	<ontario-task
		label="Task 2"
		task-id="Task-2-unique-id"
		hint-text="A hint for task 2"
		task-status="inProgress"
		link="https://example.com"
		deactivate-link="true"
	>
</ontario-task-list>

Technical Note: SSR (Server-Side Rendering) Considerations

The Ontario Task List component is SSR-compatible but includes some client-only behavior.

• To avoid hydration mismatch, always pass a valid headingLevel prop. Acceptable values: "h1", "h2", "h3", "h4". An invalid value will be replaced with "h2" on the client.
• Task counts are calculated after hydration and are not rendered during SSR. If you require stable output for task totals in SSR, consider rendering them statically with props.

SSR-safe example:

<ontario-task-list label="Your tasks" heading-level="h2">
	<ontario-task data-task-status="Completed" />
	<ontario-task data-task-status="Incomplete" />
</ontario-task-list>

Properties

Property	Attribute	Description	Type	Default
headingLevel	heading-level	Allows consumers to define the heading level for the task list component. Accepts 'h1', 'h2', 'h3' or 'h4'. Default is 'h2'.	"h1" | "h2" | "h3" | "h4" | "h5"	'h2'
label	label	The label prop used for the task list heading.	string	undefined
language	language	The language of the component. This is used for translations, and is by default set through event listeners checking for a language property from the header. If none are passed, it will default to English.	"en" | "fr" | undefined	'en'

---

Built with StencilJS