Skip to content

Padded layout for components in storybook by default #6771

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
merged 6 commits into from
Jul 27, 2022
Merged

Padded layout for components in storybook by default #6771

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7761bbc
Fix whitespace around components in storybook
alex-page Jul 26, 2022
ece8fc7
Change spacing in grid if there is padding
alex-page Jul 26, 2022
a14aab9
Create grumpy-zoos-retire.md
alex-page Jul 26, 2022
f252dd2
Clean up
alex-page Jul 27, 2022
faa9c80
Update links
alex-page Jul 27, 2022
833eb14
Merge branch 'main' into fix-component-spacing
alex-page Jul 27, 2022
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/grumpy-zoos-retire.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/polaris': patch
---

Add spacing around components in storybook, adjust grid if there is spacing
10 changes: 9 additions & 1 deletion polaris-react/.storybook/GridOverlay/GridOverlay.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,16 @@ interface Props {
maxWidth?: string;
layer?: Layer;
children?: React.ReactNode;
componentLayout: 'padded' | 'centered' | 'fullscreen';
}

export function GridOverlay({inFrame, maxWidth, layer, children}: Props) {
export function GridOverlay({
inFrame,
maxWidth,
layer,
children,
componentLayout,
}: Props) {
const [columns, setColumns] = useState(
window.innerWidth < BREAKPOINT ? COLUMNS_SMALL : COLUMNS_LARGE,
);
Expand All @@ -28,6 +35,7 @@ export function GridOverlay({inFrame, maxWidth, layer, children}: Props) {
const className = classNames('GridOverlay', inFrame && 'inFrame');
const style = {
maxWidth,
margin: componentLayout === 'padded' ? '0 1rem' : '',
zIndex: layer === 'above' || inFrame ? 1 : -1,
} as React.CSSProperties;

Expand Down
11 changes: 8 additions & 3 deletions polaris-react/.storybook/polaris-readme-loader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,14 @@ module.exports = function loader(source) {

const readme = parseCodeExamples(source);

const hasFullscreenLayout = ['App provider', 'Frame', 'Navigation'].includes(
readme.name,
);
const hasFullscreenLayout = [
'App provider',
'Frame',
'Fullscreen bar',
'Navigation',
'Sheet',
'Grid',
].includes(readme.name);

const omitAppProvider = [
'Frame',
Expand Down
5 changes: 0 additions & 5 deletions polaris-react/.storybook/preview-body.html
View file
Open in desktop

This file was deleted.

7 changes: 6 additions & 1 deletion polaris-react/.storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,12 @@ function GridOverlayDecorator(Story, context) {
const {showGrid, gridInFrame, gridWidth, gridLayer} = context.globals;

const gridOverlay = showGrid ? (
<GridOverlay inFrame={gridInFrame} maxWidth={gridWidth} layer={gridLayer} />
<GridOverlay
inFrame={gridInFrame}
maxWidth={gridWidth}
layer={gridLayer}
componentLayout={context.parameters.layout}
/>
) : null;

return (
Expand Down