npm - @vendure/docs - Versions diffs - 0.0.0-202601211551 → 0.0.0-202601211609 - Mend

@vendure/docs 0.0.0-202601211551 → 0.0.0-202601211609

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (358) hide show

package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx CHANGED Viewed

@@ -46,7 +46,7 @@ The [NotificationService](/reference/admin-ui-api/services/notification-service)
 displaying notifications to the user.
 ### entity$
-<MemberInfo kind="property" type={`Observable<Record<string, any> | undefined>`}  since="2.2.0"  />
+<MemberInfo kind="property" type={``Observable<Record<string, any> | undefined>``}  since="2.2.0"  />
 An observable of the current entity in a detail view. In a list view the observable will not emit any values.

package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx CHANGED Viewed

@@ -45,13 +45,13 @@ The location in the UI where this menu item should be displayed.
 Whether to render a divider above this item.
 ### buttonState
-<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => Observable<ActionBarButtonState | undefined>`}   />
+<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>`) => Observable<ActionBarButtonState | undefined>``}   />
 A function which returns an observable of the button state, allowing you to
 dynamically enable/disable or show/hide the button.
 ### onClick
-<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => void`}   />
+<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>`) => void``}   />
 ### routerLink

package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx CHANGED Viewed

@@ -42,18 +42,18 @@ e.g. `invoice-plugin.print-invoice`.
 The location in the UI where this button should be displayed.
 ### disabled
-<MemberInfo kind="property" type={`Observable<boolean>`}   />
+<MemberInfo kind="property" type={``Observable<boolean>``}   />
 Deprecated since v2.1.0 - use `buttonState` instead.
 ### buttonState
-<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => Observable<ActionBarButtonState>`}  since="2.1.0"  />
+<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>`) => Observable<ActionBarButtonState>``}  since="2.1.0"  />
 A function which returns an observable of the button state, allowing you to
 dynamically enable/disable or show/hide the button.
 ### onClick
-<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => void`}   />
+<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>`) => void``}   />
 ### routerLink

package/docs/reference/admin-ui-api/alerts/alert-config.mdx CHANGED Viewed

@@ -30,7 +30,7 @@ interface AlertConfig<T = any> {
 A unique identifier for the alert.
 ### check
-<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => T | Promise<T> | Observable<T>`}   />
+<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>`) => T | Promise<T> | Observable<T>``}   />
 A function which is gets the data used to determine whether the alert should be shown.
 Typically, this function will query the server or some other remote data source.
@@ -39,7 +39,7 @@ This function will be called once when the Admin UI app bootstraps, and can be a
 set to run at regular intervals by setting the `recheckIntervalMs` property.
 ### recheck
-<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => Observable<any>`} default={`undefined`}   />
+<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>`) => Observable<any>``} default={`undefined`}   />
 A function which returns an Observable which is used to determine when to re-run the `check`
 function. Whenever the observable emits, the `check` function will be called again.
@@ -58,18 +58,18 @@ recheck: () => interval(60_000)
 If this is not set, the `check` function will only be called once when the Admin UI app bootstraps.
 ### isAlert
-<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => boolean`}   />
+<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>`) => boolean``}   />
 A function which determines whether the alert should be shown based on the data returned by the `check`
 function.
 ### action
-<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => void`}   />
+<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>`) => void``}   />
 A function which is called when the alert is clicked in the Admin UI.
 ### label
-<MemberInfo kind="property" type={`(         data: T,         context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>,     ) => { text: string; translationVars?: { [key: string]: string | number } }`}   />
+<MemberInfo kind="property" type={`(         data: T,         context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>`,     ) => { text: string; translationVars?: { [key: string]: string | number } }``}   />
 A function which returns the text used in the UI to describe the alert.
 ### requiredPermissions

package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx CHANGED Viewed

@@ -37,7 +37,7 @@ interface BulkAction<ItemType = any, ComponentType = any> {
 ### getTranslationVars
-<MemberInfo kind="property" type={`(         context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a>`<ItemType, ComponentType>`,     ) => Record<string, string | number> | Promise<Record<string, string | number>>`}   />
+<MemberInfo kind="property" type={`(         context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a>`<ItemType, ComponentType>,     ) => Record<string, string | number> | Promise<Record<string, string | number>>``}   />
 An optional function that should resolve to a map of translation variables which can be
 used when translating the `label` string.
