@vendure/docs 0.0.0-202601201808 → 0.0.0-202601210957
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.
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
- package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +3 -3
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
- package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
- package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
- package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
- package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
- package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
- package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
- package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
- package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
- package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
- package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
- package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
- package/docs/reference/dashboard/page-layout/index.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +3 -3
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
- package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/index.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
- package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
- package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
- package/docs/reference/typescript-api/common/injector.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
- package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/entities/address.mdx +1 -1
- package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +2 -2
- package/docs/reference/typescript-api/entities/country.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer.mdx +1 -1
- package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet.mdx +2 -2
- package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +1 -1
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
- package/docs/reference/typescript-api/entities/product.mdx +2 -2
- package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
- package/docs/reference/typescript-api/entities/province.mdx +1 -1
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +1 -1
- package/docs/reference/typescript-api/entities/role.mdx +1 -1
- package/docs/reference/typescript-api/entities/seller.mdx +1 -1
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
- package/docs/reference/typescript-api/entities/user.mdx +1 -1
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
- package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
- package/docs/reference/typescript-api/events/event-types.mdx +30 -30
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
- package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
- package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
- package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
- package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
- package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
- package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
- package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
- package/docs/reference/typescript-api/services/country-service.mdx +7 -7
- package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
- package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
- package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
- package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +8 -8
- package/docs/reference/typescript-api/services/order-service.mdx +52 -52
- package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
- package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
- package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-service.mdx +13 -13
- package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
- package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
- package/docs/reference/typescript-api/services/province-service.mdx +5 -5
- package/docs/reference/typescript-api/services/role-service.mdx +11 -11
- package/docs/reference/typescript-api/services/search-service.mdx +2 -2
- package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
- package/docs/reference/typescript-api/services/session-service.mdx +8 -8
- package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
- package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
- package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
- package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
- package/docs/reference/typescript-api/services/user-service.mdx +12 -12
- package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
- package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
- package/package.json +1 -1
- package/docs/reference/admin-ui-api/index.mdx +0 -4
- package/docs/reference/dashboard/index.mdx +0 -4
- package/docs/reference/graphql-api/admin/_index.mdx +0 -4
- package/docs/reference/graphql-api/shop/_index.mdx +0 -4
- package/docs/reference/typescript-api/_index.mdx +0 -4
|
@@ -50,7 +50,7 @@ The [NotificationService](/reference/admin-ui-api/services/notification-service)
|
|
|
50
50
|
displaying notifications to the user.
|
|
51
51
|
### entity$
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="property" type={`Observable
|
|
53
|
+
<MemberInfo kind="property" type={`Observable<Record<string, any> | undefined>`} since="2.2.0" />
|
|
54
54
|
|
|
55
55
|
An observable of the current entity in a detail view. In a list view the observable will not emit any values.
|
|
56
56
|
|
|
@@ -49,13 +49,13 @@ The location in the UI where this menu item should be displayed.
|
|
|
49
49
|
Whether to render a divider above this item.
|
|
50
50
|
### buttonState
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>)
|
|
52
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => Observable<ActionBarButtonState | undefined>`} />
|
|
53
53
|
|
|
54
54
|
A function which returns an observable of the button state, allowing you to
|
|
55
55
|
dynamically enable/disable or show/hide the button.
|
|
56
56
|
### onClick
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>)
|
|
58
|
+
<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => void`} />
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
### routerLink
|
|
@@ -46,18 +46,18 @@ e.g. `invoice-plugin.print-invoice`.
|
|
|
46
46
|
The location in the UI where this button should be displayed.
|
|
47
47
|
### disabled
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="property" type={`Observable
|
|
49
|
+
<MemberInfo kind="property" type={`Observable<boolean>`} />
|
|
50
50
|
|
|
51
51
|
Deprecated since v2.1.0 - use `buttonState` instead.
|
|
52
52
|
### buttonState
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>)
|
|
54
|
+
<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" />
|
|
55
55
|
|
|
56
56
|
A function which returns an observable of the button state, allowing you to
|
|
57
57
|
dynamically enable/disable or show/hide the button.
|
|
58
58
|
### onClick
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>)
|
|
60
|
+
<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => void`} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### routerLink
|
|
@@ -34,7 +34,7 @@ interface AlertConfig<T = any> {
|
|
|
34
34
|
A unique identifier for the alert.
|
|
35
35
|
### check
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>)
|
|
37
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => T | Promise<T> | Observable<T>`} />
|
|
38
38
|
|
|
39
39
|
A function which is gets the data used to determine whether the alert should be shown.
|
|
40
40
|
Typically, this function will query the server or some other remote data source.
|
|
@@ -43,7 +43,7 @@ This function will be called once when the Admin UI app bootstraps, and can be a
|
|
|
43
43
|
set to run at regular intervals by setting the `recheckIntervalMs` property.
|
|
44
44
|
### recheck
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>)
|
|
46
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => Observable<any>`} default={`undefined`} />
|
|
47
47
|
|
|
48
48
|
A function which returns an Observable which is used to determine when to re-run the `check`
|
|
49
49
|
function. Whenever the observable emits, the `check` function will be called again.
|
|
@@ -62,18 +62,18 @@ recheck: () => interval(60_000)
|
|
|
62
62
|
If this is not set, the `check` function will only be called once when the Admin UI app bootstraps.
|
|
63
63
|
### isAlert
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>)
|
|
65
|
+
<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => boolean`} />
|
|
66
66
|
|
|
67
67
|
A function which determines whether the alert should be shown based on the data returned by the `check`
|
|
68
68
|
function.
|
|
69
69
|
### action
|
|
70
70
|
|
|
71
|
-
<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>)
|
|
71
|
+
<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => void`} />
|
|
72
72
|
|
|
73
73
|
A function which is called when the alert is clicked in the Admin UI.
|
|
74
74
|
### label
|
|
75
75
|
|
|
76
|
-
<MemberInfo kind="property" type={`( data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>, )
|
|
76
|
+
<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 } }`} />
|
|
77
77
|
|
|
78
78
|
A function which returns the text used in the UI to describe the alert.
|
|
79
79
|
### requiredPermissions
|
|
@@ -41,7 +41,7 @@ interface BulkAction<ItemType = any, ComponentType = any> {
|
|
|
41
41
|
|
|
42
42
|
### getTranslationVars
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="property" type={`( context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a
|
|
44
|
+
<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>>`} />
|
|
45
45
|
|
|
46
46
|
An optional function that should resolve to a map of translation variables which can be
|
|
47
47
|
used when translating the `label` string.
|
|
@@ -64,12 +64,12 @@ A class to be added to the icon element. Examples:
|
|
|
64
64
|
- is-highlight
|
|
65
65
|
### onClick
|
|
66
66
|
|
|
67
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionclickcontext'>BulkActionClickContext</a
|
|
67
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionclickcontext'>BulkActionClickContext</a><ItemType, ComponentType>) => void`} />
|
|
68
68
|
|
|
69
69
|
Defines the logic that executes when the bulk action button is clicked.
|
|
70
70
|
### isVisible
|
|
71
71
|
|
|
72
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a
|
|
72
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a><ItemType, ComponentType>) => boolean | Promise<boolean>`} />
|
|
73
73
|
|
|
74
74
|
A function that determines whether this bulk action item should be displayed in the menu.
|
|
75
75
|
If not defined, the item will always be displayed.
|
|
@@ -95,7 +95,7 @@ registerBulkAction({
|
|
|
95
95
|
```
|
|
96
96
|
### requiresPermission
|
|
97
97
|
|
|
98
|
-
<MemberInfo kind="property" type={`string | ((userPermissions: string[])
|
|
98
|
+
<MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`} />
|
|
99
99
|
|
|
100
100
|
Control the display of this item based on the user permissions.
|
|
101
101
|
|
|
@@ -207,7 +207,7 @@ interface BulkActionClickContext<ItemType, ComponentType> extends BulkActionFunc
|
|
|
207
207
|
event: MouseEvent;
|
|
208
208
|
}
|
|
209
209
|
```
|
|
210
|
-
* Extends: <code><a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a
|
|
210
|
+
* Extends: <code><a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a><ItemType, ComponentType></code>
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
|
|
@@ -215,7 +215,7 @@ interface BulkActionClickContext<ItemType, ComponentType> extends BulkActionFunc
|
|
|
215
215
|
|
|
216
216
|
### clearSelection
|
|
217
217
|
|
|
218
|
-
<MemberInfo kind="property" type={`()
|
|
218
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
219
219
|
|
|
220
220
|
Clears the selection in the active list view.
|
|
221
221
|
### event
|
|
@@ -53,7 +53,7 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
|
|
|
53
53
|
createAssets(files: File[]) => ;
|
|
54
54
|
}
|
|
55
55
|
```
|
|
56
|
-
* Implements: <code>OnInit</code>, <code>AfterViewInit</code>, <code>OnDestroy</code>, <code><a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a
|
|
56
|
+
* Implements: <code>OnInit</code>, <code>AfterViewInit</code>, <code>OnDestroy</code>, <code><a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a><<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]></code>
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
|
|
@@ -61,12 +61,12 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
|
|
|
61
61
|
|
|
62
62
|
### assets$
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="property" type={`Observable
|
|
64
|
+
<MemberInfo kind="property" type={`Observable<AssetLike[]>`} />
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
### allTags$
|
|
68
68
|
|
|
69
|
-
<MemberInfo kind="property" type={`Observable
|
|
69
|
+
<MemberInfo kind="property" type={`Observable<TagFragment[]>`} />
|
|
70
70
|
|
|
71
71
|
|
|
72
72
|
### paginationConfig
|
|
@@ -86,7 +86,7 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
|
|
|
86
86
|
|
|
87
87
|
### resolveWith
|
|
88
88
|
|
|
89
|
-
<MemberInfo kind="property" type={`(result?: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[])
|
|
89
|
+
<MemberInfo kind="property" type={`(result?: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`} />
|
|
90
90
|
|
|
91
91
|
|
|
92
92
|
### selection
|
|
@@ -80,12 +80,12 @@ class CurrencyInputComponent implements ControlValueAccessor, OnInit, OnChanges,
|
|
|
80
80
|
|
|
81
81
|
### prefix$
|
|
82
82
|
|
|
83
|
-
<MemberInfo kind="property" type={`Observable
|
|
83
|
+
<MemberInfo kind="property" type={`Observable<string>`} />
|
|
84
84
|
|
|
85
85
|
|
|
86
86
|
### suffix$
|
|
87
87
|
|
|
88
|
-
<MemberInfo kind="property" type={`Observable
|
|
88
|
+
<MemberInfo kind="property" type={`Observable<string>`} />
|
|
89
89
|
|
|
90
90
|
|
|
91
91
|
### hasFractionPart
|
|
@@ -95,12 +95,12 @@ class CurrencyInputComponent implements ControlValueAccessor, OnInit, OnChanges,
|
|
|
95
95
|
|
|
96
96
|
### onChange
|
|
97
97
|
|
|
98
|
-
<MemberInfo kind="property" type={`(val: any)
|
|
98
|
+
<MemberInfo kind="property" type={`(val: any) => void`} />
|
|
99
99
|
|
|
100
100
|
|
|
101
101
|
### onTouch
|
|
102
102
|
|
|
103
|
-
<MemberInfo kind="property" type={`()
|
|
103
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
104
104
|
|
|
105
105
|
|
|
106
106
|
### _inputValue
|
|
@@ -129,7 +129,7 @@ class DataTableComponent<T> implements AfterContentInit, OnChanges, OnInit, OnDe
|
|
|
129
129
|
|
|
130
130
|
### selectionManager
|
|
131
131
|
|
|
132
|
-
<MemberInfo kind="property" type={`SelectionManager
|
|
132
|
+
<MemberInfo kind="property" type={`SelectionManager<T>`} />
|
|
133
133
|
|
|
134
134
|
|
|
135
135
|
### pageChange
|
|
@@ -149,7 +149,7 @@ class DataTableComponent<T> implements AfterContentInit, OnChanges, OnInit, OnDe
|
|
|
149
149
|
|
|
150
150
|
### isRowSelectedFn
|
|
151
151
|
|
|
152
|
-
<MemberInfo kind="property" type={`((item: T)
|
|
152
|
+
<MemberInfo kind="property" type={`((item: T) => boolean) | undefined`} />
|
|
153
153
|
|
|
154
154
|
|
|
155
155
|
### allSelectChange
|
|
@@ -164,17 +164,17 @@ class DataTableComponent<T> implements AfterContentInit, OnChanges, OnInit, OnDe
|
|
|
164
164
|
|
|
165
165
|
### columns
|
|
166
166
|
|
|
167
|
-
<MemberInfo kind="property" type={`QueryList
|
|
167
|
+
<MemberInfo kind="property" type={`QueryList<DataTableColumnComponent>`} />
|
|
168
168
|
|
|
169
169
|
|
|
170
170
|
### templateRefs
|
|
171
171
|
|
|
172
|
-
<MemberInfo kind="property" type={`QueryList
|
|
172
|
+
<MemberInfo kind="property" type={`QueryList<TemplateRef<any>>`} />
|
|
173
173
|
|
|
174
174
|
|
|
175
175
|
### rowTemplate
|
|
176
176
|
|
|
177
|
-
<MemberInfo kind="property" type={`TemplateRef
|
|
177
|
+
<MemberInfo kind="property" type={`TemplateRef<any>`} />
|
|
178
178
|
|
|
179
179
|
|
|
180
180
|
### currentStart
|
|
@@ -185,12 +185,12 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
185
185
|
|
|
186
186
|
### columns
|
|
187
187
|
|
|
188
|
-
<MemberInfo kind="property" type={`QueryList
|
|
188
|
+
<MemberInfo kind="property" type={`QueryList<DataTable2ColumnComponent<T>>`} />
|
|
189
189
|
|
|
190
190
|
|
|
191
191
|
### customFieldColumns
|
|
192
192
|
|
|
193
|
-
<MemberInfo kind="property" type={`QueryList
|
|
193
|
+
<MemberInfo kind="property" type={`QueryList<DataTableCustomFieldColumnComponent<T>>`} />
|
|
194
194
|
|
|
195
195
|
|
|
196
196
|
### searchComponent
|
|
@@ -205,12 +205,12 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
205
205
|
|
|
206
206
|
### customSearchTemplate
|
|
207
207
|
|
|
208
|
-
<MemberInfo kind="property" type={`TemplateRef
|
|
208
|
+
<MemberInfo kind="property" type={`TemplateRef<any>`} />
|
|
209
209
|
|
|
210
210
|
|
|
211
211
|
### templateRefs
|
|
212
212
|
|
|
213
|
-
<MemberInfo kind="property" type={`QueryList
|
|
213
|
+
<MemberInfo kind="property" type={`QueryList<TemplateRef<any>>`} />
|
|
214
214
|
|
|
215
215
|
|
|
216
216
|
### injector
|
|
@@ -245,7 +245,7 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
245
245
|
|
|
246
246
|
### rowTemplate
|
|
247
247
|
|
|
248
|
-
<MemberInfo kind="property" type={`TemplateRef
|
|
248
|
+
<MemberInfo kind="property" type={`TemplateRef<any>`} />
|
|
249
249
|
|
|
250
250
|
|
|
251
251
|
### currentStart
|
|
@@ -270,7 +270,7 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
270
270
|
|
|
271
271
|
### uiLanguage$
|
|
272
272
|
|
|
273
|
-
<MemberInfo kind="property" type={`Observable
|
|
273
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
|
|
274
274
|
|
|
275
275
|
|
|
276
276
|
### destroy$
|
|
@@ -320,7 +320,7 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
320
320
|
|
|
321
321
|
### onColumnReorder
|
|
322
322
|
|
|
323
|
-
<MemberInfo kind="method" type={`(event: { column: DataTable2ColumnComponent
|
|
323
|
+
<MemberInfo kind="method" type={`(event: { column: DataTable2ColumnComponent<any>; newIndex: number }) => `} />
|
|
324
324
|
|
|
325
325
|
|
|
326
326
|
### onColumnsReset
|
|
@@ -103,12 +103,12 @@ Sets the readonly state
|
|
|
103
103
|
|
|
104
104
|
### datetimeInput
|
|
105
105
|
|
|
106
|
-
<MemberInfo kind="property" type={`ElementRef
|
|
106
|
+
<MemberInfo kind="property" type={`ElementRef<HTMLInputElement>`} />
|
|
107
107
|
|
|
108
108
|
|
|
109
109
|
### calendarTable
|
|
110
110
|
|
|
111
|
-
<MemberInfo kind="property" type={`ElementRef
|
|
111
|
+
<MemberInfo kind="property" type={`ElementRef<HTMLTableElement>`} />
|
|
112
112
|
|
|
113
113
|
|
|
114
114
|
### disabled
|
|
@@ -118,27 +118,27 @@ Sets the readonly state
|
|
|
118
118
|
|
|
119
119
|
### calendarView$
|
|
120
120
|
|
|
121
|
-
<MemberInfo kind="property" type={`Observable
|
|
121
|
+
<MemberInfo kind="property" type={`Observable<CalendarView>`} />
|
|
122
122
|
|
|
123
123
|
|
|
124
124
|
### current$
|
|
125
125
|
|
|
126
|
-
<MemberInfo kind="property" type={`Observable
|
|
126
|
+
<MemberInfo kind="property" type={`Observable<CurrentView>`} />
|
|
127
127
|
|
|
128
128
|
|
|
129
129
|
### selected$
|
|
130
130
|
|
|
131
|
-
<MemberInfo kind="property" type={`Observable
|
|
131
|
+
<MemberInfo kind="property" type={`Observable<Date | null>`} />
|
|
132
132
|
|
|
133
133
|
|
|
134
134
|
### selectedHours$
|
|
135
135
|
|
|
136
|
-
<MemberInfo kind="property" type={`Observable
|
|
136
|
+
<MemberInfo kind="property" type={`Observable<number | null>`} />
|
|
137
137
|
|
|
138
138
|
|
|
139
139
|
### selectedMinutes$
|
|
140
140
|
|
|
141
|
-
<MemberInfo kind="property" type={`Observable
|
|
141
|
+
<MemberInfo kind="property" type={`Observable<number | null>`} />
|
|
142
142
|
|
|
143
143
|
|
|
144
144
|
### years
|
|
@@ -61,7 +61,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
|
|
|
61
61
|
|
|
62
62
|
### transformControlValueAccessorValue
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="property" type={`(value: FacetValueFragment[])
|
|
64
|
+
<MemberInfo kind="property" type={`(value: FacetValueFragment[]) => any[]`} />
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
### searchInput$
|
|
@@ -76,7 +76,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
|
|
|
76
76
|
|
|
77
77
|
### searchResults$
|
|
78
78
|
|
|
79
|
-
<MemberInfo kind="property" type={`Observable
|
|
79
|
+
<MemberInfo kind="property" type={`Observable<FacetValueFragment[]>`} />
|
|
80
80
|
|
|
81
81
|
|
|
82
82
|
### selectedIds$
|
|
@@ -86,12 +86,12 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
|
|
|
86
86
|
|
|
87
87
|
### onChangeFn
|
|
88
88
|
|
|
89
|
-
<MemberInfo kind="property" type={`(val: any)
|
|
89
|
+
<MemberInfo kind="property" type={`(val: any) => void`} />
|
|
90
90
|
|
|
91
91
|
|
|
92
92
|
### onTouchFn
|
|
93
93
|
|
|
94
|
-
<MemberInfo kind="property" type={`()
|
|
94
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
95
95
|
|
|
96
96
|
|
|
97
97
|
### disabled
|
|
@@ -101,7 +101,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
|
|
|
101
101
|
|
|
102
102
|
### value
|
|
103
103
|
|
|
104
|
-
<MemberInfo kind="property" type={`Array
|
|
104
|
+
<MemberInfo kind="property" type={`Array<string | FacetValueFragment>`} />
|
|
105
105
|
|
|
106
106
|
|
|
107
107
|
### constructor
|
|
@@ -146,7 +146,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
|
|
|
146
146
|
|
|
147
147
|
### writeValue
|
|
148
148
|
|
|
149
|
-
<MemberInfo kind="method" type={`(obj: string | FacetValueFragment[] | Array
|
|
149
|
+
<MemberInfo kind="method" type={`(obj: string | FacetValueFragment[] | Array<string | number> | null) => void`} />
|
|
150
150
|
|
|
151
151
|
|
|
152
152
|
|
|
@@ -46,7 +46,7 @@ class ProductVariantSelectorComponent implements OnInit {
|
|
|
46
46
|
|
|
47
47
|
### searchResults$
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="property" type={`Observable
|
|
49
|
+
<MemberInfo kind="property" type={`Observable<ProductSelectorSearchQuery['search']['items']>`} />
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
### productSelected
|
|
@@ -54,12 +54,12 @@ class RichTextEditorComponent implements ControlValueAccessor, AfterViewInit, On
|
|
|
54
54
|
|
|
55
55
|
### onChange
|
|
56
56
|
|
|
57
|
-
<MemberInfo kind="property" type={`(val: any)
|
|
57
|
+
<MemberInfo kind="property" type={`(val: any) => void`} />
|
|
58
58
|
|
|
59
59
|
|
|
60
60
|
### onTouch
|
|
61
61
|
|
|
62
|
-
<MemberInfo kind="property" type={`()
|
|
62
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
### constructor
|
|
@@ -50,7 +50,7 @@ class ZoneSelectorComponent implements ControlValueAccessor {
|
|
|
50
50
|
|
|
51
51
|
### transformControlValueAccessorValue
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined)
|
|
53
|
+
<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined) => any`} />
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
### selectedId$
|
|
@@ -60,12 +60,12 @@ class ZoneSelectorComponent implements ControlValueAccessor {
|
|
|
60
60
|
|
|
61
61
|
### onChangeFn
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="property" type={`(val: any)
|
|
63
|
+
<MemberInfo kind="property" type={`(val: any) => void`} />
|
|
64
64
|
|
|
65
65
|
|
|
66
66
|
### onTouchFn
|
|
67
67
|
|
|
68
|
-
<MemberInfo kind="property" type={`()
|
|
68
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
69
69
|
|
|
70
70
|
|
|
71
71
|
### disabled
|
package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx
CHANGED
|
@@ -27,7 +27,7 @@ interface CustomDetailComponentConfig {
|
|
|
27
27
|
|
|
28
28
|
### component
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="property" type={`Type
|
|
30
|
+
<MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a>>`} />
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
### providers
|
package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx
CHANGED
|
@@ -31,24 +31,24 @@ interface HistoryEntryComponent {
|
|
|
31
31
|
The HistoryEntry data.
|
|
32
32
|
### getDisplayType
|
|
33
33
|
|
|
34
|
-
<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry)
|
|
34
|
+
<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => TimelineDisplayType`} />
|
|
35
35
|
|
|
36
36
|
Defines whether this entry is highlighted with a "success", "error" etc. color.
|
|
37
37
|
### isFeatured
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry)
|
|
39
|
+
<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => boolean`} />
|
|
40
40
|
|
|
41
41
|
Featured entries are always expanded. Non-featured entries start of collapsed and can be clicked
|
|
42
42
|
to expand.
|
|
43
43
|
### getName
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry)
|
|
45
|
+
<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => string | undefined`} />
|
|
46
46
|
|
|
47
47
|
Returns the name of the person who did this action. For example, it could be the Customer's name
|
|
48
48
|
or "Administrator".
|
|
49
49
|
### getIconShape
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry)
|
|
51
|
+
<MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => string | string[] | undefined`} />
|
|
52
52
|
|
|
53
53
|
Optional Clarity icon shape to display with the entry. Examples: `'note'`, `['success-standard', 'is-solid']`
|
|
54
54
|
|
package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx
CHANGED
|
@@ -26,7 +26,7 @@ interface HistoryEntryConfig {
|
|
|
26
26
|
The type should correspond to the custom HistoryEntryType string.
|
|
27
27
|
### component
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="property" type={`Type
|
|
29
|
+
<MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a>>`} />
|
|
30
30
|
|
|
31
31
|
The component to be rendered for this history entry type.
|
|
32
32
|
|