fix(core): rename OnHighlightParams to OnActiveParams

algolia · Feb 4, 2021 · 2d7762d · 2d7762d
1 parent 56cbb20
commit 2d7762d
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/packages/autocomplete-core/src/types/AutocompletePlugin.ts b/packages/autocomplete-core/src/types/AutocompletePlugin.ts
@@ -1,13 +1,13 @@
 import { AutocompleteScopeApi, BaseItem } from './AutocompleteApi';
 import { AutocompleteOptions } from './AutocompleteOptions';
-import { OnSelectParams, OnHighlightParams } from './AutocompleteSource';
+import { OnSelectParams, OnActiveParams } from './AutocompleteSource';
 
 type PluginSubscriber<TParams> = (params: TParams) => void;
 
 interface PluginSubscribeParams<TItem extends BaseItem>
   extends AutocompleteScopeApi<TItem> {
   onSelect(fn: PluginSubscriber<OnSelectParams<TItem>>): void;
-  onActive(fn: PluginSubscriber<OnHighlightParams<TItem>>): void;
+  onActive(fn: PluginSubscriber<OnActiveParams<TItem>>): void;
 }
 
 export type AutocompletePlugin<

diff --git a/packages/autocomplete-core/src/types/AutocompleteSource.ts b/packages/autocomplete-core/src/types/AutocompleteSource.ts
@@ -16,7 +16,7 @@ export interface OnSelectParams<TItem extends BaseItem>
   source: InternalAutocompleteSource<TItem>;
 }
 
-export type OnHighlightParams<TItem extends BaseItem> = OnSelectParams<TItem>;
+export type OnActiveParams<TItem extends BaseItem> = OnSelectParams<TItem>;
 
 export interface AutocompleteSource<TItem extends BaseItem> {
   // This allows flavors to pass other keys to their source.
@@ -57,7 +57,7 @@ export interface AutocompleteSource<TItem extends BaseItem> {
    * An item is highlighted either via keyboard navigation or via mouse over.
    * You can trigger different behaviors based on the event `type`.
    */
-  onActive?(params: OnHighlightParams<TItem>): void;
+  onActive?(params: OnActiveParams<TItem>): void;
 }
 
 export type InternalAutocompleteSource<TItem extends BaseItem> = {

diff --git a/packages/autocomplete-core/src/types/AutocompleteSubscribers.ts b/packages/autocomplete-core/src/types/AutocompleteSubscribers.ts
@@ -1,9 +1,9 @@
 import { BaseItem } from './AutocompleteApi';
-import { OnHighlightParams, OnSelectParams } from './AutocompleteSource';
+import { OnActiveParams, OnSelectParams } from './AutocompleteSource';
 
 export type AutocompleteSubscriber<TItem extends BaseItem> = {
   onSelect(params: OnSelectParams<TItem>): void;
-  onActive(params: OnHighlightParams<TItem>): void;
+  onActive(params: OnActiveParams<TItem>): void;
 };
 
 export type AutocompleteSubscribers<TItem extends BaseItem> = Array<

diff --git a/packages/autocomplete-plugin-algolia-insights/src/createAlgoliaInsightsPlugin.ts b/packages/autocomplete-plugin-algolia-insights/src/createAlgoliaInsightsPlugin.ts
@@ -12,7 +12,7 @@ import {
   AlgoliaInsightsHit,
   InsightsApi,
   InsightsClient,
-  OnHighlightParams,
+  OnActiveParams,
   OnItemsChangeParams,
   OnSelectParams,
 } from './types';
@@ -59,7 +59,7 @@ export type CreateAlgoliaInsightsPluginParams = {
   /**
    * Hook to send an Insights event when an item is active.
    */
-  onActive?(params: OnHighlightParams): void;
+  onActive?(params: OnActiveParams): void;
 };
 
 export function createAlgoliaInsightsPlugin({

diff --git a/packages/autocomplete-plugin-algolia-insights/src/types/EventParams.ts b/packages/autocomplete-plugin-algolia-insights/src/types/EventParams.ts
@@ -15,7 +15,7 @@ export type OnSelectParams = {
   event: any;
 };
 
-export type OnHighlightParams = OnSelectParams;
+export type OnActiveParams = OnSelectParams;
 
 export type OnItemsChangeParams = {
   insights: InsightsApi;