Storybook

Podczas pisania aplikacji ogromne znaczenie ma projektowanie oraz testowanie komponentów aplikacji. Niestety przeglądanie komponentów osobno może być trudne, lecz z pomocą przychodzi nam Storybook, dzięki niemu jesteśmy w stanie testować złożone działania i upewnić się, że napisane przez nas komponenty zawsze działają zgodnie z oczekiwaniami.

Czym jest Storybook?

Storybook jest narzędziem do tworzenia komponentów interfejsu aplikacji. Umożliwia przeglądanie komponentów, przeglądanie różnych stanów każdego komponentu oraz testowanie komponentów. Storybook sprawia, że tworzenie komponentów jest szybsze i łatwiejsze dzięki izolacji komponentów. Jesteśmy w stanie stworzyć całe interfejsy użytkownika bez konieczności poruszania się po aplikacji, a także pomaga w dokumentowaniu komponentów do ponownego użycia, a także daje możliwość testowania je wizualnie, aby zapobiec błędom. Storybook świetnie spisuje się wraz z biblioteką React, lecz także wspiera on takie technologie jak: Vue, Angular, Web Components, Ember, Svelte, Preact.

Czy szukasz wykonawcy Storybook ?

Sprawdź case studies

Pierwsze kroki

Po instalacji Storybooka, możemy stworzyć swoje pierwsze story. Story to funkcja, która opisuje sposób renderowania danego komponentu i jest zapisana w formacie Component Story Format (CSF), a pliki kończą się na .stories.js lub .stories.ts. Poniższy kod przedstawia stworzenie story, który będzie przechowywać komponent z przyciskiem.

import React from 'react';
import { Button } from './Button';

export default {
  title: 'Button',
  component: Button,
};

export const Primary = () => <Button primary>Button</Button>;

Powyższe Story można ulepszyć o dodatkową koncepcję “args”, która pozwala na dynamicznym zmienianiu argumentów komponentu, czyli będziemy wstanie naszemu przyciskowi np. zmienić dynamicznie kolor, rozmiar, tekst.

import React from 'react';
import { Button } from './Button';

export default {
  title: 'Button',
  component: Button,
};

const Template = (args) => <Button {...args} />;

export const Primary = Template.bind({});
Primary.args = {
   primary: true,
   label: 'Button',
};

Struktura i organizacja komponentów

Dobra organizacja komponentów w Storybooku jest kluczowa dla efektywnej pracy zespołu i łatwego zarządzania biblioteką UI. Storybook pozwala na grupowanie komponentów w katalogi oraz tworzenie logicznej hierarchii, co ułatwia nawigację i odnalezienie odpowiednich elementów.

Najlepszą praktyką jest organizowanie komponentów w oparciu o ich rolę w systemie – na przykład dzieląc je na atomy, molekuły i organizmy zgodnie z metodologią Atomic Design. Można także grupować komponenty według ich przeznaczenia, np. formularze, przyciski, nawigacja.

Storybook umożliwia także definiowanie nazw kategorii i podkategorii poprzez odpowiednie nazewnictwo plików – np. UI/Buttons/PrimaryButton. Dzięki temu komponenty w panelu nawigacyjnym są logicznie uporządkowane i łatwo je znaleźć. Warto również konsekwentnie stosować konwencje nazewnicze oraz dbać o spójność w opisie i organizacji plików, co znacząco poprawia czytelność projektu.

Addony – rozszerzanie możliwości Storybooka

Jednym z największych atutów Storybooka jest możliwość rozszerzania jego funkcjonalności za pomocą addonów. Dzięki nim można dostosować środowisko do własnych potrzeb, testować komponenty w różnych scenariuszach i zwiększać ich użyteczność.

Niektóre z najpopularniejszych addonów to:

• Controls – pozwala na dynamiczne modyfikowanie propsów komponentów i obserwowanie zmian w czasie rzeczywistym.
• Actions – rejestruje akcje użytkownika, np. kliknięcia, co jest przydatne do testowania eventów.
• Accessibility (A11y) – analizuje komponenty pod kątem zgodności ze standardami WCAG i pomaga poprawić dostępność.
• Viewport – umożliwia podgląd komponentów w różnych rozdzielczościach ekranów, co pomaga w testowaniu responsywności.
• Storyshots – integruje Storybooka z testami wizualnymi, pozwalając na wykrywanie niezamierzonych zmian w interfejsie.

Dzięki addon'om Storybook staje się jeszcze potężniejszym narzędziem, które nie tylko ułatwia dokumentowanie komponentów, ale także pozwala na testowanie ich funkcjonalności i optymalizację pod kątem UX/UI.

Storybook a design systemy

Storybook doskonale sprawdza się jako narzędzie do budowania i utrzymywania design systemów. Dzięki niemu zespoły projektowe i programistyczne mogą w jednym miejscu przechowywać, testować i dokumentować komponenty UI, co zapewnia spójność wizualną aplikacji.

W nowoczesnych projektach cyfrowych design systemy odgrywają kluczową rolę w utrzymaniu jednolitości interfejsów użytkownika. Storybook pozwala na:

• Centralizację komponentów – wszystkie elementy UI są dostępne w jednym repozytorium, co ułatwia ich ponowne wykorzystanie.
• Dokumentację wizualną – każdy komponent ma swój podgląd, opis i możliwe warianty, co pomaga zespołom projektowym i programistycznym w efektywnej współpracy.
• Zarządzanie wersjami komponentów – można łatwo monitorować zmiany w czasie i zapewnić kompatybilność z istniejącymi rozwiązaniami.
• Integrację z narzędziami do testowania i dostępności – dzięki addon'om można sprawdzić poprawność komponentów pod kątem usability i accessibility.

