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

a11y- Use nested list for <h3> links within the table of contents #7883

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

katiegoines
Copy link
Contributor

@katiegoines katiegoines commented Aug 9, 2024

Description of changes:

[Issue] There is content that appears as a nested list but does not use nested list markup.
[Fix] Nest h3 headings under their parent h2 in table of contents

Staging: https://a11y-toc-nested.d1egzztxsxq9xz.amplifyapp.com/react/start/quickstart/

Screenshot 2024-08-09 at 12 09 26 PM

Related GitHub issue #, if available:

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

Which platform(s) are affected by this PR (if applicable)?

  • JS
  • Swift
  • Android
  • Flutter
  • React Native

Please add the product(s)/platform(s) affected to the PR title

Checks

  • Does this PR conform to the styleguide?

  • Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.

  • Are any files being deleted with this PR? If so, have the needed redirects been created?

  • Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

    ref: MDX: [link](https://docs.amplify.aws/)
    HTML: <a href="https://docs.amplify.aws/">link</a>

When this PR is ready to merge, please check the box below

  • Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@katiegoines katiegoines marked this pull request as ready for review August 9, 2024 19:37
@katiegoines katiegoines requested a review from a team as a code owner August 9, 2024 19:37
hbuchel
hbuchel previously approved these changes Aug 12, 2024
Copy link
Contributor

@hbuchel hbuchel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link
Contributor

@hbuchel hbuchel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, left my review before noticing the console error failure. Left a note below.

subheadings: []
});
} else if (innerText && id && localName == 'h3') {
headings[headings.length - 1].subheadings.push({
Copy link
Contributor

@hbuchel hbuchel Aug 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I missed this during my review. This is causing the console error check to fail. It's on pages that don't have a parent h2 because they have improper heading structure.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed the improper heading structure throughout.

@hbuchel hbuchel self-requested a review August 12, 2024 15:24
@katiegoines katiegoines enabled auto-merge (squash) August 14, 2024 21:03
jacoblogan
jacoblogan previously approved these changes Aug 15, 2024
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