Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions _data/components/appLayout.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,20 @@ attributes:
},{
name: "store-state",
since: "15.5.0"
}, {
name: "show-ellipsis-menu",
type: "boolean",
default: "no",
required: "",
since: "15.5.4",
description: "Indicates whether or not to show ellipsis in menu items.",
},{
name: "tooltip-display-mode",
type: "'always'| 'never' | 'only-collapsed'| 'only-expanded'",
default: "only-collapsed",
required: "",
since: "15.5.4",
description: "Defines when the tooltip should be displayed. The default value is **only-collapsed**",
}
]

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions docs/components/layout/51-o-app-layout.component.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,38 @@ export class MainComponent {

![Custom user info]({{ "/assets/images/layouts/app-layout/custom_user_info.png" | absolute_url }})

## Side Menu Behavior Options
The `<o-app-layout>` component is the main layout wrapper that provides a consistent structure for applications, including a top toolbar, side navigation menu, and main content area. It supports responsive behavior and is highly customizable.

Example:

```html
<o-app-layout show-ellipsis-menu="true" tooltip-display-mode="always">
<router-outlet></router-outlet>
</o-app-layout>
```

### Show ellipsis menu <span class='menuitem-badge'>new<span>

The `show-ellipsis-menu` input controls whether long menu item labels should be visually truncated with an ellipsis (`...`) when they don’t fit in the available horizontal space. By default, this behavior is disabled and text may wrap or overflow depending on layout styles.

![App layout component with show-ellipsis-menu]({{ "/assets/images/layouts/app-layout/app-layout-show-ellipsis-menu.png" | absolute_url }})


### Tooltip display behavior <span class='menuitem-badge'>new<span>

The `tooltip-display-mode` input lets you control when tooltips should appear on side navigation items. This is especially helpful when the menu is collapsed, and labels are hidden. By default, this value es `only-collapsed`

Available modes:

* **`'always'`** – Tooltips are always shown, regardless of the menu state.
* **`'never'`** – Tooltips are never shown.
* **`'only-collapsed'`** – Tooltips are shown only when the side menu is collapsed (default).
* **`'only-expanded'`** – Tooltips are shown only when the side menu is expanded.

This setting improves accessibility and user experience by offering contextual information only when it's needed.


## Images

You can set provide images to be shown in the side navigator using the attributes `opened-sidenav-image` and `closed-sidenav-image`. Check this and other attributes in the **API** section of this page.
Expand Down