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

Docs(SplitPageLayout): add PageLayout props to .docs.json #5108

Conversation

francinelucca
Copy link
Member

Closes https://github.com/github/primer/issues/3575

The SplitPageLayout.Pane component is a PageLayout.Pane under the hood and can therefore accept any props that PageLayout.Pane accepts. This PR updates the documentation to reflect some missing props, including aria-label, aria-labelledby.

This PR also adds aria-label to Panes inSplitPageLayout stories so that it can be displayed when the content overflows.

Changelog

New

  • Adds aria-label, aria-labelledby props to SplitPageLayout.Pane docs.json file
  • Updates type and description of width prop in SplitPageLayout.Pane docs.json file to more closely match with PageLayout.Pane docs
  • Adds aria-label prop to Panes in SplitPageLayout stories

Rollout strategy

  • [] Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Docs only update

Testing & Reviewing

Navigate to deployed SplitPageLayout.Pane story and resize browser so that the pane overflows, verify in the DOM that aria-label prop is added, along with tabIndex=0 and role='region'

Merge checklist

Copy link

changeset-bot bot commented Oct 10, 2024

⚠️ No Changeset found

Latest commit: 0617eb8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@francinelucca francinelucca added staff Author is a staff member component: SplitPageLayout Issues related to the PageLayout and SplitPageLayout components skip changeset This change does not need a changelog labels Oct 10, 2024
Copy link
Contributor

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 97.61 KB (0%)
packages/react/dist/browser.umd.js 97.79 KB (0%)

@francinelucca francinelucca marked this pull request as ready for review October 10, 2024 23:41
@francinelucca francinelucca requested a review from a team as a code owner October 10, 2024 23:41
@francinelucca francinelucca added this pull request to the merge queue Oct 16, 2024
Merged via the queue into main with commit c1e27c3 Oct 16, 2024
56 of 59 checks passed
@francinelucca francinelucca deleted the francinelucca/3575-prcsplitpagelayout-keyboard-scrollable-pane-lacks-accessible-name branch October 16, 2024 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: SplitPageLayout Issues related to the PageLayout and SplitPageLayout components skip changeset This change does not need a changelog staff Author is a staff member status: review needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants