npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

neutrino-preset-storybook-react

v1.0.2

Published

Neutrino preset for Storybook with React

Downloads

11

Readme

Neutrino preset for Storybook with React

npm npm

neutrino-preset-storybook-react is a Neutrino preset for React projects to enable usage of Storybook. It is recommended to have some React preset in the configuration to be able to compile modules in Storybook. It includes some addons so you don't have to install them manually.

Features

  • Compatible with any other middlewares and presets
  • Include addons:
  • Aliases to addons so you can import them in your stories directly by name (e.g. import { Meta } from '@storybook/addon-docs/blocks')
  • MDX stories support
  • Markdown support

Requirements

  • Node.js v10.13+
  • Neutrino v9
  • Storybook v6
  • React

Installation

neutrino-preset-storybook-react can be installed from NPM. You should install it to "dependencies" (--save) or "devDependncies" (--save-dev) depending on your goal.

npm install --save-dev neutrino-preset-storybook-react

Create a ./storybook/main.js file in the root of the project, containing:

./storybook/main.js

let neutrino = require('neutrino')

module.exports = neutrino().storybookMain()

Edit your project's package.json and add these scripts

package.json

{
   "scripts": {
      "storybook": "start-storybook -p 6006",
      "build-storybook": "build-storybook"
   }
}

Usage

neutrino-preset-storybook-react can be consumed from the Neutrino API, middleware, or presets.

In neutrinorc

The preset also may be used together with another presets in Neutrino rc-file, e.g.:

.neutrinorc.js

let web       = require('@neutrino/web')
let storybook = require('neutrino-preset-storybook-react')

module.exports = {
   use: [
      web(),
      storybook()
   ]
}

In preset

Require this package and plug it into Neutrino. The following shows how you can pass an options object to the preset, showing the defaults:

let storybook = require('neutrino-preset-storybook-react')

neutrino.use(storybook({
   stories: [
      '../src/**/*.stories.@(js|jsx|ts|tsx)',
      '../src/**/*.stories.mdx'
   ],
   addons: [
      '@storybook/addon-links',
      '@storybook/addon-actions',
      '@storybook/addon-backgrounds',
      '@storybook/addon-controls',
      '@storybook/addon-docs',
      '@storybook/addon-viewport',
      '@storybook/addon-toolbars'
   ]
}))
  • stories: optional array of glob pattern paths to configure stories loading. Maps to stories property in ./storybook/main.js.
  • addons: optional array of Storybook addons that you installed in the project. Maps to addons property in ./storybook/main.js.

It is recommended to call this preset after the neutrino.config.module.rule('compile') to make it work properly. More information about usage of Neutrino preset can be found in the documentation.

Addons

In order to use addons, simply install and add them to the the addons option:

.neutrinorc.js

let storybook = require('neutrino-preset-storybook-react')

module.exports = {
   use: [
      storybook({
         addons: ['@storybook/addon-storysource']
      })
   ]
}