React Portal 项目教程

React Portal 项目教程

react-portal🎯 React component for transportation of modals, lightboxes, loading bars... to document.body or else.项目地址:https://gitcode.com/gh_mirrors/re/react-portal

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

React Portal 项目的目录结构如下：

react-portal/
├── src/
│   ├── index.js
│   ├── Portal.js
│   ├── PortalWithState.js
│   ├── utils.js
│   └── ...
├── examples/
│   ├── basic/
│   ├── modal/
│   ├── tooltip/
│   └── ...
├── .gitignore
├── package.json
├── README.md
└── ...

目录结构介绍

• src/：包含项目的主要源代码文件。
  • index.js：项目的入口文件。
  • Portal.js：基本的 Portal 组件。
  • PortalWithState.js：带有状态管理的 Portal 组件。
  • utils.js：工具函数文件。
• examples/：包含项目的示例代码，展示了如何使用 Portal 组件。
• .gitignore：Git 忽略文件配置。
• package.json：项目的依赖和脚本配置文件。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，它是整个项目的入口点。以下是 index.js 的简要介绍：

import React from 'react';
import ReactDOM from 'react-dom';
import Portal from './Portal';
import PortalWithState from './PortalWithState';

ReactDOM.render(
  <div>
    <Portal>
      <div>This is a portal content</div>
    </Portal>
    <PortalWithState>
      {({ openPortal, closePortal, isOpen, portal }) => (
        <div>
          <button onClick={openPortal}>Open Portal</button>
          {portal(
            <div>
              This is a portal with state
              <button onClick={closePortal}>Close Portal</button>
            </div>
          )}
        </div>
      )}
    </PortalWithState>
  </div>,
  document.getElementById('root')
);

启动文件介绍

• 导入了 React 和 ReactDOM 库。
• 导入了自定义的 Portal 和 PortalWithState 组件。
• 使用 ReactDOM.render 方法将组件渲染到 DOM 中的 root 元素。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的依赖、脚本和其他配置信息。以下是 package.json 的简要介绍：

{
  "name": "react-portal",
  "version": "4.2.1",
  "description": "React component for transportation of modals, lightboxes, loading bars... to document.body",
  "main": "lib/Portal.js",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "prop-types": "^15.7.2",
    "react": "^16.8.6",
    "react-dom": "^16.8.6",
    "react-scripts": "3.0.1"
  },
  "devDependencies": {
    "eslint": "^6.0.1",
    "eslint-config-react-app": "^5.0.1",
    "eslint-plugin-react": "^7.14.2"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/tajo/react-portal.git"
  },
  "keywords": [
    "react",
    "react-component",
    "portal",
    "modal",
    "lightbox",
    "react-portal"
  ],
  "author": "Vojtech Miksu <vojtech@miksu.cz>",
  "license": "MIT"
}

配置文件介绍

• name：项目的名称。
• version：项目的版本号。
• description：项目的描述。
• main：项目的主入口文件。
• scripts：项目的脚本命令

react-portal🎯 React component for transportation of modals, lightboxes, loading bars... to document.body or else.项目地址:https://gitcode.com/gh_mirrors/re/react-portal