xState Storybook 附加组件

安装

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

使用

要在 Storybook 中使用它，只需将 addons: ["storybook-xstate-addon/preset"] 添加到您的 Storybook 配置中即可。

如果您想在所有故事中启用检查器，请在您的 /.storybook/preview.js 文件中设置以下内容。使用此设置，您可以在某些故事中禁用检查器

export const parameters = {
  xstate: true,
};

要在一个或多个故事文件中启用检查器，请将 xstate 参数设置为 true 或一个选项对象。

// this will turn on the inspector for all stories in the current file
export default {
  title: "Example",
  parameters: {
    xstate: true,
    // this option is passed to the inspect function
    xstateInspectOptions: {
      url: 'https://stately.ai/viz?inspect',
      serialize: null
    }
  },
};

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

为了帮助查看更大的状态图，您可以在 xstate 参数中传递 height 选项来强制检查器的高度。

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

此外，您可以在机器注册时通过 id 向机器发送事件，方法是添加 xstate 参数。

有关更多示例用法，请参见 [./stories/Button.stories.tsx] 和 [./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
    },
  },
};

如果您希望将检查器用作主要故事本身，只需使用以下代码段（使用 React）。

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

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