Menu is a navigation / command component that supports dynamic and static positioning.
import { MenuModule } from 'primeng/menu';
Menu requires a collection of menuitems as its model.
<p-menu [model]="items"></p-menu>
Menu supports one level of nesting by defining children with items property.
<p-toast></p-toast>
<p-menu [model]="items"></p-menu>
Popup mode is enabled by setting popup property to true and calling toggle method with an event of the target.
<p-toast></p-toast>
<p-menu #menu [model]="items" [popup]="true"></p-menu>
<button pButton type="button" (click)="menu.toggle($event)" icon="pi pi-bars" label="Show"></button>
Label of a menuitem both supports simple strings and html values as well. By default, html values are escaped, use escape property to allow html.
<p-menu [model]="items"></p-menu>
Navigation is specified using url property for external links and with routerLink for internal ones. If a menuitem has an active route, p-menuitem-link-active style class is added as an indicator. Active route link can be configured with routerLinkActiveOptions property of MenuItem API.
<p-menu [model]="items"></p-menu>
The function to invoke when an item is clicked is defined using the command property.
<p-toast></p-toast>
<p-menu [model]="items"></p-menu>
Following is the list of structural style classes, for theming classes visit theming page.
| Name | Element |
|---|---|
| p-menu | Container element. |
| p-menu-list | List element. |
| p-menuitem | Menuitem element. |
| p-menuitem-text | Label of a menuitem. |
| p-menuitem-icon | Icon of a menuitem. |
Menu component uses the menu role and the value to describe the menu can either be provided with aria-labelledby or aria-label props. Each list item has a presentation role whereas anchor elements have a menuitem role with aria-label referring to the label of the item and aria-disabled defined if the item is disabled. A submenu within a Menu uses the group role with an aria-labelledby defined as the id of the submenu root menuitem label.
In popup mode, the component implicitly manages the aria-expanded, aria-haspopup and aria-controls attributes of the target element to define the relation between the target and the popup.
| Key | Function |
|---|---|
| tab | Add focus to the first item if focus moves in to the menu. If the focus is already within the menu, focus moves to the next focusable item in the page tab sequence. |
| shift + tab | Add focus to the last item if focus moves in to the menu. If the focus is already within the menu, focus moves to the previous focusable item in the page tab sequence. |
| enter | Activates the focused menuitem. If menu is in overlay mode, popup gets closes and focus moves to target. |
| space | Activates the focused menuitem. If menu is in overlay mode, popup gets closes and focus moves to target. |
| escape | If menu is in overlay mode, popup gets closes and focus moves to target. |
| down arrow | Moves focus to the next menuitem. |
| up arrow | Moves focus to the previous menuitem. |
| home | Moves focus to the first menuitem. |
| end | Moves focus to the last menuitem. |
API defines helper props, events and others for the PrimeNG Menu module.
Defines valid properties in Menu component.
| Name | Type | Default | Description |
|---|---|---|---|
| model | array | null | An array of menuitems. |
| popup | boolean | false | Defines if menu would displayed as a popup. |
| style | string | null | Inline style of the component. |
| styleClass | string | null | Style class of the component. |
| appendTo | any | null | Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name). |
| baseZIndex | number | 0 | Base zIndex value to use in layering. |
| autoZIndex | boolean | true | Whether to automatically manage layering. |
| showTransitionOptions | string | .12s cubic-bezier(0, 0, 0.2, 1) | Transition options of the show animation. |
| hideTransitionOptions | string | .1s linear | Transition options of the hide animation. |
| Name | Parameters | Description |
|---|---|---|
| toggle | event: browser event | Toggles the visibility of the popup menu. |
| show | event: browser event | Displays the popup menu. |
| hide | - | Hides the popup menu. |
| Name | Parameters | Description |
|---|---|---|
| onShow | event: Event object | Callback to invoke when overlay menu is shown. |
| onHide | event: Event object | Callback to invoke when overlay menu is hidden. |
MenuItem provides the following properties. Note that not all of them may be utilized by the menu component.
| Name | Type | Default | Description |
|---|---|---|---|
| id | string | null | Identifier of the element. |
| label | string | null | Text of the item. |
| icon | string | null | Icon of the item. |
| iconStyle | object | null | Inline style of the item's icon. |
| command | function | null | Callback to execute when item is clicked. |
| url | string | null | External link to navigate when item is clicked. |
| routerLink | array | null | RouterLink definition for internal navigation. |
| routerLinkActiveOptions | object | null | Configuration for active router link. |
| queryParams | object | null | Query parameters for internal navigation via routerLink. |
| fragment | string | null | Sets the hash fragment for the URL. |
| queryParamsHandling | QueryParamsHandling | null | How to handle query parameters in the router link for the next navigation. One of: merge : Merge new with current parameters. preserve : Preserve current parameters.k. |
| preserveFragment | boolean | false | When true, preserves the URL fragment for the next navigation. |
| skipLocationChange | boolean | null | When true, navigates without pushing a new state into history. |
| replaceUrl | boolean | null | When true, navigates while replacing the current state in history. |
| state | object | null | Developer-defined state that can be passed to any navigation. |
| items | array | null | An array of children menuitems. |
| expanded | boolean | false | Visibility of submenu. |
| disabled | boolean | false | When set as true, disables the menuitem. |
| visible | boolean | true | Whether the dom element of menuitem is created or not. |
| target | string | null | Specifies where to open the linked document. |
| escape | boolean | true | Whether to escape the label or not. Set to false to display html content. |
| separator | boolean | false | Defines the item as a separator. |
| style | object | null | Inline style of the menuitem. |
| styleClass | string | null | Style class of the menuitem. |
| badge | string | null | Value of the badge. |
| badgeStyleClass | string | null | Style class of the badge. |
| title | string | null | Tooltip text of the item. |
| automationId | any | null | Value of HTML data-* attribute. |
| tabindex | string | 0 | Specifies tab order of the item. |
| tooltipOptions | TooltipOptions | - | Options of the item's tooltip. |