[Docs] Replace Static HTML Element IDs Generated IDs (Layout Section)

[breehall]

Summary

Updates any static HTML element IDs inside of EUI documentation with IDs generated by the useGeneratedHtmlId utility hook and htmlIdGenerator()() 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 Layout 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 modes
• Checked in mobile
• Checked in Chrome, Safari, Edge, and Firefox
• Props have proper autodocs and playground toggles
• Added documentation
• Checked Code Sandbox works for the any docs examples
• Added or updated jest tests
• Checked for breaking changes and labeled appropriately
• Checked for accessibility including keyboard-only and screenreader modes
• A changelog entry exists and is marked appropriately

[kibanamachine]

Preview documentation changes for this PR: https://eui.elastic.co/pr_5220/

[kibanamachine]

Preview documentation changes for this PR: https://eui.elastic.co/pr_5220/

[cchaos]

One thing to note, is that at some point we should really be combining all these imports to point directly to src instead of src/services or src/components because they end up as separate @elastic/eui import lines.

Question:
When should we determine whether to use the new hook or old ()() version? For example the loading state example has a button toggle that still uses htmlIdGenerator()()?

I Checked:

• Accordions
  • Can you update the snippets that contain multiple accordions in the same snippet in them to also contain unique ids? Like this example uses the same constant name in both accordions, but it should probably just be accordionId1 and accordionId2. If they're separate snippets its ok to no be unique.
• Flyout
• Header
• Popover
• Modal
• Resizable panel

[kibanamachine]

Preview documentation changes for this PR: https://eui.elastic.co/pr_5220/

[breehall]

One thing to note, is that at some point we should really be combining all these imports to point directly to src instead of src/services or src/components because they end up as separate @elastic/eui import lines.

I agree. It looks like we have an open issue for this ( Issue #5104 ), so we can tackle it soon.

Question: When should we determine whether to use the new hook or old ()() version? For example the loading state example has a button toggle that still uses htmlIdGenerator()()?

I determined it based on the rule of hooks. Since useGeneratedHtmlId is a hook, it can't be placed outside of the scope of the component like htmlIdGenerator can. With this example specifically, I don't foresee a problem with simply moving the generator call and toggleButton array inside of the component. This was my thinking, but I'm welcome to ideas!

[cchaos]

I agree

👍 😄

it can't be placed outside of the scope of the component

🤦‍♀️ I totally missed this (that it wasn't created inside the component). Makes sense to keep it outside then just for simplicity sake of this PR.

[cchaos]

Hey @breehall , Is there more feedback you need on this PR? I've got some updates I need to push to the Accordion component and I know the docs I touched will conflict with this PR, so it might be good to get this one in first.

[breehall]

@cchaos I don't believe so. This PR includes your previous feedback, so it should be ok to merge. I just hesitated because I didn't see an official approval on this. But if it looks good, I'll get this one merged 😊

[cchaos]

I think there was still one more suggestion I provided about the accordions examples:

Can you update the snippets that contain multiple accordions in the same snippet in them to also contain unique ids? Like this example uses the same constant name in both accordions, but it should probably just be accordionId1 and accordionId2. If they're separate snippets its ok to not be unique.

[breehall]

@cchaos Sorry about that! I thought I had handled it, but it looks like it's updated now. Good catch!

[kibanamachine]

Preview documentation changes for this PR: https://eui.elastic.co/pr_5220/

[cchaos]

Awesome! LGTM!