fix(core): rename showCompletion to enableCompletion

francoischalifour · Aug 25, 2020 · 07b46af · 07b46af
1 parent a87a5d7
commit 07b46af
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -203,13 +203,13 @@ The text that appears in the search box input when there is no query.
 
 It is fowarded to the [`input`'s placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefplaceholder).
 
-#### `showCompletion`
+#### `enableCompletion`
 
 > `boolean` | defaults to `false`
 
 Whether to show the highlighted suggestion as completion in the input.
 
-![`showCompletion` preview](https://user-images.githubusercontent.com/6137112/68124812-7e989800-ff10-11e9-88a5-f28c1466b665.png)
+![`enableCompletion` preview](https://user-images.githubusercontent.com/6137112/68124812-7e989800-ff10-11e9-88a5-f28c1466b665.png)
 
 #### `openOnFocus`
 

diff --git a/packages/autocomplete-core/src/getCompletion.ts b/packages/autocomplete-core/src/getCompletion.ts
@@ -11,7 +11,7 @@ export function getCompletion<TItem>({
   props,
 }: GetCompletionProps<TItem>): string | null {
   if (
-    props.showCompletion === false ||
+    props.enableCompletion === false ||
     state.isOpen === false ||
     state.highlightedIndex === null ||
     state.status === 'stalled'

diff --git a/packages/autocomplete-core/src/getDefaultProps.ts b/packages/autocomplete-core/src/getDefaultProps.ts
@@ -18,7 +18,7 @@ export function getDefaultProps<TItem>(
     placeholder: '',
     autoFocus: false,
     defaultHighlightedIndex: null,
-    showCompletion: false,
+    enableCompletion: false,
     stallThreshold: 300,
     environment,
     shouldDropdownShow: ({ state }) => getItemsCount(state) > 0,

diff --git a/packages/autocomplete-core/src/getPropGetters.ts b/packages/autocomplete-core/src/getPropGetters.ts
@@ -173,7 +173,7 @@ export function getPropGetters<TItem, TEvent, TMouseEvent, TKeyboardEvent>({
     const { inputElement, maxLength = 512, ...rest } = providedProps || {};
 
     return {
-      'aria-autocomplete': props.showCompletion ? 'both' : 'list',
+      'aria-autocomplete': props.enableCompletion ? 'both' : 'list',
       'aria-activedescendant':
         store.getState().isOpen && store.getState().highlightedIndex !== null
           ? `${props.id}-item-${store.getState().highlightedIndex}`

diff --git a/packages/autocomplete-core/src/onKeyDown.ts b/packages/autocomplete-core/src/onKeyDown.ts
@@ -65,7 +65,7 @@ export function onKeyDown<TItem>({
       (event.key === 'ArrowRight' &&
         (event.target as HTMLInputElement).selectionStart ===
           store.getState().query.length)) &&
-    props.showCompletion &&
+    props.enableCompletion &&
     store.getState().highlightedIndex !== null
   ) {
     event.preventDefault();

diff --git a/packages/autocomplete-core/src/types/api.ts b/packages/autocomplete-core/src/types/api.ts
@@ -186,7 +186,7 @@ export interface PublicAutocompleteOptions<TItem> {
    *
    * @default false
    */
-  showCompletion?: boolean;
+  enableCompletion?: boolean;
   /**
    * Whether to open the dropdown on focus when there's no query.
    *
@@ -248,7 +248,7 @@ export interface AutocompleteOptions<TItem> {
   placeholder: string;
   autoFocus: boolean;
   defaultHighlightedIndex: number | null;
-  showCompletion: boolean;
+  enableCompletion: boolean;
   openOnFocus: boolean;
   stallThreshold: number;
   initialState: AutocompleteState<TItem>;

diff --git a/packages/autocomplete-js/src/autocomplete.ts b/packages/autocomplete-js/src/autocomplete.ts
@@ -125,7 +125,7 @@ export function autocomplete<TItem>({
   function render(state: AutocompleteState<TItem>) {
     input.value = state.query;
 
-    if (props.showCompletion) {
+    if (props.enableCompletion) {
       completion.textContent = state.completion;
     }
 
@@ -197,7 +197,7 @@ export function autocomplete<TItem>({
   }
 
   form.appendChild(label);
-  if (props.showCompletion) {
+  if (props.enableCompletion) {
     inputWrapper.appendChild(completion);
   }
   inputWrapper.appendChild(input);

diff --git a/packages/website/docs/createAutocomplete.md b/packages/website/docs/createAutocomplete.md
@@ -83,7 +83,7 @@ The default item index to pre-select.
 
 We recommend using `0` when the query typed aims at opening suggestion links, without triggering an actual search.
 
-### `showCompletion`
+### `enableCompletion`
 
 > `boolean` | defaults to `false`
 

diff --git a/stories/react.stories.tsx b/stories/react.stories.tsx
@@ -19,7 +19,7 @@ storiesOf('React', module)
       render(
         <Autocomplete
           placeholder="Search items…"
-          showCompletion={true}
+          enableCompletion={true}
           dropdownContainer={dropdownContainer}
           defaultHighlightedIndex={null}
           getSources={() => {
@@ -58,7 +58,7 @@ storiesOf('React', module)
       render(
         <Autocomplete
           placeholder="Search items…"
-          showCompletion={true}
+          enableCompletion={true}
           dropdownContainer={dropdownContainer}
           getSources={() => {
             return [
@@ -248,7 +248,7 @@ storiesOf('React', module)
       render(
         <Autocomplete
           placeholder="Search items…"
-          showCompletion={true}
+          enableCompletion={true}
           dropdownContainer={dropdownContainer}
           defaultHighlightedIndex={0}
           openOnFocus={true}