@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx

@@ -2,10 +2,6 @@
 title: "DatetimePickerComponent"
 generated: true
 ---
-
-
-## DatetimePickerComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/datetime-picker/datetime-picker.component.ts" sourceLine="39" packageName="@vendure/admin-ui" />
 
 A form input for selecting datetime values.
@@ -103,12 +99,12 @@ Sets the readonly state
 
 ### datetimeInput
 
-<MemberInfo kind="property" type={`ElementRef&#60;HTMLInputElement&#62;`}   />
+<MemberInfo kind="property" type={`ElementRef<HTMLInputElement>`}   />
 
 
 ### calendarTable
 
-<MemberInfo kind="property" type={`ElementRef&#60;HTMLTableElement&#62;`}   />
+<MemberInfo kind="property" type={`ElementRef<HTMLTableElement>`}   />
 
 
 ### disabled
@@ -118,27 +114,27 @@ Sets the readonly state
 
 ### calendarView$
 
-<MemberInfo kind="property" type={`Observable&#60;CalendarView&#62;`}   />
+<MemberInfo kind="property" type={`Observable<CalendarView>`}   />
 
 
 ### current$
 
-<MemberInfo kind="property" type={`Observable&#60;CurrentView&#62;`}   />
+<MemberInfo kind="property" type={`Observable<CurrentView>`}   />
 
 
 ### selected$
 
-<MemberInfo kind="property" type={`Observable&#60;Date | null&#62;`}   />
+<MemberInfo kind="property" type={`Observable<Date | null>`}   />
 
 
 ### selectedHours$
 
-<MemberInfo kind="property" type={`Observable&#60;number | null&#62;`}   />
+<MemberInfo kind="property" type={`Observable<number | null>`}   />
 
 
 ### selectedMinutes$
 
-<MemberInfo kind="property" type={`Observable&#60;number | null&#62;`}   />
+<MemberInfo kind="property" type={`Observable<number | null>`}   />
 
 
 ### years

package/docs/reference/admin-ui-api/components/dropdown-component.mdx

@@ -2,10 +2,6 @@
 title: "DropdownComponent"
 generated: true
 ---
-
-
-## DropdownComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/dropdown/dropdown.component.ts" sourceLine="28" packageName="@vendure/admin-ui" />
 
 Used for building dropdown menus.
