Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: duplicated IDs in panel #1078

Merged
merged 4 commits into from
Feb 16, 2023
Merged

fix: duplicated IDs in panel #1078

merged 4 commits into from
Feb 16, 2023

Conversation

FabienMotte
Copy link
Contributor

@FabienMotte FabienMotte commented Jan 31, 2023

Context

CR-2709

Autocomplete is rendering duplicated values for the attribute id (see image below, autocomplete-0-list ID is used in two lists). As described in the HTML specs, the value of the id attribute must be unique within the HTML document.

image

Summary

ID values currently relies on the generateAutocompleteId() method, which is unique per Autocomplete instance but not per source.

Autocomplete panel

This PR tries to fix duplicated ID attributes in the Autocomplete panel by using the sourceIndex value to get a unique ID value per instance, source and item.
The ID value is described as follows: autocomplete-${instanceId}-${sourceId}-${'list' | 'item' | 'label'}.

Autocomplete search box

For the Autocomplete search box, the ID value is described as follows: autocomplete-${instanceId}-${'input' | 'label'}.

Result

Outputted ID attribute values are unique.

→ CodeSandbox

Autocomplete instance #⁠1

Search box

Label ID: autocomplete-0-label
Input ID: autocomplete-0-input

Panel

Source #⁠1

List ID: autocomplete-0-0-list
First list item ID: autocomplete-0-0-item-0

Source #⁠2

List ID: autocomplete-0-1-list
First list item ID: autocomplete-0-1-item-5

Autocomplete instance #⁠2

Search box

Label ID: autocomplete-1-label
Input ID: autocomplete-1-input

Panel

Source #⁠1

List ID: autocomplete-1-0-list
First list item ID: autocomplete-1-0-item-0

Source #⁠2

List ID: autocomplete-1-1-list
First list item ID: autocomplete-1-1-item-5

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jan 31, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit cb0955b:

Sandbox Source
@algolia/autocomplete-example-github-repositories-custom-plugin Configuration
@algolia/autocomplete-example-instantsearch Configuration
@algolia/autocomplete-example-playground Configuration
@algolia/autocomplete-example-preview-panel-in-modal Configuration
@algolia/autocomplete-example-react-renderer Configuration
@algolia/autocomplete-example-starter-algolia Configuration
@algolia/autocomplete-example-starter Configuration
@algolia/autocomplete-example-reshape Configuration
@algolia/autocomplete-example-vue Configuration
adoring-banach-ozrwxo PR

@FabienMotte FabienMotte marked this pull request as ready for review January 31, 2023 11:36
@FabienMotte
Copy link
Contributor Author

I updated the PR description and added a CodeSandbox with 2 instances, each instance with two sections (= 2 plugins).
No IDs collide, neither in the search box nor in the panel.

@FabienMotte FabienMotte requested a review from Haroenv February 16, 2023 14:08
@FabienMotte FabienMotte merged commit a732fc5 into next Feb 16, 2023
@FabienMotte FabienMotte deleted the fix/duplicated-ids branch February 16, 2023 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants