Broadleaf Microservices
  • v1.0.0-latest-prod

Menu Types

extends ClientCallOptions

The MenuClient supports additional call configuration properties to support the request param of depthLimit

Property Type Description

depthLimit?

number

Provide any depthLimit to limit the output to only the top levels of the tree

Property Type Description

id

string

The identifier for the menu.

name

string

The unique name of the menu. This field is not displayed anywhere.

label?

string

Optional label for the menu to be displayed when it is rendered.

submenu

Array<NavigableMenuItem>

A list of the direct children of this menu with their own submenus populated.

[key: string]

unknown

Any additional custom attributes included on this menu

Property Type Description

id

string

The identifier for the menu item.

parentMenuId

string

The identifier for the parent menu.

parentMenuItemId?

string

The identifier for the parent menu item.

label

string

The user-friendly label for the menu item.

url?

string

The url that is visited when the menu item is clicked

displayOrder

number

The order in which this item should be displayed relative to its siblings in the navigation tree.

imageUrl?

string

The url of the image that should be rendered when displaying this menu item.

imageAltText?

string

The alt text of the image if imageUrl is set on the menu item.

customHtml?

string

The HTML that should be used to display the menu item.

type

string

The type of menu item.

submenu

Array<NavigableMenuItem>

A list of the direct children of this menu item with their own submenus populated.

[key: string]

unknown

Any additional custom attributes included on this menu item