@vendure/docs 0.0.0-202601211609 → 0.0.0-202601220950
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 +5 -5
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
- 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 +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- 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 +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +6 -6
- 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 +1 -1
- 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 +1 -1
- 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 +2 -2
- 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 +1 -1
- 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 +2 -2
- package/docs/reference/graphql-api/admin/_index.mdx +11 -0
- package/docs/reference/graphql-api/shop/_index.mdx +11 -0
- 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 +2 -2
- 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 +2 -2
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
- 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 +14 -14
- 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/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 +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -3
- 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 +2 -2
- 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 +5 -5
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
- 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 +12 -12
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +3 -3
- 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/request/request-context.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 +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
- 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 +6 -3
|
@@ -31,27 +31,27 @@ interface DashboardAlertDefinition<TResponse = any> {
|
|
|
31
31
|
A unique identifier for the alert.
|
|
32
32
|
### title
|
|
33
33
|
|
|
34
|
-
<MemberInfo kind="property" type={
|
|
34
|
+
<MemberInfo kind="property" type={`string | ((data: TResponse) => string)`} />
|
|
35
35
|
|
|
36
36
|
The title of the alert. Can be a string or a function that returns a string based on the response data.
|
|
37
37
|
### description
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="property" type={
|
|
39
|
+
<MemberInfo kind="property" type={`string | ((data: TResponse) => string)`} />
|
|
40
40
|
|
|
41
41
|
The description of the alert. Can be a string or a function that returns a string based on the response data.
|
|
42
42
|
### severity
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="property" type={
|
|
44
|
+
<MemberInfo kind="property" type={`AlertSeverity | ((data: TResponse) => AlertSeverity)`} />
|
|
45
45
|
|
|
46
46
|
The severity level of the alert.
|
|
47
47
|
### check
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="property" type={
|
|
49
|
+
<MemberInfo kind="property" type={`() => Promise<TResponse> | TResponse`} />
|
|
50
50
|
|
|
51
51
|
A function that checks the condition and returns the response data.
|
|
52
52
|
### shouldShow
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="property" type={
|
|
54
|
+
<MemberInfo kind="property" type={`(data: TResponse) => boolean`} />
|
|
55
55
|
|
|
56
56
|
A function that determines whether the alert should be rendered based on the response data.
|
|
57
57
|
### recheckInterval
|
|
@@ -61,7 +61,7 @@ A function that determines whether the alert should be rendered based on the res
|
|
|
61
61
|
The interval in milliseconds to recheck the condition.
|
|
62
62
|
### actions
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="property" type={
|
|
64
|
+
<MemberInfo kind="property" type={`Array<{ label: string; onClick: (args: { data: TResponse; dismiss: () => void }) => void | Promise<any>; }>`} />
|
|
65
65
|
|
|
66
66
|
Optional actions that can be performed when the alert is shown.
|
|
67
67
|
|
|
@@ -37,7 +37,7 @@ such as `'product-variants-table'` on the `'product-detail'` page.
|
|
|
37
37
|
An array of additional bulk actions that will be available on the data table.
|
|
38
38
|
### extendListDocument
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="property" type={
|
|
40
|
+
<MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`} />
|
|
41
41
|
|
|
42
42
|
Allows you to extend the list document for the data table.
|
|
43
43
|
### displayComponents
|
|
@@ -58,7 +58,7 @@ interface DashboardDetailFormExtensionDefinition {
|
|
|
58
58
|
The ID of the page where the detail form is located, e.g. `'product-detail'`, `'order-detail'`.
|
|
59
59
|
### extendDetailDocument
|
|
60
60
|
|
|
61
|
-
<MemberInfo kind="property" type={
|
|
61
|
+
<MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`} />
|
|
62
62
|
|
|
63
63
|
Extends the GraphQL query used to fetch data for the detail page, allowing you to add additional
|
|
64
64
|
fields that can be used by custom input or display components.
|
|
@@ -58,7 +58,7 @@ The `type` should correspond to a valid `HistoryEntryType`, such as
|
|
|
58
58
|
how to define custom history entry types.
|
|
59
59
|
### component
|
|
60
60
|
|
|
61
|
-
<MemberInfo kind="property" type={
|
|
61
|
+
<MemberInfo kind="property" type={`React.ComponentType<{ entry: <a href='/reference/dashboard/extensions-api/history-entries#historyentryitem'>HistoryEntryItem</a>; entity: OrderHistoryOrderDetail | CustomerHistoryCustomerDetail; }>`} />
|
|
62
62
|
|
|
63
63
|
The component which is used to render the timeline entry. It should use the
|
|
64
64
|
<DocsLink href="/reference/dashboard/extensions-api/history-entries#historyentry">HistoryEntry</DocsLink> component and pass the appropriate props to configure
|
|
@@ -225,5 +225,5 @@ Parameters
|
|
|
225
225
|
|
|
226
226
|
### props
|
|
227
227
|
|
|
228
|
-
<MemberInfo kind="parameter" type={
|
|
228
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/history-entries#historyentryprops'>HistoryEntryProps</a>>`} />
|
|
229
229
|
|
|
@@ -39,12 +39,12 @@ The location of the page block. It specifies the pageId, and then the
|
|
|
39
39
|
relative location compared to another existing block.
|
|
40
40
|
### component
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={
|
|
42
|
+
<MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`} />
|
|
43
43
|
|
|
44
44
|
The component to be rendered inside the page block.
|
|
45
45
|
### shouldRender
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="property" type={
|
|
47
|
+
<MemberInfo kind="property" type={`(context: PageContextValue) => boolean`} since="3.5.0" />
|
|
48
48
|
|
|
49
49
|
Control whether to render the page block depending on your custom
|
|
50
50
|
logic.
|
|
@@ -21,7 +21,7 @@ interface DashboardRouteDefinition {
|
|
|
21
21
|
|
|
22
22
|
### component
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="property" type={
|
|
24
|
+
<MemberInfo kind="property" type={`(route: AnyRoute) => React.ReactNode`} />
|
|
25
25
|
|
|
26
26
|
The React component that will be rendered for this route.
|
|
27
27
|
### path
|
|
@@ -31,7 +31,7 @@ The React component that will be rendered for this route.
|
|
|
31
31
|
The URL path for this route, e.g. '/my-custom-page'.
|
|
32
32
|
### navMenuItem
|
|
33
33
|
|
|
34
|
-
<MemberInfo kind="property" type={
|
|
34
|
+
<MemberInfo kind="property" type={`Partial<<a href='/reference/dashboard/extensions-api/navigation#navmenuitem'>NavMenuItem</a>> & { sectionId: string }`} />
|
|
35
35
|
|
|
36
36
|
Optional navigation menu item configuration to add this route to the nav menu
|
|
37
37
|
on the left side of the dashboard.
|
|
@@ -41,14 +41,14 @@ this item should appear in. It can also point to custom nav menu sections that
|
|
|
41
41
|
have been defined using the `navSections` extension property.
|
|
42
42
|
### loader
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="property" type={
|
|
44
|
+
<MemberInfo kind="property" type={`RouteOptions<any>['loader']`} />
|
|
45
45
|
|
|
46
46
|
Optional loader function to fetch data before the route renders.
|
|
47
47
|
The value is a Tanstack Router
|
|
48
48
|
[loader function](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#route-loaders)
|
|
49
49
|
### validateSearch
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="property" type={
|
|
51
|
+
<MemberInfo kind="property" type={`RouteOptions<any>['validateSearch']`} />
|
|
52
52
|
|
|
53
53
|
Optional search parameter validation function.
|
|
54
54
|
The value is a Tanstack Router
|
|
@@ -33,7 +33,7 @@ A unique identifier for the widget.
|
|
|
33
33
|
The display name of the widget.
|
|
34
34
|
### component
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="property" type={
|
|
36
|
+
<MemberInfo kind="property" type={`React.ComponentType<<a href='/reference/dashboard/extensions-api/widgets#dashboardbasewidgetprops'>DashboardBaseWidgetProps</a>>`} />
|
|
37
37
|
|
|
38
38
|
The React component that renders the widget.
|
|
39
39
|
### defaultSize
|
|
@@ -13,5 +13,5 @@ Parameters
|
|
|
13
13
|
|
|
14
14
|
### props
|
|
15
15
|
|
|
16
|
-
<MemberInfo kind="parameter" type={
|
|
16
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
17
17
|
|
|
@@ -13,5 +13,5 @@ Parameters
|
|
|
13
13
|
|
|
14
14
|
### props
|
|
15
15
|
|
|
16
|
-
<MemberInfo kind="parameter" type={
|
|
16
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
17
17
|
|
|
@@ -13,5 +13,5 @@ Parameters
|
|
|
13
13
|
|
|
14
14
|
### props
|
|
15
15
|
|
|
16
|
-
<MemberInfo kind="parameter" type={
|
|
16
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
17
17
|
|
|
@@ -39,7 +39,7 @@ Parameters
|
|
|
39
39
|
|
|
40
40
|
### props
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a
|
|
42
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a><TFieldValues, TName>`} />
|
|
43
43
|
|
|
44
44
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/form-field-wrapper.tsx" sourceLine="14" packageName="@vendure/dashboard" since="3.4.0" />
|
|
45
45
|
|
|
@@ -13,5 +13,5 @@ Parameters
|
|
|
13
13
|
|
|
14
14
|
### props
|
|
15
15
|
|
|
16
|
-
<MemberInfo kind="parameter" type={
|
|
16
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
17
17
|
|
|
@@ -13,5 +13,5 @@ Parameters
|
|
|
13
13
|
|
|
14
14
|
### props
|
|
15
15
|
|
|
16
|
-
<MemberInfo kind="parameter" type={
|
|
16
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
17
17
|
|
|
@@ -13,5 +13,5 @@ Parameters
|
|
|
13
13
|
|
|
14
14
|
### props
|
|
15
15
|
|
|
16
|
-
<MemberInfo kind="parameter" type={
|
|
16
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
17
17
|
|
|
@@ -47,27 +47,27 @@ The error message if the authentication fails.
|
|
|
47
47
|
Whether the user is authenticated.
|
|
48
48
|
### login
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="property" type={
|
|
50
|
+
<MemberInfo kind="property" type={`(username: string, password: string, onSuccess?: () => void) => void`} />
|
|
51
51
|
|
|
52
52
|
The function to login the user.
|
|
53
53
|
### logout
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="property" type={
|
|
55
|
+
<MemberInfo kind="property" type={`(onSuccess?: () => void) => Promise<void>`} />
|
|
56
56
|
|
|
57
57
|
The function to logout the user.
|
|
58
58
|
### user
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={
|
|
60
|
+
<MemberInfo kind="property" type={`ResultOf<typeof CurrentUserQuery>['activeAdministrator'] | undefined`} />
|
|
61
61
|
|
|
62
62
|
The user object.
|
|
63
63
|
### channels
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="property" type={
|
|
65
|
+
<MemberInfo kind="property" type={`NonNullable<ResultOf<typeof CurrentUserQuery>['me']>['channels'] | undefined`} />
|
|
66
66
|
|
|
67
67
|
The channels object.
|
|
68
68
|
### refreshCurrentUser
|
|
69
69
|
|
|
70
|
-
<MemberInfo kind="property" type={
|
|
70
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
71
71
|
|
|
72
72
|
The function to refresh the current user.
|
|
73
73
|
|
|
@@ -50,12 +50,12 @@ An array of all available channels.
|
|
|
50
50
|
The active channel.
|
|
51
51
|
### setActiveChannel
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="property" type={
|
|
53
|
+
<MemberInfo kind="property" type={`(channelId: string) => void`} />
|
|
54
54
|
|
|
55
55
|
The function to set the active channel.
|
|
56
56
|
### refreshChannels
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="property" type={
|
|
58
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
59
59
|
|
|
60
60
|
The function to refresh the channels.
|
|
61
61
|
|
|
@@ -37,7 +37,7 @@ interface DataTableBulkActionItemProps {
|
|
|
37
37
|
|
|
38
38
|
### onClick
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="property" type={
|
|
40
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### className
|
|
@@ -93,7 +93,7 @@ Parameters
|
|
|
93
93
|
|
|
94
94
|
### props
|
|
95
95
|
|
|
96
|
-
<MemberInfo kind="parameter" type={
|
|
96
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/bulk-actions#datatablebulkactionitemprops'>DataTableBulkActionItemProps</a>>`} />
|
|
97
97
|
|
|
98
98
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/data-table.ts" sourceLine="109" packageName="@vendure/dashboard" since="3.4.0" />
|
|
99
99
|
|
|
@@ -178,7 +178,7 @@ Optional order number to control the position of this bulk action in the dropdow
|
|
|
178
178
|
A larger number will appear lower in the list.
|
|
179
179
|
### component
|
|
180
180
|
|
|
181
|
-
<MemberInfo kind="property" type={
|
|
181
|
+
<MemberInfo kind="property" type={`BulkActionComponent<any>`} />
|
|
182
182
|
|
|
183
183
|
The React component that will be rendered as the bulk action item.
|
|
184
184
|
|
|
@@ -15,7 +15,7 @@ Parameters
|
|
|
15
15
|
|
|
16
16
|
### props
|
|
17
17
|
|
|
18
|
-
<MemberInfo kind="parameter" type={
|
|
18
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/data-table#datatableprops'>DataTableProps</a><TData>>`} />
|
|
19
19
|
|
|
20
20
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-table/data-table.tsx" sourceLine="113" packageName="@vendure/dashboard" since="3.4.0" />
|
|
21
21
|
|
|
@@ -57,7 +57,7 @@ interface DataTableProps<TData> {
|
|
|
57
57
|
|
|
58
58
|
### columns
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={
|
|
60
|
+
<MemberInfo kind="property" type={`ColumnDef<TData, any>[]`} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### data
|
|
@@ -97,27 +97,27 @@ interface DataTableProps<TData> {
|
|
|
97
97
|
|
|
98
98
|
### onPageChange
|
|
99
99
|
|
|
100
|
-
<MemberInfo kind="property" type={
|
|
100
|
+
<MemberInfo kind="property" type={`(table: TableType<TData>, page: number, itemsPerPage: number) => void`} />
|
|
101
101
|
|
|
102
102
|
|
|
103
103
|
### onSortChange
|
|
104
104
|
|
|
105
|
-
<MemberInfo kind="property" type={
|
|
105
|
+
<MemberInfo kind="property" type={`(table: TableType<TData>, sorting: SortingState) => void`} />
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
### onFilterChange
|
|
109
109
|
|
|
110
|
-
<MemberInfo kind="property" type={
|
|
110
|
+
<MemberInfo kind="property" type={`(table: TableType<TData>, columnFilters: ColumnFilter[]) => void`} />
|
|
111
111
|
|
|
112
112
|
|
|
113
113
|
### onColumnVisibilityChange
|
|
114
114
|
|
|
115
|
-
<MemberInfo kind="property" type={
|
|
115
|
+
<MemberInfo kind="property" type={`(table: TableType<TData>, columnVisibility: VisibilityState) => void`} />
|
|
116
116
|
|
|
117
117
|
|
|
118
118
|
### onSearchTermChange
|
|
119
119
|
|
|
120
|
-
<MemberInfo kind="property" type={
|
|
120
|
+
<MemberInfo kind="property" type={`(searchTerm: string) => void`} />
|
|
121
121
|
|
|
122
122
|
|
|
123
123
|
### defaultColumnVisibility
|
|
@@ -142,18 +142,18 @@ interface DataTableProps<TData> {
|
|
|
142
142
|
|
|
143
143
|
### setTableOptions
|
|
144
144
|
|
|
145
|
-
<MemberInfo kind="property" type={
|
|
145
|
+
<MemberInfo kind="property" type={`(table: TableOptions<TData>) => TableOptions<TData>`} />
|
|
146
146
|
|
|
147
147
|
This property allows full control over _all_ features of TanStack Table
|
|
148
148
|
when needed.
|
|
149
149
|
### onRefresh
|
|
150
150
|
|
|
151
|
-
<MemberInfo kind="property" type={
|
|
151
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
152
152
|
|
|
153
153
|
|
|
154
154
|
### onReorder
|
|
155
155
|
|
|
156
|
-
<MemberInfo kind="property" type={
|
|
156
|
+
<MemberInfo kind="property" type={`(oldIndex: number, newIndex: number, item: TData, allItems?: TData[]) => void | Promise<void>`} />
|
|
157
157
|
|
|
158
158
|
Callback when items are reordered via drag and drop.
|
|
159
159
|
When provided, enables drag-and-drop functionality.
|
|
@@ -99,7 +99,7 @@ Parameters
|
|
|
99
99
|
|
|
100
100
|
### props
|
|
101
101
|
|
|
102
|
-
<MemberInfo kind="parameter" type={
|
|
102
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/list-page#listpageprops'>ListPageProps</a><T, U, V, AC>>`} />
|
|
103
103
|
|
|
104
104
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/list-page.tsx" sourceLine="36" packageName="@vendure/dashboard" since="3.3.0" />
|
|
105
105
|
|
|
@@ -144,7 +144,7 @@ customization functionality that relies on page IDs and makes your
|
|
|
144
144
|
component extensible.
|
|
145
145
|
### route
|
|
146
146
|
|
|
147
|
-
<MemberInfo kind="property" type={
|
|
147
|
+
<MemberInfo kind="property" type={`AnyRoute | (() => AnyRoute)`} />
|
|
148
148
|
|
|
149
149
|
* The Tanstack Router `Route` object, which will be defined in the component file.
|
|
150
150
|
### title
|
|
@@ -195,7 +195,7 @@ export const collectionListDocument = graphql(`
|
|
|
195
195
|
```
|
|
196
196
|
### deleteMutation
|
|
197
197
|
|
|
198
|
-
<MemberInfo kind="property" type={
|
|
198
|
+
<MemberInfo kind="property" type={`TypedDocumentNode<any, { id: string }>`} />
|
|
199
199
|
|
|
200
200
|
Providing the `deleteMutation` will automatically add a "delete" menu item to the
|
|
201
201
|
actions column dropdown. Note that if this table already has a "delete" bulk action,
|
|
@@ -203,7 +203,7 @@ you don't need to additionally provide a delete mutation, because the bulk actio
|
|
|
203
203
|
will be added to the action column dropdown already.
|
|
204
204
|
### transformVariables
|
|
205
205
|
|
|
206
|
-
<MemberInfo kind="property" type={
|
|
206
|
+
<MemberInfo kind="property" type={`(variables: V) => V`} />
|
|
207
207
|
|
|
208
208
|
This prop can be used to intercept and transform the list query variables before they are
|
|
209
209
|
sent to the Admin API.
|
|
@@ -235,7 +235,7 @@ handling.
|
|
|
235
235
|
```
|
|
236
236
|
### onSearchTermChange
|
|
237
237
|
|
|
238
|
-
<MemberInfo kind="property" type={
|
|
238
|
+
<MemberInfo kind="property" type={`(searchTerm: string) => NonNullable<V['options']>['filter']`} />
|
|
239
239
|
|
|
240
240
|
Allows you to customize how the search term is used in the list query options.
|
|
241
241
|
For instance, when you want the term to filter on specific fields.
|
|
@@ -257,7 +257,7 @@ For instance, when you want the term to filter on specific fields.
|
|
|
257
257
|
/>
|
|
258
258
|
### customizeColumns
|
|
259
259
|
|
|
260
|
-
<MemberInfo kind="property" type={
|
|
260
|
+
<MemberInfo kind="property" type={`CustomizeColumnConfig<T>`} />
|
|
261
261
|
|
|
262
262
|
Allows you to customize the rendering and other aspects of individual columns.
|
|
263
263
|
|
|
@@ -341,7 +341,7 @@ of the `firstName` and `lastName` fields.
|
|
|
341
341
|
```
|
|
342
342
|
### defaultColumnOrder
|
|
343
343
|
|
|
344
|
-
<MemberInfo kind="property" type={
|
|
344
|
+
<MemberInfo kind="property" type={`(keyof ListQueryFields<T> | keyof AC | CustomFieldKeysOfItem<ListQueryFields<T>>)[]`} />
|
|
345
345
|
|
|
346
346
|
Allows you to specify the default order of columns in the table. When not defined, the
|
|
347
347
|
order of fields in the list query document will be used.
|
|
@@ -358,7 +358,7 @@ defaultSort={[{ id: 'orderPlacedAt', desc: true }]}
|
|
|
358
358
|
```
|
|
359
359
|
### defaultVisibility
|
|
360
360
|
|
|
361
|
-
<MemberInfo kind="property" type={
|
|
361
|
+
<MemberInfo kind="property" type={`Partial< Record<keyof ListQueryFields<T> | keyof AC | CustomFieldKeysOfItem<ListQueryFields<T>>, boolean> >`} />
|
|
362
362
|
|
|
363
363
|
Allows you to specify the default columns that are visible in the table.
|
|
364
364
|
If you set them to `true`, then only those will show by default. If you set them to `false`,
|
|
@@ -385,7 +385,7 @@ then _all other_ columns will be visible by default.
|
|
|
385
385
|
|
|
386
386
|
### facetedFilters
|
|
387
387
|
|
|
388
|
-
<MemberInfo kind="property" type={
|
|
388
|
+
<MemberInfo kind="property" type={`FacetedFilterConfig<T>`} />
|
|
389
389
|
|
|
390
390
|
Allows you to define pre-set filters based on an array of possible selections
|
|
391
391
|
|
|
@@ -409,19 +409,19 @@ Allows you to define pre-set filters based on an array of possible selections
|
|
|
409
409
|
```
|
|
410
410
|
### rowActions
|
|
411
411
|
|
|
412
|
-
<MemberInfo kind="property" type={
|
|
412
|
+
<MemberInfo kind="property" type={`RowAction<ListQueryFields<T>>[]`} />
|
|
413
413
|
|
|
414
414
|
Allows you to specify additional "actions" that will be made available in the "actions" column.
|
|
415
415
|
By default, the actions column includes all bulk actions defined in the `bulkActions` prop.
|
|
416
416
|
### transformData
|
|
417
417
|
|
|
418
|
-
<MemberInfo kind="property" type={
|
|
418
|
+
<MemberInfo kind="property" type={`(data: any[]) => any[]`} />
|
|
419
419
|
|
|
420
420
|
Allows the returned list query data to be transformed in some way. This is an advanced feature
|
|
421
421
|
that is not often required.
|
|
422
422
|
### setTableOptions
|
|
423
423
|
|
|
424
|
-
<MemberInfo kind="property" type={
|
|
424
|
+
<MemberInfo kind="property" type={`(table: TableOptions<any>) => TableOptions<any>`} />
|
|
425
425
|
|
|
426
426
|
Allows you to directly manipulate the Tanstack Table `TableOptions` object before the
|
|
427
427
|
table is created. And advanced option that is not often required.
|
|
@@ -469,7 +469,7 @@ this list. The function can be assigned to a ref and then called when
|
|
|
469
469
|
the list needs to be refreshed.
|
|
470
470
|
### onReorder
|
|
471
471
|
|
|
472
|
-
<MemberInfo kind="property" type={
|
|
472
|
+
<MemberInfo kind="property" type={`(oldIndex: number, newIndex: number, item: any) => void | Promise<void>`} />
|
|
473
473
|
|
|
474
474
|
Callback when items are reordered via drag and drop.
|
|
475
475
|
Only applies to top-level items. When provided, enables drag-and-drop functionality.
|
|
@@ -115,7 +115,7 @@ Parameters
|
|
|
115
115
|
|
|
116
116
|
### props
|
|
117
117
|
|
|
118
|
-
<MemberInfo kind="parameter" type={
|
|
118
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/paginated-list-data-table#paginatedlistdatatableprops'>PaginatedListDataTableProps</a><T, U, V, AC>>`} />
|
|
119
119
|
|
|
120
120
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="202" packageName="@vendure/dashboard" since="3.4.0" />
|
|
121
121
|
|
|
@@ -165,22 +165,22 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
165
165
|
|
|
166
166
|
### deleteMutation
|
|
167
167
|
|
|
168
|
-
<MemberInfo kind="property" type={
|
|
168
|
+
<MemberInfo kind="property" type={`TypedDocumentNode<any, any>`} />
|
|
169
169
|
|
|
170
170
|
|
|
171
171
|
### transformQueryKey
|
|
172
172
|
|
|
173
|
-
<MemberInfo kind="property" type={
|
|
173
|
+
<MemberInfo kind="property" type={`(queryKey: any[]) => any[]`} />
|
|
174
174
|
|
|
175
175
|
|
|
176
176
|
### transformVariables
|
|
177
177
|
|
|
178
|
-
<MemberInfo kind="property" type={
|
|
178
|
+
<MemberInfo kind="property" type={`(variables: V) => V`} />
|
|
179
179
|
|
|
180
180
|
|
|
181
181
|
### customizeColumns
|
|
182
182
|
|
|
183
|
-
<MemberInfo kind="property" type={
|
|
183
|
+
<MemberInfo kind="property" type={`CustomizeColumnConfig<T>`} />
|
|
184
184
|
|
|
185
185
|
|
|
186
186
|
### additionalColumns
|
|
@@ -190,17 +190,17 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
190
190
|
|
|
191
191
|
### defaultColumnOrder
|
|
192
192
|
|
|
193
|
-
<MemberInfo kind="property" type={
|
|
193
|
+
<MemberInfo kind="property" type={`(keyof ListQueryFields<T> | keyof AC | CustomFieldKeysOfItem<ListQueryFields<T>>)[]`} />
|
|
194
194
|
|
|
195
195
|
|
|
196
196
|
### defaultVisibility
|
|
197
197
|
|
|
198
|
-
<MemberInfo kind="property" type={
|
|
198
|
+
<MemberInfo kind="property" type={`Partial<Record<AllItemFieldKeys<T>, boolean>>`} />
|
|
199
199
|
|
|
200
200
|
|
|
201
201
|
### onSearchTermChange
|
|
202
202
|
|
|
203
|
-
<MemberInfo kind="property" type={
|
|
203
|
+
<MemberInfo kind="property" type={`(searchTerm: string) => NonNullable<V['options']>['filter']`} />
|
|
204
204
|
|
|
205
205
|
|
|
206
206
|
### page
|
|
@@ -225,32 +225,32 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
225
225
|
|
|
226
226
|
### onPageChange
|
|
227
227
|
|
|
228
|
-
<MemberInfo kind="property" type={
|
|
228
|
+
<MemberInfo kind="property" type={`(table: Table<any>, page: number, perPage: number) => void`} />
|
|
229
229
|
|
|
230
230
|
|
|
231
231
|
### onSortChange
|
|
232
232
|
|
|
233
|
-
<MemberInfo kind="property" type={
|
|
233
|
+
<MemberInfo kind="property" type={`(table: Table<any>, sorting: SortingState) => void`} />
|
|
234
234
|
|
|
235
235
|
|
|
236
236
|
### onFilterChange
|
|
237
237
|
|
|
238
|
-
<MemberInfo kind="property" type={
|
|
238
|
+
<MemberInfo kind="property" type={`(table: Table<any>, filters: ColumnFiltersState) => void`} />
|
|
239
239
|
|
|
240
240
|
|
|
241
241
|
### onColumnVisibilityChange
|
|
242
242
|
|
|
243
|
-
<MemberInfo kind="property" type={
|
|
243
|
+
<MemberInfo kind="property" type={`(table: Table<any>, columnVisibility: VisibilityState) => void`} />
|
|
244
244
|
|
|
245
245
|
|
|
246
246
|
### facetedFilters
|
|
247
247
|
|
|
248
|
-
<MemberInfo kind="property" type={
|
|
248
|
+
<MemberInfo kind="property" type={`FacetedFilterConfig<T>`} />
|
|
249
249
|
|
|
250
250
|
|
|
251
251
|
### rowActions
|
|
252
252
|
|
|
253
|
-
<MemberInfo kind="property" type={
|
|
253
|
+
<MemberInfo kind="property" type={`RowAction<PaginatedListItemFields<T>>[]`} />
|
|
254
254
|
|
|
255
255
|
|
|
256
256
|
### bulkActions
|
|
@@ -265,12 +265,12 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
265
265
|
|
|
266
266
|
### transformData
|
|
267
267
|
|
|
268
|
-
<MemberInfo kind="property" type={
|
|
268
|
+
<MemberInfo kind="property" type={`(data: PaginatedListItemFields<T>[]) => PaginatedListItemFields<T>[]`} />
|
|
269
269
|
|
|
270
270
|
|
|
271
271
|
### setTableOptions
|
|
272
272
|
|
|
273
|
-
<MemberInfo kind="property" type={
|
|
273
|
+
<MemberInfo kind="property" type={`(table: TableOptions<any>) => TableOptions<any>`} />
|
|
274
274
|
|
|
275
275
|
|
|
276
276
|
### registerRefresher
|
|
@@ -280,7 +280,7 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
280
280
|
|
|
281
281
|
### onReorder
|
|
282
282
|
|
|
283
|
-
<MemberInfo kind="property" type={
|
|
283
|
+
<MemberInfo kind="property" type={`( oldIndex: number, newIndex: number, item: PaginatedListItemFields<T>, ) => void | Promise<void>`} />
|
|
284
284
|
|
|
285
285
|
Callback when items are reordered via drag and drop.
|
|
286
286
|
When provided, enables drag-and-drop functionality.
|