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/pipes/time-ago-pipe.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "TimeAgoPipe"
 generated: true
 ---
-## TimeAgoPipe
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/time-ago.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
 Converts a date into the format "3 minutes ago", "5 hours ago" etc.

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

@@ -2,10 +2,6 @@
 title: "ActionBar"
 generated: true
 ---
-## ActionBar
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/ActionBar.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 A container for the primary actions on a list or detail page

package/docs/reference/admin-ui-api/react-components/card.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Card"
 generated: true
 ---
-## Card
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/Card.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 A card component which can be used to group related content.

package/docs/reference/admin-ui-api/react-components/cds-icon.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "CdsIcon"
 generated: true
 ---
-## CdsIcon
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/CdsIcon.tsx" sourceLine="47" packageName="@vendure/admin-ui" />
 A React wrapper for the Clarity UI icon component.

package/docs/reference/admin-ui-api/react-components/form-field.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "FormField"
 generated: true
 ---
-## FormField
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/FormField.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 A wrapper around form fields which provides a label, tooltip and error message.

package/docs/reference/admin-ui-api/react-components/link.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Link"
 generated: true
 ---
-## Link
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/Link.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 A React component which renders an anchor tag and navigates to the specified route when clicked.

package/docs/reference/admin-ui-api/react-components/page-block.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "PageBlock"
 generated: true
 ---
-## PageBlock
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/PageBlock.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 A container for page content which provides a consistent width and spacing.

package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "PageDetailLayout"
 generated: true
 ---
-## PageDetailLayout
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/PageDetailLayout.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
 A responsive container for detail views with a main content area and an optional sidebar.

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

@@ -2,10 +2,6 @@
 title: "RichTextEditor"
 generated: true
 ---
-## RichTextEditor
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/RichTextEditor.tsx" sourceLine="60" packageName="@vendure/admin-ui" />
 A rich text editor component which uses ProseMirror (rich text editor) under the hood.

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

@@ -2,10 +2,6 @@
 title: "ReactCustomDetailComponentConfig"
 generated: true
 ---
-## ReactCustomDetailComponentConfig
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-custom-detail-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
 Configures a React-based component to be placed in a detail page in the given location.

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

@@ -2,13 +2,9 @@
 title: "ReactDataTableComponentConfig"
 generated: true
 ---
-## ReactDataTableComponentConfig
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-data-table-component.ts" sourceLine="19" 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 ReactDataTableComponentConfig {

package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "RegisterReactCustomDetailComponent"
 generated: true
 ---
-## registerReactCustomDetailComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-custom-detail-component.ts" sourceLine="40" packageName="@vendure/admin-ui" />
 Registers a React component to be rendered in a detail page in the given location.
-Components used as custom detail components can make use of the <a href='/reference/admin-ui-api/react-hooks/use-detail-component-data#usedetailcomponentdata'>useDetailComponentData</a> hook.
+Components used as custom detail components can make use of the <DocsLink href="/reference/admin-ui-api/react-hooks/use-detail-component-data#usedetailcomponentdata">useDetailComponentData</DocsLink> hook.
 ```ts title="Signature"
 function registerReactCustomDetailComponent(config: ReactCustomDetailComponentConfig): void

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

@@ -2,10 +2,6 @@
 title: "RegisterReactDataTableComponent"
 generated: true
 ---
-## registerReactDataTableComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-data-table-component.ts" sourceLine="90" packageName="@vendure/admin-ui" />
 Registers a React component to be rendered in a data table in the given location.

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

@@ -2,13 +2,9 @@
 title: "RegisterReactFormInputComponent"
 generated: true
 ---
-## registerReactFormInputComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-form-input-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
-Registers a React component to be used as a <a href='/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent'>FormInputComponent</a>.
+Registers a React component to be used as a <DocsLink href="/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent">FormInputComponent</DocsLink>.
 ```ts title="Signature"
 function registerReactFormInputComponent(id: string, component: ElementType): void

package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "RegisterReactRouteComponentOptions"
 generated: true
 ---
-## RegisterReactRouteComponentOptions
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-route-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
 Configuration for a React-based route component.

package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "RegisterReactRouteComponent"
 generated: true
 ---
-## registerReactRouteComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-route-component.ts" sourceLine="30" packageName="@vendure/admin-ui" />
 Registers a React component to be used as a route component.

package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "UseDetailComponentData"
 generated: true
 ---
-## useDetailComponentData
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-detail-component-data.ts" sourceLine="34" packageName="@vendure/admin-ui" />
 Provides the data available to React-based CustomDetailComponents.

