Skip to main content

PageTabConfig

PageTabConfig​

@vendure/admin-uipage.service.ts

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​

property
PageLocationId

A valid location representing a list or detail page.

tabIcon​

property
string

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

route​

property
string

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

tab​

property
string

The name of the tab to display in the UI.

priority​

property
number

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

component​

property
Type<any> | ReturnType<typeof detailComponentWithResolver>

The component to render at the route of the tab.

routeConfig​

property
Route

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.