page-tab-config.md 2.2 KB


title: "PageTabConfig" weight: 10 date: 2023-07-26T19:00:02.572Z showtoc: true

generated: true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

PageTabConfig

The object used to configure a new page tab.

interface PageTabConfig {
  location: PageLocationId;
  tabIcon?: string;
  route: string;
  tab: string;
  priority?: number;
  component: Type<any> | ReturnType<typeof detailComponentWithResolver>;
  routeConfig?: Route;
}
### location PageLocationId`} /> A valid location representing a list or detail page. ### tabIcon An optional icon to display in the tab. The icon should be a valid shape name from the [Clarity Icons](https://core.clarity.design/foundation/icons/shapes/) set. ### route The route path to the tab. This will be appended to the route of the parent page. ### tab The name of the tab to display in the UI. ### priority The priority of the tab. Tabs with a lower priority will be displayed first. ### component detailComponentWithResolver>`} /> The component to render at the route of the tab. ### routeConfig 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.