Hvad er Storybook, og hvordan kan jeg bruge det til at oprette et komponentbibliotek i React?

Rammer som React, Vue og Angular hjælper alle udviklere med at oprette modulære systemer ved hjælp af komponenter, men det inkluderer normalt ikke en god måde at se dem alle fra et højere synspunkt.

Så hvordan kan vi bruge Storybook til at opbygge biblioteker og designe systemer, der selvdokumenterer, når vi bygger dem?

  • Hvad er Storybook?
  • Hvad skal vi bygge?
  • Trin 0: Bootstrapping af en app
  • Trin 1: Installation af Storybook
  • Trin 2: Oprettelse af en ny knap
  • Trin 3: Brug af vores nye knapkomponent
  • Gentag: Oprettelse af en ny headerkomponent
  • Flere Storybook-funktioner

Hvad er Storybook?

Storybook er et JavaScript-værktøj, der giver udviklere mulighed for at oprette organiserede brugergrænsefladesystemer, der gør både byggeprocessen og dokumentationen mere effektiv og lettere at bruge.

Når du først har bygget en komponent, giver Storybook dig mulighed for at oprette en "historiefil", hvor du derefter kan importere din komponent og oprette forskellige eksempler på brugssager i en iFramed sandkasse ved hjælp af den pågældende komponent.

Dette giver et organiseret og fokuseret miljø til at bygge nye komponenter og arbejde på eksisterende.

Hvad skal vi bygge?

Vi starter en ny React JS-app ved hjælp af Create React App.

Inde i den app skal vi installere Storybook og oprette et par nye komponenter, der hjælper os med at lære, hvordan vi opretter nye komponenter, som vi kan arbejde på i en historie og derefter bruge den i en React-app.

Trin 0: Bootstrapping af en app

For at komme i gang skal vi starte fra bunden med Create React App. Dette hjælper os med at fokusere på at blive produktive i Storybook snarere end at gå igennem at integrere den i en aktuel app.

Når det er sagt, hvis du allerede arbejder med en app oprettet ved hjælp af Create React App, der ikke er skubbet ud, skal du stadig kunne følge med i del 1 og ud over lige det samme!

Så lad os komme i gang ved at navigere til, hvor vi vil oprette vores nye app og køre kommandoen Opret reager app:

npx create-react-app my-storybook 

Bemærk: Du er velkommen til at erstatte my-storybookmed det valgte katalognavn.

Når det er kørt, kan du navigere til biblioteket:

cd my-storybook 

Og vi er klar til at gå!

Trin 1: Installation af Storybook

Storybook gør det heldigvis virkelig nemt at komme i gang med en standardinstallation af React. Især med Create React App registrerer Storybook automatisk, at vi bruger en app oprettet ved hjælp af CRA og installerer afhængighederne og stilladser alt for os.

Initialisering af historiebog

For at komme i gang med installation af Storybook skal du køre:

npx -p @storybook/cli sb init 

Hvis du ikke bruger Create React App, eller det ikke fungerede, kan du tjekke deres tilgængelige guider i deres dokumenter.

Når det er færdigt, skal alle vores Storybook-afhængigheder installeres.

Start af Storybook

Så nu er vi klar til at komme i bevægelse! Endelig kør:

yarn storybook # or npm run storybook 

Og når alt er indlæst, åbner Storybook en ny fane i din browser, og du skal nu se en velkomstbesked inde i dit nye Storybook-dashboard!

Følg med på forpligtelsen!

Trin 2: Oprettelse af en ny knap

Hvis du tog et sekund at pikke rundt på instrumentbrættet, har du måske bemærket, at det kommer forudindlæst med en knap, der er tilgængelig som en demo.

Du skal også bemærke, at hvis du klikker på knappen, ser du faktisk en handling udskrevet inde i fanen Handlinger nederst. Dette viser begivenheden, der er fanget fra et klik på knappen.

It's simple, but this is great to get a nice feel about what to expect in storybook. The only issue is, this is meant purely for demonstration purposes, so let's build our own button to replace it.

Creating a new Button component

To get started, let's first create a few directories:

  • Under src, create a new folder called components
  • Under components, create a new folder called Button

Once you create those folders, create a new file called index.js inside of your src/components/Button folder and inside add:

// Inside src/components/Button/index.js export { default } from './Button'; 

This will import the next file we created called Button.js which will allow us to more easily import our files with src/components/Button instead of /src/components/Button/Button.

Next, let's create Button.js right next to our index.js file with the following content:

// Inside src/components/Button/Button.js import React from 'react'; const Button = ({ children, ...rest }) => { return (  { children }  ) } export default Button; 

Here, we're creating a new component called Button that adds a class of button to the element and passes through the children. We're a additionally destructuring the rest of the props into the rest variable and spreading that value into the element.

If you've followed along, your files should now look like this:

Using our new Button component

So now that we have our Button component, let's use it!

Open up the file src/stories/1-Button.stories.js and replace the line that's importing Button with:

And once you hit save, you can open back up your browser tab with your Storybook dashboard, and you can now see a button that looks mostly similar, but it uses the browser's default styles for the element. You'll even notice that if you click it, the event will still be logged under the Actions tab.

