The Task List Builder allows content authors to create structured checklists that end users can modify and print as PDFs. The component has a flexible design that can be used for a variety of situations, including:
- organising tasks and subtasks required to work towards a common goal
- documenting steps of a process
- listing items and organising them into different categories.
Whether it's for planning career milestones or gathering essential documents, the Task List Builder offers a user-friendly interface that ensures each item is clearly grouped and easy to understand.
On this page
- Adding to a landing page
- Configuring the Task List Builder
- Creating tasks
- Disclaimer
- Saving the component to the page
- Deleting Tasks and Subtasks
- See this live on nsw.gov.au
Adding to a landing page
To add the Task List Builder on a landing page, find it listed under DCS in the Add Block screen, or use the block name filter by entering 'Task List Builder Block'.
Configuring the Task List Builder
Block description
Title: Optionally provide a title for the block for administrative purposes. This will only display when you are using layout mode; it is not visible on the published website.
Goal
This field, displayed at the top of the task list, allows users to enter their specific goal.
- Label Heading – this will be a bold heading that will appear at the top of the component.
- Helper text – this will display between the heading and the goal field. Use it to describe what content should be entered into the field.
- Goal – this displays within the goal field. Use it to provide an example of what should be entered in this field.
For checklists, where a goal isn’t required, tick ‘Hide heading’ to remove the goal field from the page.
Task settings
This section lets you customise labels and helper text for tasks and subtasks. This is useful when different labels are needed, such as a checklist for documents.
- Task - Label Heading – control what the sections of the task list will be called.
- Task - helper text – insert text to guide the user on what type of section or category of items they should be creating.
- Add task prompt – this controls the CTA that appears on the button beneath the existing ‘tasks’ (or whatever you define them as) on the page. The button allows you to add a new task/section.
- Add subtask prompt – this controls the label on the link to add a subtask, which is visible in edit mode.
- Subtask - Label Heading – controls how the subtasks will be referred to in the tool, for example in a document checklist, each subtask could be a document.
- Subtask - Helper text – provide helper text to guide the user on what type of item or task they should create.
In the backend
How it appears in the front end
Creating tasks
Once you are happy with the configuration of your task list you can start creating tasks. These are the tasks that will appear on the published page.
Think of the tasks you add in the CMS as prompts. Visitors can edit, delete or add their own tasks before they print or save the page.
To create a task
In the CMS, categories are always 'tasks' and items within them are 'subtasks', regardless of your custom labels. Your labels are visible only in draft, preview, or published mode.
1) Press the ‘Add task’ button.
2) Name your task
You can add another task beneath this task by pressing ‘Add Task’ again.
Currently you can’t reorder tasks in the Task List Builder; you'll need to delete the tasks and start again.
Adding subtasks
Now you can add subtasks, or whatever label you are using, by pressing the Add subtask button.
- You can add another subtask by pressing the ‘Add subtask’ button again.
- Repeat until all the subtasks you require under that task/category have been added.
Disclaimer
As this tool allows users to change content that appears on the NSW Government webpage, a disclaimer is required. A default statement is included, but this can be edited by the page author.
On the published page the disclaimer appears below the ‘Save or print checklist’ button.
Saving the component to the page
Once you have completed all the fields press the ‘Update’ button.
Deleting Tasks and Subtasks
Tasks
Press the ‘Remove Task’ button (next to the ‘Add subtask’ button) to delete a task.
Subtasks
Press the ‘Remove subtask’ button (beneath the Subtask field) to delete a subtask.
See this live on nsw.gov.au
Check out Task List Builder to see how this works on a live page. You can also see how agencies have used this on their pages below:
Need any more help?
If you have any questions, or require assistance with anything mentioned in this article, submit a request via the webform.