widget-integration package
Classes
|
Class |
Description |
|---|---|
|
Service for handling recommendation widget analytics and tracking data storage. This service manages the persistence of recommendation widget tracking data to localStorage, enabling analytics and tracking of user interactions with recommendation widgets. It provides customizable storage key generation and error handling that can be extended by Technical Support teams for shop-specific requirements. | |
|
API service for handling recommendation widget requests to the Boost recommendation engine. This service extends to provide specialized functionality for fetching product recommendations from the Boost API. It manages request construction through extensible protected methods that allow Technical Support teams to customize query parameters and body payloads for shop-specific requirements. The service uses a functional pipeline approach to transform request parameters, applying currency settings and B2B configurations automatically while allowing additional customizations through method overrides. | |
|
Data model for recommendation widgets containing configuration and product data. | |
|
Service for managing recommendation widgets and their data. | |
|
Controller for managing recommendation widget lifecycle, rendering, and carousel functionality. This controller orchestrates the complete lifecycle of recommendation widgets, from data fetching to rendering and carousel initialization. It provides numerous extension points for Technical Support teams to customize widget behavior for specific shops without modifying core code. |
Interfaces
|
Interface |
Description |
|---|---|
|
Slick carousel instance interface for type-safe method calls. Provides type definitions for interacting with an initialized Slick carousel. Represents the jQuery plugin instance returned by $('.element').slick(). | |
|
Slick carousel configuration options. Defines the behavior and appearance of the Slick carousel used for recommendation widgets with carousel layout. For complete options reference, see: https://kenwheeler.github.io/slick/ | |
Type Aliases
|
Type Alias |
Description |
|---|---|
|
AdditionalElement Settings | |
|
Cart Settings | |
|
QuickView Settings | |
|
Configuration properties for initializing the RecommendationWidgetController. | |
|
Internal state management for the recommendation widget controller. | |
|
Tracking data structure for recommendation widgets. Defines the shape of data stored for recommendation widget analytics and tracking. This data is persisted to localStorage to track user interactions with recommendation widgets and enable analytics reporting. | |