Styling our Button component

Finally, we probably don't want to use the browser default styles, so let's make it look nice.

In our src/components/Button directory, add a new file Button.css and add the following content:

/* Inside src/components/Button/Button.css */ .button { color: white; font-weight: bold; background-color: blueviolet; border: none; padding: .8em 1em; border-radius: .2rem; } 

This applies a few styles to our .button class like adding a background color and changing the font color to white.

But if you open Storybook, you'll notice it didn't do anything. To use it, we need to import it into our component.

Inside src/components/Button/Button.js add the following at the top under the React import:

import './Button.css'; 

And once you save that and open up your browser, you should now see our new button with our updated styles!

Follow along with the commit!

Step 3: Using our new Button component

The ultimate goal of our component is to use it right? So let's add it to our app.

Switching over to the React app

First we'll need to either start our React app in a new terminal tab or kill the Storybook process and start the React process there. To start the React app using Create React App, run:

yarn start # or npm run start 

Once that loads, we should have our standard Create React App if you're following along with me:

Importing and using the new button

Next, inside of src/App.js, let's import our new Button at the top of the page:

import Button from './components/Button'; 

With Button imported, we can use it. Here, we can simply add it anywhere we want in the page. I'm going to replace the Learn React link with:

Hello, Storybook!

And if we save and reload the page, we should now see our Button on the page!

Follow along with the commit

Repeat: Creating a new Header component

The great thing about Storybook and React (or any of the supported frameworks) is that this process scales to as many components as you want.

So let's build another component!

Creating our Header component

Similar to our Button, let's start off by creating the set of directories and files that give us our component.

Since we already did this once, I'm going to provide the code without walking through what's going on.

Let's start off by spinning back up our Storybook server with:

yarn storybook # or npm run storybook 

Create a Header directory inside the src/components directory.

Create an index.js file inside of src/components/Header with the following content:

// In src/components/Header/index.js export { default } from './Header'; 

Create a Header.js file inside of src/components/Header with the following content:

// In src/components/Header/Header.js import React from 'react'; import './Header.css'; const Header = ({ children }) => { return ( 

{ children }

) } export default Header;

Create a Header.css file inside of src/components/Header with the following content:

/* In src/components/Header/Header.css */ .header { font-family: sans-serif; font-size: 2.5em; color: blueviolet; border-bottom: solid 5px aqua; padding-bottom: .2em; box-shadow: 0 5px 0 blueviolet; } 

Now if you notice, if you try to open up Storybook, again, nothing will happen. This time we need to create a new story file.

Creating a new Story file

Inside src/stories, add a new file called 2-Header.stories.js:

// Inside src/stories/2-Header.stories.js import React from 'react'; import Header from '../components/Header'; export default { title: 'Header', component: Header, }; export const Text = () => Hello Header; 

Here's a breakdown of our story file:

  • First, we import our component – this is pretty standard any time we want to use it
  • The first thing we export is a default object. With Storybook, it expects the default export to be the configuration of our story, so here we provide it with a title and we pass in the component that we're using for this story
  • The second and last thing we export is the Text constant. With Storybook, any non-default export will be considered a variation that will get nested under the title that you provide in the default export

And if you save this file and open up your Storybook dashboard in the browser, you should now see the new header!

Using the Header component

Using our component is just the same as our Button component, so inside of src/App.js, let's add our Header.

After starting your React server, first import our new Header:

// In src/App.js import Header from './components/Header'; 

Then add it to the top of the page:

// In src/App.js My App 

And if you open the page, we'll see our new Header!

Follow along with the commit!

Adding more components

As you've noticed with our second Repeat step – adding a new component is pretty much the same process for any type of component we want to add. Once we have it in our library, we can develop it in a focused environment and then import it to our app to use.

You can now use this to manage your library of components and better maintain an entire system for your project!

More Storybook features

Storybook doesn't stop with just adding components, it provides the ability to configure Addons that enhance the core capabilities opening up a lot of possibilities.

Here are some of my favorites...

Story Source

When building a component system, the hope is that people can easily use these components. But if you don't have documentation, someone would have to open up the file or try to find another use example.

Instead, Story Source shows the code source of the story file you created allowing someone browsing your Storybook dashboard to get an example right along with the component output!

Storyshots

If you're a fan of automated testing, you might have heard of using Jest or another tool for adding snapshot testing to your app.

StoryShots is a way to easily add Jest snapshot testing to your component system. It creates snapshots based off of the stories you create so you can make sure that your components aren't fundamentally changing (or breaking) during development.

What's your favorite part of Storybook?

Share with me on Twitter!

Continue the conversation!

[email protected] is an awseome tool to manage a library of components for your project’s design system ?

It makes it fun to create and update components in a focused env ?‍?

Jeg gennemgår, hvad Storybook er, og hvordan kommer jeg i gang? #Webdev # 100DaysOfCode // t.co / 4TLFlmp4Df

- Colby Fayock (@colbyfayock) 9. juni 2020

Følg mig for mere Javascript, UX og andre interessante ting!

  • ? Følg mig på Twitter
  • ? ️ Abonner på min Youtube
  • ✉️ Tilmeld dig mit nyhedsbrev