@vendure/docs 0.0.0-202601161541

package/docs/reference/dashboard/detail-views/use-detail-page.md

@@ -0,0 +1,234 @@
+---
+title: "UseDetailPage"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## useDetailPage
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="240" packageName="@vendure/dashboard" since="3.3.0" />
+
+**Status: Developer Preview**
+
+This hook is used to create an entity detail page which can read
+and update an entity.
+
+*Example*
+
+```ts
+const { form, submitHandler, entity, isPending, resetForm } = useDetailPage({
+    queryDocument: paymentMethodDetailDocument,
+    createDocument: createPaymentMethodDocument,
+    updateDocument: updatePaymentMethodDocument,
+    setValuesForUpdate: entity => {
+        return {
+            id: entity.id,
+            enabled: entity.enabled,
+            name: entity.name,
+            code: entity.code,
+            description: entity.description,
+            checker: entity.checker?.code
+                ? {
+                      code: entity.checker?.code,
+                      arguments: entity.checker?.args,
+                  }
+                : null,
+            handler: entity.handler?.code
+                ? {
+                      code: entity.handler?.code,
+                      arguments: entity.handler?.args,
+                  }
+                : null,
+            translations: entity.translations.map(translation => ({
+                id: translation.id,
+                languageCode: translation.languageCode,
+                name: translation.name,
+                description: translation.description,
+            })),
+            customFields: entity.customFields,
+        };
+    },
+    transformCreateInput: input => {
+        return {
+            ...input,
+            checker: input.checker?.code ? input.checker : undefined,
+            handler: input.handler,
+        };
+    },
+    params: { id: params.id },
+    onSuccess: async data => {
+        toast.success(i18n.t('Successfully updated payment method'));
+        resetForm();
+        if (creatingNewEntity) {
+            await navigate({ to: `../$id`, params: { id: data.id } });
+        }
+    },
+    onError: err => {
+        toast.error(i18n.t('Failed to update payment method'), {
+            description: err instanceof Error ? err.message : 'Unknown error',
+        });
+    },
+});
+```
+
+```ts title="Signature"
+function useDetailPage<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>, EntityField extends keyof ResultOf<T> = keyof ResultOf<T>, VarNameUpdate extends keyof VariablesOf<U> = 'input', VarNameCreate extends keyof VariablesOf<C> = 'input'>(options: DetailPageOptions<T, C, U, EntityField, VarNameCreate, VarNameUpdate>): UseDetailPageResult<T, U, EntityField>
+```
+Parameters
+
+### options
+
+<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a>&#60;T, C, U, EntityField, VarNameCreate, VarNameUpdate&#62;`} />
+
+
+
+## DetailPageOptions
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="46" packageName="@vendure/dashboard" since="3.3.0" />
+
+Options used to configure the result of the `useDetailPage` hook.
+
+```ts title="Signature"
+interface DetailPageOptions<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>, EntityField extends keyof ResultOf<T> = DetailEntityPath<T>, VarNameCreate extends keyof VariablesOf<C> = 'input', VarNameUpdate extends keyof VariablesOf<U> = 'input'> {
+    pageId?: string;
+    queryDocument: T;
+    entityField?: EntityField;
+    params: {
+        id: string;
+    };
+    entityName?: string;
+    createDocument?: C;
+    updateDocument?: U;
+    setValuesForUpdate: (
+        entity: NonNullable<ResultOf<T>[EntityField]>,
+    ) => WithLooseCustomFields<VariablesOf<U>[VarNameUpdate]>;
+    transformCreateInput?: (input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate];
+    transformUpdateInput?: (input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate];
+    onSuccess?: (entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void;
+    onError?: (error: unknown) => void;
+}
+```
+
+<div className="members-wrapper">
+
+### pageId
+
+<MemberInfo kind="property" type={`string`}   />
+
+The page id. This is optional, but if provided, it will be used to
+identify the page when extending the detail page query
+### queryDocument
+
+<MemberInfo kind="property" type={`T`}   />
+
+The query document to fetch the entity.
+### entityField
+
+<MemberInfo kind="property" type={`EntityField`}   />
+
+The field of the query document that contains the entity.
+### params
+
+<MemberInfo kind="property" type={`{         id: string;     }`}   />
+
+The parameters used to identify the entity.
+### entityName
+
+<MemberInfo kind="property" type={`string`}   />
+
+The entity type name for custom field configuration lookup.
+Required to filter out readonly custom fields before mutations.
+If not provided, the function will try to infer it from the query document.
+### createDocument
+
+<MemberInfo kind="property" type={`C`}   />
+
+The document to create the entity.
+### updateDocument
+
+<MemberInfo kind="property" type={`U`}   />
+
+The document to update the entity.
+### setValuesForUpdate
+
+<MemberInfo kind="property" type={`(         entity: NonNullable&#60;ResultOf&#60;T&#62;[EntityField]&#62;,     ) =&#62; WithLooseCustomFields&#60;VariablesOf&#60;U&#62;[VarNameUpdate]&#62;`}   />
+
+The function to set the values for the update document.
+### transformCreateInput
+
+<MemberInfo kind="property" type={`(input: VariablesOf&#60;C&#62;[VarNameCreate]) =&#62; VariablesOf&#60;C&#62;[VarNameCreate]`}   />
+
+
+### transformUpdateInput
+
+<MemberInfo kind="property" type={`(input: VariablesOf&#60;U&#62;[VarNameUpdate]) =&#62; VariablesOf&#60;U&#62;[VarNameUpdate]`}   />
+
+
+### onSuccess
+
+<MemberInfo kind="property" type={`(entity: ResultOf&#60;C&#62;[keyof ResultOf&#60;C&#62;] | ResultOf&#60;U&#62;[keyof ResultOf&#60;U&#62;]) =&#62; void`}   />
+
+The function to call when the update is successful.
+### onError
+
+<MemberInfo kind="property" type={`(error: unknown) =&#62; void`}   />
+
+The function to call when the update is successful.
+
+
+</div>
+
+
+## UseDetailPageResult
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="158" packageName="@vendure/dashboard" since="3.3.0" />
+
+
+
+```ts title="Signature"
+interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>, EntityField extends keyof ResultOf<T>> {
+    form: UseFormReturn<RemoveNullFields<VariablesOf<U>['input']>>;
+    submitHandler: (event: FormEvent<HTMLFormElement>) => void;
+    entity?: DetailPageEntity<T, EntityField>;
+    isPending: boolean;
+    refreshEntity: () => void;
+    resetForm: () => void;
+}
+```
+
+<div className="members-wrapper">
+
+### form
+
+<MemberInfo kind="property" type={`UseFormReturn&#60;RemoveNullFields&#60;VariablesOf&#60;U&#62;['input']&#62;&#62;`}   />
+
+
+### submitHandler
+
+<MemberInfo kind="property" type={`(event: FormEvent&#60;HTMLFormElement&#62;) =&#62; void`}   />
+
+
+### entity
+
+<MemberInfo kind="property" type={`DetailPageEntity&#60;T, EntityField&#62;`}   />
+
+
+### isPending
+
+<MemberInfo kind="property" type={`boolean`}   />
+
+
+### refreshEntity
+
+<MemberInfo kind="property" type={`() =&#62; void`}   />
+
+
+### resetForm
+
+<MemberInfo kind="property" type={`() =&#62; void`}   />
+
+
+
+
+</div>

