add-nav-menu-item.md 1.6 KB


title: "AddNavMenuItem" isDefaultIndex: false

generated: true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

addNavMenuItem

Add a menu item to an existing section specified by sectionId. The id of the section can be found by inspecting the DOM and finding the data-section-id attribute. Providing the before argument will move the item before any existing item with the specified id. If omitted (or if the name is not found) the item will be appended to the end of the section.

This should be used in the NgModule providers array of your ui extension module.

Example

import { addNavMenuItem } from '@vendure/admin-ui/core';

export default [
    addNavMenuItem({
        id: 'reviews',
        label: 'Product Reviews',
        routerLink: ['/extensions/reviews'],
        icon: 'star',
    },
    'marketing'),
];
function addNavMenuItem(config: NavMenuItem, sectionId: string, before?: string): Provider

Parameters

config

NavMenuItem`} />

sectionId

before