@propeller-commerce/propeller-v2-react-ui 0.7.0 → 0.8.0
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/CHANGELOG.md +56 -0
- package/dist/index.cjs +110 -78
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +87 -2
- package/dist/index.d.ts +87 -2
- package/dist/index.js +111 -80
- package/dist/index.js.map +1 -1
- package/dist/pure.cjs +1 -1
- package/dist/pure.cjs.map +1 -1
- package/dist/pure.d.cts +5 -0
- package/dist/pure.d.ts +5 -0
- package/dist/pure.js +1 -1
- package/dist/pure.js.map +1 -1
- package/dist/styles.css +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -185,6 +185,11 @@ interface ProductGridConfig {
|
|
|
185
185
|
afterAddToCart?: (cart: Cart, item?: CartMainItem) => void;
|
|
186
186
|
/** Called when the user chooses to proceed to checkout. */
|
|
187
187
|
onProceedToCheckout?: () => void;
|
|
188
|
+
/**
|
|
189
|
+
* Called when an anonymous visitor clicks the log-in action that replaces
|
|
190
|
+
* add-to-cart in a semi-closed portal. The host owns navigation.
|
|
191
|
+
*/
|
|
192
|
+
onLoginClick?: () => void;
|
|
188
193
|
/** Called when the user clicks the request-a-quote action. */
|
|
189
194
|
onRequestQuoteClick?: (cart: Cart) => void;
|
|
190
195
|
/** Called when a product/cluster favorite is toggled; `isFavorite` is the new state. */
|
|
@@ -3570,6 +3575,13 @@ interface ClusterCardProps {
|
|
|
3570
3575
|
showSku?: boolean;
|
|
3571
3576
|
/** Show the default product manufacturer. Defaults to false. */
|
|
3572
3577
|
showManufacturer?: boolean;
|
|
3578
|
+
/** Authenticated user. Resolved from PropellerProvider when omitted. */
|
|
3579
|
+
user?: Contact | Customer | null;
|
|
3580
|
+
/**
|
|
3581
|
+
* Portal access mode. In `'semi-closed'` price and stock are withheld from
|
|
3582
|
+
* anonymous visitors. Resolved from PropellerProvider when omitted.
|
|
3583
|
+
*/
|
|
3584
|
+
portalMode?: string;
|
|
3573
3585
|
/**
|
|
3574
3586
|
* Show default product stock information (quantity badge).
|
|
3575
3587
|
* Reads `defaultProduct.inventory.totalQuantity`. Defaults to true.
|
|
@@ -4059,6 +4071,14 @@ interface ClusterOptionsProps {
|
|
|
4059
4071
|
showErrors?: boolean;
|
|
4060
4072
|
/** Currency symbol for prices. Defaults to '€'. */
|
|
4061
4073
|
currency?: string;
|
|
4074
|
+
/** Authenticated user. Resolved from PropellerProvider when omitted. */
|
|
4075
|
+
user?: Contact | Customer | null;
|
|
4076
|
+
/**
|
|
4077
|
+
* Portal access mode. In `'semi-closed'` option prices are omitted from the
|
|
4078
|
+
* dropdown labels and preview for anonymous visitors. Resolved from
|
|
4079
|
+
* PropellerProvider when omitted.
|
|
4080
|
+
*/
|
|
4081
|
+
portalMode?: string;
|
|
4062
4082
|
/** Extra CSS class applied to the root element. */
|
|
4063
4083
|
className?: string;
|
|
4064
4084
|
}
|
|
@@ -4839,6 +4859,35 @@ interface ItemStockProps {
|
|
|
4839
4859
|
declare function ItemStock(props: ItemStockProps): React$1.JSX.Element;
|
|
4840
4860
|
declare const _default: React$1.MemoExoticComponent<typeof ItemStock>;
|
|
4841
4861
|
|
|
4862
|
+
/**
|
|
4863
|
+
* @rsc-blocked — Client-only component: takes an onClick handler.
|
|
4864
|
+
* Must be rendered inside (or below) a Client Component boundary; cannot be
|
|
4865
|
+
* imported directly into a React Server Component. The 'use client' header
|
|
4866
|
+
* above marks this boundary to Next.js.
|
|
4867
|
+
*/
|
|
4868
|
+
|
|
4869
|
+
interface LoginToOrderButtonProps {
|
|
4870
|
+
/**
|
|
4871
|
+
* Invoked when the button is clicked. The host owns navigation — the package
|
|
4872
|
+
* cannot know whether the app routes with a Next `<Link>`, a Vue router or a
|
|
4873
|
+
* plain redirect. When omitted the button still renders but does nothing.
|
|
4874
|
+
*/
|
|
4875
|
+
onLoginClick?: () => void;
|
|
4876
|
+
/** Translated labels. Key: `loginToOrder`. */
|
|
4877
|
+
labels?: Record<string, string>;
|
|
4878
|
+
/** Extra classes appended to the button. */
|
|
4879
|
+
className?: string;
|
|
4880
|
+
}
|
|
4881
|
+
/**
|
|
4882
|
+
* Log-in call to action shown in place of add-to-cart.
|
|
4883
|
+
*
|
|
4884
|
+
* A semi-closed portal hides ordering from anonymous visitors. Rendering
|
|
4885
|
+
* nothing in that slot leaves a dead end, so callers swap in this button:
|
|
4886
|
+
* it occupies the same position as the add-to-cart control and sends the
|
|
4887
|
+
* visitor to the host's login route.
|
|
4888
|
+
*/
|
|
4889
|
+
declare function LoginToOrderButton(props: LoginToOrderButtonProps): React$1.JSX.Element;
|
|
4890
|
+
|
|
4842
4891
|
/**
|
|
4843
4892
|
* @rsc-blocked — Client-only component: JSX event handlers (onClick/onChange/etc.).
|
|
4844
4893
|
* Must be rendered inside (or below) a Client Component boundary; cannot be
|
|
@@ -5558,6 +5607,11 @@ interface ProductBundlesProps {
|
|
|
5558
5607
|
* modalTitle, continueShopping, proceedToCheckout, noCartId
|
|
5559
5608
|
*/
|
|
5560
5609
|
labels?: Record<string, string>;
|
|
5610
|
+
/**
|
|
5611
|
+
* Show the "log in to see prices" prompt when prices are hidden.
|
|
5612
|
+
* Defaults to true; pass false to render nothing in its place.
|
|
5613
|
+
*/
|
|
5614
|
+
showLoginPrompt?: boolean;
|
|
5561
5615
|
/**
|
|
5562
5616
|
* When true a modal popup is shown after a successful add-to-cart
|
|
5563
5617
|
* with buttons to continue shopping or proceed to checkout.
|
|
@@ -5673,6 +5727,18 @@ interface ProductCardProps {
|
|
|
5673
5727
|
graphqlClient?: GraphQLClient;
|
|
5674
5728
|
/** Authenticated user. Resolved from PropellerProvider when omitted. */
|
|
5675
5729
|
user?: Contact | Customer | null;
|
|
5730
|
+
/**
|
|
5731
|
+
* Portal access mode — `'open'` / `'semi-closed'` / `'closed'`. Resolved from
|
|
5732
|
+
* PropellerProvider when omitted. In `'semi-closed'` the card hides price and
|
|
5733
|
+
* stock from anonymous visitors and offers a log-in action in place of
|
|
5734
|
+
* add-to-cart; signed-in users are unaffected.
|
|
5735
|
+
*/
|
|
5736
|
+
portalMode?: string;
|
|
5737
|
+
/**
|
|
5738
|
+
* Invoked when an anonymous visitor clicks the log-in action that replaces
|
|
5739
|
+
* add-to-cart in a semi-closed portal. The host owns navigation.
|
|
5740
|
+
*/
|
|
5741
|
+
onLoginClick?: () => void;
|
|
5676
5742
|
/** ID of the cart that add-to-cart targets. */
|
|
5677
5743
|
cartId?: string;
|
|
5678
5744
|
/** Configuration object (URL builders, image filters, etc.). */
|
|
@@ -6083,6 +6149,11 @@ interface ProductGridProps {
|
|
|
6083
6149
|
/** * When true, AddToCart shows a success modal instead of a toast. * Defaults to false. */ showModal?: boolean;
|
|
6084
6150
|
/** * Render − / + stepper buttons in AddToCart. * Defaults to true. */ allowIncrDecr?: boolean;
|
|
6085
6151
|
/** Called when "Proceed to checkout" is clicked in the AddToCart modal. */ onProceedToCheckout?: () => void;
|
|
6152
|
+
/**
|
|
6153
|
+
* Called when an anonymous visitor clicks the log-in action that replaces
|
|
6154
|
+
* add-to-cart in a semi-closed portal. The host owns navigation.
|
|
6155
|
+
*/
|
|
6156
|
+
onLoginClick?: () => void;
|
|
6086
6157
|
/** Called when "Request a Quote" is clicked in the AddToCart modal. */ onRequestQuoteClick?: (cart: Cart) => void;
|
|
6087
6158
|
/** * Label overrides forwarded directly to the embedded AddToCart component. * Keys: add, adding, addedToCart, outOfStock, noCartId, errorAdding, * modalTitle, quantity, continueShopping, proceedToCheckout */ addToCartLabels?: Record<string, string>;
|
|
6088
6159
|
/** * Show the stock / availability widget on each product card. * Forwarded directly to `ProductCard.showStock`. * Defaults to false. */ showStock?: boolean;
|
|
@@ -6292,8 +6363,17 @@ interface ProductInfoProps {
|
|
|
6292
6363
|
includeTax?: boolean;
|
|
6293
6364
|
/** Currency symbol used by the price section. */
|
|
6294
6365
|
currency?: string;
|
|
6295
|
-
/**
|
|
6366
|
+
/**
|
|
6367
|
+
* Portal visibility mode. In `'semi-closed'` the price, stock row and
|
|
6368
|
+
* add-to-cart are withheld from anonymous visitors, who get a log-in action
|
|
6369
|
+
* in place of add-to-cart instead.
|
|
6370
|
+
*/
|
|
6296
6371
|
portalMode?: string;
|
|
6372
|
+
/**
|
|
6373
|
+
* Invoked when an anonymous visitor clicks the log-in action that replaces
|
|
6374
|
+
* add-to-cart in a semi-closed portal. The host owns navigation.
|
|
6375
|
+
*/
|
|
6376
|
+
onLoginClick?: () => void;
|
|
6297
6377
|
beforeContent?: (product: Product) => React$1.ReactNode;
|
|
6298
6378
|
afterContent?: (product: Product) => React$1.ReactNode;
|
|
6299
6379
|
/** Compound mode opt-in. When provided, ProductInfo renders the compound
|
|
@@ -6410,6 +6490,11 @@ interface ProductPriceProps {
|
|
|
6410
6490
|
* Available keys: inclTax, exclTax, loginToSeePrices
|
|
6411
6491
|
*/
|
|
6412
6492
|
labels?: Record<string, string>;
|
|
6493
|
+
/**
|
|
6494
|
+
* Show the "log in to see prices" prompt when the price is hidden.
|
|
6495
|
+
* Defaults to true; pass false to render nothing in its place.
|
|
6496
|
+
*/
|
|
6497
|
+
showLoginPrompt?: boolean;
|
|
6413
6498
|
/** Tailwind text-size class for the leading price. Defaults to 'text-3xl'. */
|
|
6414
6499
|
priceSize?: string;
|
|
6415
6500
|
/** Extra CSS class applied to the root element. */
|
|
@@ -7230,4 +7315,4 @@ declare function DefaultProductBadges(props: BadgesComponentProps): React__defau
|
|
|
7230
7315
|
*/
|
|
7231
7316
|
declare function DefaultProductSurcharges(props: ProductSurchargesComponentProps): React__default.JSX.Element | null;
|
|
7232
7317
|
|
|
7233
|
-
export { AccountIconAndMenu, type AccountIconAndMenuProps, ActionCode, type ActionCodeProps, type AddContactFormState, type AddItemOptions, _default$1 as AddToCart, type AddToCartProps, AddToFavorite, type AddToFavoriteProps, AddressCardExport as AddressCard, type AddressCardProps, type AddressInput, AddressSelector, type AddressSelectorProps, type AttributeDisplayItem, type AttributeGroup, BreadcrumbsWithProvider as Breadcrumbs, type BreadcrumbsProps, CartBonusItems, type CartBonusItemsProps, CartCarriers, type CartCarriersProps, CartIconAndSidebar, type CartIconAndSidebarProps, type CartInitConfig, CartItemExport as CartItem, type CartItemProps, CartOverview, type CartOverviewProps, CartPaymethods, type CartPaymethodsProps, CartSummary, type CartSummaryProps, CategoryDescription, type CategoryDescriptionProps, CategoryShortDescriptionWithProvider as CategoryShortDescription, type CategoryShortDescriptionProps, ClusterCardExport as ClusterCard, type ClusterCardProps, ClusterConfigurator, type ClusterConfiguratorProps, ClusterInfo, type ClusterInfoProps, ClusterOptions, type ClusterOptionsProps, CompanySwitcher, type CompanySwitcherProps, type ConfiguredSetting, _default$1 as DefaultAddToCart, AddToFavorite as DefaultAddToFavorite, _default as DefaultItemStock, DefaultProductBadges, ProductBulkPrices as DefaultProductBulkPrices, ProductBundles as DefaultProductBundles, DefaultProductImage, ProductPriceDisplay as DefaultProductPrice, DefaultProductSurcharges, DeliveryDate, type DeliveryDateProps, FavoriteListDetails, type FavoriteListDetailsProps, type FavoriteListFormData, FavoriteListItemExport as FavoriteListItem, type FavoriteListItemProps, FavoriteLists, type FavoriteListsProps, type FetchActiveCartConfig, type FetchCrossupsellsInput, ForgotPassword, type ForgotPasswordProps, type GetCrossupsellsOptions, GridFilters, GridFiltersPanel, type GridFiltersPanelProps, type GridFiltersProps, GridPagination, type GridPaginationProps, GridTitleWithProvider as GridTitle, type GridTitleProps, GridToolbar, type GridToolbarProps, _default as ItemStock, type ItemStockProps, ItemsOverview, type ItemsOverviewProps, LoginFormExport as LoginForm, type LoginFormProps, MachineCard, type MachineCardProps, MachineGrid, type MachineGridProps, type MachineListingState, Menu, type MenuCategory, type MenuProps, OrderActions, type OrderActionsProps, OrderBonusItems, type OrderBonusItemsProps, OrderItemCard, type OrderItemCardProps, OrderList, type OrderListProps, type OrderSearchForm, OrderShipments, type OrderShipmentsProps, OrderSummary, type OrderSummaryProps, OrderTotals, type OrderTotalsProps, type PlaceOrderOptions, PriceToggle, type PriceToggleProps, ProductBulkPricesWithProvider as ProductBulkPrices, type ProductBulkPricesProps, ProductBundles, type ProductBundlesProps, ProductCard, type ProductCardProps, ProductDescription, type ProductDescriptionProps, ProductDownloads, type ProductDownloadsProps, ProductGallery, type ProductGalleryProps, ProductGridCompound as ProductGrid, type ProductGridConfig, ProductGridConfigProvider, type ProductGridProps, ProductInfoExport as ProductInfo, type ProductInfoProps, ProductPriceWithProvider as ProductPrice, type ProductPriceProps, ProductShortDescriptionWithProvider as ProductShortDescription, type ProductShortDescriptionProps, ProductSlider, type ProductSliderProps, ProductSpecifications, type ProductSpecificationsProps, ProductTabs, type ProductTabsProps, ProductVideos, type ProductVideosProps, type PropellerDeps, PropellerDepsProvider, type PropellerDepsProviderProps, type PropellerInfra, PropellerProvider, type PropellerProviderProps, type PropellerScope, PurchaseAuthorizationConfigurator, type PurchaseAuthorizationConfiguratorProps, PurchaseAuthorizationRequests, type PurchaseAuthorizationRequestsProps, QuickOrder, type QuickOrderLine, type QuickOrderMatch, type QuickOrderProps, type QuickOrderSubmitResult, type QuickOrderUploadLine, QuoteActions, type QuoteActionsProps, RegisterForm, type RegisterFormProps, type ResolveSpec, type RowEdit, SearchBar, type SearchBarProps, type UseAddressOptions, type UseAddressReturn, type LoginResult as UseAuthLoginResult, type UseAuthOptions, type RegisterContactInput as UseAuthRegisterContactInput, type RegisterCustomerInput as UseAuthRegisterCustomerInput, type UseAuthReturn, type UseCartOptions, type UseCartReturn, type UseCheckoutOptions, type UseCheckoutReturn, type UseClusterConfiguratorOptions, type UseClusterConfiguratorReturn, type UseCompanyOptions, type UseCompanyReturn, type UseFavoritesOptions, type UseFavoritesReturn, type UseMachinesOptions, type UseMachinesReturn, type UseMenuOptions, type UseMenuReturn, type UseOrdersOptions, type UseOrdersReturn, type BundleItem as UseProductBundlesBundleItem, type UseProductBundlesOptions, type UseProductBundlesReturn, type UseProductInfoOptions, type UseProductInfoReturn, type UseProductSearchOptions, type UseProductSearchReturn, type UseProductSliderOptions, type UseProductSliderReturn, type UseProductSpecsOptions, type UseProductSpecsReturn, type UsePurchaseAuthorizationConfiguratorOptions, type UsePurchaseAuthorizationConfiguratorReturn, type UsePurchaseAuthorizationRequestsOptions, type UsePurchaseAuthorizationRequestsReturn, type UseQuickOrderOptions, type UseQuickOrderReturn, type UseSparePartsOptions, type UseSparePartsReturn, UserDetails, type UserDetailsProps, buildRootMachinesQuery, fetchActiveCart, initCart, mergeAnonymousCart, useAddress, useAuth, useCart, useCheckout, useClusterConfigurator, useCompany, useFavorites, useInfraProps, useMachines, useMenu, useOrders, useProductBundles, useProductGridConfig, useProductInfo, useProductSearch, useProductSlider, useProductSpecs, usePropellerContext, usePropellerDeps, usePropellerScope, usePurchaseAuthorizationConfigurator, usePurchaseAuthorizationRequests, useQuickOrder, useRequiredPropellerDeps, useResolvedProps, useServices, useSpareParts, useUserMode };
|
|
7318
|
+
export { AccountIconAndMenu, type AccountIconAndMenuProps, ActionCode, type ActionCodeProps, type AddContactFormState, type AddItemOptions, _default$1 as AddToCart, type AddToCartProps, AddToFavorite, type AddToFavoriteProps, AddressCardExport as AddressCard, type AddressCardProps, type AddressInput, AddressSelector, type AddressSelectorProps, type AttributeDisplayItem, type AttributeGroup, BreadcrumbsWithProvider as Breadcrumbs, type BreadcrumbsProps, CartBonusItems, type CartBonusItemsProps, CartCarriers, type CartCarriersProps, CartIconAndSidebar, type CartIconAndSidebarProps, type CartInitConfig, CartItemExport as CartItem, type CartItemProps, CartOverview, type CartOverviewProps, CartPaymethods, type CartPaymethodsProps, CartSummary, type CartSummaryProps, CategoryDescription, type CategoryDescriptionProps, CategoryShortDescriptionWithProvider as CategoryShortDescription, type CategoryShortDescriptionProps, ClusterCardExport as ClusterCard, type ClusterCardProps, ClusterConfigurator, type ClusterConfiguratorProps, ClusterInfo, type ClusterInfoProps, ClusterOptions, type ClusterOptionsProps, CompanySwitcher, type CompanySwitcherProps, type ConfiguredSetting, _default$1 as DefaultAddToCart, AddToFavorite as DefaultAddToFavorite, _default as DefaultItemStock, DefaultProductBadges, ProductBulkPrices as DefaultProductBulkPrices, ProductBundles as DefaultProductBundles, DefaultProductImage, ProductPriceDisplay as DefaultProductPrice, DefaultProductSurcharges, DeliveryDate, type DeliveryDateProps, FavoriteListDetails, type FavoriteListDetailsProps, type FavoriteListFormData, FavoriteListItemExport as FavoriteListItem, type FavoriteListItemProps, FavoriteLists, type FavoriteListsProps, type FetchActiveCartConfig, type FetchCrossupsellsInput, ForgotPassword, type ForgotPasswordProps, type GetCrossupsellsOptions, GridFilters, GridFiltersPanel, type GridFiltersPanelProps, type GridFiltersProps, GridPagination, type GridPaginationProps, GridTitleWithProvider as GridTitle, type GridTitleProps, GridToolbar, type GridToolbarProps, _default as ItemStock, type ItemStockProps, ItemsOverview, type ItemsOverviewProps, LoginFormExport as LoginForm, type LoginFormProps, LoginToOrderButton, type LoginToOrderButtonProps, MachineCard, type MachineCardProps, MachineGrid, type MachineGridProps, type MachineListingState, Menu, type MenuCategory, type MenuProps, OrderActions, type OrderActionsProps, OrderBonusItems, type OrderBonusItemsProps, OrderItemCard, type OrderItemCardProps, OrderList, type OrderListProps, type OrderSearchForm, OrderShipments, type OrderShipmentsProps, OrderSummary, type OrderSummaryProps, OrderTotals, type OrderTotalsProps, type PlaceOrderOptions, PriceToggle, type PriceToggleProps, ProductBulkPricesWithProvider as ProductBulkPrices, type ProductBulkPricesProps, ProductBundles, type ProductBundlesProps, ProductCard, type ProductCardProps, ProductDescription, type ProductDescriptionProps, ProductDownloads, type ProductDownloadsProps, ProductGallery, type ProductGalleryProps, ProductGridCompound as ProductGrid, type ProductGridConfig, ProductGridConfigProvider, type ProductGridProps, ProductInfoExport as ProductInfo, type ProductInfoProps, ProductPriceWithProvider as ProductPrice, type ProductPriceProps, ProductShortDescriptionWithProvider as ProductShortDescription, type ProductShortDescriptionProps, ProductSlider, type ProductSliderProps, ProductSpecifications, type ProductSpecificationsProps, ProductTabs, type ProductTabsProps, ProductVideos, type ProductVideosProps, type PropellerDeps, PropellerDepsProvider, type PropellerDepsProviderProps, type PropellerInfra, PropellerProvider, type PropellerProviderProps, type PropellerScope, PurchaseAuthorizationConfigurator, type PurchaseAuthorizationConfiguratorProps, PurchaseAuthorizationRequests, type PurchaseAuthorizationRequestsProps, QuickOrder, type QuickOrderLine, type QuickOrderMatch, type QuickOrderProps, type QuickOrderSubmitResult, type QuickOrderUploadLine, QuoteActions, type QuoteActionsProps, RegisterForm, type RegisterFormProps, type ResolveSpec, type RowEdit, SearchBar, type SearchBarProps, type UseAddressOptions, type UseAddressReturn, type LoginResult as UseAuthLoginResult, type UseAuthOptions, type RegisterContactInput as UseAuthRegisterContactInput, type RegisterCustomerInput as UseAuthRegisterCustomerInput, type UseAuthReturn, type UseCartOptions, type UseCartReturn, type UseCheckoutOptions, type UseCheckoutReturn, type UseClusterConfiguratorOptions, type UseClusterConfiguratorReturn, type UseCompanyOptions, type UseCompanyReturn, type UseFavoritesOptions, type UseFavoritesReturn, type UseMachinesOptions, type UseMachinesReturn, type UseMenuOptions, type UseMenuReturn, type UseOrdersOptions, type UseOrdersReturn, type BundleItem as UseProductBundlesBundleItem, type UseProductBundlesOptions, type UseProductBundlesReturn, type UseProductInfoOptions, type UseProductInfoReturn, type UseProductSearchOptions, type UseProductSearchReturn, type UseProductSliderOptions, type UseProductSliderReturn, type UseProductSpecsOptions, type UseProductSpecsReturn, type UsePurchaseAuthorizationConfiguratorOptions, type UsePurchaseAuthorizationConfiguratorReturn, type UsePurchaseAuthorizationRequestsOptions, type UsePurchaseAuthorizationRequestsReturn, type UseQuickOrderOptions, type UseQuickOrderReturn, type UseSparePartsOptions, type UseSparePartsReturn, UserDetails, type UserDetailsProps, buildRootMachinesQuery, fetchActiveCart, initCart, mergeAnonymousCart, useAddress, useAuth, useCart, useCheckout, useClusterConfigurator, useCompany, useFavorites, useInfraProps, useMachines, useMenu, useOrders, useProductBundles, useProductGridConfig, useProductInfo, useProductSearch, useProductSlider, useProductSpecs, usePropellerContext, usePropellerDeps, usePropellerScope, usePurchaseAuthorizationConfigurator, usePurchaseAuthorizationRequests, useQuickOrder, useRequiredPropellerDeps, useResolvedProps, useServices, useSpareParts, useUserMode };
|
package/dist/index.d.ts
CHANGED
|
@@ -185,6 +185,11 @@ interface ProductGridConfig {
|
|
|
185
185
|
afterAddToCart?: (cart: Cart, item?: CartMainItem) => void;
|
|
186
186
|
/** Called when the user chooses to proceed to checkout. */
|
|
187
187
|
onProceedToCheckout?: () => void;
|
|
188
|
+
/**
|
|
189
|
+
* Called when an anonymous visitor clicks the log-in action that replaces
|
|
190
|
+
* add-to-cart in a semi-closed portal. The host owns navigation.
|
|
191
|
+
*/
|
|
192
|
+
onLoginClick?: () => void;
|
|
188
193
|
/** Called when the user clicks the request-a-quote action. */
|
|
189
194
|
onRequestQuoteClick?: (cart: Cart) => void;
|
|
190
195
|
/** Called when a product/cluster favorite is toggled; `isFavorite` is the new state. */
|
|
@@ -3570,6 +3575,13 @@ interface ClusterCardProps {
|
|
|
3570
3575
|
showSku?: boolean;
|
|
3571
3576
|
/** Show the default product manufacturer. Defaults to false. */
|
|
3572
3577
|
showManufacturer?: boolean;
|
|
3578
|
+
/** Authenticated user. Resolved from PropellerProvider when omitted. */
|
|
3579
|
+
user?: Contact | Customer | null;
|
|
3580
|
+
/**
|
|
3581
|
+
* Portal access mode. In `'semi-closed'` price and stock are withheld from
|
|
3582
|
+
* anonymous visitors. Resolved from PropellerProvider when omitted.
|
|
3583
|
+
*/
|
|
3584
|
+
portalMode?: string;
|
|
3573
3585
|
/**
|
|
3574
3586
|
* Show default product stock information (quantity badge).
|
|
3575
3587
|
* Reads `defaultProduct.inventory.totalQuantity`. Defaults to true.
|
|
@@ -4059,6 +4071,14 @@ interface ClusterOptionsProps {
|
|
|
4059
4071
|
showErrors?: boolean;
|
|
4060
4072
|
/** Currency symbol for prices. Defaults to '€'. */
|
|
4061
4073
|
currency?: string;
|
|
4074
|
+
/** Authenticated user. Resolved from PropellerProvider when omitted. */
|
|
4075
|
+
user?: Contact | Customer | null;
|
|
4076
|
+
/**
|
|
4077
|
+
* Portal access mode. In `'semi-closed'` option prices are omitted from the
|
|
4078
|
+
* dropdown labels and preview for anonymous visitors. Resolved from
|
|
4079
|
+
* PropellerProvider when omitted.
|
|
4080
|
+
*/
|
|
4081
|
+
portalMode?: string;
|
|
4062
4082
|
/** Extra CSS class applied to the root element. */
|
|
4063
4083
|
className?: string;
|
|
4064
4084
|
}
|
|
@@ -4839,6 +4859,35 @@ interface ItemStockProps {
|
|
|
4839
4859
|
declare function ItemStock(props: ItemStockProps): React$1.JSX.Element;
|
|
4840
4860
|
declare const _default: React$1.MemoExoticComponent<typeof ItemStock>;
|
|
4841
4861
|
|
|
4862
|
+
/**
|
|
4863
|
+
* @rsc-blocked — Client-only component: takes an onClick handler.
|
|
4864
|
+
* Must be rendered inside (or below) a Client Component boundary; cannot be
|
|
4865
|
+
* imported directly into a React Server Component. The 'use client' header
|
|
4866
|
+
* above marks this boundary to Next.js.
|
|
4867
|
+
*/
|
|
4868
|
+
|
|
4869
|
+
interface LoginToOrderButtonProps {
|
|
4870
|
+
/**
|
|
4871
|
+
* Invoked when the button is clicked. The host owns navigation — the package
|
|
4872
|
+
* cannot know whether the app routes with a Next `<Link>`, a Vue router or a
|
|
4873
|
+
* plain redirect. When omitted the button still renders but does nothing.
|
|
4874
|
+
*/
|
|
4875
|
+
onLoginClick?: () => void;
|
|
4876
|
+
/** Translated labels. Key: `loginToOrder`. */
|
|
4877
|
+
labels?: Record<string, string>;
|
|
4878
|
+
/** Extra classes appended to the button. */
|
|
4879
|
+
className?: string;
|
|
4880
|
+
}
|
|
4881
|
+
/**
|
|
4882
|
+
* Log-in call to action shown in place of add-to-cart.
|
|
4883
|
+
*
|
|
4884
|
+
* A semi-closed portal hides ordering from anonymous visitors. Rendering
|
|
4885
|
+
* nothing in that slot leaves a dead end, so callers swap in this button:
|
|
4886
|
+
* it occupies the same position as the add-to-cart control and sends the
|
|
4887
|
+
* visitor to the host's login route.
|
|
4888
|
+
*/
|
|
4889
|
+
declare function LoginToOrderButton(props: LoginToOrderButtonProps): React$1.JSX.Element;
|
|
4890
|
+
|
|
4842
4891
|
/**
|
|
4843
4892
|
* @rsc-blocked — Client-only component: JSX event handlers (onClick/onChange/etc.).
|
|
4844
4893
|
* Must be rendered inside (or below) a Client Component boundary; cannot be
|
|
@@ -5558,6 +5607,11 @@ interface ProductBundlesProps {
|
|
|
5558
5607
|
* modalTitle, continueShopping, proceedToCheckout, noCartId
|
|
5559
5608
|
*/
|
|
5560
5609
|
labels?: Record<string, string>;
|
|
5610
|
+
/**
|
|
5611
|
+
* Show the "log in to see prices" prompt when prices are hidden.
|
|
5612
|
+
* Defaults to true; pass false to render nothing in its place.
|
|
5613
|
+
*/
|
|
5614
|
+
showLoginPrompt?: boolean;
|
|
5561
5615
|
/**
|
|
5562
5616
|
* When true a modal popup is shown after a successful add-to-cart
|
|
5563
5617
|
* with buttons to continue shopping or proceed to checkout.
|
|
@@ -5673,6 +5727,18 @@ interface ProductCardProps {
|
|
|
5673
5727
|
graphqlClient?: GraphQLClient;
|
|
5674
5728
|
/** Authenticated user. Resolved from PropellerProvider when omitted. */
|
|
5675
5729
|
user?: Contact | Customer | null;
|
|
5730
|
+
/**
|
|
5731
|
+
* Portal access mode — `'open'` / `'semi-closed'` / `'closed'`. Resolved from
|
|
5732
|
+
* PropellerProvider when omitted. In `'semi-closed'` the card hides price and
|
|
5733
|
+
* stock from anonymous visitors and offers a log-in action in place of
|
|
5734
|
+
* add-to-cart; signed-in users are unaffected.
|
|
5735
|
+
*/
|
|
5736
|
+
portalMode?: string;
|
|
5737
|
+
/**
|
|
5738
|
+
* Invoked when an anonymous visitor clicks the log-in action that replaces
|
|
5739
|
+
* add-to-cart in a semi-closed portal. The host owns navigation.
|
|
5740
|
+
*/
|
|
5741
|
+
onLoginClick?: () => void;
|
|
5676
5742
|
/** ID of the cart that add-to-cart targets. */
|
|
5677
5743
|
cartId?: string;
|
|
5678
5744
|
/** Configuration object (URL builders, image filters, etc.). */
|
|
@@ -6083,6 +6149,11 @@ interface ProductGridProps {
|
|
|
6083
6149
|
/** * When true, AddToCart shows a success modal instead of a toast. * Defaults to false. */ showModal?: boolean;
|
|
6084
6150
|
/** * Render − / + stepper buttons in AddToCart. * Defaults to true. */ allowIncrDecr?: boolean;
|
|
6085
6151
|
/** Called when "Proceed to checkout" is clicked in the AddToCart modal. */ onProceedToCheckout?: () => void;
|
|
6152
|
+
/**
|
|
6153
|
+
* Called when an anonymous visitor clicks the log-in action that replaces
|
|
6154
|
+
* add-to-cart in a semi-closed portal. The host owns navigation.
|
|
6155
|
+
*/
|
|
6156
|
+
onLoginClick?: () => void;
|
|
6086
6157
|
/** Called when "Request a Quote" is clicked in the AddToCart modal. */ onRequestQuoteClick?: (cart: Cart) => void;
|
|
6087
6158
|
/** * Label overrides forwarded directly to the embedded AddToCart component. * Keys: add, adding, addedToCart, outOfStock, noCartId, errorAdding, * modalTitle, quantity, continueShopping, proceedToCheckout */ addToCartLabels?: Record<string, string>;
|
|
6088
6159
|
/** * Show the stock / availability widget on each product card. * Forwarded directly to `ProductCard.showStock`. * Defaults to false. */ showStock?: boolean;
|
|
@@ -6292,8 +6363,17 @@ interface ProductInfoProps {
|
|
|
6292
6363
|
includeTax?: boolean;
|
|
6293
6364
|
/** Currency symbol used by the price section. */
|
|
6294
6365
|
currency?: string;
|
|
6295
|
-
/**
|
|
6366
|
+
/**
|
|
6367
|
+
* Portal visibility mode. In `'semi-closed'` the price, stock row and
|
|
6368
|
+
* add-to-cart are withheld from anonymous visitors, who get a log-in action
|
|
6369
|
+
* in place of add-to-cart instead.
|
|
6370
|
+
*/
|
|
6296
6371
|
portalMode?: string;
|
|
6372
|
+
/**
|
|
6373
|
+
* Invoked when an anonymous visitor clicks the log-in action that replaces
|
|
6374
|
+
* add-to-cart in a semi-closed portal. The host owns navigation.
|
|
6375
|
+
*/
|
|
6376
|
+
onLoginClick?: () => void;
|
|
6297
6377
|
beforeContent?: (product: Product) => React$1.ReactNode;
|
|
6298
6378
|
afterContent?: (product: Product) => React$1.ReactNode;
|
|
6299
6379
|
/** Compound mode opt-in. When provided, ProductInfo renders the compound
|
|
@@ -6410,6 +6490,11 @@ interface ProductPriceProps {
|
|
|
6410
6490
|
* Available keys: inclTax, exclTax, loginToSeePrices
|
|
6411
6491
|
*/
|
|
6412
6492
|
labels?: Record<string, string>;
|
|
6493
|
+
/**
|
|
6494
|
+
* Show the "log in to see prices" prompt when the price is hidden.
|
|
6495
|
+
* Defaults to true; pass false to render nothing in its place.
|
|
6496
|
+
*/
|
|
6497
|
+
showLoginPrompt?: boolean;
|
|
6413
6498
|
/** Tailwind text-size class for the leading price. Defaults to 'text-3xl'. */
|
|
6414
6499
|
priceSize?: string;
|
|
6415
6500
|
/** Extra CSS class applied to the root element. */
|
|
@@ -7230,4 +7315,4 @@ declare function DefaultProductBadges(props: BadgesComponentProps): React__defau
|
|
|
7230
7315
|
*/
|
|
7231
7316
|
declare function DefaultProductSurcharges(props: ProductSurchargesComponentProps): React__default.JSX.Element | null;
|
|
7232
7317
|
|
|
7233
|
-
export { AccountIconAndMenu, type AccountIconAndMenuProps, ActionCode, type ActionCodeProps, type AddContactFormState, type AddItemOptions, _default$1 as AddToCart, type AddToCartProps, AddToFavorite, type AddToFavoriteProps, AddressCardExport as AddressCard, type AddressCardProps, type AddressInput, AddressSelector, type AddressSelectorProps, type AttributeDisplayItem, type AttributeGroup, BreadcrumbsWithProvider as Breadcrumbs, type BreadcrumbsProps, CartBonusItems, type CartBonusItemsProps, CartCarriers, type CartCarriersProps, CartIconAndSidebar, type CartIconAndSidebarProps, type CartInitConfig, CartItemExport as CartItem, type CartItemProps, CartOverview, type CartOverviewProps, CartPaymethods, type CartPaymethodsProps, CartSummary, type CartSummaryProps, CategoryDescription, type CategoryDescriptionProps, CategoryShortDescriptionWithProvider as CategoryShortDescription, type CategoryShortDescriptionProps, ClusterCardExport as ClusterCard, type ClusterCardProps, ClusterConfigurator, type ClusterConfiguratorProps, ClusterInfo, type ClusterInfoProps, ClusterOptions, type ClusterOptionsProps, CompanySwitcher, type CompanySwitcherProps, type ConfiguredSetting, _default$1 as DefaultAddToCart, AddToFavorite as DefaultAddToFavorite, _default as DefaultItemStock, DefaultProductBadges, ProductBulkPrices as DefaultProductBulkPrices, ProductBundles as DefaultProductBundles, DefaultProductImage, ProductPriceDisplay as DefaultProductPrice, DefaultProductSurcharges, DeliveryDate, type DeliveryDateProps, FavoriteListDetails, type FavoriteListDetailsProps, type FavoriteListFormData, FavoriteListItemExport as FavoriteListItem, type FavoriteListItemProps, FavoriteLists, type FavoriteListsProps, type FetchActiveCartConfig, type FetchCrossupsellsInput, ForgotPassword, type ForgotPasswordProps, type GetCrossupsellsOptions, GridFilters, GridFiltersPanel, type GridFiltersPanelProps, type GridFiltersProps, GridPagination, type GridPaginationProps, GridTitleWithProvider as GridTitle, type GridTitleProps, GridToolbar, type GridToolbarProps, _default as ItemStock, type ItemStockProps, ItemsOverview, type ItemsOverviewProps, LoginFormExport as LoginForm, type LoginFormProps, MachineCard, type MachineCardProps, MachineGrid, type MachineGridProps, type MachineListingState, Menu, type MenuCategory, type MenuProps, OrderActions, type OrderActionsProps, OrderBonusItems, type OrderBonusItemsProps, OrderItemCard, type OrderItemCardProps, OrderList, type OrderListProps, type OrderSearchForm, OrderShipments, type OrderShipmentsProps, OrderSummary, type OrderSummaryProps, OrderTotals, type OrderTotalsProps, type PlaceOrderOptions, PriceToggle, type PriceToggleProps, ProductBulkPricesWithProvider as ProductBulkPrices, type ProductBulkPricesProps, ProductBundles, type ProductBundlesProps, ProductCard, type ProductCardProps, ProductDescription, type ProductDescriptionProps, ProductDownloads, type ProductDownloadsProps, ProductGallery, type ProductGalleryProps, ProductGridCompound as ProductGrid, type ProductGridConfig, ProductGridConfigProvider, type ProductGridProps, ProductInfoExport as ProductInfo, type ProductInfoProps, ProductPriceWithProvider as ProductPrice, type ProductPriceProps, ProductShortDescriptionWithProvider as ProductShortDescription, type ProductShortDescriptionProps, ProductSlider, type ProductSliderProps, ProductSpecifications, type ProductSpecificationsProps, ProductTabs, type ProductTabsProps, ProductVideos, type ProductVideosProps, type PropellerDeps, PropellerDepsProvider, type PropellerDepsProviderProps, type PropellerInfra, PropellerProvider, type PropellerProviderProps, type PropellerScope, PurchaseAuthorizationConfigurator, type PurchaseAuthorizationConfiguratorProps, PurchaseAuthorizationRequests, type PurchaseAuthorizationRequestsProps, QuickOrder, type QuickOrderLine, type QuickOrderMatch, type QuickOrderProps, type QuickOrderSubmitResult, type QuickOrderUploadLine, QuoteActions, type QuoteActionsProps, RegisterForm, type RegisterFormProps, type ResolveSpec, type RowEdit, SearchBar, type SearchBarProps, type UseAddressOptions, type UseAddressReturn, type LoginResult as UseAuthLoginResult, type UseAuthOptions, type RegisterContactInput as UseAuthRegisterContactInput, type RegisterCustomerInput as UseAuthRegisterCustomerInput, type UseAuthReturn, type UseCartOptions, type UseCartReturn, type UseCheckoutOptions, type UseCheckoutReturn, type UseClusterConfiguratorOptions, type UseClusterConfiguratorReturn, type UseCompanyOptions, type UseCompanyReturn, type UseFavoritesOptions, type UseFavoritesReturn, type UseMachinesOptions, type UseMachinesReturn, type UseMenuOptions, type UseMenuReturn, type UseOrdersOptions, type UseOrdersReturn, type BundleItem as UseProductBundlesBundleItem, type UseProductBundlesOptions, type UseProductBundlesReturn, type UseProductInfoOptions, type UseProductInfoReturn, type UseProductSearchOptions, type UseProductSearchReturn, type UseProductSliderOptions, type UseProductSliderReturn, type UseProductSpecsOptions, type UseProductSpecsReturn, type UsePurchaseAuthorizationConfiguratorOptions, type UsePurchaseAuthorizationConfiguratorReturn, type UsePurchaseAuthorizationRequestsOptions, type UsePurchaseAuthorizationRequestsReturn, type UseQuickOrderOptions, type UseQuickOrderReturn, type UseSparePartsOptions, type UseSparePartsReturn, UserDetails, type UserDetailsProps, buildRootMachinesQuery, fetchActiveCart, initCart, mergeAnonymousCart, useAddress, useAuth, useCart, useCheckout, useClusterConfigurator, useCompany, useFavorites, useInfraProps, useMachines, useMenu, useOrders, useProductBundles, useProductGridConfig, useProductInfo, useProductSearch, useProductSlider, useProductSpecs, usePropellerContext, usePropellerDeps, usePropellerScope, usePurchaseAuthorizationConfigurator, usePurchaseAuthorizationRequests, useQuickOrder, useRequiredPropellerDeps, useResolvedProps, useServices, useSpareParts, useUserMode };
|
|
7318
|
+
export { AccountIconAndMenu, type AccountIconAndMenuProps, ActionCode, type ActionCodeProps, type AddContactFormState, type AddItemOptions, _default$1 as AddToCart, type AddToCartProps, AddToFavorite, type AddToFavoriteProps, AddressCardExport as AddressCard, type AddressCardProps, type AddressInput, AddressSelector, type AddressSelectorProps, type AttributeDisplayItem, type AttributeGroup, BreadcrumbsWithProvider as Breadcrumbs, type BreadcrumbsProps, CartBonusItems, type CartBonusItemsProps, CartCarriers, type CartCarriersProps, CartIconAndSidebar, type CartIconAndSidebarProps, type CartInitConfig, CartItemExport as CartItem, type CartItemProps, CartOverview, type CartOverviewProps, CartPaymethods, type CartPaymethodsProps, CartSummary, type CartSummaryProps, CategoryDescription, type CategoryDescriptionProps, CategoryShortDescriptionWithProvider as CategoryShortDescription, type CategoryShortDescriptionProps, ClusterCardExport as ClusterCard, type ClusterCardProps, ClusterConfigurator, type ClusterConfiguratorProps, ClusterInfo, type ClusterInfoProps, ClusterOptions, type ClusterOptionsProps, CompanySwitcher, type CompanySwitcherProps, type ConfiguredSetting, _default$1 as DefaultAddToCart, AddToFavorite as DefaultAddToFavorite, _default as DefaultItemStock, DefaultProductBadges, ProductBulkPrices as DefaultProductBulkPrices, ProductBundles as DefaultProductBundles, DefaultProductImage, ProductPriceDisplay as DefaultProductPrice, DefaultProductSurcharges, DeliveryDate, type DeliveryDateProps, FavoriteListDetails, type FavoriteListDetailsProps, type FavoriteListFormData, FavoriteListItemExport as FavoriteListItem, type FavoriteListItemProps, FavoriteLists, type FavoriteListsProps, type FetchActiveCartConfig, type FetchCrossupsellsInput, ForgotPassword, type ForgotPasswordProps, type GetCrossupsellsOptions, GridFilters, GridFiltersPanel, type GridFiltersPanelProps, type GridFiltersProps, GridPagination, type GridPaginationProps, GridTitleWithProvider as GridTitle, type GridTitleProps, GridToolbar, type GridToolbarProps, _default as ItemStock, type ItemStockProps, ItemsOverview, type ItemsOverviewProps, LoginFormExport as LoginForm, type LoginFormProps, LoginToOrderButton, type LoginToOrderButtonProps, MachineCard, type MachineCardProps, MachineGrid, type MachineGridProps, type MachineListingState, Menu, type MenuCategory, type MenuProps, OrderActions, type OrderActionsProps, OrderBonusItems, type OrderBonusItemsProps, OrderItemCard, type OrderItemCardProps, OrderList, type OrderListProps, type OrderSearchForm, OrderShipments, type OrderShipmentsProps, OrderSummary, type OrderSummaryProps, OrderTotals, type OrderTotalsProps, type PlaceOrderOptions, PriceToggle, type PriceToggleProps, ProductBulkPricesWithProvider as ProductBulkPrices, type ProductBulkPricesProps, ProductBundles, type ProductBundlesProps, ProductCard, type ProductCardProps, ProductDescription, type ProductDescriptionProps, ProductDownloads, type ProductDownloadsProps, ProductGallery, type ProductGalleryProps, ProductGridCompound as ProductGrid, type ProductGridConfig, ProductGridConfigProvider, type ProductGridProps, ProductInfoExport as ProductInfo, type ProductInfoProps, ProductPriceWithProvider as ProductPrice, type ProductPriceProps, ProductShortDescriptionWithProvider as ProductShortDescription, type ProductShortDescriptionProps, ProductSlider, type ProductSliderProps, ProductSpecifications, type ProductSpecificationsProps, ProductTabs, type ProductTabsProps, ProductVideos, type ProductVideosProps, type PropellerDeps, PropellerDepsProvider, type PropellerDepsProviderProps, type PropellerInfra, PropellerProvider, type PropellerProviderProps, type PropellerScope, PurchaseAuthorizationConfigurator, type PurchaseAuthorizationConfiguratorProps, PurchaseAuthorizationRequests, type PurchaseAuthorizationRequestsProps, QuickOrder, type QuickOrderLine, type QuickOrderMatch, type QuickOrderProps, type QuickOrderSubmitResult, type QuickOrderUploadLine, QuoteActions, type QuoteActionsProps, RegisterForm, type RegisterFormProps, type ResolveSpec, type RowEdit, SearchBar, type SearchBarProps, type UseAddressOptions, type UseAddressReturn, type LoginResult as UseAuthLoginResult, type UseAuthOptions, type RegisterContactInput as UseAuthRegisterContactInput, type RegisterCustomerInput as UseAuthRegisterCustomerInput, type UseAuthReturn, type UseCartOptions, type UseCartReturn, type UseCheckoutOptions, type UseCheckoutReturn, type UseClusterConfiguratorOptions, type UseClusterConfiguratorReturn, type UseCompanyOptions, type UseCompanyReturn, type UseFavoritesOptions, type UseFavoritesReturn, type UseMachinesOptions, type UseMachinesReturn, type UseMenuOptions, type UseMenuReturn, type UseOrdersOptions, type UseOrdersReturn, type BundleItem as UseProductBundlesBundleItem, type UseProductBundlesOptions, type UseProductBundlesReturn, type UseProductInfoOptions, type UseProductInfoReturn, type UseProductSearchOptions, type UseProductSearchReturn, type UseProductSliderOptions, type UseProductSliderReturn, type UseProductSpecsOptions, type UseProductSpecsReturn, type UsePurchaseAuthorizationConfiguratorOptions, type UsePurchaseAuthorizationConfiguratorReturn, type UsePurchaseAuthorizationRequestsOptions, type UsePurchaseAuthorizationRequestsReturn, type UseQuickOrderOptions, type UseQuickOrderReturn, type UseSparePartsOptions, type UseSparePartsReturn, UserDetails, type UserDetailsProps, buildRootMachinesQuery, fetchActiveCart, initCart, mergeAnonymousCart, useAddress, useAuth, useCart, useCheckout, useClusterConfigurator, useCompany, useFavorites, useInfraProps, useMachines, useMenu, useOrders, useProductBundles, useProductGridConfig, useProductInfo, useProductSearch, useProductSlider, useProductSpecs, usePropellerContext, usePropellerDeps, usePropellerScope, usePurchaseAuthorizationConfigurator, usePurchaseAuthorizationRequests, useQuickOrder, useRequiredPropellerDeps, useResolvedProps, useServices, useSpareParts, useUserMode };
|