package/docs/reference/dashboard/detail-views/use-generated-form.md

@@ -0,0 +1,105 @@
+---
+title: "UseGeneratedForm"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## useGeneratedForm
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="86" packageName="@vendure/dashboard" since="3.3.0" />
+
+This hook is used to create a form from a document and an entity.
+It will create a form with the fields defined in the document's input type.
+It will also create a submit handler that will submit the form to the server.
+
+This hook is mostly used internally by the higher-level <a href='/reference/dashboard/detail-views/use-detail-page#usedetailpage'>useDetailPage</a> hook,
+but can in some cases be useful to use directly.
+
+*Example*
+
+```tsx
+const { form, submitHandler } = useGeneratedForm({
+ document: setDraftOrderCustomFieldsDocument,
+ varName: undefined,
+ entity: entity,
+ setValues: entity => {
+   return {
+     orderId: entity.id,
+     input: {
+       customFields: entity.customFields,
+     },
+   };
+ },
+});
+```
+
+```ts title="Signature"
+function useGeneratedForm<T extends TypedDocumentNode<any, any>, VarName extends keyof VariablesOf<T> | undefined, E extends Record<string, any> = Record<string, any>>(options: GeneratedFormOptions<T, VarName, E>): void
+```
+Parameters
+
+### options
+
+<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a>&#60;T, VarName, E&#62;`} />
+
+
+
+## GeneratedFormOptions
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="24" packageName="@vendure/dashboard" since="3.3.0" />
+
+Options for the useGeneratedForm hook.
+
+```ts title="Signature"
+interface GeneratedFormOptions<T extends TypedDocumentNode<any, any>, VarName extends keyof VariablesOf<T> | undefined = 'input', E extends Record<string, any> = Record<string, any>> {
+    document?: T;
+    varName?: VarName;
+    entity: E | null | undefined;
+    customFieldConfig?: any[];
+    setValues: (
+        entity: NonNullable<E>,
+    ) => WithLooseCustomFields<
+        VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>
+    >;
+    onSubmit?: (
+        values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>,
+    ) => void;
+}
+```
+
+<div className="members-wrapper">
+
+### document
+
+<MemberInfo kind="property" type={`T`}   />
+
+The document to use to generate the form.
+### varName
+
+<MemberInfo kind="property" type={`VarName`}   />
+
+The name of the variable to use in the document.
+### entity
+
+<MemberInfo kind="property" type={`E | null | undefined`}   />
+
+The entity to use to generate the form.
+### customFieldConfig
+
+<MemberInfo kind="property" type={`any[]`}   />
+
+
+### setValues
+
+<MemberInfo kind="property" type={`(         entity: NonNullable&#60;E&#62;,     ) =&#62; WithLooseCustomFields&#60;         VarName extends keyof VariablesOf&#60;T&#62; ? VariablesOf&#60;T&#62;[VarName] : VariablesOf&#60;T&#62;     &#62;`}   />
+
+
+### onSubmit
+
+<MemberInfo kind="property" type={`(         values: VarName extends keyof VariablesOf&#60;T&#62; ? VariablesOf&#60;T&#62;[VarName] : VariablesOf&#60;T&#62;,     ) =&#62; void`}   />
+
+
+
+
+</div>

