@empathyco/x-components
Version:
Empathy X Components
188 lines (182 loc) • 18.1 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [SnippetCallbacks](./x-components.snippetcallbacks.md)
## SnippetCallbacks variable
This component subscribes to any [XEvent](./x-components.xevent.md) with a custom callbacks provided by the snippet configuration.
**Signature:**
```typescript
_default: import("vue").DefineComponent<{}, {
eventListeners: import("vue").ComputedRef<Partial<{
ColumnsNumberProvided: (payload: number, metadata: WireMetadata) => unknown;
RenderedColumnsNumberChanged: (payload: number, metadata: WireMetadata) => unknown;
SuggestionsDisplayed: (payload: import("@empathyco/x-types").Suggestion[], metadata: WireMetadata) => unknown;
TogglePanelStateChanged: (payload: boolean, metadata: WireMetadata) => unknown;
UserAcceptedAQuery: (payload: string, metadata: WireMetadata) => unknown;
UserAcceptedSpellcheckQuery: (payload: string, metadata: WireMetadata) => unknown;
UserClickedAResult: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
UserClickedADisplayResult: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
UserClickedCloseEventsModal: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedCloseModal: (payload: string, metadata: WireMetadata) => unknown;
UserClickedCloseX: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedOutOfMainModal: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedColumnPicker: (payload: number, metadata: WireMetadata) => unknown;
UserClickedOpenEventsModal: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedOpenModal: (payload: string, metadata: WireMetadata) => unknown;
UserClickedOpenX: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedOutOfEventsModal: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedOutOfModal: (payload: string, metadata: WireMetadata) => unknown;
UserClickedPanelToggleButton: (payload: string, metadata: WireMetadata) => unknown;
UserClickedResultAddToCart: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
UserClickedAResultRating: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
UserClickedScrollToTop: (payload: string, metadata: WireMetadata) => unknown;
UserOpenXProgrammatically: (payload: undefined, metadata: WireMetadata) => unknown;
UserPressedArrowKey: (payload: import("..").ArrowKey, metadata: WireMetadata) => unknown;
UserReachedEmpathizeTop: (payload: undefined, metadata: WireMetadata) => unknown;
UserSelectedAResultVariant: (payload: {
result: import("@empathyco/x-types").Result;
variant: import("@empathyco/x-types").ResultVariant;
level: number;
queryPreviewHash: import("vue").ComputedRef<string> | null;
}, metadata: WireMetadata) => unknown;
UserSelectedASuggestion: (payload: import("@empathyco/x-types").Suggestion, metadata: WireMetadata) => unknown;
SnippetCallbackExecuted: (payload: {
event: import("../wiring").XEvent;
callbackReturn: unknown;
payload: import("..").ExtractPayload<import("../wiring").XEvent>;
metadata: WireMetadata;
}, metadata: WireMetadata) => unknown;
ModuleRegistered: (payload: keyof import("..").XModulesTree, metadata: WireMetadata) => unknown;
DeviceProvided: (payload: string | null, metadata: WireMetadata) => unknown;
EmpathizeClosed: (payload: undefined, metadata: WireMetadata) => unknown;
EmpathizeOpened: (payload: undefined, metadata: WireMetadata) => unknown;
UserClosedEmpathize: (payload: undefined, metadata: WireMetadata) => unknown;
UserChangedExtraParams: (payload: import("@empathyco/x-utils").Dictionary<unknown>, metadata: WireMetadata) => unknown;
ExtraParamsChanged: (payload: import("@empathyco/x-utils").Dictionary<unknown>, metadata: WireMetadata) => unknown;
ExtraParamsProvided: (payload: import("@empathyco/x-utils").Dictionary<unknown>, metadata: WireMetadata) => unknown;
ExtraParamsInitialized: (payload: import("@empathyco/x-utils").Dictionary<unknown>, metadata: WireMetadata) => unknown;
FacetsGroupChanged: (payload: import("..").FacetsGroup, metadata: WireMetadata) => unknown;
FacetsGroupProvided: (payload: import("..").FacetsGroup, metadata: WireMetadata) => unknown;
PreselectedFiltersProvided: (payload: import("@empathyco/x-types").RawFilter[], metadata: WireMetadata) => unknown;
SelectedFiltersChanged: (payload: import("@empathyco/x-types").Filter[], metadata: WireMetadata) => unknown;
SelectedFiltersForRequestChanged: (payload: import("@empathyco/x-types").Filter[], metadata: WireMetadata) => unknown;
UserChangedSelectedFilters: (payload: import("@empathyco/x-types").Filter[], metadata: WireMetadata) => unknown;
UserClickedAFilter: (payload: import("@empathyco/x-types").Filter, metadata: WireMetadata) => unknown;
UserClickedAHierarchicalFilter: (payload: import("@empathyco/x-types").HierarchicalFilter, metadata: WireMetadata) => unknown;
UserClickedANumberRangeFilter: (payload: import("@empathyco/x-types").NumberRangeFilter, metadata: WireMetadata) => unknown;
UserClickedASimpleFilter: (payload: import("@empathyco/x-types").SimpleFilter, metadata: WireMetadata) => unknown;
UserClickedAllFilter: (payload: [string | number], metadata: WireMetadata) => unknown;
UserModifiedEditableNumberRangeFilter: (payload: import("@empathyco/x-types").EditableNumberRangeFilter, metadata: WireMetadata) => unknown;
UserClickedClearAllFilters: (payload: (string | number)[] | undefined, metadata: WireMetadata) => unknown;
FacetsQueryChanged: (payload: string, metadata: WireMetadata) => unknown;
HistoryQueriesDisplayed: (payload: import("@empathyco/x-types").HistoryQuery[], metadata: WireMetadata) => unknown;
HistoryQueriesQueryChanged: (payload: string, metadata: WireMetadata) => unknown;
HistoryQueriesStorageKeyChanged: (payload: string, metadata: WireMetadata) => unknown;
SessionHistoryQueriesChanged: (payload: import("@empathyco/x-types").HistoryQuery[], metadata: WireMetadata) => unknown;
UserPressedClearHistoryQueries: (payload: undefined, metadata: WireMetadata) => unknown;
UserPressedRemoveHistoryQuery: (payload: import("@empathyco/x-types").HistoryQuery, metadata: WireMetadata) => unknown;
UserSelectedAHistoryQuery: (payload: import("@empathyco/x-types").HistoryQuery, metadata: WireMetadata) => unknown;
UserClickedEnableHistoryQueries: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedDisableHistoryQueries: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedConfirmDisableHistoryQueries: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedDismissDisableHistoryQueries: (payload: undefined, metadata: WireMetadata) => unknown;
IdentifierResultsChanged: (payload: import("@empathyco/x-types").Result[], metadata: WireMetadata) => unknown;
IdentifierResultsRequestUpdated: (payload: import("@empathyco/x-types").IdentifierResultsRequest | null, metadata: WireMetadata) => unknown;
UserClickedAIdentifierResult: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
NextQueriesChanged: (payload: import("@empathyco/x-types").NextQuery[], metadata: WireMetadata) => unknown;
NextQueriesDisplayed: (payload: import("@empathyco/x-types").NextQuery[], metadata: WireMetadata) => unknown;
NextQueriesRequestUpdated: (payload: import("@empathyco/x-types").NextQueriesRequest | null, metadata: WireMetadata) => unknown;
UserSelectedANextQuery: (payload: import("@empathyco/x-types").NextQuery, metadata: WireMetadata) => unknown;
NextQueryPreviewMountedHook: (payload: string, metadata: WireMetadata) => unknown;
PopularSearchesRequestUpdated: (payload: import("@empathyco/x-types").PopularSearchesRequest, metadata: WireMetadata) => unknown;
PopularSearchDisplayed: (payload: import("@empathyco/x-types").Suggestion[], metadata: WireMetadata) => unknown;
UserSelectedAPopularSearch: (payload: import("@empathyco/x-types").Suggestion, metadata: WireMetadata) => unknown;
QueryPreviewRequestUpdated: (payload: import("@empathyco/x-types").SearchRequest, metadata: WireMetadata) => unknown;
UserAcceptedAQueryPreview: (payload: import("..").QueryPreviewInfo, metadata: WireMetadata) => unknown;
QueryPreviewUnselected: (payload: import("@empathyco/x-utils").Dictionary<unknown>, metadata: WireMetadata) => unknown;
QueryPreviewMounted: (payload: string, metadata: WireMetadata) => unknown;
QueryPreviewUnmounted: (payload: {
queryPreviewHash: string;
cache: boolean;
}, metadata: WireMetadata) => unknown;
QuerySuggestionsChanged: (payload: import("@empathyco/x-types").Suggestion[], metadata: WireMetadata) => unknown;
QuerySuggestionsRequestUpdated: (payload: import("@empathyco/x-types").QuerySuggestionsRequest | null, metadata: WireMetadata) => unknown;
UserSelectedAQuerySuggestion: (payload: import("@empathyco/x-types").Suggestion, metadata: WireMetadata) => unknown;
RecommendationsChanged: (payload: import("@empathyco/x-types").Result[], metadata: WireMetadata) => unknown;
RecommendationsRequestUpdated: (payload: import("@empathyco/x-types").RecommendationsRequest, metadata: WireMetadata) => unknown;
UserClickedARecommendation: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
RelatedTagsChanged: (payload: import("@empathyco/x-types").RelatedTag[], metadata: WireMetadata) => unknown;
RelatedTagsRequestUpdated: (payload: import("@empathyco/x-types").RelatedTagsRequest | null, metadata: WireMetadata) => unknown;
SelectedRelatedTagsChanged: (payload: import("@empathyco/x-types").RelatedTag[], metadata: WireMetadata) => unknown;
UserDeselectedARelatedTag: (payload: import("@empathyco/x-types").RelatedTag, metadata: WireMetadata) => unknown;
UserPickedARelatedTag: (payload: import("@empathyco/x-types").RelatedTag, metadata: WireMetadata) => unknown;
UserSelectedARelatedTag: (payload: import("@empathyco/x-types").RelatedTag, metadata: WireMetadata) => unknown;
ScrollRestoreSucceeded: (payload: undefined, metadata: WireMetadata) => unknown;
ScrollRestoreFailed: (payload: undefined, metadata: WireMetadata) => unknown;
UserAlmostReachedScrollEnd: (payload: boolean, metadata: WireMetadata) => unknown;
UserChangedScrollDirection: (payload: import("./scroll").ScrollDirection, metadata: WireMetadata) => unknown;
UserReachedScrollEnd: (payload: boolean, metadata: WireMetadata) => unknown;
UserReachedScrollStart: (payload: boolean, metadata: WireMetadata) => unknown;
UserScrolled: (payload: number, metadata: WireMetadata) => unknown;
UserScrolledToElement: (payload: string, metadata: WireMetadata) => unknown;
SearchBoxQueryChanged: (payload: string, metadata: WireMetadata) => unknown;
UserHoveredInSearchBox: (payload: undefined, metadata: WireMetadata) => unknown;
UserHoveredOutSearchBox: (payload: undefined, metadata: WireMetadata) => unknown;
UserBlurredSearchBox: (payload: undefined, metadata: WireMetadata) => unknown;
UserClearedQuery: (payload: string, metadata: WireMetadata) => unknown;
UserClickedSearchBox: (payload: undefined, metadata: WireMetadata) => unknown;
UserFocusedSearchBox: (payload: undefined, metadata: WireMetadata) => unknown;
UserIsTypingAQuery: (payload: string, metadata: WireMetadata) => unknown;
UserPressedClearSearchBoxButton: (payload: undefined, metadata: WireMetadata) => unknown;
UserPressedEnterKey: (payload: string, metadata: WireMetadata) => unknown;
UserPressedSearchButton: (payload: string, metadata: WireMetadata) => unknown;
UserTalked: (payload: string, metadata: WireMetadata) => unknown;
FacetsChanged: (payload: import("@empathyco/x-types").Facet[], metadata: WireMetadata) => unknown;
PageChanged: (payload: number, metadata: WireMetadata) => unknown;
ReloadSearchRequested: (payload: undefined, metadata: WireMetadata) => unknown;
ResultsChanged: (payload: import("@empathyco/x-types").Result[], metadata: WireMetadata) => unknown;
SearchRequestChanged: (payload: import("..").InternalSearchRequest | null, metadata: WireMetadata) => unknown;
SearchRequestUpdated: (payload: import("..").InternalSearchRequest | null, metadata: WireMetadata) => unknown;
SearchResponseChanged: (payload: import("..").InternalSearchResponse, metadata: WireMetadata) => unknown;
SearchTaggingChanged: (payload: import("@empathyco/x-types").TaggingRequest, metadata: WireMetadata) => unknown;
SortChanged: (payload: string, metadata: WireMetadata) => unknown;
SpellcheckChanged: (payload: string, metadata: WireMetadata) => unknown;
UserClickedASort: (payload: string, metadata: WireMetadata) => unknown;
SelectedSortProvided: (payload: string, metadata: WireMetadata) => unknown;
UserClickedPartialQuery: (payload: string, metadata: WireMetadata) => unknown;
UserReachedResultsListEnd: (payload: undefined, metadata: WireMetadata) => unknown;
UserClickedARedirection: (payload: import("@empathyco/x-types").Redirection, metadata: WireMetadata) => unknown;
UserClickedAPromoted: (payload: import("@empathyco/x-types").Promoted, metadata: WireMetadata) => unknown;
UserClickedABanner: (payload: import("@empathyco/x-types").Banner, metadata: WireMetadata) => unknown;
UserClickedAbortARedirection: (payload: undefined, metadata: WireMetadata) => unknown;
UserSelectedAPage: (payload: number, metadata: WireMetadata) => unknown;
SemanticQueryRequestUpdated: (payload: import("@empathyco/x-types").SemanticQueriesRequest | null, metadata: WireMetadata) => unknown;
SemanticQueriesResponseChanged: (payload: import("@empathyco/x-types").SemanticQuery[], metadata: WireMetadata) => unknown;
UserSelectedASemanticQuery: (payload: import("@empathyco/x-types").SemanticQuery, metadata: WireMetadata) => unknown;
ConsentChanged: (payload: boolean, metadata: WireMetadata) => unknown;
ConsentProvided: (payload: boolean, metadata: WireMetadata) => unknown;
PDPIsLoaded: (payload: string, metadata: WireMetadata) => unknown;
ResultURLTrackingEnabled: (payload: string, metadata: WireMetadata) => unknown;
SearchTaggingReceived: (payload: import("@empathyco/x-types").TaggingRequest, metadata: WireMetadata) => unknown;
TrackableElementDisplayed: (payload: import("@empathyco/x-types").Taggable, metadata: WireMetadata) => unknown;
UserClickedPDPAddToCart: (payload: string | undefined, metadata: WireMetadata) => unknown;
TaggingConfigProvided: (payload: import("..").TaggingConfig, metadata: WireMetadata) => unknown;
ExperienceControlsEventsChanged: (payload: Partial<import("../wiring").XEventsTypes>, metadata: WireMetadata) => unknown;
ExperienceControlsRequestUpdated: (payload: import("@empathyco/x-types").ExperienceControlsRequest | null, metadata: WireMetadata) => unknown;
ParamsLoadedFromUrl: (payload: import("..").UrlParams, metadata: WireMetadata) => unknown;
ExtraParamsLoadedFromUrl: (payload: import("@empathyco/x-utils").Dictionary<unknown>, metadata: WireMetadata) => unknown;
PushableUrlStateUpdated: (payload: import("..").UrlParams, metadata: WireMetadata) => unknown;
ReplaceableUrlStateUpdated: (payload: import("..").UrlParams, metadata: WireMetadata) => unknown;
RelatedPromptsRequestUpdated: (payload: import("@empathyco/x-types").RelatedPromptsRequest | null, metadata: WireMetadata) => unknown;
SelectedRelatedPromptChanged: (payload: number, metadata: WireMetadata) => unknown;
UserSelectedARelatedPrompt: (payload: number, metadata: WireMetadata) => unknown;
UserSelectedARelatedPromptQuery: (payload: number, metadata: WireMetadata) => unknown;
UserClickedARelatedPromptResult: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
UserClickedARelatedPromptAdd2Cart: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
RelatedPromptsResponseChanged: (payload: import("@empathyco/x-types").RelatedPrompt[], metadata: WireMetadata) => unknown;
RelatedPromptsUnmounted: (payload: undefined, metadata: WireMetadata) => unknown;
ReloadRelatedPromptsRequested: (payload: undefined, metadata: WireMetadata) => unknown;
AiSuggestionsRequestUpdated: (payload: import("@empathyco/x-types").AiSuggestionsRequest | null, metadata: WireMetadata) => unknown;
AiSuggestionsSearchRequestUpdated: (payload: import("@empathyco/x-types").AiSuggestionsSearchRequest | null, metadata: WireMetadata) => unknown;
UserClickedAiOverviewExpandButton: (payload: boolean, metadata: WireMetadata) => unknown;
}>>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>
```