React Storybook Addon Info 使用教程

React Storybook Addon Info 使用教程

react-storybook-addon-infoREPO/PACKAGE MOVED - A storybook addon to show additional information for your stories.项目地址:https://gitcode.com/gh_mirrors/re/react-storybook-addon-info

1. 项目的目录结构及介绍

React Storybook Addon Info 项目的目录结构如下：

react-storybook-addon-info/
├── dist/
├── examples/
├── src/
│   ├── components/
│   ├── index.js
│   ├── options.js
│   ├── propTables.js
│   ├── utils.js
│   └── withInfo.js
├── .babelrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── webpack.config.js

目录介绍

• dist/: 编译后的文件目录。
• examples/: 示例代码目录。
• src/: 源代码目录。
  • components/: 组件目录。
  • index.js: 入口文件。
  • options.js: 配置选项文件。
  • propTables.js: 属性表文件。
  • utils.js: 工具函数文件。
  • withInfo.js: 主要功能实现文件。
• .babelrc: Babel 配置文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 许可证文件。
• README.md: 项目说明文件。
• package.json: 项目依赖和脚本配置文件。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，它是整个项目的入口文件。该文件主要负责导出 withInfo 高阶组件，以便在 Storybook 中使用。

import withInfo from './withInfo';

export default withInfo;

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一些关键配置：

{
  "name": "react-storybook-addon-info",
  "version": "1.0.0",
  "description": "A Storybook addon to show additional information for your stories.",
  "main": "dist/index.js",
  "scripts": {
    "build": "webpack",
    "start": "webpack-dev-server"
  },
  "dependencies": {
    "react": "^16.0.0",
    "react-dom": "^16.0.0"
  },
  "devDependencies": {
    "babel-core": "^6.26.0",
    "babel-loader": "^7.1.2",
    "webpack": "^3.6.0",
    "webpack-dev-server": "^2.9.1"
  }
}

webpack.config.js

webpack.config.js 文件是 Webpack 的配置文件，用于构建和打包项目。以下是一些关键配置：

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'index.js',
    libraryTarget: 'commonjs2'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        include: path.resolve(__dirname, 'src'),
        exclude: /(node_modules|dist)/,
        use: {
          loader: 'babel-loader',
          options: {
            presets: ['env']
          }
        }
      }
    ]
  },
  externals: {
    'react': 'commonjs react'
  }
};

通过以上配置，可以构建和打包项目，并在 Storybook 中使用 withInfo 高阶组件来展示组件的额外信息。

react-storybook-addon-infoREPO/PACKAGE MOVED - A storybook addon to show additional information for your stories.项目地址:https://gitcode.com/gh_mirrors/re/react-storybook-addon-info