Storybook Addon Remix React Router

在你的故事中使用 Remix React Router。

✨注意✨
该包已重命名为 storybook-addon-remix-react-router。
仓库也已重命名，所以你是在正确的页面上。
迁移是强制性的，以支持 Storybook 8。

最近更新

✅ 支持 Storybook 8，使用 storybook-addon-remix-react-router@3。
✅ 你现在可以使用 useStoryElement 在多个位置注入故事。
✅ routing 参数现在接受一个字符串，该字符串将用作路由路径和位置路径名。

入门

安装包

npm i -D storybook-addon-remix-react-router

将它添加到你的 Storybook 配置文件中

// .storybook/main.ts

export default {
  addons: ['storybook-addon-remix-react-router'],
} satisfies StorybookConfig;

装饰组件的所有故事

要将路由器添加到组件的所有故事，只需将其添加到 decorators 数组中即可。

请注意，parameters.reactRouter 是可选的，默认情况下路由器将在 / 处渲染组件。

import { withRouter } from 'storybook-addon-remix-react-router';

export default {
  title: 'User Profile',
  render: () => <UserProfile />,
  decorators: [withRouter],
  parameters: {
    reactRouter: reactRouterParameters({
      location: {
        pathParams: { userId: '42' },
      },
      routing: { path: '/users/:userId' },
    }),
  },
};

装饰特定故事

要更改单个故事的配置，你可以执行以下操作

import { withRouter } from 'storybook-addon-remix-react-router';

export default {
  title: 'User Profile',
  render: () => <UserProfile />,
  decorators: [withRouter],
};

export const FromHomePage = {
  parameters: {
    reactRouter: reactRouterParameters({
      location: {
        pathParams: { userId: '42' },
        searchParams: { tab: 'activityLog' },
        state: { fromPage: 'homePage' },
      },
      routing: {
        path: '/users/:userId',
        handle: 'Profile',
      },
    }),
  },
};

全局装饰所有故事

通过在你的 preview.js 文件中添加装饰器，将所有项目的故事情节包装在路由器内。

// .storybook/preview.js

export default {
  decorators: [withRouter],
  parameters: {
    reactRouter: reactRouterParameters({ ... }),
  }
} satisfies Preview;

位置

要指定与浏览器位置相关的任何内容，请使用 location 属性。

type LocationParameters = {
  path?: string | ((inferredPath: string, pathParams: Record<string, string>) => string | undefined);
  pathParams?: PathParams;
  searchParams?: ConstructorParameters<typeof URLSearchParams>[0];
  hash?: string;
  state?: unknown;
};

推断的路径

如果未提供 location.path，则将使用 routing 属性和 pathParams 中的连接 path 生成浏览器路径名。

路径作为函数

你可以向 path 提供一个函数。
它将接收来自 routing 属性和 pathParams 的连接 path 作为参数。
如果函数返回一个 string，则将按原样使用它。如果你需要，请自行调用 react-router 中的 generatePath。
如果函数返回 undefined，则它将回退到默认行为，就像你没有为 location.path 提供任何值一样。

路由

你可以将 routing 设置为 createBrowserRouter 接受的任何内容。
为了让你的生活更轻松，storybook-addon-remix-react-router 附带了一些路由助手

export const MyStory = {
  parameters: {
    reactRouter: reactRouterParameters({
      routing: reactRouterOutlet(<MyOutlet />),
    }),
  },
};

路由助手

以下助手开箱即用

reactRouterOutlet(); // Render a single outlet
reactRouterOutlets(); // Render multiple outlets
reactRouterNestedOutlets(); // Render multiple outlets nested one into another
reactRouterNestedAncestors(); // Render the story as an outlet of nested outlets

你还可以创建自己的助手，并使用导出的类型 RoutingHelper 来帮助你

import { RoutingHelper } from 'storybook-addon-remix-react-router';

const myCustomHelper: RoutingHelper = () => {
  // Routing creation logic
};

RouterRoute 基本上是来自 react-router 的本机 RouteObject; 增强了 { useStoryElement?: boolean }。如果你想接受一个 JSX 并将其转换为 RouterRoute，你可以使用导出的函数 castRouterRoute。

将故事用作路由元素

只需在路由配置对象中设置 { useStoryElement: true }。

专用面板

导航事件、加载器和操作被记录下来，以便你更好地了解组件的生命周期。

兼容性

需要 react-router 版本 6.4+。此包旨在支持 Storybook > 7 和 React > 16。

✅ Storybook 8.0
✅ Storybook 7.0

✅ React 18
✅ React 17
✅ React 16

如果你在任何版本中遇到问题，请提交一个 issue。

贡献

欢迎贡献。

在编写任何代码之前，请提交一个 issue 来展示你想要在这个插件中看到的错误或用例。

许可证

此包是在 Apache 2.0 许可证下发布的。