@@ -60,12 +60,12 @@ A class to be added to the icon element. Examples:
 - is-highlight
 ### onClick
-<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionclickcontext'>BulkActionClickContext</a>`<ItemType, ComponentType>`) => void`}   />
+<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionclickcontext'>BulkActionClickContext</a>`<ItemType, ComponentType>) => void``}   />
 Defines the logic that executes when the bulk action button is clicked.
 ### isVisible
-<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a>`<ItemType, ComponentType>`) => boolean | Promise<boolean>`}   />
+<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a>`<ItemType, ComponentType>) => boolean | Promise<boolean>``}   />
 A function that determines whether this bulk action item should be displayed in the menu.
 If not defined, the item will always be displayed.
@@ -91,7 +91,7 @@ registerBulkAction({
 ```
 ### requiresPermission
-<MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`}   />
+<MemberInfo kind="property" type={``string | ((userPermissions: string[]) => boolean)``}   />
 Control the display of this item based on the user permissions.
@@ -199,7 +199,7 @@ interface BulkActionClickContext<ItemType, ComponentType> extends BulkActionFunc
 ### clearSelection
-<MemberInfo kind="property" type={`() => void`}   />
+<MemberInfo kind="property" type={``() => void``}   />
 Clears the selection in the active list view.
 ### event

package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx CHANGED Viewed

@@ -57,12 +57,12 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
 ### assets$
-<MemberInfo kind="property" type={`Observable<AssetLike[]>`}   />
+<MemberInfo kind="property" type={``Observable<AssetLike[]>``}   />
 ### allTags$
-<MemberInfo kind="property" type={`Observable<TagFragment[]>`}   />
+<MemberInfo kind="property" type={``Observable<TagFragment[]>``}   />
 ### paginationConfig
@@ -82,7 +82,7 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
 ### resolveWith
-<MemberInfo kind="property" type={`(result?: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`}   />
+<MemberInfo kind="property" type={`(result?: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`[]) => void``}   />
 ### selection

package/docs/reference/admin-ui-api/components/currency-input-component.mdx CHANGED Viewed

@@ -76,12 +76,12 @@ class CurrencyInputComponent implements ControlValueAccessor, OnInit, OnChanges,
 ### prefix$
-<MemberInfo kind="property" type={`Observable<string>`}   />
+<MemberInfo kind="property" type={``Observable<string>``}   />
 ### suffix$
-<MemberInfo kind="property" type={`Observable<string>`}   />
+<MemberInfo kind="property" type={``Observable<string>``}   />
 ### hasFractionPart
@@ -91,12 +91,12 @@ class CurrencyInputComponent implements ControlValueAccessor, OnInit, OnChanges,
 ### onChange
-<MemberInfo kind="property" type={`(val: any) => void`}   />
+<MemberInfo kind="property" type={``(val: any) => void``}   />
 ### onTouch
-<MemberInfo kind="property" type={`() => void`}   />
+<MemberInfo kind="property" type={``() => void``}   />
 ### _inputValue

package/docs/reference/admin-ui-api/components/data-table-component.mdx CHANGED Viewed

@@ -125,7 +125,7 @@ class DataTableComponent<T> implements AfterContentInit, OnChanges, OnInit, OnDe
 ### selectionManager
-<MemberInfo kind="property" type={`SelectionManager<T>`}   />
+<MemberInfo kind="property" type={``SelectionManager<T>``}   />
 ### pageChange
@@ -145,7 +145,7 @@ class DataTableComponent<T> implements AfterContentInit, OnChanges, OnInit, OnDe
 ### isRowSelectedFn
-<MemberInfo kind="property" type={`((item: T) => boolean) | undefined`}   />
+<MemberInfo kind="property" type={``((item: T) => boolean) | undefined``}   />
 ### allSelectChange
