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

Require the as prop in heading components #1008

Merged
merged 1 commit into from
Jun 29, 2021
Merged

Conversation

connor-baer
Copy link
Member

@connor-baer connor-baer commented Jun 29, 2021

Purpose

A common navigation technique for users of screen reading software is jumping from heading to heading to quickly determine the content of the page. Because of this, it is important to not skip one or more heading levels. Doing so may create confusion, as the person navigating this way may be left wondering where the missing heading is.

From MDN

Approach and changes

  • Made the as prop required in the Headline and SubHeadline components. This requires developers to intentionally set the heading level to ensure a consistent and accessible page structure.

Definition of done

  • Development completed
  • Reviewers assigned
  • Unit and integration tests
  • Meets minimum browser support
  • Meets accessibility requirements

@connor-baer connor-baer added this to the v3.0 milestone Jun 29, 2021
@connor-baer connor-baer requested a review from a team as a code owner June 29, 2021 10:08
@connor-baer connor-baer requested review from amelako and removed request for a team June 29, 2021 10:08
@changeset-bot
Copy link

changeset-bot bot commented Jun 29, 2021

🦋 Changeset detected

Latest commit: 45efe01

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sumup/circuit-ui Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link

vercel bot commented Jun 29, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sumup/oss-circuit-ui/HKMfsgx1A6gJCHPdp5w1tLFsgYyj
✅ Preview: https://oss-circuit-ui-git-feature-heading-level-sumup.vercel.app

@connor-baer connor-baer added the ♿ accessibility Improves usability label Jun 29, 2021
@codecov
Copy link

codecov bot commented Jun 29, 2021

Codecov Report

Merging #1008 (45efe01) into next (23b4251) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             next    #1008   +/-   ##
=======================================
  Coverage   91.05%   91.05%           
=======================================
  Files         161      161           
  Lines        2684     2684           
  Branches      768      794   +26     
=======================================
  Hits         2444     2444           
+ Misses        215      214    -1     
- Partials       25       26    +1     
Impacted Files Coverage Δ
...ckages/circuit-ui/components/Headline/Headline.tsx 85.71% <ø> (ø)
.../circuit-ui/components/SubHeadline/SubHeadline.tsx 100.00% <ø> (ø)
...es/circuit-ui/components/Pagination/Pagination.tsx 87.50% <0.00%> (ø)

@connor-baer connor-baer merged commit e76f2d0 into next Jun 29, 2021
@connor-baer connor-baer deleted the feature/heading-level branch June 29, 2021 11:40
This was referenced Aug 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants