feat(component): add enhancements to panel component #1678
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@bigcommerce/big-design': minor | ||
| '@bigcommerce/docs': minor | ||
| --- | ||
|
|
||
| Enhanced Panel component with extra features like Lozenge, Dropdown action and a new PanelContents component |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import React, { memo, ReactNode } from 'react'; | ||
|
|
||
| import { BoxProps } from '../../Box'; | ||
|
|
||
| import { StyledPanelContents, StyledPanelContentsWrapper } from './styled'; | ||
|
|
||
| export interface PanelContentProps extends BoxProps { | ||
| children?: ReactNode; | ||
| padded?: boolean; | ||
| height?: string; | ||
| scrollable?: boolean; | ||
| } | ||
|
|
||
| export const PanelContents: React.FC<PanelContentProps> = memo(({ children, ...props }) => { | ||
| return ( | ||
| <StyledPanelContentsWrapper {...props}> | ||
| <StyledPanelContents {...props}>{children}</StyledPanelContents> | ||
| </StyledPanelContentsWrapper> | ||
| ); | ||
| }); | ||
|
|
||
| PanelContents.displayName = 'PanelContents'; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`PanelContents renders StyledPanelContents with correct props 1`] = ` | ||
| <div | ||
| class="styled__StyledBox-sc-12d4dbf-0 imudcb styled__StyledPanelContents-sc-dd60c8b6-1 fnisvI" | ||
| height="auto" | ||
| > | ||
| Test string | ||
| </div> | ||
| `; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export { PanelContents, type PanelContentProps } from './Contents'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| import { theme } from '@bigcommerce/big-design-theme'; | ||
| import { render } from '@testing-library/react'; | ||
| import React from 'react'; | ||
|
|
||
| import { PanelContents } from './Contents'; | ||
|
|
||
| describe('PanelContents', () => { | ||
| it('renders children correctly', () => { | ||
| const { getByText } = render( | ||
| <PanelContents> | ||
| <div>Test Content</div> | ||
| </PanelContents>, | ||
| ); | ||
|
|
||
| expect(getByText('Test Content')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('applies default props to StyledPanelContentsWrapper', () => { | ||
| const { container } = render(<PanelContents />); | ||
| const wrapper = container.firstChild; | ||
|
|
||
| expect(wrapper).toHaveStyle('height: auto'); | ||
| }); | ||
|
|
||
| it('applies the `padded` prop correctly', () => { | ||
| const { container } = render(<PanelContents padded={false} />); | ||
| const wrapper = container.firstChild; | ||
|
|
||
| expect(wrapper).toHaveStyle(`margin-inline: -${theme.spacing.medium}`); | ||
| }); | ||
|
|
||
| it('applies the `height` prop correctly', () => { | ||
| const { container } = render(<PanelContents height="200px">Test string</PanelContents>); | ||
| const wrapper = container.firstChild; | ||
|
|
||
| expect(wrapper).toHaveStyle('height: 200px'); | ||
| }); | ||
|
|
||
| it('applies the `scrollable` prop correctly', () => { | ||
| const { container } = render(<PanelContents scrollable>Test string</PanelContents>); | ||
| const wrapper = container.firstChild; | ||
|
|
||
| expect(wrapper).toHaveStyle('overflow: auto'); | ||
| }); | ||
|
|
||
| it('renders StyledPanelContents with correct props', () => { | ||
| const { getByText } = render(<PanelContents scrollable>Test string</PanelContents>); | ||
| const contents = getByText('Test string'); | ||
|
|
||
| expect(contents).toBeInTheDocument(); | ||
| expect(contents).toMatchSnapshot(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| import { theme as defaultTheme } from '@bigcommerce/big-design-theme'; | ||
| import styled, { css } from 'styled-components'; | ||
|
|
||
| import { Box } from '../../Box'; | ||
|
|
||
| import { PanelContentProps } from './Contents'; | ||
|
|
||
| export const StyledPanelContentsWrapper = styled(Box)<Omit<PanelContentProps, 'children'>>` | ||
| ${({ theme, scrollable }) => | ||
| scrollable && | ||
| css` | ||
| background-image: linear-gradient( | ||
| 0deg, | ||
| ${theme.colors.secondary40} 0%, | ||
| transparent 1px, | ||
| transparent 100% | ||
| ), | ||
| linear-gradient(180deg, ${theme.colors.secondary40} 0%, transparent 1px, transparent 100%); | ||
| overflow: auto; | ||
| `} | ||
| ${({ height }) => | ||
| height && | ||
| css` | ||
| height: ${height}; | ||
| `} | ||
| ${({ theme, padded }) => | ||
| padded !== true && | ||
|
Contributor
There was a problem hiding this comment. we normally just do negative boolean checks like |
||
| css` | ||
| margin-inline: -${theme.spacing.medium}; | ||
| `} | ||
| ${({ theme }) => theme.breakpoints.tablet} { | ||
| ${({ theme, padded }) => | ||
| padded !== true && | ||
| css` | ||
| margin-inline: -${theme.spacing.xLarge}; | ||
|
Contributor
There was a problem hiding this comment. these minus margins are a bit awkward both the technique, plus they're trying to undo the Panel's padding, without referencing the Panel's padding value I'm also guessing that we wouldn't want e.g. <Panel
header="Panel header"
fullWidthContents
>
<Text>
Hello there
</Text>
</Panel>or with a <Panel
header="Panel header"
contents={{ fullWidth: true }}
>
<Text>
Hello there
</Text>
</Panel> |
||
| `} | ||
| } | ||
| `; | ||
| StyledPanelContentsWrapper.defaultProps = { | ||
| theme: defaultTheme, | ||
| padded: true, | ||
| scrollable: false, | ||
| height: 'auto', | ||
| }; | ||
|
|
||
| export const StyledPanelContents = styled(Box)<Omit<PanelContentProps, 'children'>>` | ||
| min-height: 100%; | ||
| ${({ theme, scrollable }) => | ||
| scrollable && | ||
| css` | ||
| border-block-start: ${theme.border.box}; | ||
| border-block-end: ${theme.border.box}; | ||
| border-block-start-color: ${theme.colors.white}; | ||
| border-block-end-color: ${theme.colors.white}; | ||
| `} | ||
| `; | ||
| StyledPanelContents.defaultProps = { | ||
| theme: defaultTheme, | ||
| padded: true, | ||
| scrollable: false, | ||
| height: 'auto', | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| export { Panel, type PanelProps } from './Panel'; | ||
| export { PanelContents, type PanelContentProps } from './Contents'; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would we ever want to support a scenario where the height is fixed, but scrolling is disabled?
would this just result in content being abruptly cropped and unreachable?