Merge pull request #2508 from magento-devdocs/search-events-overview

Search events overview

Author: ccondra

src/_data/toc/live-search.yml

@@ -42,6 +42,10 @@ pages:
       url: /live-search/product-search.html
       versionless: true
 
+- label: Events
+  url: /live-search/events.html
+  versionless: true
+
 - label: Release Notes
   url: /live-search/release-notes.html
   versionless: true

src/live-search/events.md

@@ -0,0 +1,15 @@
+---
+group: live-search
+title: Events
+ee_only: True
+---
+
+The [_Storefront Events SDK_](https://devdocs.magento.com/shared-services/storefront-events-sdk.html) provides access to a common data layer, with event publishing and subscription services.  The [_Storefront Event Collector_](https://devdocs.magento.com/shared-services/storefront-event-collector.html) package listens for events and includes the following search-related functions:
+
+|Function|Description|
+|---|---|
+|`searchProductClick`|Triggered when a shopper clicks a product in the "search as you type" popover or on the search results page. |
+|`searchRequestSent`|Triggered by the following events in the "search as you type" popover:<br />- Type or press Enter<br />- Click _View All_<br /><br />Triggered by the following events on search results pages:<br />- Select a filter<br />- Change the sort order (_Sort By_)<br />- Change the sort direction (ascending or descending)<br />- Change the number of results per page (_Show # per page_)<br />- Navigate to the next page<br />- Navigate to the previous page<br />- Navigate to a different page|
+|`searchResponseReceived`|Triggered when Live Search returns results for the "search as you type" popover or search results page.|
+|`searchResultsView`|Triggered when results appear in the "search as you type" popover or search results page.|
+|`searchSuggestionClick`|Triggered when a shopper clicks a product suggestion in the "search as you type" popover.|

src/shared-services/storefront-event-collector.md

@@ -43,7 +43,6 @@ The collector then begins listening for the following events. When any of these
 -  `recsResponseReceived`
 -  `recsUnitRender`
 -  `recsUnitView`
--  `searchCategoryClick`
 -  `searchProductClick`
 -  `searchRequestSent`
 -  `searchResponseReceived`