PageTabConfig

Package: @vendure/admin-ui File: page.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;
}

Members

location

property

type:

PageLocationId

A valid location representing a list or detail page.

tabIcon

property

type:

string

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

route

property

type:

string

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

tab

property

type:

string

The name of the tab to display in the UI.

priority

property

type:

number

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

component

property

type:

Type<any> | ReturnType<typeof detailComponentWithResolver>

The component to render at the route of the tab.

routeConfig

property

type:

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.

Contents