Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/storybookjs/design-system

🗃 Storybook Design System
https://github.com/storybookjs/design-system

Last synced: about 1 month ago
JSON representation

🗃 Storybook Design System

Lists

README 

        
# Storybook Design System






[![NPM](https://img.shields.io/npm/v/@storybook/design-system.svg)](https://www.npmjs.com/package/@storybook/design-system) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)



## Used by



- [Storybook homepage](https://storybook.js.org/)

- [LearnStorybook.com](https://www.learnstorybook.com/)

- [Chromatic.com](https://www.chromatic.com/)



Note: this design system is not used in Storybook's UI. The stack is different and theming requirements of Storybook add complexity beyond the scope of this project. However, Storybook's visual design is identical to what's here.



## Tech stack



Building components



- 📚 [Storybook](https://storybook.js.org) for UI component development and [auto-generated docs](https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a)

- 👩‍🎤 [Storybook theming |](https://emotion.sh/) for component-scoped styling

- ⚛️ [React](https://reactjs.org/) declarative component-centric UI



Maintaining the system



- 📦 [NPM](https://www.npmjs.com/) for [packaging and distribution](https://blog.hichroma.com/how-packaging-makes-it-dead-simple-to-share-ui-components-29912593539d)

- ✅ [Chromatic](https://www.chromatic.com/) to prevent UI bugs in components (by Storybook maintainers)

- 🚥 [CircleCI](https://circleci.com/) Continuous integration



## Why



The Storybook design system codifies existing UI components into a central, well-maintained repository. It is built to address having to paste the same components into multiple projects again and again. This simplifies building UI's with Storybook's design patterns.



#### What we're doing



- Build and maintain a design system in the open

- Share UI components between multiple apps

- Dogfood upcoming Storybook features

- Welcome contributors of all levels and backgrounds



#### What we're not doing



- Rewrite all new components from scratch

- Overhaul the visual design of components

- Typescript (the consumer apps don't use it)

- Compete with more general design systems like ANT or Material.



## Install



```bash

npm install --save @storybook/design-system

```



## Global Styles



Components within the design system assume that a set of global styles have been configured. Depending upon the needs of the application, this can be done several ways:



#### Option 1: Render the `GlobalStyle` component



Useful when you don't need any custom `body` styling in the application, typically this would be placed in a layout component that wraps all pages, or a top-level `App` component.



```javascript

import { global } from '@storybook/design-system';

const { GlobalStyle } = global;

```



```javascript

/* Render the global styles once per page */



```



#### Option 2: Use the `bodyStyles` to apply styling



Useful when you want build upon the shared global styling.



```javascript

import { Global, css } from '@storybook/theming';

import { global } from '@storybook/design-system';

const { bodyStyles } = global;



const customGlobalStyle = css`

  body {

    ${bodyStyles}// Custom body styling for the app

  }

`;



const CustomGlobalStyle = () => ;

```



```javascript

/* Render the global styles once per page */



```



## Font Loading



Rather than `@import` fonts in the `GlobalStyle` component, the design system's font URL is exported with the intention of using it in a `` tag as the href. Different frameworks and environments handle component re-renders in their own way (a re-render would cause the font to be re-fetched), so this approach allows the design system consumers to choose the font loading method that is most appropriate for their environment.



#### Option 1: Build the link tag manually



```javascript

import { global } from '@storybook/design-system';



const fontLink = document.createElement('link');



fontLink.href = global.fontUrl;

fontLink.rel = 'stylesheet';



document.head.appendChild(fontLink);

```



#### Option 2: Render the link tag in a component



```jsx

import React from 'react';

import { global } from '@storybook/design-system';



const Layout = ({ children }) => (

  

    

      

    



    {children}

  

);



export default Layout;

```



## Development Scripts



#### `yarn release`



> Bump the version



> Push a release to GitHub and npm



> Push a changelog to GitHub



_Notes:_



- Requires authentication with [`npm adduser`](https://docs.npmjs.com/cli/adduser.html)

- [`auto`](https://github.com/intuit/auto) is used to generate a changelog and push it to GitHub. In order for this to work correctly, **environment variables called `GH_TOKEN` and `NPM_TOKEN` are needed** that reference a [GitHub personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) and a [NPM "Publish" token](https://docs.npmjs.com/creating-and-viewing-access-tokens) with the appropriate permissions to update the repo.



## License



MIT © [shilman](https://github.com/shilman)