@@ -160,17 +160,17 @@ class DataTableComponent<T> implements AfterContentInit, OnChanges, OnInit, OnDe
 ### columns
-<MemberInfo kind="property" type={`QueryList<DataTableColumnComponent>`}   />
+<MemberInfo kind="property" type={``QueryList<DataTableColumnComponent>``}   />
 ### templateRefs
-<MemberInfo kind="property" type={`QueryList<TemplateRef<any>>`}   />
+<MemberInfo kind="property" type={``QueryList<TemplateRef<any>>``}   />
 ### rowTemplate
-<MemberInfo kind="property" type={`TemplateRef<any>`}   />
+<MemberInfo kind="property" type={``TemplateRef<any>``}   />
 ### currentStart

package/docs/reference/admin-ui-api/components/data-table2component.mdx CHANGED Viewed

@@ -181,12 +181,12 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
 ### columns
-<MemberInfo kind="property" type={`QueryList<DataTable2ColumnComponent<T>>`}   />
+<MemberInfo kind="property" type={``QueryList<DataTable2ColumnComponent<T>>``}   />
 ### customFieldColumns
-<MemberInfo kind="property" type={`QueryList<DataTableCustomFieldColumnComponent<T>>`}   />
+<MemberInfo kind="property" type={``QueryList<DataTableCustomFieldColumnComponent<T>>``}   />
 ### searchComponent
@@ -201,12 +201,12 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
 ### customSearchTemplate
-<MemberInfo kind="property" type={`TemplateRef<any>`}   />
+<MemberInfo kind="property" type={``TemplateRef<any>``}   />
 ### templateRefs
-<MemberInfo kind="property" type={`QueryList<TemplateRef<any>>`}   />
+<MemberInfo kind="property" type={``QueryList<TemplateRef<any>>``}   />
 ### injector
@@ -241,7 +241,7 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
 ### rowTemplate
-<MemberInfo kind="property" type={`TemplateRef<any>`}   />
+<MemberInfo kind="property" type={``TemplateRef<any>``}   />
 ### currentStart
@@ -266,7 +266,7 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
 ### uiLanguage$
