page-tab-config.mdx 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. ---
  2. title: "PageTabConfig"
  3. generated: true
  4. ---
  5. <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/page/page.service.ts" sourceLine="14" packageName="@vendure/admin-ui" />
  6. The object used to configure a new page tab.
  7. ```ts title="Signature"
  8. interface PageTabConfig {
  9. location: PageLocationId;
  10. tabIcon?: string;
  11. route: string;
  12. tab: string;
  13. priority?: number;
  14. component: Type<any> | ReturnType<typeof detailComponentWithResolver>;
  15. routeConfig?: Route;
  16. }
  17. ```
  18. <div className="members-wrapper">
  19. ### location
  20. <MemberInfo kind="property" type={`<a href='/reference/admin-ui-api/action-bar/page-location-id#pagelocationid'>PageLocationId</a>`} />
  21. A valid location representing a list or detail page.
  22. ### tabIcon
  23. <MemberInfo kind="property" type={`string`} />
  24. An optional icon to display in the tab. The icon
  25. should be a valid shape name from the [Clarity Icons](https://core.clarity.design/foundation/icons/shapes/)
  26. set.
  27. ### route
  28. <MemberInfo kind="property" type={`string`} />
  29. The route path to the tab. This will be appended to the
  30. route of the parent page.
  31. ### tab
  32. <MemberInfo kind="property" type={`string`} />
  33. The name of the tab to display in the UI.
  34. ### priority
  35. <MemberInfo kind="property" type={`number`} />
  36. The priority of the tab. Tabs with a lower priority will be displayed first.
  37. ### component
  38. <MemberInfo kind="property" type={`Type<any> | ReturnType<typeof <a href='/reference/admin-ui-api/list-detail-views/detail-component-with-resolver#detailcomponentwithresolver'>detailComponentWithResolver</a>>`} />
  39. The component to render at the route of the tab.
  40. ### routeConfig
  41. <MemberInfo kind="property" type={`Route`} />
  42. You can optionally provide any native Angular route configuration options here.
  43. Any values provided here will take precedence over the values generated
  44. by the `route` and `component` properties.
  45. </div>