common

Enumerations

Enumeration	Description
COMMON_SDK_EVENTS	-
REVIEWS_WIDGET_NAMES	-
REWARDS_WIDGET_NAMES	-
WISHLIST_WIDGET_NAMES	-

Classes

Class	Description
ModalClosedSdkEvent	Event detail for modalClosed event.
ModalOpenedSdkEvent	Event detail for modalOpened event.
WidgetClosedSdkEvent	Event detail for widgetClosed event.
WidgetInjectedSdkEvent	Event detail for widgetInjected event.
WidgetOpenedSdkEvent	Event detail for widgetOpened event.

Interfaces

Interface	Description
CustomURLsBuilderInterface	-
ModifyURLFunction	A function type for modifying URLs within the SDK. Takes a URL string as input and returns a modified URL string.

Type Aliases

Type Alias	Description
ModalToken	-

Functions

Function	Description
setCustomURLsBuilder	The setCustomURLsBuilder method allows you to provide custom URL builders for product, collection, and login pages. Use this on custom storefronts where Shopify's standard URL structure (/products/<handle>, /collections/<handle>, /account/login) does not apply.
setGlobalProductId	This method sets a global product ID to be used as a fallback when a widget requires a product ID but none is provided. Using a global product ID ensures consistent behavior across widgets that depend on product-specific data.
setGlobalVariantId	This method sets a global variant ID to be used as a fallback when a widget requires a product variant ID but none is provided. Using a global variant ID ensures consistent behavior across widgets that depend on variant-specific data.
setModifyURLFunction	The setModifyURLFunction method allows you to define a custom function to modify URLs within the SDK. This can be useful for adding query parameters, changing paths, or any other URL transformations needed for your application.