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

Support non-semantic header option #140

Open
blackfalcon opened this issue Jan 6, 2025 · 0 comments · May be fixed by #141
Open

Support non-semantic header option #140

blackfalcon opened this issue Jan 6, 2025 · 0 comments · May be fixed by #141
Assignees
Labels
auro-header not-reviewed Issue has not been reviewed by Auro team members Type: Feature New Feature

Comments

@blackfalcon
Copy link
Member

Is your feature request related to a problem? Please describe.

While reviewing pages for SEO and a11y, I have encountered a few examples where auro-header is being used for presentational use and incorrectly using heading tags within content where it is not necessary.

For example, while it can be argued that the passenger content could be a heading element, it is pretty understandable that the x2 should NOT be a header. See the following screen shot.

Screenshot 2025-01-06 at 12 39 51 PM

Here is the current HTML for this UI

<div class="number-of-passenger svelte-dib9pa">
  <auro-header body="LG" display="300" data-shadow-root="shadow-root-57">Passengers</auro-header> 
  <div>
    <auro-header body="LG" display="300" data-shadow-root="shadow-root-58">x2</auro-header>
  </div>
</div>

Describe the solution you'd like

Users should be allowed to generate a visually appealing header, but also sans the forced semantic HTML when not needed.

This will allow for fewer issues regarding page SEO and reduce complexity when content is read back to users of assistive technologies.

Describe alternatives you've considered

Leave as is. But the cost of not making this update will continue to cause issues with page SEO and assistive technologies.

Additional context

n/a

Exit criteria

This issue can be closed once there is a solution allowing users to select a non-semantic option while maintaining the expected visual experience.

@blackfalcon blackfalcon added Type: Feature New Feature not-reviewed Issue has not been reviewed by Auro team members auro-header labels Jan 6, 2025
blackfalcon added a commit that referenced this issue Jan 6, 2025
This commit will add functional support for allowing users to easily
generate a visual header without the semantic context.

On branch dsande/nonsemanticheader
Your branch is up to date with 'origin/dsande/nonsemanticheader'.
Changes to be committed:
modified:   src/auro-header.js
@blackfalcon blackfalcon changed the title auro-header: [feature summary] Support non-semantic header option Jan 6, 2025
blackfalcon added a commit that referenced this issue Jan 6, 2025
Changes to be committed:
modified:   test/auro-header.test.js
@blackfalcon blackfalcon linked a pull request Jan 6, 2025 that will close this issue
6 tasks
@blackfalcon blackfalcon linked a pull request Jan 6, 2025 that will close this issue
6 tasks
@blackfalcon blackfalcon self-assigned this Jan 6, 2025
blackfalcon added a commit that referenced this issue Jan 6, 2025
This commit will add functional support for allowing users to easily
generate a visual header without the semantic context.

On branch dsande/nonsemanticheader
Your branch is up to date with 'origin/dsande/nonsemanticheader'.
Changes to be committed:
modified:   src/auro-header.js
blackfalcon added a commit that referenced this issue Jan 6, 2025
Changes to be committed:
modified:   test/auro-header.test.js
blackfalcon added a commit that referenced this issue Jan 7, 2025
This commit will add functional support for allowing users to easily
generate a visual header without the semantic context.

On branch dsande/nonsemanticheader
Your branch is up to date with 'origin/dsande/nonsemanticheader'.
Changes to be committed:
modified:   src/auro-header.js
blackfalcon added a commit that referenced this issue Jan 7, 2025
Changes to be committed:
modified:   test/auro-header.test.js
blackfalcon added a commit that referenced this issue Jan 7, 2025
This commit will add functional support for allowing users to easily
generate a visual header without the semantic context.

On branch dsande/nonsemanticheader
Your branch is up to date with 'origin/dsande/nonsemanticheader'.
Changes to be committed:
modified:   src/auro-header.js
blackfalcon added a commit that referenced this issue Jan 7, 2025
Changes to be committed:
modified:   test/auro-header.test.js
blackfalcon added a commit that referenced this issue Jan 7, 2025
This commit will add functional support for allowing users to easily
generate a visual header without the semantic context.

On branch dsande/nonsemanticheader
Your branch is up to date with 'origin/dsande/nonsemanticheader'.
Changes to be committed:
modified:   src/auro-header.js
blackfalcon added a commit that referenced this issue Jan 7, 2025
Changes to be committed:
modified:   test/auro-header.test.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auro-header not-reviewed Issue has not been reviewed by Auro team members Type: Feature New Feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants