> For the complete documentation index, see [llms.txt](https://docs.appfarm.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appfarm.io/library/ui-components/menu-list.md).

# Menu list

The UI component **Menu List** allows you to easily set up a vertical 1-level menu. You may add List Items (e.g. "My Orders"), Subheaders and Dividers to this List. List Items are clickable, and may perform navigational actions `on click`.

{% hint style="info" %}
Showroom: [Menu List example](https://showroom.appfarm.app/ui-components/menu-list), with its setup in Appfarm Create ([register](https://showroom.appfarm.app/sign-up) for access).
{% endhint %}

## Settings

Here are some of the properties in Appfarm Create which are custom for a **Menu List:**

### **List Items**

These are the entries in the Menu List. 3 different **types** exist:

* List Item: A clickable item with a title, such as "My Orders".
* Subheader: A static text, serving as a title or grouping of subsequent list items. Set the text in **Title**.
* Divider: A horizontal line, serving as a divider between logical distinct sections of the menu.

### Visual type

Only applicable for List Items. Here you can choose what will your list items be sorted by visually. The options are:

* **Icon:** *A static icon* - will be used as the fallback if *Icon Value* is defined but does not provide a value; *Icon Value - a* dynamic icon defined by an *ENUM* value. Will fallback to *Icon* (if defined), if the *ENUM* value does not provide an icon. You can also set an **Icon color**, and select **Badge** to show a badge on the icon, with a **Badge value** and a **Badge color** (default Secondary).
* **Avatar:** An avatar at the beginning of each list item/row. It enables data binding to an Image property, as well as setting up an Avatar Background Color.

### Primary text

Only applicable for List Items. This is the title of the menu item.

### Secondary text

Only applicable for List Items. This is an optional subtitle displayed below the Primary text. Usually a category or a description, with less importance and not in focus.

When Secondary text is set, select **Allow three lines** to let the Secondary text wrap onto a new line.

### Action type

Only applicable for List Items. If we want an implemented functionality of one of the already existing components. The options are:

* **Action Button:** A button selecting and highlighting the list item when clicked;
* **Checkbox:** A built-in *Checkbox* UI component;
* **Switch:** A built-in *Switch* UI componen&#x74;*;*
* **Toggle Button:** An Icon Button that toggles a Boolean value.

For **Action Button**, select the icon in **Action icon**. For **Checkbox**, **Switch** and **Toggle Button**, bind **Toggle value** to a Boolean property. **Toggle Button** also has **Toggled on icon** and **Toggled off icon**.

### Highlighted

Only applicable for List Items. The item will be highlighted (the menu item will be visually marked as active/selected) when the condition defined is `true`.

### **Dense**

Only applicable for List Items, or for the whole Menu List. Compact vertical padding will be used for the list item. You may also apply this setting to the whole Menu List.

### Inset text

Only applicable for List Items. The text will be indented.

### **Enable Divider**

Render a divider line between list items. Available for the whole Menu List and for each List Item.

### Inset divider

Shown when **Divider** is selected, for the whole Menu List or for a List Item. The divider line will be shortened and displayed in the length of the list item text.

### Visible and Disabled

Only applicable for List Items. **Visible** controls whether the item is shown, and **Disabled** makes the item unclickable.

### **On Click**

Select an action to run when the List Item is clicked. For example, an action that navigates to a specific view.

### On action click

Only available when **Action type** is **Action Button**. Select an action to run when the action button on the List Item is clicked.

### **Disable Padding**

Vertical padding will be removed from the whole Menu List.

### **Disable Gutters**

The left and right padding is removed from the whole Menu List


---

# 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://docs.appfarm.io/library/ui-components/menu-list.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.
