story-browser v5.4.0

Story Browser

Story Browser will render React based CSF (Component Story Format) files.

The difference is that this is just a React component, avoiding all of the tooling issues from StoryBook and ViteBook However, you must route to this component and/or embed it into your application yourself

Features:

• Render stories in iframes (Optional)
• CLI to generate an import map for story files in the project
• Can be rethemed (CSS variables & Class names)
• Has dark & light theme
• Sidebar is a nested, collapsable, searchable tree
• Planned:
  • Can zoom rendered component in/out

Not planned:

• Full CSF support

• React Usage
• CLI Usage

• Contributing

React Usage

import { StoryBrowser, useStoryBrowser } from 'story-browser'
import * as modules from './storymap'

// This example uses the `xroute` library for rounting
export const StoryBrowserPage = ({ router }: { router: XRouter }) => 
  <StoryBrowser
    modules={modules}
    activeStoryId={router.routes.storyBrowser.pathname?.story}
    onActiveStoryIdChanged={(story) =>
      router.routes.storyBrowser.push({ pathname: { story } })
    }
    /** @example "/story/my-story--id" */
    onStoryUri={({ storyId }) =>
      router.routes.story.toUri({
        pathname: { story: storyId },
      })
    }
    layout={{
      branding: 'storyBrowser',
      initialSidebarPosition: 'open',
      initialTheme: 'light',
      asFullscreenOverlay: true,
    }}
  />

The full example also includes how to utilize iFramed components See the full example here: ./testProject/Root.tsx

CLI Usage

# Install it
npm add story-browser

# Generate a story map to import into the component
# This is a simple glob pattern
npm run makeStoryMap './src/**/*.stories.tsx' --output ./src/storyBrowser/storyMap.ts

Contributing

git clone https://github.com/nfour/story-browser.git
cd story-browser
pnpm i
pnpm dev # start dev server for ./testProject