package/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "UseFormControl"
 generated: true
 ---
-## useFormControl
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-form-control.ts" sourceLine="31" packageName="@vendure/admin-ui" />
 Provides access to the current FormControl value and a method to update the value.

package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "UseInjector"
 generated: true
 ---
-## useInjector
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-injector.ts" sourceLine="27" packageName="@vendure/admin-ui" />
 Exposes the Angular injector which allows the injection of services into React components.

package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "UseLazyQuery"
 generated: true
 ---
-## useLazyQuery
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-query.ts" sourceLine="119" packageName="@vendure/admin-ui" since="2.2.0" />
 A React hook which allows you to execute a GraphQL query lazily.

package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "UseMutation"
 generated: true
 ---
-## useMutation
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-query.ts" sourceLine="181" packageName="@vendure/admin-ui" />
 A React hook which allows you to execute a GraphQL mutation.

package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "UsePageMetadata"
 generated: true
 ---
-## usePageMetadata
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-page-metadata.ts" sourceLine="31" packageName="@vendure/admin-ui" />
 Provides functions for setting the current page title and breadcrumb.

package/docs/reference/admin-ui-api/react-hooks/use-query.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "UseQuery"
 generated: true
 ---
-## useQuery
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-query.ts" sourceLine="43" packageName="@vendure/admin-ui" />
 A React hook which provides access to the results of a GraphQL query.

package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "UseRichTextEditor"
 generated: true
 ---
-## useRichTextEditor
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-rich-text-editor.ts" sourceLine="40" packageName="@vendure/admin-ui" />
 Provides access to the ProseMirror (rich text editor) instance.

package/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "UseRouteParams"
 generated: true
 ---
-## useRouteParams
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-route-params.ts" sourceLine="23" packageName="@vendure/admin-ui" />
 Provides access to the current route params and query params.

package/docs/reference/admin-ui-api/routes/register-route-component-options.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "RegisterRouteComponentOptions"
 generated: true
 ---
-## RegisterRouteComponentOptions
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-route-component.ts" sourceLine="19" packageName="@vendure/admin-ui" />
 Configuration for a route component.

package/docs/reference/admin-ui-api/routes/register-route-component.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "RegisterRouteComponent"
 generated: true
 ---
-## registerRouteComponent
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-route-component.ts" sourceLine="79" packageName="@vendure/admin-ui" />
 Registers an Angular standalone component to be rendered in a route.

package/docs/reference/admin-ui-api/services/data-service.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "DataService"
 generated: true
 ---
-## DataService
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/data/providers/data.service.ts" sourceLine="34" packageName="@vendure/admin-ui" />
 Used to interact with the Admin API via GraphQL queries. Internally this service uses the
