0Pricing
React Academy · Lektion

Storybook in einem React-Projekt einrichten

Installieren Sie Storybook, konfigurieren Sie es für Vite oder CRA und durchsuchen Sie den Component Explorer.

Storybook in einem React-Projekt einrichten ist eine kostenlose React Academy-Lektion auf CoddyKit. Dies ist Lektion 1 von 4. Du kannst die komplette Lektion unten kostenlos lesen – dann übst du sie direkt im Browser mit einem integrierten Code-Editor und einem KI-Tutor rund um die Uhr. Sie ist Teil des React Academy-Lernpfads, und dein Fortschritt wird über Web und CoddyKit-App synchronisiert. Der React Academy-Kurs umfasst insgesamt 4 Lektionen.

Was ist Storybook?

Storybook ist ein Tool zum Entwickeln, Dokumentieren und Testen von UI-Komponenten in Isolation. Jede Story stellt einen bestimmten Zustand einer Komponente dar, der in der Storybook-Oberfläche angezeigt werden kann, ohne die vollständige App auszuführen.

Installation

Führen Sie den Storybook-Init-Befehl in Ihrem React-Projekt aus. Storybook erkennt Ihr Framework (Vite, CRA, Next.js) automatisch und erstellt die Konfiguration.

# For a Vite + React project:
npx storybook@latest init

# This creates:
# .storybook/main.ts
# .storybook/preview.ts
# src/stories/ (example stories)

Storybook starten

Starten Sie den Entwicklungsserver von Storybook auf Port 6006. Dadurch wird der Komponenten-Explorer in Ihrem Browser geöffnet.

npm run storybook
# or
npx storybook dev -p 6006

Die Konfiguration .storybook/main.ts

main.ts teilt Storybook mit, wo Stories zu finden sind, welche Add-ons geladen werden sollen und welches Framework verwendet wird.

import type { StorybookConfig } from '@storybook/react-vite';

const config: StorybookConfig = {
  stories: ['../src/**/*.stories.@(ts|tsx)'],
  addons: [
    '@storybook/addon-essentials',
    '@storybook/addon-interactions',
  ],
  framework: {
    name: '@storybook/react-vite',
    options: {},
  },
};

export default config;

Die Konfiguration .storybook/preview.ts

preview.ts wendet globale Decorators an (z. B. indem alle Stories in einen Provider eingeschlossen werden) und legt globale Parameter wie die Hintergrundfarbe fest.

import type { Preview } from '@storybook/react';
import '../src/index.css'; // global styles

const preview: Preview = {
  parameters: {
    backgrounds: {
      default: 'light',
      values: [{ name: 'light', value: '#fff' }, { name: 'dark', value: '#333' }],
    },
  },
  decorators: [
    (Story) => (
      <ThemeProvider theme={defaultTheme}>
        <Story />
      </ThemeProvider>
    ),
  ],
};

export default preview;

Decorators für Context hinzufügen

Verwenden Sie Decorators in preview.ts, um alle Stories in die benötigten Provider (Router, Theme, i18n) einzuschließen. Dadurch müssen die Stories diese nicht einzeln importieren.

decorators: [
  (Story) => (
    <MemoryRouter>
      <QueryClientProvider client={new QueryClient()}>
        <Story />
      </QueryClientProvider>
    </MemoryRouter>
  ),
],

In der Storybook-Oberfläche navigieren

Die Seitenleiste gruppiert Stories nach Komponente. Klicken Sie auf eine Story, um sie auf der Canvas anzuzeigen. Der Tab „Docs“ zeigt automatisch generierte API-Dokumentation aus Ihren TypeScript-Props.

Ein statisches Storybook erstellen

Erstellen Sie aus Ihren Stories eine statische HTML-Website, die Sie auf Chromatic, GitHub Pages oder einem beliebigen CDN hosten können.

npm run build-storybook
# Output in storybook-static/

Storybook für die Dokumentation von Designsystemen

Storybook eignet sich hervorragend als lebendige Dokumentation für Designsysteme. Fügen Sie @storybook/addon-docs (Teil von essentials) hinzu, um aus Ihren TypeScript-Typen automatisch Prop-Tabellen und Anwendungsbeispiele zu generieren.

Hot Module Replacement

Storybook unterstützt HMR. Wenn Sie eine Komponenten- oder Story-Datei bearbeiten, wird die Storybook-Canvas sofort aktualisiert, ohne dass die gesamte Seite neu geladen wird.

TypeScript-Unterstützung

Das Framework @storybook/react-vite bietet erstklassige TypeScript-Unterstützung. Verwenden Sie die Generics Meta und StoryObj für vollständig typisierte Stories.

import type { Meta, StoryObj } from '@storybook/react';
import { Button } from './Button';

const meta: Meta<typeof Button> = {
  component: Button,
};
export default meta;

type Story = StoryObj<typeof Button>;
export const Primary: Story = { args: { label: 'Click me' } };

Kurzer Check

Welche Storybook-Konfigurationsdatei ist dafür verantwortlich, globale Decorators anzuwenden, beispielsweise alle Stories in einen Provider einzuschließen?

Zusammenfassung

Führen Sie npx storybook init aus, um Storybook einzurichten, konfigurieren Sie globale Provider in preview.ts und fügen Sie Add-ons in main.ts hinzu. Verwenden Sie die Generics Meta und StoryObj für typisierte Stories und erstellen Sie mit build-storybook eine statische Website zum Teilen.

Häufig gestellte Fragen

Ist die Lektion „Storybook in einem React-Projekt einrichten“ kostenlos?

Ja — der vollständige Text von „Storybook in einem React-Projekt einrichten“ ist hier im Web kostenlos zu lesen. Um sie interaktiv zu üben (integrierter Code-Editor und 24/7 KI-Tutor) und den Rest des React Academy-Kurses freizuschalten, upgrade auf CoddyKit PRO. Der React Academy-Kurs umfasst insgesamt 4 Lektionen.

Was lerne ich in „Storybook in einem React-Projekt einrichten“?

Installieren Sie Storybook, konfigurieren Sie es für Vite oder CRA und durchsuchen Sie den Component Explorer. Du übst React Academy mit praktischem Code, den du direkt im Browser ausführst, und ein 24/7 KI-Tutor beantwortet deine Fragen während du die Lektion bearbeitest.

Brauche ich Erfahrung, um React Academy zu starten?

Keine Vorkenntnisse erforderlich. React Academy auf CoddyKit ist für Anfänger bis fortgeschrittene Lernende strukturiert, sodass du hier starten oder von Anfang an beginnen und in deinem eigenen Tempo voranschreiten kannst. Dies ist Lektion 1 von 4.

Wie lange dauert die Lektion „Storybook in einem React-Projekt einrichten“?

Die meisten CoddyKit-Lektionen dauern etwa 5–10 Minuten. Jede ist kompakt und interaktiv, sodass du stetig Fortschritte machst und genau dort weitermachst, wo du aufgehört hast – im Web und in der App.

Kann ich in dieser React Academy-Lektion Code schreiben und ausführen?

Ja. Jede React Academy-Lektion enthält einen integrierten Code-Editor, sodass du echten Code direkt in deinem Browser schreibst und ausführst und sofort KI-Feedback erhältst — ohne lokale Einrichtung erforderlich.

Alle Lektionen in diesem Kurs

  1. Storybook in einem React-Projekt einrichten
  2. CSF3-Stories schreiben
  3. Args, Controls und das Actions-Addon
  4. Storybook-Tests und visuelle Regression
← Zurück zu React Academy