fix: generate elements ids in a consistent manner #1194
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,7 +16,12 @@ import { | |
| GetRootProps, | ||
| InternalAutocompleteOptions, | ||
| } from './types'; | ||
| import { | ||
| getActiveItem, | ||
| getAutocompleteElementId, | ||
| isOrContainsNode, | ||
| isSamsung, | ||
| } from './utils'; | ||
|
|
||
| interface GetPropGettersOptions<TItem extends BaseItem> | ||
| extends AutocompleteScopeApi<TItem> { | ||
|
|
@@ -104,8 +109,15 @@ export function getPropGetters< | |
| role: 'combobox', | ||
| 'aria-expanded': store.getState().isOpen, | ||
| 'aria-haspopup': 'listbox', | ||
| 'aria-owns': store.getState().isOpen | ||
| ? store | ||
| .getState() | ||
| .collections.map(({ source }) => | ||
| getAutocompleteElementId(props.id, 'list', source) | ||
| ) | ||
| .join(' ') | ||
| : undefined, | ||
|
Comment on lines
+112
to
+119
There was a problem hiding this comment. This is conform to the reference, making Autocomplete the owner of all the sources' lists. |
||
| 'aria-labelledby': getAutocompleteElementId(props.id, 'label'), | ||
| ...rest, | ||
| }; | ||
| }; | ||
|
|
@@ -180,12 +192,23 @@ export function getPropGetters< | |
| 'aria-autocomplete': 'both', | ||
| 'aria-activedescendant': | ||
| store.getState().isOpen && store.getState().activeItemId !== null | ||
| ? getAutocompleteElementId( | ||
| props.id, | ||
| `item-${store.getState().activeItemId}`, | ||
| activeItem?.source | ||
| ) | ||
| : undefined, | ||
| 'aria-controls': store.getState().isOpen | ||
| ? store | ||
| .getState() | ||
| .collections.map(({ source }) => | ||
| getAutocompleteElementId(props.id, 'list', source) | ||
| ) | ||
| .join(' ') | ||
| : undefined, | ||
|
Comment on lines
+201
to
+208
There was a problem hiding this comment. This gives a comprehensive value of all lists that are controlled by the input (MDN). |
||
| 'aria-labelledby': getAutocompleteElementId(props.id, 'label'), | ||
| value: store.getState().completion || store.getState().query, | ||
| id: getAutocompleteElementId(props.id, 'input'), | ||
| autoComplete: 'off', | ||
| autoCorrect: 'off', | ||
| autoCapitalize: 'off', | ||
|
|
@@ -241,29 +264,21 @@ export function getPropGetters< | |
| }; | ||
| }; | ||
|
|
||
| const getLabelProps: GetLabelProps = (rest) => { | ||
| return { | ||
| htmlFor: getAutocompleteElementId(props.id, 'input'), | ||
| id: getAutocompleteElementId(props.id, 'label'), | ||
| ...rest, | ||
| }; | ||
| }; | ||
|
|
||
| const getListProps: GetListProps = (providedProps) => { | ||
| const { source, ...rest } = providedProps || {}; | ||
|
|
||
| return { | ||
| role: 'listbox', | ||
| 'aria-labelledby': getAutocompleteElementId(props.id, 'label'), | ||
| id: getAutocompleteElementId(props.id, 'list', source), | ||
| ...rest, | ||
| }; | ||
| }; | ||
|
|
@@ -284,12 +299,14 @@ export function getPropGetters< | |
| }; | ||
|
|
||
| const getItemProps: GetItemProps<any, TMouseEvent> = (providedProps) => { | ||
| const { item, source, ...rest } = providedProps; | ||
|
|
||
| return { | ||
| id: getAutocompleteElementId( | ||
| props.id, | ||
| `item-${item.__autocomplete_id}`, | ||
| source | ||
| ), | ||
| role: 'option', | ||
| 'aria-selected': store.getState().activeItemId === item.__autocomplete_id, | ||
| onMouseMove(event) { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. I didn't create a specific test case for this simple method, because its output is testable on multiple occasions in other integration tests and snapshots. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import type { InternalAutocompleteSource } from '../types'; | ||
|
|
||
| /** | ||
| * Returns a full element id for an autocomplete element. | ||
| * | ||
| * @param autocompleteInstanceId The id of the autocomplete instance | ||
| * @param elementId The specific element id | ||
| * @param source The source of the element, when it needs to be scoped | ||
| */ | ||
| export function getAutocompleteElementId( | ||
| autocompleteInstanceId: string, | ||
| elementId: string, | ||
| source?: InternalAutocompleteSource<any> | ||
| ) { | ||
| return [autocompleteInstanceId, source?.sourceId, elementId] | ||
| .filter(Boolean) | ||
| .join('-') | ||
| .replace(/\s/g, ''); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bit unfortunate that this gets calculated again instead of saved in the collection, but it makes sense