Skip to content

UserMenuItemModel

UserMenuItemModel = { icon?: string; kind: "resource"; label?: string; resource: string; } | { icon?: string; kind: "page"; label?: string; page: string; } | { href: string; icon?: string; kind: "link"; label: string; }

Defined in: packages/schema/src/model.ts:1038

An entry in the menu under the signed-in user, at the bottom of the sidebar.

{ icon?: string; kind: "resource"; label?: string; resource: string; }

optional icon?: string

The entry’s icon; the resource’s sidebar icon when omitted.

kind: "resource"

Opens a resource’s list.

optional label?: string

The entry’s label; the view’s plural name when omitted.

resource: string

The resource, which leaves the sidebar.


{ icon?: string; kind: "page"; label?: string; page: string; }

optional icon?: string

The entry’s icon.

kind: "page"

Opens a composed page.

optional label?: string

The entry’s label; the page’s title when omitted.

page: string

The page, which leaves the sidebar.


{ href: string; icon?: string; kind: "link"; label: string; }

href: string

The address: https:, http: or mailto:.

optional icon?: string

The entry’s icon; external-link when omitted.

kind: "link"

Opens an address outside the admin in a new tab.

label: string

The entry’s label.