@vendure/docs 0.0.0-202601201656 → 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/dist/manifest.d.ts +1 -2
- package/dist/manifest.d.ts.map +1 -1
- package/dist/manifest.js +55 -1
- package/dist/manifest.js.map +1 -1
- 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 +2 -2
- 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
|
@@ -44,5 +44,5 @@ Parameters
|
|
|
44
44
|
|
|
45
45
|
### props
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
47
|
+
<MemberInfo kind="parameter" type={`Readonly<{ label: string | React.ReactNode; id?: string; href?: string; disabled?: boolean; search?: Record<string, string>; className?: string; }>`} />
|
|
48
48
|
|
|
@@ -46,7 +46,7 @@ interface FacetValueSelectorProps {
|
|
|
46
46
|
|
|
47
47
|
### onValueSelect
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>)
|
|
49
|
+
<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>) => void`} />
|
|
50
50
|
|
|
51
51
|
The function to call when a facet value is selected.
|
|
52
52
|
|
|
@@ -28,7 +28,7 @@ Parameters
|
|
|
28
28
|
|
|
29
29
|
### props
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
31
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>>`} />
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -61,7 +61,7 @@ interface VendureImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
|
|
|
61
61
|
ref?: React.Ref<HTMLImageElement>;
|
|
62
62
|
}
|
|
63
63
|
```
|
|
64
|
-
* Extends: <code>React.ImgHTMLAttributes
|
|
64
|
+
* Extends: <code>React.ImgHTMLAttributes<HTMLImageElement></code>
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
|
|
@@ -115,7 +115,7 @@ The fallback to show if no asset is provided. If no fallback is provided,
|
|
|
115
115
|
a default placeholder will be shown.
|
|
116
116
|
### ref
|
|
117
117
|
|
|
118
|
-
<MemberInfo kind="property" type={`React.Ref
|
|
118
|
+
<MemberInfo kind="property" type={`React.Ref<HTMLImageElement>`} />
|
|
119
119
|
|
|
120
120
|
The ref to the image element.
|
|
121
121
|
|
|
@@ -19,7 +19,7 @@ Parameters
|
|
|
19
19
|
|
|
20
20
|
### props
|
|
21
21
|
|
|
22
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a
|
|
22
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a><T, C, U>`} />
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -62,7 +62,7 @@ A unique identifier for the page.
|
|
|
62
62
|
The Tanstack Router route used to navigate to this page.
|
|
63
63
|
### title
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="property" type={`(entity: ResultOf
|
|
65
|
+
<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => string`} />
|
|
66
66
|
|
|
67
67
|
The title of the page.
|
|
68
68
|
### queryDocument
|
|
@@ -82,7 +82,7 @@ The mutation document used to create the entity.
|
|
|
82
82
|
The mutation document used to update the entity.
|
|
83
83
|
### setValuesForUpdate
|
|
84
84
|
|
|
85
|
-
<MemberInfo kind="property" type={`(entity: ResultOf
|
|
85
|
+
<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => VariablesOf<U>['input']`} />
|
|
86
86
|
|
|
87
87
|
A function that sets the values for the update input type based on the entity.
|
|
88
88
|
|
|
@@ -78,7 +78,7 @@ Parameters
|
|
|
78
78
|
|
|
79
79
|
### options
|
|
80
80
|
|
|
81
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a
|
|
81
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a><T, C, U, EntityField, VarNameCreate, VarNameUpdate>`} />
|
|
82
82
|
|
|
83
83
|
|
|
84
84
|
|
|
@@ -151,27 +151,27 @@ The document to create the entity.
|
|
|
151
151
|
The document to update the entity.
|
|
152
152
|
### setValuesForUpdate
|
|
153
153
|
|
|
154
|
-
<MemberInfo kind="property" type={`( entity: NonNullable
|
|
154
|
+
<MemberInfo kind="property" type={`( entity: NonNullable<ResultOf<T>[EntityField]>, ) => WithLooseCustomFields<VariablesOf<U>[VarNameUpdate]>`} />
|
|
155
155
|
|
|
156
156
|
The function to set the values for the update document.
|
|
157
157
|
### transformCreateInput
|
|
158
158
|
|
|
159
|
-
<MemberInfo kind="property" type={`(input: VariablesOf
|
|
159
|
+
<MemberInfo kind="property" type={`(input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate]`} />
|
|
160
160
|
|
|
161
161
|
|
|
162
162
|
### transformUpdateInput
|
|
163
163
|
|
|
164
|
-
<MemberInfo kind="property" type={`(input: VariablesOf
|
|
164
|
+
<MemberInfo kind="property" type={`(input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate]`} />
|
|
165
165
|
|
|
166
166
|
|
|
167
167
|
### onSuccess
|
|
168
168
|
|
|
169
|
-
<MemberInfo kind="property" type={`(entity: ResultOf
|
|
169
|
+
<MemberInfo kind="property" type={`(entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void`} />
|
|
170
170
|
|
|
171
171
|
The function to call when the update is successful.
|
|
172
172
|
### onError
|
|
173
173
|
|
|
174
|
-
<MemberInfo kind="property" type={`(error: unknown)
|
|
174
|
+
<MemberInfo kind="property" type={`(error: unknown) => void`} />
|
|
175
175
|
|
|
176
176
|
The function to call when the update is successful.
|
|
177
177
|
|
|
@@ -200,17 +200,17 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
|
|
|
200
200
|
|
|
201
201
|
### form
|
|
202
202
|
|
|
203
|
-
<MemberInfo kind="property" type={`UseFormReturn
|
|
203
|
+
<MemberInfo kind="property" type={`UseFormReturn<RemoveNullFields<VariablesOf<U>['input']>>`} />
|
|
204
204
|
|
|
205
205
|
|
|
206
206
|
### submitHandler
|
|
207
207
|
|
|
208
|
-
<MemberInfo kind="property" type={`(event: FormEvent
|
|
208
|
+
<MemberInfo kind="property" type={`(event: FormEvent<HTMLFormElement>) => void`} />
|
|
209
209
|
|
|
210
210
|
|
|
211
211
|
### entity
|
|
212
212
|
|
|
213
|
-
<MemberInfo kind="property" type={`DetailPageEntity
|
|
213
|
+
<MemberInfo kind="property" type={`DetailPageEntity<T, EntityField>`} />
|
|
214
214
|
|
|
215
215
|
|
|
216
216
|
### isPending
|
|
@@ -220,12 +220,12 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
|
|
|
220
220
|
|
|
221
221
|
### refreshEntity
|
|
222
222
|
|
|
223
|
-
<MemberInfo kind="property" type={`()
|
|
223
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
224
224
|
|
|
225
225
|
|
|
226
226
|
### resetForm
|
|
227
227
|
|
|
228
|
-
<MemberInfo kind="property" type={`()
|
|
228
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
229
229
|
|
|
230
230
|
|
|
231
231
|
|
|
@@ -40,7 +40,7 @@ Parameters
|
|
|
40
40
|
|
|
41
41
|
### options
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a
|
|
43
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a><T, VarName, E>`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
|
|
@@ -91,12 +91,12 @@ The entity to use to generate the form.
|
|
|
91
91
|
|
|
92
92
|
### setValues
|
|
93
93
|
|
|
94
|
-
<MemberInfo kind="property" type={`( entity: NonNullable
|
|
94
|
+
<MemberInfo kind="property" type={`( entity: NonNullable<E>, ) => WithLooseCustomFields< VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T> >`} />
|
|
95
95
|
|
|
96
96
|
|
|
97
97
|
### onSubmit
|
|
98
98
|
|
|
99
|
-
<MemberInfo kind="property" type={`( values: VarName extends keyof VariablesOf
|
|
99
|
+
<MemberInfo kind="property" type={`( values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>, ) => void`} />
|
|
100
100
|
|
|
101
101
|
|
|
102
102
|
|
|
@@ -32,7 +32,7 @@ interface DashboardActionBarItem {
|
|
|
32
32
|
The ID of the page where the action bar item should be displayed.
|
|
33
33
|
### component
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="property" type={`React.FunctionComponent
|
|
35
|
+
<MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`} />
|
|
36
36
|
|
|
37
37
|
A React component that will be rendered in the action bar. Typically, you would use
|
|
38
38
|
the default Shadcn `<Button>` component.
|
|
@@ -35,27 +35,27 @@ interface DashboardAlertDefinition<TResponse = any> {
|
|
|
35
35
|
A unique identifier for the alert.
|
|
36
36
|
### title
|
|
37
37
|
|
|
38
|
-
<MemberInfo kind="property" type={`string | ((data: TResponse)
|
|
38
|
+
<MemberInfo kind="property" type={`string | ((data: TResponse) => string)`} />
|
|
39
39
|
|
|
40
40
|
The title of the alert. Can be a string or a function that returns a string based on the response data.
|
|
41
41
|
### description
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="property" type={`string | ((data: TResponse)
|
|
43
|
+
<MemberInfo kind="property" type={`string | ((data: TResponse) => string)`} />
|
|
44
44
|
|
|
45
45
|
The description of the alert. Can be a string or a function that returns a string based on the response data.
|
|
46
46
|
### severity
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="property" type={`AlertSeverity | ((data: TResponse)
|
|
48
|
+
<MemberInfo kind="property" type={`AlertSeverity | ((data: TResponse) => AlertSeverity)`} />
|
|
49
49
|
|
|
50
50
|
The severity level of the alert.
|
|
51
51
|
### check
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="property" type={`()
|
|
53
|
+
<MemberInfo kind="property" type={`() => Promise<TResponse> | TResponse`} />
|
|
54
54
|
|
|
55
55
|
A function that checks the condition and returns the response data.
|
|
56
56
|
### shouldShow
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="property" type={`(data: TResponse)
|
|
58
|
+
<MemberInfo kind="property" type={`(data: TResponse) => boolean`} />
|
|
59
59
|
|
|
60
60
|
A function that determines whether the alert should be rendered based on the response data.
|
|
61
61
|
### recheckInterval
|
|
@@ -65,7 +65,7 @@ A function that determines whether the alert should be rendered based on the res
|
|
|
65
65
|
The interval in milliseconds to recheck the condition.
|
|
66
66
|
### actions
|
|
67
67
|
|
|
68
|
-
<MemberInfo kind="property" type={`Array
|
|
68
|
+
<MemberInfo kind="property" type={`Array<{ label: string; onClick: (args: { data: TResponse; dismiss: () => void }) => void | Promise<any>; }>`} />
|
|
69
69
|
|
|
70
70
|
Optional actions that can be performed when the alert is shown.
|
|
71
71
|
|
|
@@ -41,7 +41,7 @@ such as `'product-variants-table'` on the `'product-detail'` page.
|
|
|
41
41
|
An array of additional bulk actions that will be available on the data table.
|
|
42
42
|
### extendListDocument
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="property" type={`string | DocumentNode | (()
|
|
44
|
+
<MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`} />
|
|
45
45
|
|
|
46
46
|
Allows you to extend the list document for the data table.
|
|
47
47
|
### displayComponents
|
|
@@ -66,7 +66,7 @@ interface DashboardDetailFormExtensionDefinition {
|
|
|
66
66
|
The ID of the page where the detail form is located, e.g. `'product-detail'`, `'order-detail'`.
|
|
67
67
|
### extendDetailDocument
|
|
68
68
|
|
|
69
|
-
<MemberInfo kind="property" type={`string | DocumentNode | (()
|
|
69
|
+
<MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`} />
|
|
70
70
|
|
|
71
71
|
Extends the GraphQL query used to fetch data for the detail page, allowing you to add additional
|
|
72
72
|
fields that can be used by custom input or display components.
|
|
@@ -62,7 +62,7 @@ The `type` should correspond to a valid `HistoryEntryType`, such as
|
|
|
62
62
|
how to define custom history entry types.
|
|
63
63
|
### component
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="property" type={`React.ComponentType
|
|
65
|
+
<MemberInfo kind="property" type={`React.ComponentType<{ entry: <a href='/reference/dashboard/extensions-api/history-entries#historyentryitem'>HistoryEntryItem</a>; entity: OrderHistoryOrderDetail | CustomerHistoryCustomerDetail; }>`} />
|
|
66
66
|
|
|
67
67
|
The component which is used to render the timeline entry. It should use the
|
|
68
68
|
<a href='/reference/dashboard/extensions-api/history-entries#historyentry'>HistoryEntry</a> component and pass the appropriate props to configure
|
|
@@ -241,5 +241,5 @@ Parameters
|
|
|
241
241
|
|
|
242
242
|
### props
|
|
243
243
|
|
|
244
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
244
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/history-entries#historyentryprops'>HistoryEntryProps</a>>`} />
|
|
245
245
|
|
|
@@ -43,12 +43,12 @@ The location of the page block. It specifies the pageId, and then the
|
|
|
43
43
|
relative location compared to another existing block.
|
|
44
44
|
### component
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="property" type={`React.FunctionComponent
|
|
46
|
+
<MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`} />
|
|
47
47
|
|
|
48
48
|
The component to be rendered inside the page block.
|
|
49
49
|
### shouldRender
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="property" type={`(context: PageContextValue)
|
|
51
|
+
<MemberInfo kind="property" type={`(context: PageContextValue) => boolean`} since="3.5.0" />
|
|
52
52
|
|
|
53
53
|
Control whether to render the page block depending on your custom
|
|
54
54
|
logic.
|
|
@@ -25,7 +25,7 @@ interface DashboardRouteDefinition {
|
|
|
25
25
|
|
|
26
26
|
### component
|
|
27
27
|
|
|
28
|
-
<MemberInfo kind="property" type={`(route: AnyRoute)
|
|
28
|
+
<MemberInfo kind="property" type={`(route: AnyRoute) => React.ReactNode`} />
|
|
29
29
|
|
|
30
30
|
The React component that will be rendered for this route.
|
|
31
31
|
### path
|
|
@@ -35,7 +35,7 @@ The React component that will be rendered for this route.
|
|
|
35
35
|
The URL path for this route, e.g. '/my-custom-page'.
|
|
36
36
|
### navMenuItem
|
|
37
37
|
|
|
38
|
-
<MemberInfo kind="property" type={`Partial
|
|
38
|
+
<MemberInfo kind="property" type={`Partial<<a href='/reference/dashboard/extensions-api/navigation#navmenuitem'>NavMenuItem</a>> & { sectionId: string }`} />
|
|
39
39
|
|
|
40
40
|
Optional navigation menu item configuration to add this route to the nav menu
|
|
41
41
|
on the left side of the dashboard.
|
|
@@ -45,14 +45,14 @@ this item should appear in. It can also point to custom nav menu sections that
|
|
|
45
45
|
have been defined using the `navSections` extension property.
|
|
46
46
|
### loader
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="property" type={`RouteOptions
|
|
48
|
+
<MemberInfo kind="property" type={`RouteOptions<any>['loader']`} />
|
|
49
49
|
|
|
50
50
|
Optional loader function to fetch data before the route renders.
|
|
51
51
|
The value is a Tanstack Router
|
|
52
52
|
[loader function](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#route-loaders)
|
|
53
53
|
### validateSearch
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="property" type={`RouteOptions
|
|
55
|
+
<MemberInfo kind="property" type={`RouteOptions<any>['validateSearch']`} />
|
|
56
56
|
|
|
57
57
|
Optional search parameter validation function.
|
|
58
58
|
The value is a Tanstack Router
|
|
@@ -37,7 +37,7 @@ A unique identifier for the widget.
|
|
|
37
37
|
The display name of the widget.
|
|
38
38
|
### component
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="property" type={`React.ComponentType
|
|
40
|
+
<MemberInfo kind="property" type={`React.ComponentType<<a href='/reference/dashboard/extensions-api/widgets#dashboardbasewidgetprops'>DashboardBaseWidgetProps</a>>`} />
|
|
41
41
|
|
|
42
42
|
The React component that renders the widget.
|
|
43
43
|
### defaultSize
|
|
@@ -17,5 +17,5 @@ Parameters
|
|
|
17
17
|
|
|
18
18
|
### props
|
|
19
19
|
|
|
20
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
20
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
21
21
|
|
|
@@ -17,5 +17,5 @@ Parameters
|
|
|
17
17
|
|
|
18
18
|
### props
|
|
19
19
|
|
|
20
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
20
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
21
21
|
|
|
@@ -17,5 +17,5 @@ Parameters
|
|
|
17
17
|
|
|
18
18
|
### props
|
|
19
19
|
|
|
20
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
20
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
21
21
|
|
|
@@ -43,7 +43,7 @@ Parameters
|
|
|
43
43
|
|
|
44
44
|
### props
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a
|
|
46
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a><TFieldValues, TName>`} />
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
|
|
@@ -17,5 +17,5 @@ Parameters
|
|
|
17
17
|
|
|
18
18
|
### props
|
|
19
19
|
|
|
20
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
20
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
21
21
|
|
|
@@ -17,5 +17,5 @@ Parameters
|
|
|
17
17
|
|
|
18
18
|
### props
|
|
19
19
|
|
|
20
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
20
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
21
21
|
|
|
@@ -17,5 +17,5 @@ Parameters
|
|
|
17
17
|
|
|
18
18
|
### props
|
|
19
19
|
|
|
20
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
20
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
|
|
21
21
|
|
|
@@ -55,27 +55,27 @@ The error message if the authentication fails.
|
|
|
55
55
|
Whether the user is authenticated.
|
|
56
56
|
### login
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="property" type={`(username: string, password: string, onSuccess?: ()
|
|
58
|
+
<MemberInfo kind="property" type={`(username: string, password: string, onSuccess?: () => void) => void`} />
|
|
59
59
|
|
|
60
60
|
The function to login the user.
|
|
61
61
|
### logout
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="property" type={`(onSuccess?: ()
|
|
63
|
+
<MemberInfo kind="property" type={`(onSuccess?: () => void) => Promise<void>`} />
|
|
64
64
|
|
|
65
65
|
The function to logout the user.
|
|
66
66
|
### user
|
|
67
67
|
|
|
68
|
-
<MemberInfo kind="property" type={`ResultOf
|
|
68
|
+
<MemberInfo kind="property" type={`ResultOf<typeof CurrentUserQuery>['activeAdministrator'] | undefined`} />
|
|
69
69
|
|
|
70
70
|
The user object.
|
|
71
71
|
### channels
|
|
72
72
|
|
|
73
|
-
<MemberInfo kind="property" type={`NonNullable
|
|
73
|
+
<MemberInfo kind="property" type={`NonNullable<ResultOf<typeof CurrentUserQuery>['me']>['channels'] | undefined`} />
|
|
74
74
|
|
|
75
75
|
The channels object.
|
|
76
76
|
### refreshCurrentUser
|
|
77
77
|
|
|
78
|
-
<MemberInfo kind="property" type={`()
|
|
78
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
79
79
|
|
|
80
80
|
The function to refresh the current user.
|
|
81
81
|
|
|
@@ -58,12 +58,12 @@ An array of all available channels.
|
|
|
58
58
|
The active channel.
|
|
59
59
|
### setActiveChannel
|
|
60
60
|
|
|
61
|
-
<MemberInfo kind="property" type={`(channelId: string)
|
|
61
|
+
<MemberInfo kind="property" type={`(channelId: string) => void`} />
|
|
62
62
|
|
|
63
63
|
The function to set the active channel.
|
|
64
64
|
### refreshChannels
|
|
65
65
|
|
|
66
|
-
<MemberInfo kind="property" type={`()
|
|
66
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
67
67
|
|
|
68
68
|
The function to refresh the channels.
|
|
69
69
|
|
|
@@ -41,7 +41,7 @@ interface DataTableBulkActionItemProps {
|
|
|
41
41
|
|
|
42
42
|
### onClick
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="property" type={`()
|
|
44
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### className
|
|
@@ -101,7 +101,7 @@ Parameters
|
|
|
101
101
|
|
|
102
102
|
### props
|
|
103
103
|
|
|
104
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
104
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/bulk-actions#datatablebulkactionitemprops'>DataTableBulkActionItemProps</a>>`} />
|
|
105
105
|
|
|
106
106
|
|
|
107
107
|
|
|
@@ -190,7 +190,7 @@ Optional order number to control the position of this bulk action in the dropdow
|
|
|
190
190
|
A larger number will appear lower in the list.
|
|
191
191
|
### component
|
|
192
192
|
|
|
193
|
-
<MemberInfo kind="property" type={`BulkActionComponent
|
|
193
|
+
<MemberInfo kind="property" type={`BulkActionComponent<any>`} />
|
|
194
194
|
|
|
195
195
|
The React component that will be rendered as the bulk action item.
|
|
196
196
|
|
|
@@ -19,7 +19,7 @@ Parameters
|
|
|
19
19
|
|
|
20
20
|
### props
|
|
21
21
|
|
|
22
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
22
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/data-table#datatableprops'>DataTableProps</a><TData>>`} />
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -65,7 +65,7 @@ interface DataTableProps<TData> {
|
|
|
65
65
|
|
|
66
66
|
### columns
|
|
67
67
|
|
|
68
|
-
<MemberInfo kind="property" type={`ColumnDef
|
|
68
|
+
<MemberInfo kind="property" type={`ColumnDef<TData, any>[]`} />
|
|
69
69
|
|
|
70
70
|
|
|
71
71
|
### data
|
|
@@ -105,27 +105,27 @@ interface DataTableProps<TData> {
|
|
|
105
105
|
|
|
106
106
|
### onPageChange
|
|
107
107
|
|
|
108
|
-
<MemberInfo kind="property" type={`(table: TableType
|
|
108
|
+
<MemberInfo kind="property" type={`(table: TableType<TData>, page: number, itemsPerPage: number) => void`} />
|
|
109
109
|
|
|
110
110
|
|
|
111
111
|
### onSortChange
|
|
112
112
|
|
|
113
|
-
<MemberInfo kind="property" type={`(table: TableType
|
|
113
|
+
<MemberInfo kind="property" type={`(table: TableType<TData>, sorting: SortingState) => void`} />
|
|
114
114
|
|
|
115
115
|
|
|
116
116
|
### onFilterChange
|
|
117
117
|
|
|
118
|
-
<MemberInfo kind="property" type={`(table: TableType
|
|
118
|
+
<MemberInfo kind="property" type={`(table: TableType<TData>, columnFilters: ColumnFilter[]) => void`} />
|
|
119
119
|
|
|
120
120
|
|
|
121
121
|
### onColumnVisibilityChange
|
|
122
122
|
|
|
123
|
-
<MemberInfo kind="property" type={`(table: TableType
|
|
123
|
+
<MemberInfo kind="property" type={`(table: TableType<TData>, columnVisibility: VisibilityState) => void`} />
|
|
124
124
|
|
|
125
125
|
|
|
126
126
|
### onSearchTermChange
|
|
127
127
|
|
|
128
|
-
<MemberInfo kind="property" type={`(searchTerm: string)
|
|
128
|
+
<MemberInfo kind="property" type={`(searchTerm: string) => void`} />
|
|
129
129
|
|
|
130
130
|
|
|
131
131
|
### defaultColumnVisibility
|
|
@@ -150,18 +150,18 @@ interface DataTableProps<TData> {
|
|
|
150
150
|
|
|
151
151
|
### setTableOptions
|
|
152
152
|
|
|
153
|
-
<MemberInfo kind="property" type={`(table: TableOptions
|
|
153
|
+
<MemberInfo kind="property" type={`(table: TableOptions<TData>) => TableOptions<TData>`} />
|
|
154
154
|
|
|
155
155
|
This property allows full control over _all_ features of TanStack Table
|
|
156
156
|
when needed.
|
|
157
157
|
### onRefresh
|
|
158
158
|
|
|
159
|
-
<MemberInfo kind="property" type={`()
|
|
159
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
160
160
|
|
|
161
161
|
|
|
162
162
|
### onReorder
|
|
163
163
|
|
|
164
|
-
<MemberInfo kind="property" type={`(oldIndex: number, newIndex: number, item: TData, allItems?: TData[])
|
|
164
|
+
<MemberInfo kind="property" type={`(oldIndex: number, newIndex: number, item: TData, allItems?: TData[]) => void | Promise<void>`} />
|
|
165
165
|
|
|
166
166
|
Callback when items are reordered via drag and drop.
|
|
167
167
|
When provided, enables drag-and-drop functionality.
|