package/docs/reference/dashboard/extensions-api/action-bar.md

@@ -0,0 +1,66 @@
+---
+title: "ActionBar"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## DashboardActionBarItem
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/layout.ts" sourceLine="17" packageName="@vendure/dashboard" since="3.3.0" />
+
+Allows you to define custom action bar items for any page in the dashboard, which is the
+top bar that normally contains the main call-to-action buttons such as "update" or "create".
+
+This API also allows you to specify dropdown menu items, which when defined, will appear in
+a context menu to the very right of the ActionBar.
+
+```ts title="Signature"
+interface DashboardActionBarItem {
+    pageId: string;
+    component: React.FunctionComponent<{ context: PageContextValue }>;
+    type?: 'button' | 'dropdown';
+    requiresPermission?: string | string[];
+}
+```
+
+<div className="members-wrapper">
+
+### pageId
+
+<MemberInfo kind="property" type={`string`}   />
+
+The ID of the page where the action bar item should be displayed.
+### component
+
+<MemberInfo kind="property" type={`React.FunctionComponent&#60;{ context: PageContextValue }&#62;`}   />
+
+A React component that will be rendered in the action bar. Typically, you would use
+the default Shadcn `<Button>` component.
+### type
+
+<MemberInfo kind="property" type={`'button' | 'dropdown'`} default={`'button'`}   />
+
+The type of action bar item to display. Defaults to `button`.
+The 'dropdown' type is used to display the action bar item as a dropdown menu item.
+
+When using the dropdown type, use a suitable [dropdown item](https://ui.shadcn.com/docs/components/dropdown-menu)
+component, such as:
+
+```tsx
+import { DropdownMenuItem } from '@vendure/dashboard';
+
+// ...
+
+{
+  component: () => <DropdownMenuItem>My Item</DropdownMenuItem>
+}
+```
+### requiresPermission
+
+<MemberInfo kind="property" type={`string | string[]`}   />
+
+Any permissions that are required to display this action bar item.
+
+
+</div>

package/docs/reference/dashboard/extensions-api/alerts.md

@@ -0,0 +1,78 @@
+---
+title: "Alerts"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## DashboardAlertDefinition
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/alerts.ts" sourceLine="11" packageName="@vendure/dashboard" since="3.3.0" />
+
+Allows you to define custom alerts that can be displayed in the dashboard.
+
+```ts title="Signature"
+interface DashboardAlertDefinition<TResponse = any> {
+    id: string;
+    title: string | ((data: TResponse) => string);
+    description?: string | ((data: TResponse) => string);
+    severity: AlertSeverity | ((data: TResponse) => AlertSeverity);
+    check: () => Promise<TResponse> | TResponse;
+    shouldShow: (data: TResponse) => boolean;
+    recheckInterval?: number;
+    actions?: Array<{
+        label: string;
+        onClick: (args: { data: TResponse; dismiss: () => void }) => void | Promise<any>;
+    }>;
+}
+```
+
+<div className="members-wrapper">
+
+### id
+
+<MemberInfo kind="property" type={`string`}   />
+
+A unique identifier for the alert.
+### title
+
+<MemberInfo kind="property" type={`string | ((data: TResponse) =&#62; string)`}   />
+
+The title of the alert. Can be a string or a function that returns a string based on the response data.
+### description
+
+<MemberInfo kind="property" type={`string | ((data: TResponse) =&#62; string)`}   />
+
+The description of the alert. Can be a string or a function that returns a string based on the response data.
+### severity
+
+<MemberInfo kind="property" type={`AlertSeverity | ((data: TResponse) =&#62; AlertSeverity)`}   />
+
+The severity level of the alert.
+### check
+
+<MemberInfo kind="property" type={`() =&#62; Promise&#60;TResponse&#62; | TResponse`}   />
+
+A function that checks the condition and returns the response data.
+### shouldShow
+
+<MemberInfo kind="property" type={`(data: TResponse) =&#62; boolean`}   />
+
+A function that determines whether the alert should be rendered based on the response data.
+### recheckInterval
+
+<MemberInfo kind="property" type={`number`}   />
+
+The interval in milliseconds to recheck the condition.
+### actions
+
+<MemberInfo kind="property" type={`Array&#60;{         label: string;         onClick: (args: { data: TResponse; dismiss: () =&#62; void }) =&#62; void | Promise&#60;any&#62;;     }&#62;`}   />
+
+Optional actions that can be performed when the alert is shown.
+
+The `onClick()` handler will receive the data returned by the `check` function,
+as well as a `dismiss()` function that can be used to immediately dismiss the
+current alert.
+
+
+</div>

package/docs/reference/dashboard/extensions-api/data-tables.md

@@ -0,0 +1,55 @@
+---
+title: "DataTables"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## DashboardDataTableExtensionDefinition
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/data-table.ts" sourceLine="131" packageName="@vendure/dashboard" since="3.4.0" />
+
+This allows you to customize aspects of existing data tables in the dashboard.
+
+```ts title="Signature"
+interface DashboardDataTableExtensionDefinition {
+    pageId: string;
+    blockId?: string;
+    bulkActions?: BulkAction[];
+    extendListDocument?: string | DocumentNode | (() => DocumentNode | string);
+    displayComponents?: DashboardDataTableDisplayComponent[];
+}
+```
+
+<div className="members-wrapper">
+
+### pageId
+
+<MemberInfo kind="property" type={`string`}   />
+
+The ID of the page where the data table is located, e.g. `'product-list'`, `'order-list'`.
+### blockId
+
+<MemberInfo kind="property" type={`string`}   />
+
+The ID of the data table block. Defaults to `'list-table'`, which is the default blockId
+for the standard list pages. However, some other pages may use a different blockId,
+such as `'product-variants-table'` on the `'product-detail'` page.
+### bulkActions
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/list-views/bulk-actions#bulkaction'>BulkAction</a>[]`}   />
+
+An array of additional bulk actions that will be available on the data table.
+### extendListDocument
+
+<MemberInfo kind="property" type={`string | DocumentNode | (() =&#62; DocumentNode | string)`}   />
+
+Allows you to extend the list document for the data table.
+### displayComponents
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/list-views/data-table#dashboarddatatabledisplaycomponent'>DashboardDataTableDisplayComponent</a>[]`}   />
+
+Custom display components for specific columns in the data table.
+
+
+</div>

package/docs/reference/dashboard/extensions-api/define-dashboard-extension.md

@@ -0,0 +1,142 @@
+---
+title: "DefineDashboardExtension"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## defineDashboardExtension
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/define-dashboard-extension.ts" sourceLine="62" packageName="@vendure/dashboard" since="3.3.0" />
+
+The main entry point for extensions to the React-based dashboard. Every dashboard extension
+must contain a call to this function, usually in the entry point file that is referenced by
+the `dashboard` property of the plugin decorator.
+
+Every type of customisation of the dashboard can be defined here, including:
+
+- Navigation (nav sections and routes)
+- Layout (action bar items and page blocks)
+- Widgets
+- Form components (custom form components, input components, and display components)
+- Data tables
+- Detail forms
+- Login
+- Custom history entries
+
+*Example*
+
+```tsx
+defineDashboardExtension({
+ navSections: [],
+ routes: [],
+ pageBlocks: [],
+ actionBarItems: [],
+});
+```
+
+```ts title="Signature"
+function defineDashboardExtension(extension: DashboardExtension): void
+```
+Parameters
+
+### extension
+
+<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/extensions-api/define-dashboard-extension#dashboardextension'>DashboardExtension</a>`} />
+
+
+
+## DashboardExtension
+
+<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/extension-api-types.ts" sourceLine="34" packageName="@vendure/dashboard" since="3.3.0" />
+
+This is the main interface for defining _all_ extensions to the dashboard.
+
+Every type of customisation of the dashboard can be defined here, including:
+
+- Navigation (nav sections and routes)
+- Layout (action bar items and page blocks)
+- Widgets for the Insights page
+- Form components
+- Data tables
+- Detail forms
+- Login page customisation
+
+```ts title="Signature"
+interface DashboardExtension {
+    routes?: DashboardRouteDefinition[];
+    navSections?: DashboardNavSectionDefinition[];
+    pageBlocks?: DashboardPageBlockDefinition[];
+    actionBarItems?: DashboardActionBarItem[];
+    alerts?: DashboardAlertDefinition[];
+    widgets?: DashboardWidgetDefinition[];
+    customFormComponents?: DashboardCustomFormComponents;
+    dataTables?: DashboardDataTableExtensionDefinition[];
+    detailForms?: DashboardDetailFormExtensionDefinition[];
+    login?: DashboardLoginExtensions;
+    historyEntries?: DashboardHistoryEntryComponent[];
+}
+```
+
+<div className="members-wrapper">
+
+### routes
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/routes#dashboardroutedefinition'>DashboardRouteDefinition</a>[]`}   />
+
+Allows you to define custom routes such as list or detail views.
+### navSections
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/navigation#dashboardnavsectiondefinition'>DashboardNavSectionDefinition</a>[]`}   />
+
+Allows you to define custom nav sections for the dashboard.
+### pageBlocks
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/page-blocks#dashboardpageblockdefinition'>DashboardPageBlockDefinition</a>[]`}   />
+
+Allows you to define custom page blocks for any page in the dashboard.
+### actionBarItems
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/action-bar#dashboardactionbaritem'>DashboardActionBarItem</a>[]`}   />
+
+Allows you to define custom action bar items for any page in the dashboard.
+### alerts
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/alerts#dashboardalertdefinition'>DashboardAlertDefinition</a>[]`}   />
+
+Allows you to define custom alerts that can be displayed in the dashboard.
+### widgets
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/widgets#dashboardwidgetdefinition'>DashboardWidgetDefinition</a>[]`}   />
+
+Allows you to define custom routes for the dashboard, which will render the
+given components and optionally also add a nav menu item.
+### customFormComponents
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/form-components#dashboardcustomformcomponents'>DashboardCustomFormComponents</a>`}   />
+
+Unified registration for custom form custom field components.
+### dataTables
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/data-tables#dashboarddatatableextensiondefinition'>DashboardDataTableExtensionDefinition</a>[]`}   />
+
+Allows you to customize aspects of existing data tables in the dashboard.
+### detailForms
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/detail-forms#dashboarddetailformextensiondefinition'>DashboardDetailFormExtensionDefinition</a>[]`}   />
+
+Allows you to customize the detail form for any page in the dashboard.
+### login
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/login#dashboardloginextensions'>DashboardLoginExtensions</a>`}   />
+
+Allows you to customize the login page with custom components.
+### historyEntries
+
+<MemberInfo kind="property" type={`<a href='/reference/dashboard/extensions-api/history-entries#dashboardhistoryentrycomponent'>DashboardHistoryEntryComponent</a>[]`}   />
+
+Allows a custom component to be used to render a history entry item
+in the Order or Customer history lists.
+
+
+</div>