@@ -26,7 +22,7 @@ class DataService {
 <MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`}   />
-Perform a GraphQL query. Returns a <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a> which allows further control over
+Perform a GraphQL query. Returns a <DocsLink href="/reference/admin-ui-api/services/data-service#queryresult">QueryResult</DocsLink> which allows further control over
 they type of result returned, e.g. stream of values, single value etc.
 *Example*
@@ -65,10 +61,6 @@ const result$ = this.dataService.mutate(gql`
 </div>
-## QueryResult
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/data/query-result.ts" sourceLine="31" packageName="@vendure/admin-ui" />
 This class wraps the Apollo Angular QueryRef object and exposes some getters

package/docs/reference/admin-ui-api/services/modal-service.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "ModalService"
 generated: true
 ---
-## ModalService
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.service.ts" sourceLine="21" packageName="@vendure/admin-ui" />
 This service is responsible for instantiating a ModalDialog component and
@@ -30,7 +26,7 @@ class ModalService {
 <MemberInfo kind="method" type={`(component: Type<T> &#38; Type<<a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a><R>>, options?: <a href='/reference/admin-ui-api/services/modal-service#modaloptions'>ModalOptions</a><T>) => Observable<R | undefined>`}   />
-Create a modal from a component. The component must implement the <a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a> interface.
+Create a modal from a component. The component must implement the <DocsLink href="/reference/admin-ui-api/services/modal-service#dialog">Dialog</DocsLink> interface.
 Additionally, the component should include templates for the title and the buttons to be
 displayed in the modal dialog. See example:
@@ -78,10 +74,6 @@ Displays a modal dialog with the provided title, body and buttons.
 </div>
-## Dialog
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.types.ts" sourceLine="9" packageName="@vendure/admin-ui" />
 Any component intended to be used with the ModalService.fromComponent() method must implement
@@ -105,10 +97,6 @@ to this method and then complete.
 </div>
-## DialogConfig
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.types.ts" sourceLine="33" packageName="@vendure/admin-ui" />
 Configures a generic modal dialog.
@@ -153,10 +141,6 @@ interface DialogConfig<T> {
 </div>
-## ModalOptions
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.types.ts" sourceLine="48" packageName="@vendure/admin-ui" />
 Options to configure the behaviour of the modal.

package/docs/reference/admin-ui-api/services/notification-service.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "NotificationService"
 generated: true
 ---
-## NotificationService
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/notification/notification.service.ts" sourceLine="54" packageName="@vendure/admin-ui" />
 Provides toast notification functionality.
@@ -70,10 +66,6 @@ Display a toast notification.
 </div>
-## NotificationType
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/notification/notification.service.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 The types of notification available.
@@ -81,10 +73,6 @@ The types of notification available.
 ```ts title="Signature"
 type NotificationType = 'info' | 'success' | 'error' | 'warning'
 ```
-## ToastConfig
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/notification/notification.service.ts" sourceLine="23" packageName="@vendure/admin-ui" />
 Configuration for a toast notification.

package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "PageTabConfig"
 generated: true
 ---
-## PageTabConfig
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/page/page.service.ts" sourceLine="14" packageName="@vendure/admin-ui" />
 The object used to configure a new page tab.

package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "RegisterPageTab"
 generated: true
 ---
-## registerPageTab
 <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-page-tab.ts" sourceLine="24" packageName="@vendure/admin-ui" />
 Add a tab to an existing list or detail page.

package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "AdminUiExtension"
 generated: true
 ---
-## AdminUiExtension
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="130" packageName="@vendure/ui-devkit" />
 Defines extensions to the Admin UI application by specifying additional
@@ -166,14 +162,10 @@ exclude: ['**/*.spec.ts']
 </div>
-## TranslationExtension
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="18" packageName="@vendure/ui-devkit" />
 Defines extensions to the Admin UI translations. Can be used as a stand-alone extension definition which only adds translations
-without adding new UI functionality, or as part of a full <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextension'>AdminUiExtension</a>.
+without adding new UI functionality, or as part of a full <DocsLink href="/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextension">AdminUiExtension</DocsLink>.
 ```ts title="Signature"
 interface TranslationExtension {
@@ -203,10 +195,6 @@ translations: {
 </div>
-## StaticAssetExtension
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="44" packageName="@vendure/ui-devkit" />
 Defines extensions which copy static assets to the custom Admin UI application source asset directory.
@@ -228,10 +216,6 @@ directory.
 </div>
-## GlobalStylesExtension
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="60" packageName="@vendure/ui-devkit" />
 Defines extensions which add global styles to the custom Admin UI application.
@@ -253,10 +237,6 @@ incorporated into the Admin UI app global stylesheet.
 </div>
-## SassVariableOverridesExtension
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="76" packageName="@vendure/ui-devkit" />
 Defines an extension which allows overriding Clarity Design System's Sass variables used in styles on the Admin UI.
@@ -278,10 +258,6 @@ default values defined in Clarity.
 </div>
-## UiExtensionRouteDefinition
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="92" packageName="@vendure/ui-devkit" />
 Defines a route which will be added to the Admin UI application.
@@ -319,10 +295,6 @@ This is useful when the extension is intended to replace the default Admin UI, r
 </div>
-## StaticAssetDefinition
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="280" packageName="@vendure/ui-devkit" />
 A static asset can be provided as a path to the asset, or as an object containing a path and a new
@@ -331,10 +303,6 @@ name, which will cause the compiler to copy and then rename the asset.
 ```ts title="Signature"
 type StaticAssetDefinition = string | { path: string; rename: string }
 ```
-## AdminUiExtensionSharedModule
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="289" packageName="@vendure/ui-devkit" />
 Configuration defining a single NgModule with which to extend the Admin UI.
@@ -369,10 +337,6 @@ The name of the extension module class.
 </div>
-## AdminUiExtensionLazyModule
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="316" packageName="@vendure/ui-devkit" />
 Configuration defining a single NgModule with which to extend the Admin UI.

package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "CompileUiExtensions"
 generated: true
 ---
-## compileUiExtensions
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/compile.ts" sourceLine="36" packageName="@vendure/ui-devkit" />
 Compiles the Admin UI app with the specified extensions.

package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Helpers"
 generated: true
 ---
-## setBranding
 <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/helpers.ts" sourceLine="26" packageName="@vendure/ui-devkit" />
 A helper function to simplify the process of setting custom branding images.