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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 16, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b98036b
Docs(SplitPageLayout): add PageLayout props to .docs.json
francinelucca Oct 10, 2024
0617eb8
Docs(SplitPageLayout): remove deprecated dividerWhenNarrow from .docs…
francinelucca Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions packages/react/src/SplitPageLayout/SplitPageLayout.docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,21 @@
{
"name": "SplitPageLayout.Pane",
"props": [
{
"name": "aria-label",
"type": "string | undefined",
"description": "Label for the pane. Required if the pane overflows and doesn't have aria-labelledby."
},
{
"name": "aria-labelledby",
"type": "string | undefined",
"description": "Id of an element that acts as a label for the pane. Required if the pane overflows and doesn't have aria-label."
},
{
"name": "width",
"type": "| 'small' | 'medium' | 'large'",
"type": "| 'small' | 'medium' | 'large' | { min: string max: string default: string }",
"defaultValue": "'medium'",
"description": "The width of the pane."
"description": "The width of the pane. If using custom widths, provide an object with keys 'min', 'max' and 'default'."
},
{
"name": "minWidth",
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/SplitPageLayout/SplitPageLayout.features.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export default {

export const SettingsPage: StoryFn<typeof SplitPageLayout> = () => (
<SplitPageLayout>
<SplitPageLayout.Pane position="start">
<SplitPageLayout.Pane position="start" aria-label="Navigation Pane">
<NavList aria-label="Main navigation">
<NavList.Item href="#">Profile</NavList.Item>
<NavList.Item href="#" aria-current="page">
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/SplitPageLayout/SplitPageLayout.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ export const Default = () => (
<SplitPageLayout.Header>
<Placeholder label="Header" height={100} />
</SplitPageLayout.Header>
<SplitPageLayout.Pane position="start">
<SplitPageLayout.Pane position="start" aria-label="Pane">
<Placeholder label="Pane" height={400} />
</SplitPageLayout.Pane>
<SplitPageLayout.Content>
Expand Down
Loading