fix(core): rename shouldPanelShow to shouldPanelOpen

This new name is more aligned with the `isOpen` state getter.
algolia · Feb 9, 2021 · c442884 · c442884
1 parent 3827605
commit c442884
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/packages/autocomplete-core/src/getDefaultProps.ts b/packages/autocomplete-core/src/getDefaultProps.ts
@@ -26,7 +26,7 @@ export function getDefaultProps<TItem extends BaseItem>(
     defaultActiveItemId: null,
     stallThreshold: 300,
     environment,
-    shouldPanelShow: ({ state }) => getItemsCount(state) > 0,
+    shouldPanelOpen: ({ state }) => getItemsCount(state) > 0,
     ...props,
     // Since `generateAutocompleteId` triggers a side effect (it increments
     // and internal counter), we don't want to execute it if unnecessary.

diff --git a/packages/autocomplete-core/src/onInput.ts b/packages/autocomplete-core/src/onInput.ts
@@ -60,7 +60,7 @@ export function onInput<TItem extends BaseItem>({
       }))
     );
     setIsOpen(
-      nextState.isOpen ?? props.shouldPanelShow({ state: store.getState() })
+      nextState.isOpen ?? props.shouldPanelOpen({ state: store.getState() })
     );
 
     return Promise.resolve();
@@ -107,12 +107,12 @@ export function onInput<TItem extends BaseItem>({
         .then((collections) => {
           setStatus('idle');
           setCollections(collections as any);
+          const isPanelOpen = props.shouldPanelOpen({
+            state: store.getState(),
+          });
           setIsOpen(
             nextState.isOpen ??
-              ((props.openOnFocus &&
-                !query &&
-                props.shouldPanelShow({ state: store.getState() })) ||
-                props.shouldPanelShow({ state: store.getState() }))
+              ((props.openOnFocus && !query && isPanelOpen) || isPanelOpen)
           );
 
           const highlightedItem = getActiveItem(store.getState());

diff --git a/packages/autocomplete-core/src/types/AutocompleteOptions.ts b/packages/autocomplete-core/src/types/AutocompleteOptions.ts
@@ -113,7 +113,7 @@ export interface AutocompleteOptions<TItem extends BaseItem> {
   /**
    * The function called to determine whether the panel should open.
    */
-  shouldPanelShow?(params: { state: AutocompleteState<TItem> }): boolean;
+  shouldPanelOpen?(params: { state: AutocompleteState<TItem> }): boolean;
   /**
    * The function called when the Autocomplete form is submitted.
    */
@@ -144,7 +144,7 @@ export interface InternalAutocompleteOptions<TItem extends BaseItem>
   environment: AutocompleteEnvironment;
   navigator: AutocompleteNavigator<TItem>;
   plugins: Array<AutocompletePlugin<TItem, unknown>>;
-  shouldPanelShow(params: { state: AutocompleteState<TItem> }): boolean;
+  shouldPanelOpen(params: { state: AutocompleteState<TItem> }): boolean;
   onSubmit(params: OnSubmitParams<TItem>): void;
   onReset(params: OnResetParams<TItem>): void;
   onInput?(params: OnInputParams<TItem>): void | Promise<any>;

diff --git a/packages/autocomplete-js/src/__tests__/autocomplete.test.ts b/packages/autocomplete-js/src/__tests__/autocomplete.test.ts
@@ -377,15 +377,15 @@ describe('autocomplete-js', () => {
     });
   });
 
-  test('allows user-provided shouldPanelShow', () => {
+  test('allows user-provided shouldPanelOpen', () => {
     const container = document.createElement('div');
     const panelContainer = document.createElement('div');
 
     document.body.appendChild(panelContainer);
     autocomplete<{ label: string }>({
       container,
       panelContainer,
-      shouldPanelShow: () => false,
+      shouldPanelOpen: () => false,
       getSources() {
         return [
           {

diff --git a/packages/autocomplete-js/src/autocomplete.ts b/packages/autocomplete-js/src/autocomplete.ts
@@ -47,8 +47,8 @@ export function autocomplete<TItem extends BaseItem>(
         onStateChangeRef.current?.(options as any);
         props.value.core.onStateChange?.(options as any);
       },
-      shouldPanelShow:
-        optionsRef.current.shouldPanelShow ||
+      shouldPanelOpen:
+        optionsRef.current.shouldPanelOpen ||
         (({ state }) => {
           const hasItems = getItemsCount(state) > 0;
 

diff --git a/packages/website/docs/partials/createAutocomplete-props.md b/packages/website/docs/partials/createAutocomplete-props.md
@@ -70,7 +70,7 @@ Navigator API to redirect the user when a link should be opened.
 
 Learn more on the [Navigator API](/docs/keyboard-navigation) documentation.
 
-### `shouldPanelShow`
+### `shouldPanelOpen`
 
 > `(params: { state: AutocompleteState }) => boolean`