SPRAWDŹ SWOJĄ WIEDZE Z TEMATU storybook

Pytanie

 1/5

Do czego służy Storybook?

Do tworzenia dokumentacji projektów

Do tworzenia izolowanych komponentów UI

Do zarządzania zadaniami w projektach

Do tworzenia stron internetowych

Sprawdź odpowiedź

W jakim języku programowania jest napisany Storybook?

Python

Ruby

JavaScript

Java

Sprawdź odpowiedź

Jakie są główne frameworkami, z którymi Storybook może współpracować?

React, Vue, Angular, Svelte

Django, Laravel, Express

Flutter, Xamarin, React Native

Rails, Spring, Phoenix

Sprawdź odpowiedź

Jakie polecenie jest używane do uruchomienia Storybook?

start-storybook

run-storybook

run storybook

launch storybook

Sprawdź odpowiedź

Jakie polecenie jest używane do dodania Storybook do istniejącego projektu?

npx sb init

npm install storybook

npx -p @storybook/cli sb init

storybook init

Sprawdź odpowiedź

Dlaczego warto używać Storybooka?

Storybook to narzędzie, które znacząco ułatwia pracę nad komponentami interfejsu użytkownika, szczególnie w projektach, gdzie modularność i wielokrotne wykorzystanie elementów są kluczowe. Jednym z głównych powodów, dla których warto używać Storybooka, jest możliwość tworzenia i testowania komponentów w izolacji, niezależnie od reszty aplikacji. Dzięki temu deweloperzy mogą skupić się na wyglądzie i funkcjonalności pojedynczego komponentu, bez konieczności uruchamiania całej aplikacji. To nie tylko przyspiesza proces developmentu, ale również redukuje ryzyko wprowadzenia błędów do istniejącego kodu.

Storybook wspiera szybki feedback dzięki swojej interaktywnej naturze. Deweloperzy mogą natychmiast zobaczyć zmiany w kodzie komponentu w dedykowanym środowisku Storybooka. Ponadto, dzięki wizualnemu przeglądowi wszystkich komponentów w jednym miejscu, łatwiej jest zachować spójność w projekcie, co jest kluczowe w dużych aplikacjach, gdzie nad kodem pracuje wielu programistów. Storybook ułatwia również współpracę z designerami i product managerami, którzy mogą zobaczyć i przetestować komponenty na bieżąco, zgłaszając uwagi i sugestie, co prowadzi do szybszego iterowania nad projektem.

Kolejną zaletą korzystania z Storybooka jest łatwość tworzenia dokumentacji komponentów. W miarę jak komponenty są tworzone i testowane, Storybook automatycznie generuje dokumentację, która może być używana przez innych członków zespołu. To ułatwia onboardowanie nowych deweloperów oraz zwiększa zrozumienie struktury i użycia komponentów w projekcie. Dodatkowo, dzięki licznym dostępnym dodatkom, takim jak integracja z narzędziami do testowania dostępności, deweloperzy mogą zapewnić, że ich komponenty są nie tylko funkcjonalne, ale również zgodne z najlepszymi praktykami dostępności.

FAQ – najczęstsze pytania dotyczące Storybook

1. Czym jest Storybook?

Storybook to narzędzie open source służące do budowania, testowania i dokumentowania komponentów interfejsu użytkownika w izolacji, bez konieczności uruchamiania całej aplikacji.

2. Dlaczego warto używać Storybooka?

Storybook pozwala tworzyć i testować komponenty niezależnie od logiki aplikacji, co przyspiesza rozwój, ułatwia współpracę w zespołach i poprawia jakość UI.

3. Dla jakich technologii można używać Storybooka?

Storybook wspiera wiele technologii frontendowych, takich jak React, Vue, Angular, Svelte, a także frameworki mobilne, np. React Native.

4. Czy Storybook jest trudny w konfiguracji?

Nie, konfiguracja Storybooka jest stosunkowo prosta, a narzędzie oferuje gotowe skrypty instalacyjne dla popularnych środowisk programistycznych.

5. Jak wygląda workflow pracy z Storybookiem?

Programista tworzy pojedyncze "stories" dla komponentów, które opisują różne ich stany i warianty, a następnie przegląda je i testuje w środowisku Storybooka.

6. Czy Storybook wspiera testowanie komponentów?

Tak, Storybook integruje się z narzędziami do testowania wizualnego, jednostkowego i dostępności, jak np. Chromatic, Jest czy Testing Library.

7. Czy mogę używać Storybooka w projektach komercyjnych?

Tak, Storybook jest darmowy i dostępny na licencji MIT, co oznacza, że można go bez przeszkód używać w projektach komercyjnych.

8. Czy Storybook można zintegrować z systemem CI/CD?

Tak, Storybook bardzo dobrze współpracuje z pipeline’ami CI/CD, umożliwiając automatyczne budowanie dokumentacji komponentów i ich testowanie.

9. Czy Storybook może generować dokumentację komponentów?

Tak, Storybook automatycznie tworzy interaktywną dokumentację komponentów, co pomaga w utrzymaniu aktualnej wiedzy o ich stanie i funkcjonalności.