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

Allow Banner to be rendered as a section #2541

Merged
merged 4 commits into from
Jan 26, 2024
Merged

Allow Banner to be rendered as a section #2541

merged 4 commits into from
Jan 26, 2024

Conversation

khiga8
Copy link
Contributor

@khiga8 khiga8 commented Jan 25, 2024

Authors: Please fill out this form carefully and completely.

Reviewers: By approving this Pull Request you are approving the code change, as well as its deployment and mitigation plans.
Please read this description carefully. If you feel there is anything unclear or missing, please ask for updates.

What are you trying to accomplish?

I want to allow Banner to be rendered as a <section>, so I have an option to render it as a region landmark (via <section aria-labelledby>), without explicitly setting a role.

Integration

No

List the issues that this change affects.

Closes #2540

Risk Assessment

  • Low risk the change is small, highly observable, and easily rolled back.
  • Medium risk changes that are isolated, reduced in scope or could impact few users. The change will not impact library availability.
  • High risk changes are those that could impact customers and SLOs, low or no test coverage, low observability, or slow to rollback.

What approach did you choose and why?

There may be more updates incoming but this is a non-breaking, baby step change and it shouldn't impact any existing Banner instances.

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Added/updated previews (Lookbook)
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

@khiga8 khiga8 requested review from a team and camertron January 25, 2024 03:36
Copy link

changeset-bot bot commented Jan 25, 2024

🦋 Changeset detected

Latest commit: 4d282e1

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

This PR includes changesets to release 1 package
Name Type
@primer/view-components Patch

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

Copy link
Member

@keithamus keithamus left a comment

Choose a reason for hiding this comment

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

Great stuff! 🚢

@khiga8
Copy link
Contributor Author

khiga8 commented Jan 26, 2024

@keithamus I do not permission to merge so please merge whenever :)

@keithamus keithamus merged commit 116a343 into main Jan 26, 2024
29 of 30 checks passed
@keithamus keithamus deleted the kh-allow-section branch January 26, 2024 15:43
@primer primer bot mentioned this pull request Jan 26, 2024
@khiga8 khiga8 self-assigned this Feb 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow Banner to be rendered as a <section>
2 participants