[Docs] Replace Static HTML Element IDs Generated IDs (Display Section) #5270
Conversation
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
Merging in the latest code from the master branch
Pulling in the latest code from EUI Master
Merging in the latest code from the Master branch
…s useGeneratedHtmlId utility function
…the IDs useGeneratedHtmlId utility function
… to use the IDs useGeneratedHtmlId utility function
… IDs useGeneratedHtmlId utility function
…l-htmlIdGenerator_docs_display Merging in the lastest code from the Master branch
… IDs useGeneratedHtmlId utility function
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5270/ |
ym
pushed a commit
to ym/eui
that referenced
this pull request
Oct 29, 2021
elastic#5270) * Update NPM version * Revised element IDs within the Card section of src/docs to use the IDs useGeneratedHtmlId utility function * Revised element IDs within the List Group section of src/docs to use the IDs useGeneratedHtmlId utility function * Revised element IDs within the Notification Event section of src/docs to use the IDs useGeneratedHtmlId utility function * Revised element IDs within the Tooltip section of src/docs to use the IDs useGeneratedHtmlId utility function * Delete package-lock.json * Update package.json * Update package.json * Update yarn.lock * Revised element IDs within the Tooltip section of src/docs to use the IDs useGeneratedHtmlId utility function
This was referenced Oct 29, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Updates any static HTML element IDs inside of EUI documentation with IDs generated by the
useGeneratedHtmlIdutility hook andhtmlIdGenerator()()utility function. This change is based on Issue #4774 where it was reported that including multiple copies of the same code snippet can cause duplicate ID errors. While static IDs were removed, the existing generated IDs were standardized across relevant files.Page-by-page review of the docs revealed that there are about 80 instances of HTML element IDs in the docs. Here is a document defining the pages and components affected by this change.
This PR is to handle generated ID changes within the Display section of the docs
Before
After
Note
This started in PR 5114 and after team input, I'll be creating smaller PRs for each major section of the docs.
Checklist
Check against all themes for compatibility in both light and dark modesChecked in mobileChecked in Chrome, Safari, Edge, and FirefoxAdded or updated jest testsA changelog entry exists and is marked appropriately