# Menu & Navigation in ONEWEB

ONEWEB adopts a **hierarchical navigation structure** to organize application content and features in a clear and scalable manner.\
Using ONEWEB, users can link **Entities** or **Pages** to an application through the **Menu Configuration** screen, allowing intuitive access to application functionality.

This approach helps ensure consistency, usability, and ease of navigation across complex applications.

<figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2F9kUuVugnsl45LVKFeFnE%2Fimage.png?alt=media&#x26;token=a1defcb2-10e5-46b5-8418-90c820a8cff6" alt=""><figcaption></figcaption></figure>

***

### Menu Configuration Workflow

To configure a menu item in ONEWEB:

1. Select the **hierarchical position** where the menu item should appear.
2. Click the menu icon to open the **Menu Properties** screen.
3. Configure the menu item properties as required.
4. Save the menu configuration.
5. Log out and log back in to apply the changes.

Once completed, the menu item becomes available for navigation within the application.

***

### Menu Properties Overview

The **Menu Properties** screen allows you to define how a menu item behaves, how it is displayed, and what action is executed when a user selects it.

<figure><img src="https://2015371994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMpDjHWFRUtZ5nJcSfVXd%2Fuploads%2FYpf9OtKvrpLMcQcgTffF%2Fimage.png?alt=media&#x26;token=9412d778-d30b-425c-90f5-06e6e13b827e" alt=""><figcaption></figcaption></figure>

***

### Menu Property Definitions

| Property          | Mandatory | Default          | Description                                                                                                                      |
| ----------------- | --------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Menu ID**       | Yes       | System Generated | Unique, system‑generated identifier for the menu item. This value cannot be modified.                                            |
| **Description**   | Yes       | —                | Display name of the menu item as shown in the menu.                                                                              |
| **Sequence**      | Yes       | —                | Determines the order in which the menu item appears within the menu.                                                             |
| **Mapping**       | No        | —                | Used to link an **Entity** to the menu. When selected, you must also specify how the entity opens (SEARCH or INSERT mode).       |
| **Action URL**    | Yes       | —                | URL executed when the menu item is clicked. If linked to an entity, the URL can be auto‑generated using the **Generate** button. |
| **Reference**     | Yes       | System Generated | Identifies the parent menu item. This value is system‑generated and cannot be modified.                                          |
| **Type**          | Yes       | `LABEL`          | Defines menu behavior. `LABEL` expands to show child menus, while `PAGE` executes the configured URL.                            |
| **Action Target** | Yes       | `mainframe`      | Specifies where the content is loaded. Supported values are `mainframe` and `mainheader`.                                        |
| **Menu Level**    | Yes       | System Generated | Indicates the depth of the menu item within the overall menu hierarchy.                                                          |

***

### Menu Types and Behavior

* **LABEL**\
  Used for parent menu items. Clicking the menu expands it to reveal child items.
* **PAGE**\
  Used for actionable menu items. Clicking the menu loads the configured Action URL.

This separation allows clean hierarchical structures while maintaining clear navigation behavior.

***

### Summary

The **Menu & Navigation** system in ONEWEB provides a structured and flexible way to organize application features.

By leveraging hierarchical menus and configurable menu properties, applications can:

* Present complex functionality in an intuitive manner
* Maintain consistent navigation across pages
* Link menus to entities or custom pages
* Scale navigation structures as applications grow

A well‑designed menu structure enhances usability and ensures a smooth user experience across the application.


---

# Agent Instructions: 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:

```
GET https://docs.onewebstack.com/building-apps/ui-page-designer/ux-ui-components/menu-and-navigation/menu-and-navigation-in-oneweb.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
