feat(core): rename shouldDropdownOpen to shouldDropdownShow

See #16 (review)
francoischalifour · Feb 14, 2020 · f2c3eb2 · f2c3eb2
1 parent e035d2c
commit f2c3eb2
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -407,9 +407,9 @@ Called when the input changes.
 
 This turns experience is "controlled" mode. You'll be in charge of updating the state with the [top-level API](#autocomplete).
 
-#### `shouldDropdownOpen`
+#### `shouldDropdownShow`
 
-> `(options: { state: AutocompleteState }) => boolean` | defaults to `({ state }) => state.results.some(result => result.suggestions.length > 0)`
+> `(options: { state: AutocompleteState }) => boolean` | defaults to `({ state }) => state.suggestions.some(suggestion => suggestion.items.length > 0)`
 
 Called to check whether the dropdown should open based on the Autocomplete state.
 

diff --git a/packages/autocomplete-core/defaultProps.ts b/packages/autocomplete-core/defaultProps.ts
@@ -22,7 +22,7 @@ export function getDefaultProps<TItem>(
     showCompletion: false,
     stallThreshold: 300,
     environment,
-    shouldDropdownOpen: ({ state }) => getItemsCount(state) > 0,
+    shouldDropdownShow: ({ state }) => getItemsCount(state) > 0,
     onStateChange: noop,
     onSubmit: noop,
     ...props,

diff --git a/packages/autocomplete-core/onInput.ts b/packages/autocomplete-core/onInput.ts
@@ -49,7 +49,7 @@ export function onInput<TItem>({
       }))
     );
     setIsOpen(
-      nextState.isOpen ?? props.shouldDropdownOpen({ state: store.getState() })
+      nextState.isOpen ?? props.shouldDropdownShow({ state: store.getState() })
     );
 
     return;
@@ -103,7 +103,7 @@ export function onInput<TItem>({
           setIsOpen(
             nextState.isOpen ??
               (query.length >= props.minLength &&
-                props.shouldDropdownOpen({ state: store.getState() }))
+                props.shouldDropdownShow({ state: store.getState() }))
           );
         })
         .catch(error => {

diff --git a/packages/autocomplete-core/types/api.ts b/packages/autocomplete-core/types/api.ts
@@ -181,7 +181,7 @@ export interface PublicAutocompleteOptions<TItem> {
   /**
    * The function called to determine whether the dropdown should open.
    */
-  shouldDropdownOpen?(options: { state: AutocompleteState<TItem> }): boolean;
+  shouldDropdownShow?(options: { state: AutocompleteState<TItem> }): boolean;
   /**
    * The function called when the autocomplete form is submitted.
    */
@@ -202,6 +202,6 @@ export interface AutocompleteOptions<TItem> {
   getSources: GetSources<TItem>;
   environment: Environment;
   navigator: Navigator<TItem>;
-  shouldDropdownOpen(options: { state: AutocompleteState<TItem> }): boolean;
+  shouldDropdownShow(options: { state: AutocompleteState<TItem> }): boolean;
   onSubmit(params: EventHandlerParams<TItem>): void;
 }