> For the complete documentation index, see [llms.txt](https://design.mirakl.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://design.mirakl.com/~/changes/DpgERwSwrKIthStzL4D6/components/actions/tasklist.md).

# Tasklist

Tasklists are designed to display multiple tasks users will have to complete to finalize a complex process (e.g. store or profile creation).

<figure><img src="https://1297765105-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMoZPkWOmnKvoMWGW4aeM%2Fuploads%2Fhme7XuBP3QuU8xTtZ4Z3%2FTasklist%20Hero.png?alt=media&amp;token=9339c8b2-037a-4658-93c7-5585a9f3e7b3" alt=""><figcaption></figcaption></figure>

## Overview <a href="#id-4766dc" id="id-4766dc"></a>

#### Steps <a href="#id-805189" id="id-805189"></a>

Each step is made of:

* a status icon
* a title
* a paragraph
* an illustration (optional)
* 1 or 2 buttons

<table data-header-hidden data-full-width="true"><thead><tr><th width="117"></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Status</strong></td><td><strong>Description</strong></td><td><strong>Example</strong></td></tr><tr><td>To do</td><td><ul><li>Icon is blank</li><li>Collapsed</li></ul><p><br></p></td><td><img src="https://zeroheight.com/uploads/iwAvyoGAMt5YJ5sFdzgOAA.png" alt=""></td></tr><tr><td>Active</td><td><ul><li>Icon is blank</li><li>Expanded</li><li>Can have 2 buttons (one Primary and one Secondary)</li></ul></td><td><img src="https://zeroheight.com/uploads/yBlNzCV6L-ZFPNhXRTyDTA.png" alt=""></td></tr><tr><td>Done</td><td><ul><li>Icon is ticked + green</li><li>Can be expanded or collapsed</li></ul><p><br></p></td><td><p><img src="https://zeroheight.com/uploads/QQwcXB4ukUV9P3jJl55xeA.png" alt=""></p><p><br></p></td></tr></tbody></table>

`Tasklist` has 2 modes:

* Steps have to be completed in the order in which they're listed
* Steps can be completed in any order

## Guidelines <a href="#id-4766dc" id="id-4766dc"></a>

#### Limit the number of tasks <a href="#id-94b5f2" id="id-94b5f2"></a>

The component doesn't have a task limit, but we recommend restricting the number of tasks to a decent number. Think about the user's mental workload.

#### Group actions with similar topics into tasks <a href="#id-28ebbd" id="id-28ebbd"></a>

Group related requests into tasks, like "Configure your shipping settings" or "Import your catalog". This will help users understand what's expected from them and plan ahead.

Task names should start with verbs (check, configure, create, add...).

{% hint style="info" %}
Use the subtitle to describe what the task will involve and why it matters to complete it.
{% endhint %}

#### Marking tasks as completed <a href="#id-26e337" id="id-26e337"></a>

It may happen that our users will need to state that the task is completed. Use "Mark as done" as a secondary button.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://design.mirakl.com/~/changes/DpgERwSwrKIthStzL4D6/components/actions/tasklist.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.