Skip to content

Commit 733a10b

Browse files
fxss5201fxss5201
committed
feat: 更新说明文档
1 parent 290f091 commit 733a10b

2 files changed

Lines changed: 82 additions & 69 deletions

File tree

‎README-zh.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# react-components
2+
3+
[示例](https://fxss5201.github.io/react-components/)
4+
5+
`react ^19.2.0` + `react-router ^7.9.6` + `react-redux ^9.2.0` + `antd ^6.1.0` + `typescript ~5.8.3`
6+
7+
通过配置既可作为展示网站、又可作为后台管理系统。
8+
9+
## 核心功能
10+
11+
1. 主题切换
12+
2. 多语言
13+
3. 路由中间件
14+
4. 路由对象可配置 是否缓存 、权限、水印及以下布局调整：
15+
1. 在菜单中是否隐藏该路由
16+
2. 在标签页中是否隐藏该路由
17+
3. 进入该路由时是否隐藏头部
18+
4. 进入该路由时是否隐藏菜单
19+
5. 进入该路由时是否收起菜单
20+
6. 进入该路由时是否隐藏底部
21+
7. 进入该路由时是否隐藏面包屑导航
22+
8. 进入该路由时是否隐藏标签页
23+
5. MOCK 接口
24+
6. 封装多个组件：
25+
1. 复制到剪贴板
26+
2. 文件相关：
27+
1. 文件选择（支持选择文件、选择文件夹（含根目录）、选择文件夹（不含根目录））
28+
2. 文件拖拽选择
29+
3. 文件抽屉（支持上传文件/文件夹、下载文件/文件夹）
30+
4. 文件哈希
31+
3. Markdown 渲染/编辑
32+
4. JSON 渲染/编辑
33+
5. 代码编辑器
34+
6. MDX 渲染
35+
7. Echarts 封装
36+
8. 表单块，支持通过配置生成表单。
37+
9. 表格页，支持通过配置生成表格、表格搜索、表格分页、表格操作弹窗。
38+
10. 表格页再封装，将通用操作（查询、添加、删除、修改、分页逻辑）封装在一起。
39+
11. 登录页
40+
12. 重置密码页

‎README.md‎

Lines changed: 42 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,42 @@
1-
# React + TypeScript + Vite
2-
3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4-
5-
Currently, two official plugins are available:
6-
7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9-
10-
## Expanding the ESLint configuration
11-
12-
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
13-
14-
```js
15-
export default tseslint.config([
16-
globalIgnores(['dist']),
17-
{
18-
files: ['**/*.{ts,tsx}'],
19-
extends: [
20-
// Other configs...
21-
22-
// Remove tseslint.configs.recommended and replace with this
23-
...tseslint.configs.recommendedTypeChecked,
24-
// Alternatively, use this for stricter rules
25-
...tseslint.configs.strictTypeChecked,
26-
// Optionally, add this for stylistic rules
27-
...tseslint.configs.stylisticTypeChecked,
28-
29-
// Other configs...
30-
],
31-
languageOptions: {
32-
parserOptions: {
33-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
34-
tsconfigRootDir: import.meta.dirname,
35-
},
36-
// other options...
37-
},
38-
},
39-
])
40-
```
41-
42-
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
43-
44-
```js
45-
// eslint.config.js
46-
import reactX from 'eslint-plugin-react-x'
47-
import reactDom from 'eslint-plugin-react-dom'
48-
49-
export default tseslint.config([
50-
globalIgnores(['dist']),
51-
{
52-
files: ['**/*.{ts,tsx}'],
53-
extends: [
54-
// Other configs...
55-
// Enable lint rules for React
56-
reactX.configs['recommended-typescript'],
57-
// Enable lint rules for React DOM
58-
reactDom.configs.recommended,
59-
],
60-
languageOptions: {
61-
parserOptions: {
62-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
63-
tsconfigRootDir: import.meta.dirname,
64-
},
65-
// other options...
66-
},
67-
},
68-
])
69-
```
1+
# react-components
2+
3+
[中文文档](https://github.com/fxss5201/react-components/blob/main/README-zh.md)
4+
5+
[Demo](https://fxss5201.github.io/react-components/)
6+
7+
`react ^19.2.0` + `react-router ^7.9.6` + `react-redux ^9.2.0` + `antd ^6.1.0` + `typescript ~5.8.3`
8+
9+
It can be configured as both a display website and a backend management system.
10+
11+
## Core Functionality
12+
13+
1. Theme Switching
14+
2. Multi-language Support
15+
3. Route Middleware
16+
4. Configurable Route Objects (caching, permissions, watermark, and layout adjustments):
17+
1. Hide route in menu
18+
2. Hide route in tabs
19+
3. Hide header when entering the route
20+
4. Hide menu when entering the route
21+
5. Collapse menu when entering the route
22+
6. Hide footer when entering the route
23+
7. Hide breadcrumb navigation when entering the route
24+
8. Hide tabs when entering the route
25+
5. MOCK APIs
26+
6. Multiple Encapsulated Components:
27+
1. Copy to Clipboard
28+
2. File-related:
29+
1. File Selection (supports selecting files, folders (including root directory), folders (excluding root directory))
30+
2. File Drag-and-Drop Selection
31+
3. File Drawer (supports uploading files/folders, downloading files/folders)
32+
4. File Hash
33+
3. Markdown Rendering/Editing
34+
4. JSON Rendering/Editing
35+
5. Code Editor
36+
6. MDX Rendering
37+
7. Echarts Wrapper
38+
8. Form Block, supports generating forms through configuration
39+
9. Table Page, supports generating tables, table search, table pagination, and table operation modals through configuration
40+
10. Enhanced Table Page, encapsulates common operations (query, add, delete, modify, pagination logic) together
41+
11. Login Page
42+
12. Reset Password Page

0 commit comments

Comments
 (0)