npm - @vendure/docs - Versions diffs - 0.0.0-202601210957 → 0.0.0-202601211028 - Mend

@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211028

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 (582) hide show

package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Default Inputs"
 generated: true
 ---
-## BooleanFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/boolean-form-input/boolean-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 A checkbox input. The default input component for `boolean` fields.
@@ -47,10 +43,6 @@ class BooleanFormInputComponent implements FormInputComponent {
 </div>
-## HtmlEditorFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/code-editor-form-input/html-editor-form-input.component.ts" sourceLine="23" packageName="@vendure/admin-ui" />
 A JSON editor input with syntax highlighting and error detection. Works well
@@ -90,10 +82,6 @@ class HtmlEditorFormInputComponent extends BaseCodeEditorFormInputComponent impl
 </div>
-## JsonEditorFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/code-editor-form-input/json-editor-form-input.component.ts" sourceLine="33" packageName="@vendure/admin-ui" />
 A JSON editor input with syntax highlighting and error detection. Works well
@@ -133,10 +121,6 @@ class JsonEditorFormInputComponent extends BaseCodeEditorFormInputComponent impl
 </div>
-## CombinationModeFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/combination-mode-form-input/combination-mode-form-input.component.ts" sourceLine="17" packageName="@vendure/admin-ui" />
 A special input used to display the "Combination mode" AND/OR toggle.
@@ -208,10 +192,6 @@ class CombinationModeFormInputComponent implements FormInputComponent, OnInit {
 </div>
-## CurrencyFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/currency-form-input/currency-form-input.component.ts" sourceLine="17" packageName="@vendure/admin-ui" />
 An input for monetary values. Should be used with `int` type fields.
@@ -265,10 +245,6 @@ class CurrencyFormInputComponent implements FormInputComponent {
 </div>
-## CustomerGroupFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/customer-group-form-input/customer-group-form-input.component.ts" sourceLine="20" packageName="@vendure/admin-ui" />
 Allows the selection of a Customer via an autocomplete select input.
@@ -341,10 +317,6 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
 </div>
-## DateFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/date-form-input/date-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 Allows selection of a datetime. Default input for `datetime` type fields.
@@ -404,10 +376,6 @@ class DateFormInputComponent implements FormInputComponent {
 </div>
-## FacetValueFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/facet-value-form-input/facet-value-form-input.component.ts" sourceLine="16" packageName="@vendure/admin-ui" />
 Allows the selection of multiple FacetValues via an autocomplete select input.
@@ -469,10 +437,6 @@ class FacetValueFormInputComponent implements FormInputComponent {
 </div>
-## NumberFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/number-form-input/number-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 Displays a number input. Default input for `int` and `float` type fields.
@@ -544,10 +508,6 @@ class NumberFormInputComponent implements FormInputComponent {
 </div>
-## PasswordFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/password-form-input/password-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 Displays a password text input. Should be used with `string` type fields.
@@ -589,10 +549,6 @@ class PasswordFormInputComponent implements FormInputComponent {
 </div>
-## ProductSelectorFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/product-selector-form-input/product-selector-form-input.component.ts" sourceLine="20" packageName="@vendure/admin-ui" />
 Allows the selection of multiple ProductVariants via an autocomplete select input.
@@ -671,15 +627,11 @@ class ProductSelectorFormInputComponent implements FormInputComponent, OnInit {
 </div>
-## RelationFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/relation-form-input/relation-form-input.component.ts" sourceLine="17" packageName="@vendure/admin-ui" />
 The default input component for `relation` type custom fields. Allows the selection
 of a ProductVariant, Product, Customer or Asset. For other entity types, a custom
-implementation will need to be defined. See <a href='/reference/admin-ui-api/custom-input-components/register-form-input-component#registerforminputcomponent'>registerFormInputComponent</a>.
+implementation will need to be defined. See <DocsLink href="/reference/admin-ui-api/custom-input-components/register-form-input-component#registerforminputcomponent">registerFormInputComponent</DocsLink>.
 ```ts title="Signature"
 class RelationFormInputComponent implements FormInputComponent {
@@ -718,13 +670,9 @@ class RelationFormInputComponent implements FormInputComponent {
 </div>
-## RichTextFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/rich-text-form-input/rich-text-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
-Uses the <a href='/reference/admin-ui-api/components/rich-text-editor-component#richtexteditorcomponent'>RichTextEditorComponent</a> as in input for `text` type fields.
+Uses the <DocsLink href="/reference/admin-ui-api/components/rich-text-editor-component#richtexteditorcomponent">RichTextEditorComponent</DocsLink> as in input for `text` type fields.
 ```ts title="Signature"
 class RichTextFormInputComponent implements FormInputComponent {
@@ -763,10 +711,6 @@ class RichTextFormInputComponent implements FormInputComponent {
 </div>
-## SelectFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/select-form-input/select-form-input.component.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 Uses a select input to allow the selection of a string value. Should be used with
@@ -839,10 +783,6 @@ class SelectFormInputComponent implements FormInputComponent, OnInit {
 </div>
-## StructFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/struct-form-input/struct-form-input.component.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 A checkbox input. The default input component for `boolean` fields.
@@ -923,10 +863,6 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
 </div>
-## TextFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/text-form-input/text-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 Uses a regular text form input. This is the default input for `string` and `localeString` type fields.
@@ -980,10 +916,6 @@ class TextFormInputComponent implements FormInputComponent {
 </div>
-## TextareaFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/textarea-form-input/textarea-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 Uses textarea form input. This is the default input for `text` type fields.

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

@@ -2,10 +2,6 @@
 title: "FormInputComponent"
 generated: true
 ---
-## FormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="11" packageName="@vendure/admin-ui" />
 This interface should be implemented by any component being used as a custom input. For example,

package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "RegisterFormInputComponent"
 generated: true
 ---
-## registerFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-form-input-component.ts" sourceLine="53" packageName="@vendure/admin-ui" />
 Registers a custom FormInputComponent which can be used to control the argument inputs
-of a <a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a> (e.g. CollectionFilter, ShippingMethod etc.) or for
+of a <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">ConfigurableOperationDef</DocsLink> (e.g. CollectionFilter, ShippingMethod etc.) or for
 a custom field.
 *Example*
@@ -45,7 +41,7 @@ const config: VendureConfig = {
 }
 ```
-or with an argument of a <a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a>:
+or with an argument of a <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">ConfigurableOperationDef</DocsLink>:
 *Example*

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

@@ -2,10 +2,6 @@
 title: "CustomColumnComponent"
 generated: true
 ---
-## CustomColumnComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table-2/data-table-custom-component.service.ts" sourceLine="44" packageName="@vendure/admin-ui" />
 Components which are to be used to render custom cells in a data table should implement this interface.

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

@@ -2,13 +2,9 @@
 title: "DataTableComponentConfig"
 generated: true
 ---
-## DataTableComponentConfig
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table-2/data-table-custom-component.service.ts" sourceLine="54" 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 DataTableComponentConfig {
@@ -36,7 +32,7 @@ The column in the table where the custom component should be placed.
 <MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a>>`}   />
 The component to render in the table cell. This component should implement the
-<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a> interface.
+<DocsLink href="/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent">CustomColumnComponent</DocsLink> interface.
 ### providers
 <MemberInfo kind="property" type={`Provider[]`}   />

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

@@ -2,14 +2,10 @@
 title: "RegisterDataTableComponent"
 generated: true
 ---
-## registerDataTableComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-data-table-component.ts" sourceLine="45" packageName="@vendure/admin-ui" />
 Allows you to override the default component used to render the data of a particular column in a DataTable.
-The component should implement the <a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a> interface. The tableId and columnId can
+The component should implement the <DocsLink href="/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent">CustomColumnComponent</DocsLink> interface. The tableId and columnId can
 be determined by pressing `ctrl + u` when running the Admin UI in dev mode.
 *Example*

package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "DashboardWidgetConfig"
 generated: true
 ---
-## DashboardWidgetConfig
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/dashboard-widget/dashboard-widget-types.ts" sourceLine="11" packageName="@vendure/admin-ui" />
 A configuration object for a dashboard widget.

package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "RegisterDashboardWidget"
 generated: true
 ---
-## registerDashboardWidget
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-dashboard-widget.ts" sourceLine="16" packageName="@vendure/admin-ui" />
 Registers a dashboard widget. Once registered, the widget can be set as part of the default
-(using <a href='/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout#setdashboardwidgetlayout'>setDashboardWidgetLayout</a>).
+(using <DocsLink href="/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout#setdashboardwidgetlayout">setDashboardWidgetLayout</DocsLink>).
 ```ts title="Signature"
 function registerDashboardWidget(id: string, config: DashboardWidgetConfig): void

package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "SetDashboardWidgetLayout"
 generated: true
 ---
-## setDashboardWidgetLayout
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-dashboard-widget.ts" sourceLine="31" packageName="@vendure/admin-ui" />
 Sets the default widget layout for the Admin UI dashboard.

package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "WidgetLayoutDefinition"
 generated: true
 ---
-## WidgetLayoutDefinition
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/dashboard-widget/dashboard-widget-types.ts" sourceLine="51" packageName="@vendure/admin-ui" />
 A configuration object for the default dashboard widget layout.

package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "IfMultichannelDirective"
 generated: true
 ---
-## IfMultichannelDirective
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/directives/if-multichannel.directive.ts" sourceLine="21" packageName="@vendure/admin-ui" />
 Structural directive that displays the given element if the Vendure instance has multiple channels

package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "IfPermissionsDirective"
 generated: true
 ---
-## IfPermissionsDirective
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/directives/if-permissions.directive.ts" sourceLine="26" packageName="@vendure/admin-ui" />
 Conditionally shows/hides templates based on the current active user having the specified permission.

package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "BaseDetailComponent"
 generated: true
 ---
-## BaseDetailComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="57" packageName="@vendure/admin-ui" />
 A base class for entity detail views. It should be used in conjunction with the
-<a href='/reference/admin-ui-api/list-detail-views/base-entity-resolver#baseentityresolver'>BaseEntityResolver</a>.
+<DocsLink href="/reference/admin-ui-api/list-detail-views/base-entity-resolver#baseentityresolver">BaseEntityResolver</DocsLink>.
 *Example*

package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx CHANGED Viewed

@@ -2,15 +2,11 @@
 title: "BaseEntityResolver"
 generated: true
 ---
-## BaseEntityResolver
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-entity-resolver.ts" sourceLine="55" packageName="@vendure/admin-ui" />
 A base resolver for an entity detail route. Resolves to an observable of the given entity, or a "blank"
 version if the route id equals "create". Should be used together with details views which extend the
-<a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a>.
+<DocsLink href="/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent">BaseDetailComponent</DocsLink>.
 *Example*

package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx CHANGED Viewed

@@ -2,16 +2,12 @@
 title: "BaseListComponent"
 generated: true
 ---
-## BaseListComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-list.component.ts" sourceLine="43" packageName="@vendure/admin-ui" />
 This is a base class which implements the logic required to fetch and manipulate
 a list of data from a query which returns a PaginatedList type.
-It is normally used in combination with the <a href='/reference/admin-ui-api/components/data-table2component#datatable2component'>DataTable2Component</a>.
+It is normally used in combination with the <DocsLink href="/reference/admin-ui-api/components/data-table2component#datatable2component">DataTable2Component</DocsLink>.
 ```ts title="Signature"
 class BaseListComponent<ResultType, ItemType, VariableType extends Record<string, any> = any> implements OnInit, OnDestroy {

package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "DetailComponentWithResolver"
 generated: true
 ---
-## detailComponentWithResolver
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="256" packageName="@vendure/admin-ui" />
-A helper function for creating tabs that point to a <a href='/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent'>TypedBaseDetailComponent</a>. This takes
+A helper function for creating tabs that point to a <DocsLink href="/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent">TypedBaseDetailComponent</DocsLink>. This takes
 care of the route resolver parts so that the detail component automatically has access to the
 correct resolved detail data.

package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "TypedBaseDetailComponent"
 generated: true
 ---
-## TypedBaseDetailComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="186" packageName="@vendure/admin-ui" />
-A version of the <a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a> which is designed to be used with a
+A version of the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent">BaseDetailComponent</DocsLink> which is designed to be used with a
 [TypedDocumentNode](https://the-guild.dev/graphql/codegen/plugins/typescript/typed-document-node).
 ```ts title="Signature"

package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "TypedBaseListComponent"
 generated: true
 ---
-## TypedBaseListComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-list.component.ts" sourceLine="217" packageName="@vendure/admin-ui" />
-A version of the <a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a> which is designed to be used with a
+A version of the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent">BaseListComponent</DocsLink> which is designed to be used with a
 [TypedDocumentNode](https://the-guild.dev/graphql/codegen/plugins/typescript/typed-document-node).
 ```ts title="Signature"

package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "AddNavMenuItem"
 generated: true
 ---
-## addNavMenuItem
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-nav-menu-item.ts" sourceLine="66" packageName="@vendure/admin-ui" />
 Add a menu item to an existing section specified by `sectionId`. The id of the section

package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "AddNavMenuSection"
 generated: true
 ---
-## addNavMenuSection
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-nav-menu-item.ts" sourceLine="30" packageName="@vendure/admin-ui" />
 Add a section to the main nav menu. Providing the `before` argument will

package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "NavMenuItem"
 generated: true
 ---
-## NavMenuItem
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="37" packageName="@vendure/admin-ui" />
 A NavMenuItem is a menu item in the main (left-hand side) nav

package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "NavMenuSection"
 generated: true
 ---
-## NavMenuSection
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="57" packageName="@vendure/admin-ui" />
 A NavMenuSection is a grouping of links in the main
@@ -56,7 +52,7 @@ interface NavMenuSection {
 <MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`}   />
 Control the display of this item based on the user permissions. Note: if you attempt to pass a
-<a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a> object, you will get a compilation error. Instead, pass the plain
+<DocsLink href="/reference/typescript-api/auth/permission-definition#permissiondefinition">PermissionDefinition</DocsLink> object, you will get a compilation error. Instead, pass the plain
 string version. For example, if the permission is defined as:
 ```ts
 export const MyPermission = new PermissionDefinition('ProductReview');

package/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Navigation Types"
 generated: true
 ---
-## NavMenuBadge
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="19" packageName="@vendure/admin-ui" />
 A color-coded notification badge which will be displayed by the

package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "AssetPreviewPipe"
 generated: true
 ---
-## AssetPreviewPipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/asset-preview.pipe.ts" sourceLine="19" packageName="@vendure/admin-ui" />
 Given an Asset object (an object with `preview` and optionally `focalPoint` properties), this pipe

package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "DurationPipe"
 generated: true
 ---
-## DurationPipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/duration.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 Displays a number of milliseconds in a more human-readable format,

package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "FileSizePipe"
 generated: true
 ---
-## FileSizePipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/file-size.pipe.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 Formats a number into a human-readable file size string.

package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "HasPermissionPipe"
 generated: true
 ---
-## HasPermissionPipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/has-permission.pipe.ts" sourceLine="16" packageName="@vendure/admin-ui" />
 A pipe which checks the provided permission against all the permissions of the current user.

package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "LocaleCurrencyNamePipe"
 generated: true
 ---
-## LocaleCurrencyNamePipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-currency-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 Displays a human-readable name for a given ISO 4217 currency code.

package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "LocaleCurrencyPipe"
 generated: true
 ---
-## LocaleCurrencyPipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-currency.pipe.ts" sourceLine="20" packageName="@vendure/admin-ui" />
 Formats a Vendure monetary value (in cents) into the correct format for the configured currency and display

package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "LocaleDatePipe"
 generated: true
 ---
-## LocaleDatePipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-date.pipe.ts" sourceLine="19" packageName="@vendure/admin-ui" />
 A replacement of the Angular DatePipe which makes use of the Intl API

package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "LocaleLanguageNamePipe"
 generated: true
 ---
-## LocaleLanguageNamePipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-language-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 Displays a human-readable name for a given ISO 639-1 language code.

package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "LocaleRegionNamePipe"
 generated: true
 ---
-## LocaleRegionNamePipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-region-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 Displays a human-readable name for a given region.