Skip to content

2909 splitpagelayoutpane accepts an id but doesnt apply it #2922

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

Merged
agreenberry merged 9 commits into from
Mar 6, 2023
Merged

2909 splitpagelayoutpane accepts an id but doesnt apply it #2922

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a67cfa0
test(SplitPageLayout): added failing test to fix
agreenberry Feb 21, 2023
1912cfc
fix(PageLayout): conditionally include `id` prop
agreenberry Feb 21, 2023
e642d80
chore: added changeset
agreenberry Feb 21, 2023
a20e931
docs(SplitPageLayout): updated story
agreenberry Feb 21, 2023
ad58cb4
Merge branch 'main' into 2909-splitpagelayoutpane-accepts-an-id-but-d…
agreenberry Feb 22, 2023
a15c8ba
Merge branch 'main' into 2909-splitpagelayoutpane-accepts-an-id-but-d…
agreenberry Feb 24, 2023
735b8af
Merge branch 'main' into 2909-splitpagelayoutpane-accepts-an-id-but-d…
agreenberry Feb 24, 2023
db83a92
Merge branch 'main' into 2909-splitpagelayoutpane-accepts-an-id-but-d…
agreenberry Feb 28, 2023
ea540cd
Merge branch 'main' into 2909-splitpagelayoutpane-accepts-an-id-but-d…
agreenberry Mar 6, 2023
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
5 changes: 5 additions & 0 deletions .changeset/rotten-hats-wonder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Updated PageLayout.Pane to conditionally include id prop
1 change: 1 addition & 0 deletions src/PageLayout/PageLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,7 @@ const Pane = React.forwardRef<HTMLDivElement, React.PropsWithChildren<PageLayout
'--pane-max-width-diff': '959px',
},
})}
{...(id && {id: paneId})}
Copy link
Contributor

@colebemis colebemis Mar 1, 2023

Choose a reason for hiding this comment

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

How do you feel about simplifying to this?

Suggested change
{...(id && {id: paneId})}
id={id}

If id is undefined, it won't pass id to the underlying component.

If id is defined, paneId and id will be the same, so we can use either.

>
{resizable && (
<VisuallyHidden>
Expand Down
6 changes: 6 additions & 0 deletions src/SplitPageLayout/SplitPageLayout.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,11 @@ const meta: Meta = {
control: {type: 'radio'},
table: {category: 'Pane props'},
},
'Pane.id': {
type: 'string',
defaultValue: 'customId',
table: {category: 'Pane props'},
},
'Pane.position.narrow': {
type: {
name: 'enum',
Expand Down Expand Up @@ -351,6 +356,7 @@ const Template: Story = args => (
regular: args['Pane.hidden.regular'],
wide: args['Pane.hidden.wide'],
}}
id={args['Pane.id']}
>
<Placeholder height={args['Pane placeholder height']} label="Pane" />
</SplitPageLayout.Pane>
Expand Down
15 changes: 15 additions & 0 deletions src/SplitPageLayout/SplitPageLayout.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,21 @@ describe('SplitPageLayout', () => {
</SplitPageLayout>
</ThemeProvider>,
)

expect(container).toMatchSnapshot()
})

it('renders Pane with a custom ID', () => {
const {getByText} = render(
<ThemeProvider>
<SplitPageLayout>
<SplitPageLayout.Pane id="customId">Pane Content</SplitPageLayout.Pane>
</SplitPageLayout>
</ThemeProvider>,
)

const pane = getByText('Pane Content')

expect(pane.getAttribute('id')).toBe('customId')
})
})