PageTabConfig

The object used to configure a new page tab.

Signature

interface PageTabConfig {    location: PageLocationId;    tabIcon?: string;    route: string;    tab: string;    priority?: number;    component: Type<any> | ReturnType<typeof detailComponentWithResolver>;    routeConfig?: Route;}

location

propertyPageLocationId

A valid location representing a list or detail page.

tabIcon

propertystring

An optional icon to display in the tab. The icon should be a valid shape name from the Clarity Icons set.

route

propertystring

The route path to the tab. This will be appended to the route of the parent page.

tab

propertystring

The name of the tab to display in the UI.

priority

propertynumber

The priority of the tab. Tabs with a lower priority will be displayed first.

component

propertyType<any> | ReturnType<typeof detailComponentWithResolver>

The component to render at the route of the tab.

routeConfig

propertyRoute

You can optionally provide any native Angular route configuration options here. Any values provided here will take precedence over the values generated by the route and component properties.

PageTabConfig

@vendure/admin-ui Source

The object used to configure a new page tab.

Signature

interface PageTabConfig {    location: PageLocationId;    tabIcon?: string;    route: string;    tab: string;    priority?: number;    component: Type<any> | ReturnType<typeof detailComponentWithResolver>;    routeConfig?: Route;}

location

propertyPageLocationId

A valid location representing a list or detail page.

tabIcon

propertystring

An optional icon to display in the tab. The icon should be a valid shape name from the Clarity Icons set.

route

propertystring

The route path to the tab. This will be appended to the route of the parent page.

tab

propertystring

The name of the tab to display in the UI.

priority

propertynumber

The priority of the tab. Tabs with a lower priority will be displayed first.

component

propertyType<any> | ReturnType<typeof detailComponentWithResolver>

The component to render at the route of the tab.

routeConfig

propertyRoute

You can optionally provide any native Angular route configuration options here. Any values provided here will take precedence over the values generated by the route and component properties.