-<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`}   />
+<MemberInfo kind="property" type={``Observable<`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`>``}   />
 ### destroy$
@@ -316,7 +316,7 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
 ### onColumnReorder
-<MemberInfo kind="method" type={`(event: { column: DataTable2ColumnComponent<any>; newIndex: number }) => `}   />
+<MemberInfo kind="method" type={`(event: `{ column: DataTable2ColumnComponent<any>; newIndex: number }`) => `}   />
 ### onColumnsReset

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

@@ -99,12 +99,12 @@ Sets the readonly state
 ### datetimeInput
-<MemberInfo kind="property" type={`ElementRef<HTMLInputElement>`}   />
+<MemberInfo kind="property" type={``ElementRef<HTMLInputElement>``}   />
 ### calendarTable
-<MemberInfo kind="property" type={`ElementRef<HTMLTableElement>`}   />
+<MemberInfo kind="property" type={``ElementRef<HTMLTableElement>``}   />
 ### disabled
@@ -114,27 +114,27 @@ Sets the readonly state
 ### calendarView$
-<MemberInfo kind="property" type={`Observable<CalendarView>`}   />
+<MemberInfo kind="property" type={``Observable<CalendarView>``}   />
 ### current$
-<MemberInfo kind="property" type={`Observable<CurrentView>`}   />
+<MemberInfo kind="property" type={``Observable<CurrentView>``}   />
 ### selected$
-<MemberInfo kind="property" type={`Observable<Date | null>`}   />
+<MemberInfo kind="property" type={``Observable<Date | null>``}   />
 ### selectedHours$
-<MemberInfo kind="property" type={`Observable<number | null>`}   />
+<MemberInfo kind="property" type={``Observable<number | null>``}   />
 ### selectedMinutes$
-<MemberInfo kind="property" type={`Observable<number | null>`}   />
+<MemberInfo kind="property" type={``Observable<number | null>``}   />
 ### years

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

@@ -68,7 +68,7 @@ class DropdownComponent {
 ### onOpenChange
-<MemberInfo kind="method" type={`(callback: (isOpen: boolean) => void) => `}   />
+<MemberInfo kind="method" type={`(callback: `(isOpen: boolean) => void`) => `}   />
 ### setTriggerElement

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

@@ -57,7 +57,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 ### transformControlValueAccessorValue
-<MemberInfo kind="property" type={`(value: FacetValueFragment[]) => any[]`}   />
+<MemberInfo kind="property" type={``(value: FacetValueFragment[]) => any[]``}   />
 ### searchInput$
@@ -72,7 +72,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 ### searchResults$
-<MemberInfo kind="property" type={`Observable<FacetValueFragment[]>`}   />
+<MemberInfo kind="property" type={``Observable<FacetValueFragment[]>``}   />
 ### selectedIds$
@@ -82,12 +82,12 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 ### onChangeFn
-<MemberInfo kind="property" type={`(val: any) => void`}   />
+<MemberInfo kind="property" type={``(val: any) => void``}   />
 ### onTouchFn
-<MemberInfo kind="property" type={`() => void`}   />
+<MemberInfo kind="property" type={``() => void``}   />
 ### disabled
@@ -97,7 +97,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 ### value
-<MemberInfo kind="property" type={`Array<string | FacetValueFragment>`}   />
+<MemberInfo kind="property" type={``Array<string | FacetValueFragment>``}   />
 ### constructor
@@ -142,7 +142,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
 ### writeValue
-<MemberInfo kind="method" type={`(obj: string | FacetValueFragment[] | Array<string | number> | 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 CHANGED Viewed

@@ -58,7 +58,7 @@ class ObjectTreeComponent implements OnChanges {
 ### entries
-<MemberInfo kind="property" type={`Array<{ key: string; value: any }>`}   />
+<MemberInfo kind="property" type={``Array<{ key: string; value: any }>``}   />
 ### constructor

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

@@ -42,7 +42,7 @@ class ProductVariantSelectorComponent implements OnInit {
 ### searchResults$
-<MemberInfo kind="property" type={`Observable<ProductSelectorSearchQuery['search']['items']>`}   />
+<MemberInfo kind="property" type={``Observable<ProductSelectorSearchQuery['search']['items']>``}   />
 ### productSelected

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

@@ -50,12 +50,12 @@ class RichTextEditorComponent implements ControlValueAccessor, AfterViewInit, On
 ### onChange
-<MemberInfo kind="property" type={`(val: any) => void`}   />
+<MemberInfo kind="property" type={``(val: any) => void``}   />
 ### onTouch
-<MemberInfo kind="property" type={`() => void`}   />
+<MemberInfo kind="property" type={``() => void``}   />
 ### constructor

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

@@ -46,7 +46,7 @@ class ZoneSelectorComponent implements ControlValueAccessor {
 ### transformControlValueAccessorValue
-<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined) => any`}   />
+<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>` | undefined) => any``}   />
 ### selectedId$
@@ -56,12 +56,12 @@ class ZoneSelectorComponent implements ControlValueAccessor {
 ### onChangeFn
-<MemberInfo kind="property" type={`(val: any) => void`}   />
+<MemberInfo kind="property" type={``(val: any) => void``}   />
 ### onTouchFn
-<MemberInfo kind="property" type={`() => void`}   />
+<MemberInfo kind="property" type={``() => void``}   />
 ### disabled

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

@@ -23,7 +23,7 @@ interface CustomDetailComponentConfig {
 ### component
-<MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a>>`}   />
+<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.mdx CHANGED Viewed

@@ -18,7 +18,7 @@ interface CustomDetailComponent {
 ### entity$
-<MemberInfo kind="property" type={`Observable<any>`}   />
+<MemberInfo kind="property" type={``Observable<any>``}   />
 ### detailForm

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

@@ -27,24 +27,24 @@ interface HistoryEntryComponent {
 The HistoryEntry data.
 ### getDisplayType
-<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => 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) => 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) => 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) => 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 CHANGED Viewed

@@ -22,7 +22,7 @@ interface HistoryEntryConfig {
 The type should correspond to the custom HistoryEntryType string.
 ### component
-<MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a>>`}   />
+<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.