> 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/design/components/navigation/sidebar.md).

# Sidebar

Sidebar menu is the primary navigation. It provides access to the main sections of the platform.

<figure><img src="https://1297765105-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMoZPkWOmnKvoMWGW4aeM%2Fuploads%2F6lja1tuCgdGTihFNq2ud%2FSidebar%20Hero.png?alt=media&amp;token=e0315934-da0f-48c6-96ba-253b3271fc20" alt=""><figcaption></figcaption></figure>

Navigation sidebar appears to the left side of all our products. It showcases all Mirakl key features and enables users to easily switch between activities.

{% hint style="info" %}
Automatically handled by ROMA
{% endhint %}

## Overview <a href="#id-430dd3" id="id-430dd3"></a>

* `Sidebar` is collapsible to make sure users can focus on their tasks. When `Sidebar` is collapsed, users can hover the icon and an action menu appears.
* `Sidebar` items *may* display a counter, like **Messages**.
* `Sidebar` header may have a Store switcher feature that triggers an action menu.

<figure><img src="https://1297765105-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMoZPkWOmnKvoMWGW4aeM%2Fuploads%2FI1rwgs9f3J6HcCFZ2Pz0%2FSidebar%20-%20Overview.png?alt=media&amp;token=257e14ba-d148-4b50-beb3-eef466939211" alt=""><figcaption><p>Sidebar and topbar</p></figcaption></figure>

{% hint style="info" %}
`Sidebar` always goes with [`Topbar`](/design/components/navigation/top-bar.md). While Sidebar allows users to navigate through various activities, `Topbar` is dedicated its profile and personal activities.
{% endhint %}

Sidebar menu supports two levels of navigation :&#x20;

* Section (level 1) is the main level, used as a heading of nested pages.
* Sub-level (level 2) is the secondary level with direct redirection to targeted pages.

Sections are displayed in white (theme.color.white) with an icon. \
With a chevron, it means sub-level are attached to the section. Thus, on click to Section title, it opens Sub-level menu. \
Without a chevron, it means no sub-level are attached to the section. Thus, on click, users are redirected to the section page.

Sub-level are displayed in blue (theme.color.primary\[900]) with no icons. \
Sub-level must always be attached to a Section. **At least two Sub-levels are needed to created a nested section.**

<figure><img src="https://1297765105-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMoZPkWOmnKvoMWGW4aeM%2Fuploads%2FVFNWMehRi4hOeUoezbh5%2Fsidebar.png?alt=media&amp;token=e4112441-10c8-4754-9543-349a8cab1468" alt="" width="180"><figcaption><p>Illustration of Sections and Sub-level </p></figcaption></figure>

## Content <a href="#id-954f45" id="id-954f45"></a>

Naming Section and Sub-section is strategic in user experience. Users must be able to scan an dunderstand very quickly menu. Keep the navigation link text short. They can be shorter versions of pages titles. Try to use a specific task/mission without necessarily using an action verb.

## Accessibility

Navigational mechanisms must be repeated within a set of Web pages. (WCAG 3.2.3, level AA) Order, naming and behavior must be repeated through all sections. Thus, it is important to respect naming convention. Naming a section or a sub-section must be a joint effort of Product, Design, Content and Marketing teams.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://design.mirakl.com/design/components/navigation/sidebar.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
