!example that shows how the columns look when enabled

⚙️ Install

``sh
npm install storybook-addon-grid
`

`js
// .storybook/main.js
const config = {
addons: ['storybook-addon-grid'],
};
`

>

🚀 Usage

The column guides are controlled with parameters and
as such you can define this globally or per story.

The column guides can be turned on either via clicking the toolbar button, or via a keyboard shortcut Ctrl +
G.

> Note: Due to the nature of z-index, the root div of the stories will have a position: relative and
> z-index: 0 applied to it, allowing the column guides to sit over the top.

$3

Column design system is defined by 3 values:

- the number of columns
- the gap between them
- the gutter — minimal margin between the system and the screen
- maximal-width for the system to limit maximum width of all columns as well.

#### columns?: number = 12

The number of columns guides.

#### gap?: string = '20px'

The gap between columns.

#### gutter?: string = '50px'

System's gutter (margin) for both left and right.

Define to override the gutter defined on the right-hand-side.

#### maxWidth?: string = '1024px'

The maximum width our columns should grow.

#### color?: string = 'rgba(255, 0, 0, 0.1)'

Sets the color used for the column guides.

##### _Global Parameters~_

`js
// .storybook/preview.js
export const parameters = {
grid: {
gridOn: true,
columns: 12,
gap: '20px',
gutter: '50px',
maxWidth: '1024px',
},
};
`

##### _Per story~_

`js
// MyComponent.stories.js
export const Example = () => {...};
Example.parameters = {
grid: {
columns: 6,
},
};
`

$3

The way storybook-addon-grid solves responsive properties is leaving this up to you. We don't you to build
abstractions and implementations for this addon, we want to reuse existing patterns you may already be using.

In fact all properties map through to css, so any css variable you expose is consumable.

eg:

`css
// file: my-styles.css
@media (min-width: 768px) {
:root {
--columns: 8;
--gap: 12px;
--gutter: 24px;
}
}
`

`ts
Story.parameters = {
grid: {
// a custom variable names for the number of columns
columns: 'var(--columns)',
// or the gutter
gutter: 'var(--gutter)',
// or the gap
gap: 'var(--gap)',
},
};
`

You can see this in action over at our example story ResponsiveGrid`.

📚 Further Readings

- https://compassofdesign.com/articles/design-principle-1-guides-gutters-and-grids

❤ Thanks

Special thanks to Marina for the initial implementation and design.

License

MIT © Marais Rossouw