@@ -72,7 +68,7 @@ class DropdownComponent {
 
 ### onOpenChange
 
-<MemberInfo kind="method" type={`(callback: (isOpen: boolean) =&#62; void) => `}   />
+<MemberInfo kind="method" type={`(callback: (isOpen: boolean) => void) => `}   />
 
 
 ### setTriggerElement

package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx

@@ -2,10 +2,6 @@
 title: "FacetValueSelectorComponent"
 generated: true
 ---
-
-
-## FacetValueSelectorComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/facet-value-selector/facet-value-selector.component.ts" sourceLine="34" packageName="@vendure/admin-ui" />
 
 A form control for selecting facet values.
@@ -61,7 +57,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 
 ### transformControlValueAccessorValue
 
-<MemberInfo kind="property" type={`(value: FacetValueFragment[]) =&#62; any[]`}   />
+<MemberInfo kind="property" type={`(value: FacetValueFragment[]) => any[]`}   />
 
 
 ### searchInput$
@@ -76,7 +72,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 
 ### searchResults$
 
-<MemberInfo kind="property" type={`Observable&#60;FacetValueFragment[]&#62;`}   />
+<MemberInfo kind="property" type={`Observable<FacetValueFragment[]>`}   />
 
 
 ### selectedIds$
@@ -86,12 +82,12 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 
 ### onChangeFn
 
-<MemberInfo kind="property" type={`(val: any) =&#62; void`}   />
+<MemberInfo kind="property" type={`(val: any) => void`}   />
 
 
 ### onTouchFn
 
-<MemberInfo kind="property" type={`() =&#62; void`}   />
+<MemberInfo kind="property" type={`() => void`}   />
 
 
 ### disabled
@@ -101,7 +97,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 
 ### value
 
-<MemberInfo kind="property" type={`Array&#60;string | FacetValueFragment&#62;`}   />
+<MemberInfo kind="property" type={`Array<string | FacetValueFragment>`}   />
 
 
 ### constructor
@@ -146,7 +142,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 
 ### writeValue
 
-<MemberInfo kind="method" type={`(obj: string | FacetValueFragment[] | Array&#60;string | number&#62; | null) => void`}   />
+<MemberInfo kind="method" type={`(obj: string | FacetValueFragment[] | Array<string | number> | null) => void`}   />
 
 
 

package/docs/reference/admin-ui-api/components/object-tree-component.mdx

@@ -2,10 +2,6 @@
 title: "ObjectTreeComponent"
 generated: true
 ---
-
-
-## ObjectTreeComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/object-tree/object-tree.component.ts" sourceLine="22" packageName="@vendure/admin-ui" />
 
 This component displays a plain JavaScript object as an expandable tree.
@@ -62,7 +58,7 @@ class ObjectTreeComponent implements OnChanges {
 
 ### entries
 
-<MemberInfo kind="property" type={`Array&#60;{ key: string; value: any }&#62;`}   />
+<MemberInfo kind="property" type={`Array<{ key: string; value: any }>`}   />
 
 
 ### constructor

package/docs/reference/admin-ui-api/components/order-state-label-component.mdx

@@ -2,10 +2,6 @@
 title: "OrderStateLabelComponent"
 generated: true
 ---
-
-
-## OrderStateLabelComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/order-state-label/order-state-label.component.ts" sourceLine="13" packageName="@vendure/admin-ui" />
 
 Displays the state of an order in a colored chip.

package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx

@@ -2,10 +2,6 @@
 title: "ProductVariantSelectorComponent"
 generated: true
 ---
-
-
-## ProductVariantSelectorComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/product-variant-selector/product-variant-selector.component.ts" sourceLine="21" packageName="@vendure/admin-ui" />
 
 A component for selecting product variants via an autocomplete-style select input.
@@ -46,7 +42,7 @@ class ProductVariantSelectorComponent implements OnInit {
 
 ### searchResults$
 
-<MemberInfo kind="property" type={`Observable&#60;ProductSelectorSearchQuery['search']['items']&#62;`}   />
+<MemberInfo kind="property" type={`Observable<ProductSelectorSearchQuery['search']['items']>`}   />
 
 
 ### productSelected

package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx

@@ -2,10 +2,6 @@
 title: "RichTextEditorComponent"
 generated: true
 ---
-
-
-## RichTextEditorComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/rich-text-editor/rich-text-editor.component.ts" sourceLine="32" packageName="@vendure/admin-ui" />
 
 A rich text (HTML) editor based on Prosemirror (https://prosemirror.net/)
@@ -54,12 +50,12 @@ class RichTextEditorComponent implements ControlValueAccessor, AfterViewInit, On
 
 ### onChange
 
-<MemberInfo kind="property" type={`(val: any) =&#62; void`}   />
+<MemberInfo kind="property" type={`(val: any) => void`}   />
 
 
 ### onTouch
 
-<MemberInfo kind="property" type={`() =&#62; void`}   />
+<MemberInfo kind="property" type={`() => void`}   />
 
 
 ### constructor

package/docs/reference/admin-ui-api/components/zone-selector-component.mdx

@@ -2,10 +2,6 @@
 title: "ZoneSelectorComponent"
 generated: true
 ---
-
-
-## ZoneSelectorComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/zone-selector/zone-selector.component.ts" sourceLine="40" packageName="@vendure/admin-ui" />
 
 A form control for selecting zones.
@@ -50,7 +46,7 @@ class ZoneSelectorComponent implements ControlValueAccessor {
 
 ### transformControlValueAccessorValue
 
-<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined) =&#62; any`}   />
+<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined) => any`}   />
 
 
 ### selectedId$
@@ -60,12 +56,12 @@ class ZoneSelectorComponent implements ControlValueAccessor {
 
 ### onChangeFn
 
-<MemberInfo kind="property" type={`(val: any) =&#62; void`}   />
+<MemberInfo kind="property" type={`(val: any) => void`}   />
 
 
 ### onTouchFn
 
-<MemberInfo kind="property" type={`() =&#62; void`}   />
+<MemberInfo kind="property" type={`() => void`}   />
 
 
 ### disabled

package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx

@@ -2,13 +2,9 @@
 title: "CustomDetailComponentConfig"
 generated: true
 ---
-
-
-## CustomDetailComponentConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-detail-component/custom-detail-component-types.ts" sourceLine="25" packageName="@vendure/admin-ui" />
 
-Configures a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a> to be placed in the given location.
+Configures a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink> to be placed in the given location.
 
 ```ts title="Signature"
 interface CustomDetailComponentConfig {
@@ -27,7 +23,7 @@ interface CustomDetailComponentConfig {
 
 ### component
 
-<MemberInfo kind="property" type={`Type&#60;<a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a>&#62;`}   />
+<MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a>>`}   />
 
 
 ### providers

package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx

@@ -2,13 +2,9 @@
 title: "CustomDetailComponentLocationId"
 generated: true
 ---
-
-
-## CustomDetailComponentLocationId
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="115" packageName="@vendure/admin-ui" />
 
-The valid locations for embedding a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a>.
+The valid locations for embedding a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink>.
 
 ```ts title="Signature"
 type CustomDetailComponentLocationId = | 'administrator-profile'

package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx

@@ -2,10 +2,6 @@
 title: "CustomDetailComponent"
 generated: true
 ---
-
-
-## CustomDetailComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-detail-component/custom-detail-component-types.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 
 CustomDetailComponents allow any arbitrary Angular components to be embedded in entity detail
@@ -22,7 +18,7 @@ interface CustomDetailComponent {
 
 ### entity$
 
-<MemberInfo kind="property" type={`Observable&#60;any&#62;`}   />
+<MemberInfo kind="property" type={`Observable<any>`}   />
 
 
 ### detailForm

package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx

@@ -2,13 +2,9 @@
 title: "RegisterCustomDetailComponent"
 generated: true
 ---
-
-
-## registerCustomDetailComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-custom-detail-component.ts" sourceLine="57" packageName="@vendure/admin-ui" />
 
-Registers a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a> to be placed in a given location. This allows you
+Registers a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink> to be placed in a given location. This allows you
 to embed any type of custom Angular component in the entity detail pages of the Admin UI.
 
 *Example*

package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx

@@ -2,13 +2,9 @@
 title: "CustomerHistoryEntryComponent"
 generated: true
 ---
-
-
-## CustomerHistoryEntryComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="64" packageName="@vendure/admin-ui" since="1.9.0" />
 
-Used to implement a <a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a> which requires access to the Customer object.
+Used to implement a <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent">HistoryEntryComponent</DocsLink> which requires access to the Customer object.
 
 ```ts title="Signature"
 interface CustomerHistoryEntryComponent extends HistoryEntryComponent {

package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx

@@ -2,15 +2,11 @@
 title: "HistoryEntryComponent"
 generated: true
 ---
-
-
-## HistoryEntryComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="16" packageName="@vendure/admin-ui" since="1.9.0" />
 
 This interface should be implemented by components intended to display a history entry in the
 Order or Customer history timeline. If the component needs access to the Order or Customer object itself,
-you should implement <a href='/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component#orderhistoryentrycomponent'>OrderHistoryEntryComponent</a> or <a href='/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component#customerhistoryentrycomponent'>CustomerHistoryEntryComponent</a> respectively.
+you should implement <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component#orderhistoryentrycomponent">OrderHistoryEntryComponent</DocsLink> or <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component#customerhistoryentrycomponent">CustomerHistoryEntryComponent</DocsLink> respectively.
 
 ```ts title="Signature"
 interface HistoryEntryComponent {
@@ -31,24 +27,24 @@ interface HistoryEntryComponent {
 The HistoryEntry data.
 ### getDisplayType
 
-<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) =&#62; TimelineDisplayType`}   />
+<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => TimelineDisplayType`}   />
 
 Defines whether this entry is highlighted with a "success", "error" etc. color.
 ### isFeatured
 
-<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) =&#62; boolean`}   />
+<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => boolean`}   />
 
 Featured entries are always expanded. Non-featured entries start of collapsed and can be clicked
 to expand.
 ### getName
 
-<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) =&#62; string | undefined`}   />
+<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => string | undefined`}   />
 
 Returns the name of the person who did this action. For example, it could be the Customer's name
 or "Administrator".
 ### getIconShape
 
-<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) =&#62; string | string[] | undefined`}   />
+<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => string | string[] | undefined`}   />
 
 Optional Clarity icon shape to display with the entry. Examples: `'note'`, `['success-standard', 'is-solid']`
 

package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx

@@ -2,13 +2,9 @@
 title: "HistoryEntryConfig"
 generated: true
 ---
-
-
-## HistoryEntryConfig
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="75" packageName="@vendure/admin-ui" since="1.9.0" />
 
-Configuration for registering a custom <a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a>.
+Configuration for registering a custom <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent">HistoryEntryComponent</DocsLink>.
 
 ```ts title="Signature"
 interface HistoryEntryConfig {
@@ -26,7 +22,7 @@ interface HistoryEntryConfig {
 The type should correspond to the custom HistoryEntryType string.
 ### component
 
-<MemberInfo kind="property" type={`Type&#60;<a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a>&#62;`}   />
+<MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a>>`}   />
 
 The component to be rendered for this history entry type.
 

package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx

@@ -2,13 +2,9 @@
 title: "OrderHistoryEntryComponent"
 generated: true
 ---
-
-
-## OrderHistoryEntryComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="53" packageName="@vendure/admin-ui" since="1.9.0" />
 
-Used to implement a <a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a> which requires access to the Order object.
+Used to implement a <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent">HistoryEntryComponent</DocsLink> which requires access to the Order object.
 
 ```ts title="Signature"
 interface OrderHistoryEntryComponent extends HistoryEntryComponent {

package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx

@@ -2,13 +2,9 @@
 title: "RegisterHistoryEntryComponent"
 generated: true
 ---
-
-
-## registerHistoryEntryComponent
-
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-history-entry-component.ts" sourceLine="68" packageName="@vendure/admin-ui" since="1.9.0" />
 
-Registers a <a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a> for displaying history entries in the Order/Customer
+Registers a <DocsLink href="/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent">HistoryEntryComponent</DocsLink> for displaying history entries in the Order/Customer
 history timeline.
 
 *Example*