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 🙏

© 2021 – Pkg Stats / Ryan Hefner

storybook-xstate-addon

v1.1.5

Published

Storybook addon for displaying xstate inspector inside storybook

Downloads

8,019

Readme

xState Storybook Addon

Installation

npm install -D @storybook/addons storybook-xstate-addon @xstate/inspect @xstate/react

Usage

To use this in storybook simply add addons: ["storybook-xstate-addon/preset"] to your storybook config.

If you want to enable the inspector in all stories, set the following in your /.storybook/preview.js file. With this setting on you can disable the inspector in certain stories

export const parameters = {
  xstate: true,
};

To enable the inspector in a single story/stories file, set the xstate parameter to true or an options object.

// this will turn on the inspector for all stories in the current file
export default {
  title: "Example",
  parameters: {
    xstate: true,
  },
};

// this turns the inspector on for only a single story
StoryComponent.parameters = {
  xstate: true,
};

To assist with viewing larger state charts, you can pass the height option in the xstate parameter to force the height of the inspector.

StoryComponent.parameters = {
  xstate: {
    height: "1000px",
  },
};

Additionally, you can send events to a machine by id when it is registered by adding the xstate parameter.

For more example usages see [./stories/Button.stories.tsx] and [./stories/Machines.stories.tsx].

StoryComponent.parameters = {
  xstate: {
    machine_id1: {
      events: "event",
    },
    machine_id2: {
      events: { type: "event" },
    },
    machine_id3: {
      events: [{ type: "event1" }, { type: "event2" }],
    },
    machine_id4: {
      events: (state) => "event",
    },
    machine_id5: {
      events: ["event1", "event2"],
      delay: 2.5e3, // milliseconds to delay before sending the next event
      shouldRepeatEvents: true, // for looping event sequences
    },
  },
};

If you wish to use the Inspector as the main story itself, simply use the following snippet (uses react).

import { RenderMachine } from 'storybook-xstate-addon/RenderMachine';

export const MachinePreview = () => <RenderMachine machine={confirmMachine} options={...optionsToUseMachine} events={[...events]} />;