register-route-component.mdx 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. ---
  2. title: "RegisterRouteComponent"
  3. generated: true
  4. ---
  5. <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-route-component.ts" sourceLine="79" packageName="@vendure/admin-ui" />
  6. Registers an Angular standalone component to be rendered in a route.
  7. *Example*
  8. ```ts title="routes.ts"
  9. import { registerRouteComponent } from '@vendure/admin-ui/core';
  10. import { registerReactRouteComponent } from '@vendure/admin-ui/react';
  11. import { ProductReviewDetailComponent } from './components/product-review-detail/product-review-detail.component';
  12. import { AllProductReviewsList } from './components/all-product-reviews-list/all-product-reviews-list.component';
  13. import { GetReviewDetailDocument } from './generated-types';
  14. export default [
  15. registerRouteComponent({
  16. path: '',
  17. component: AllProductReviewsList,
  18. breadcrumb: 'Product reviews',
  19. }),
  20. registerRouteComponent({
  21. path: ':id',
  22. component: ProductReviewDetailComponent,
  23. query: GetReviewDetailDocument,
  24. entityKey: 'productReview',
  25. getBreadcrumbs: entity => [
  26. {
  27. label: 'Product reviews',
  28. link: ['/extensions', 'product-reviews'],
  29. },
  30. {
  31. label: `#${entity?.id} (${entity?.product.name})`,
  32. link: [],
  33. },
  34. ],
  35. }),
  36. ];
  37. ```
  38. ```ts title="Signature"
  39. function registerRouteComponent<Component extends any | BaseDetailComponent<Entity>, Entity extends { id: string; updatedAt?: string }, T extends DocumentNode | TypedDocumentNode<any, { id: string }>, Field extends keyof ResultOf<T>, R extends Field>(options: RegisterRouteComponentOptions<Component, Entity, T, Field, R>): void
  40. ```
  41. Parameters
  42. ### options
  43. <MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/routes/register-route-component-options#registerroutecomponentoptions'>RegisterRouteComponentOptions</a><Component, Entity, T, Field, R>`} />