From 07b46afb6c382a3f8be5bb711b477b4cbc0c1382 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Chalifour?= Date: Tue, 25 Aug 2020 10:40:27 +0200 Subject: [PATCH] fix(core): rename `showCompletion` to `enableCompletion` --- README.md | 4 ++-- packages/autocomplete-core/src/getCompletion.ts | 2 +- packages/autocomplete-core/src/getDefaultProps.ts | 2 +- packages/autocomplete-core/src/getPropGetters.ts | 2 +- packages/autocomplete-core/src/onKeyDown.ts | 2 +- packages/autocomplete-core/src/types/api.ts | 4 ++-- packages/autocomplete-js/src/autocomplete.ts | 4 ++-- packages/website/docs/createAutocomplete.md | 2 +- stories/react.stories.tsx | 6 +++--- 9 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8b8822f58..ae57c03b6 100644 --- 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 index 087ce773a..f3ee30912 100644 --- a/packages/autocomplete-core/src/getCompletion.ts +++ b/packages/autocomplete-core/src/getCompletion.ts @@ -11,7 +11,7 @@ export function getCompletion({ props, }: GetCompletionProps): 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 index 01bc55786..7a97f3170 100644 --- a/packages/autocomplete-core/src/getDefaultProps.ts +++ b/packages/autocomplete-core/src/getDefaultProps.ts @@ -18,7 +18,7 @@ export function getDefaultProps( 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 index dd86bb429..3ced31d0d 100644 --- a/packages/autocomplete-core/src/getPropGetters.ts +++ b/packages/autocomplete-core/src/getPropGetters.ts @@ -173,7 +173,7 @@ export function getPropGetters({ 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 index bd4b12d21..8285f07ba 100644 --- a/packages/autocomplete-core/src/onKeyDown.ts +++ b/packages/autocomplete-core/src/onKeyDown.ts @@ -65,7 +65,7 @@ export function onKeyDown({ (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 index ebffe6bc5..c95c6b639 100644 --- a/packages/autocomplete-core/src/types/api.ts +++ b/packages/autocomplete-core/src/types/api.ts @@ -186,7 +186,7 @@ export interface PublicAutocompleteOptions { * * @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 { placeholder: string; autoFocus: boolean; defaultHighlightedIndex: number | null; - showCompletion: boolean; + enableCompletion: boolean; openOnFocus: boolean; stallThreshold: number; initialState: AutocompleteState; diff --git a/packages/autocomplete-js/src/autocomplete.ts b/packages/autocomplete-js/src/autocomplete.ts index 51dacf23a..2ba83e327 100644 --- a/packages/autocomplete-js/src/autocomplete.ts +++ b/packages/autocomplete-js/src/autocomplete.ts @@ -125,7 +125,7 @@ export function autocomplete({ function render(state: AutocompleteState) { input.value = state.query; - if (props.showCompletion) { + if (props.enableCompletion) { completion.textContent = state.completion; } @@ -197,7 +197,7 @@ export function autocomplete({ } 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 index eb75926ce..3b090942b 100644 --- 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 index 06a5eed1b..0be551179 100644 --- a/stories/react.stories.tsx +++ b/stories/react.stories.tsx @@ -19,7 +19,7 @@ storiesOf('React', module) render( { @@ -58,7 +58,7 @@ storiesOf('React', module) render( { return [ @@ -248,7 +248,7 @@ storiesOf('React', module) render(