[Docs] Replace Static HTML Element IDs Generated IDs (Nav Section) #5224
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
…Ds generated the htmlIdGenerator utility function
…l-htmlIdGenerator_docs Merging in the latest code from Master
…Ds generated the useGeneratedHtmlId utility function
…eehall/eui into breehall-htmlIdGenerator_docs Merging in the lastest code from the Master branch.
…generated the useGeneratedHtmlId utility function
…generated the useGeneratedHtmlId utility function
…generated the useGeneratedHtmlId utility function
…l-htmlIdGenerator_docs Merging in the latest code from the Master branch
…generated the useGeneratedHtmlId utility function
…enerated the useGeneratedHtmlId utility function
…l-htmlIdGenerator_docs Merging in the latest code from the Master branch
…l-htmlIdGenerator_docs Merging in the latest code from teh Master branch
… use the useGeneratedHtmlId utility function
…l-htmlIdGenerator_docs Merging in the latest code from Master
… use the useGeneratedHtmlId utility function
…useGeneratedHtmlId utility function
…useGeneratedHtmlId utility function
… use the useGeneratedHtmlId utility function
…e the useGeneratedHtmlId utility function
…lIdGenerator_docs_nav Merging in the latest code from the useGeneratedHtmlId changes from the src-docs layout section
…o use the useGeneratedHtmlId utility function
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5224/ |
|
@thompsongl I've removed myself as a reviewer of this one. But you can use the guidance I provided in the first one to help review this one. #5220 |
|
Is this ready to review, @breehall, or still in progress? |
…r changes from the src/docs layout section
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5224/ |
|
@thompsongl yep, this one is now ready for review! |
thompsongl
approved these changes
Oct 14, 2021
ym
pushed a commit
to ym/eui
that referenced
this pull request
Oct 29, 2021
…lastic#5224) * Revised element IDs within the Accordion section of src/docs to use IDs generated the htmlIdGenerator utility function * Revised element IDs within the Accordion section of src/docs to use IDs generated the useGeneratedHtmlId utility function * Revised element IDs within the Flyout section of src/docs to use IDs generated the useGeneratedHtmlId utility function * Revised element IDs within the Header section of src/docs to use IDs generated the useGeneratedHtmlId utility function * Revised element IDs within the Header section of src/docs to use IDs generated the useGeneratedHtmlId utility function * Revised element IDs within the Header section of src/docs to use IDs generated the useGeneratedHtmlId utility function * Revised element IDs within the Modal section of src/docs to use IDs generated the useGeneratedHtmlId utility function * Test commit * Revised element IDs within the Resizable Panel section of src/docs to use the useGeneratedHtmlId utility function * Revised element IDs within the Resizable Panel section of src/docs to use the useGeneratedHtmlId utility function * Revised element IDs within the Button section of src/docs to use the useGeneratedHtmlId utility function * Revised element IDs within the Button section of src/docs to use the useGeneratedHtmlId utility function * Revised element IDs within the Collapsible Nav section of src/docs to use the useGeneratedHtmlId utility function * Revised element IDs within the Context Menu section of src/docs to use the useGeneratedHtmlId utility function * Revisions from PR * Revised element IDs within the Keypad and Tabs sections of src/docs to use the 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 Nav 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