@pointcloud/pcloud-components 0.1.28 → 0.1.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -44
- package/README_USER.md +133 -0
- package/dist/esm/Loading/index.js +3 -2
- package/dist/umd/pcloud-components.min.js +1 -1
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -2,28 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
>)  ?style=flat&logo=antdesign>)  ?style=flat&logo=webcomponentsdotorg>) ?style=flat>)
|
|
4
4
|
|
|
5
|
-
pcloud-components 是一套基于 Antd v4.24.16+ React v17 开发的业务组件库。
|
|
6
|
-
该项目已经发布到
|
|
5
|
+
pcloud-components 是一套基于 Antd v4.24.16 + React v17 开发的业务组件库。
|
|
6
|
+
该项目已经发布到 [npm](https://www.npmjs.com/package/@pointcloud/pcloud-components)仓库。
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## 快速使用
|
|
9
9
|
|
|
10
10
|
```
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
cd pcloud-components
|
|
17
|
-
|
|
18
|
-
npm install
|
|
19
|
-
or
|
|
20
|
-
pnpm install
|
|
21
|
-
or
|
|
22
|
-
yarn install
|
|
23
|
-
|
|
24
|
-
// 启动项目
|
|
25
|
-
npm start or npm run dev
|
|
26
|
-
pnpm start or pnpm dev
|
|
11
|
+
# 安装依赖
|
|
12
|
+
npm i @pointcloud/pcloud-components or yarn add @pointcloud/pcloud-components
|
|
13
|
+
|
|
14
|
+
# 引入组件
|
|
15
|
+
import { DCascader } from '@pointcloud/pcloud-components';
|
|
27
16
|
```
|
|
28
17
|
|
|
29
18
|
## 推荐环境
|
|
@@ -37,32 +26,33 @@ pnpm >= 8.15.9
|
|
|
37
26
|
|
|
38
27
|
```
|
|
39
28
|
📁pcloud-components
|
|
40
|
-
├─ 📁.dumi
|
|
41
|
-
│ ├─ 📁tmp
|
|
42
|
-
│ └─ 📄global.less
|
|
43
|
-
├─ 📁.husky
|
|
44
|
-
├─ 📁docker
|
|
45
|
-
│ └─ 📄nginx.conf
|
|
46
|
-
├─ 📁scripts
|
|
47
|
-
│ ├─ 📄clean-tmp.js
|
|
29
|
+
├─ 📁.dumi # api站点相关目录，例如全局样式、全局脚本、站点主题、自定义组件等
|
|
30
|
+
│ ├─ 📁tmp # dumi运行时目录
|
|
31
|
+
│ └─ 📄global.less # 全局样式
|
|
32
|
+
├─ 📁.husky # 代码提交相关配置
|
|
33
|
+
├─ 📁docker # docker部署相关文件
|
|
34
|
+
│ └─ 📄nginx.conf # nginx配置
|
|
35
|
+
├─ 📁scripts # 全局脚本目录
|
|
36
|
+
│ ├─ 📄clean-tmp.js # 清除.dumi目录下自动生成的tmp目录
|
|
48
37
|
│ └─ 📄source-replace-loader.js # 用于解决第三方主题antd版本冲突的webpack loader
|
|
49
|
-
├─ 📁docs
|
|
50
|
-
│ ├─ 📁components
|
|
51
|
-
│ ├─ 📄guide.zh-CN.md
|
|
52
|
-
│ └─ 📄index.zh-CN.md
|
|
53
|
-
├─ 📁
|
|
54
|
-
├─ 📁
|
|
55
|
-
|
|
56
|
-
│ ├─ 📁
|
|
57
|
-
│
|
|
58
|
-
│
|
|
59
|
-
|
|
60
|
-
├─ 📄.
|
|
61
|
-
├─ 📄.
|
|
62
|
-
├─ 📄.
|
|
63
|
-
├─ 📄.
|
|
64
|
-
├─ 📄.
|
|
65
|
-
|
|
38
|
+
├─ 📁docs # 文档目录，适用于普通文档生成路由，详见dumi官方介绍
|
|
39
|
+
│ ├─ 📁components # 组件库页面的文档
|
|
40
|
+
│ ├─ 📄guide.zh-CN.md # 指南页面的文档
|
|
41
|
+
│ └─ 📄index.zh-CN.md # 首页页面的文档
|
|
42
|
+
├─ 📁docs-dist # 组件文档目录
|
|
43
|
+
├─ 📁public # 站点的静态资源目录
|
|
44
|
+
├─ 📁src # 组件目录
|
|
45
|
+
│ ├─ 📁DCascader # 组件1
|
|
46
|
+
│ ├─ 📁DForm # 组件2
|
|
47
|
+
│ ...... # 组件n
|
|
48
|
+
│ └─ 📄index.ts # 组件导出配置
|
|
49
|
+
├─ 📄.dumirc.ts # dumi 的配置文件
|
|
50
|
+
├─ 📄.fatherrc.ts # father 的配置文件，用于组件库打包
|
|
51
|
+
├─ 📄.eslintrc.js # eslint插件配置
|
|
52
|
+
├─ 📄.release-it.js # release-it配置
|
|
53
|
+
├─ 📄.prettierrc.js # prettier插件配置
|
|
54
|
+
├─ 📄.stylelintrc # stylelint插件配置
|
|
55
|
+
└─ 📄tsconfig.json # ts相关配置
|
|
66
56
|
```
|
|
67
57
|
|
|
68
58
|
## 组件开发指南
|
|
@@ -335,3 +325,15 @@ git commit -m "fix: 修复bug" // type后的冒号和空格不可省略，descri
|
|
|
335
325
|
```
|
|
336
326
|
npm run release
|
|
337
327
|
```
|
|
328
|
+
|
|
329
|
+
## FAQ
|
|
330
|
+
|
|
331
|
+
1. 安装组件后, 为什么项目中的 antd 组件都是英文的？
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
- 这是因为antd的默认语言是英文，项目启动时，会自动加载中文语言包，如果项目需要使用英文，请自行在项目入口处导入英文语言包, 并使用ConfigProvider组件注入.
|
|
335
|
+
|
|
336
|
+
2. 项目安装的是 antd5 的版本, 能使用组件吗？
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
- 此组件库基于antd 4.24.16开发，antd5的版本暂时不兼容，请使用antd4.x版本, 后续会升级到antd5版本
|
package/README_USER.md
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# @pointcloud/pcloud-components
|
|
2
|
+
|
|
3
|
+
[](https://npmjs.org/package/@pointcloud/pcloud-components)
|
|
4
|
+
[](https://npmjs.org/package/@pointcloud/pcloud-components)
|
|
5
|
+
[](https://npmjs.org/package/@pointcloud/pcloud-components)
|
|
6
|
+
|
|
7
|
+
一套基于 Ant Design v4.24.16 和 React v17.0.2 开发的业务组件库，包含 20+ 个高质量组件，可帮助您快速构建企业级中后台产品原型。
|
|
8
|
+
|
|
9
|
+
## 🎁 组件列表
|
|
10
|
+
|
|
11
|
+
### 表单组件
|
|
12
|
+
|
|
13
|
+
| 组件名称 | 描述 |
|
|
14
|
+
| ----------- | ----------------------------------- |
|
|
15
|
+
| DForm | 基于 Ant Design Form 的增强表单组件 |
|
|
16
|
+
| DInput | 增强版输入框组件 |
|
|
17
|
+
| DSelect | 支持异步加载的下拉选择组件 |
|
|
18
|
+
| DCascader | 支持异步加载的级联选择组件 |
|
|
19
|
+
| DTreeSelect | 支持异步加载的树选择组件 |
|
|
20
|
+
| DUpload | 文件上传组件 |
|
|
21
|
+
| ColorPicker | 颜色选择器组件 |
|
|
22
|
+
|
|
23
|
+
### 数据展示组件
|
|
24
|
+
|
|
25
|
+
| 组件名称 | 描述 |
|
|
26
|
+
| ------------ | ---------------- |
|
|
27
|
+
| DTable | 增强版表格组件 |
|
|
28
|
+
| LabelValue | 标签值展示组件 |
|
|
29
|
+
| WordCloud | 词云组件 |
|
|
30
|
+
| ScrollNumber | 数字滚动动画组件 |
|
|
31
|
+
| AspectRatio | 宽高比容器组件 |
|
|
32
|
+
| NoData | 无数据展示组件 |
|
|
33
|
+
| IPAddress | IP 地址输入组件 |
|
|
34
|
+
|
|
35
|
+
### 模态框组件
|
|
36
|
+
|
|
37
|
+
| 组件名称 | 描述 |
|
|
38
|
+
| --------- | ---------------- |
|
|
39
|
+
| DModal | 增强版模态框组件 |
|
|
40
|
+
| ModalForm | 表单模态框组件 |
|
|
41
|
+
| LoginForm | 登录表单组件 |
|
|
42
|
+
|
|
43
|
+
### 其他业务组件
|
|
44
|
+
|
|
45
|
+
| 组件名称 | 描述 |
|
|
46
|
+
| ------------------ | ------------------ |
|
|
47
|
+
| Loading | 全局加载组件 |
|
|
48
|
+
| ContextMenu | 右键菜单组件 |
|
|
49
|
+
| AdvancedFilter | 高级筛选组件 |
|
|
50
|
+
| InfiniteScrollList | 无限滚动列表组件 |
|
|
51
|
+
| PictureCard | 图片卡片组件 |
|
|
52
|
+
| SignaturePad | 签名板组件 |
|
|
53
|
+
| RndDrag | 可拖拽调整大小组件 |
|
|
54
|
+
| RCropper | 图片裁剪组件 |
|
|
55
|
+
|
|
56
|
+
## 🚀 安装
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# 使用 npm
|
|
60
|
+
npm install @pointcloud/pcloud-components
|
|
61
|
+
|
|
62
|
+
# 使用 yarn
|
|
63
|
+
yarn add @pointcloud/pcloud-components
|
|
64
|
+
|
|
65
|
+
# 使用 pnpm
|
|
66
|
+
pnpm add @pointcloud/pcloud-components
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## 🔨 快速开始
|
|
70
|
+
|
|
71
|
+
### 1. 基础使用
|
|
72
|
+
|
|
73
|
+
```jsx
|
|
74
|
+
import React from 'react';
|
|
75
|
+
import { DCascader } from '@pointcloud/pcloud-components';
|
|
76
|
+
|
|
77
|
+
const App = () => {
|
|
78
|
+
const handleChange = (value, selectedOptions) => {
|
|
79
|
+
console.log(value, selectedOptions);
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
return <DCascader showSearch placeholder="请选择" onChange={handleChange} />;
|
|
83
|
+
};
|
|
84
|
+
|
|
85
|
+
export default App;
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### 2. 使用表单组件
|
|
89
|
+
|
|
90
|
+
```jsx
|
|
91
|
+
import React from 'react';
|
|
92
|
+
import { DForm, DInput, DSelect } from '@pointcloud/pcloud-components';
|
|
93
|
+
|
|
94
|
+
const App = () => {
|
|
95
|
+
const onFinish = (values) => {
|
|
96
|
+
console.log('表单值:', values);
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
return (
|
|
100
|
+
<DForm onFinish={onFinish}>
|
|
101
|
+
<DForm.Item label="用户名" name="username">
|
|
102
|
+
<DInput placeholder="请输入用户名" />
|
|
103
|
+
</DForm.Item>
|
|
104
|
+
|
|
105
|
+
<DForm.Item label="状态" name="status">
|
|
106
|
+
<DSelect
|
|
107
|
+
options={[
|
|
108
|
+
{ label: '启用', value: 1 },
|
|
109
|
+
{ label: '禁用', value: 0 },
|
|
110
|
+
]}
|
|
111
|
+
/>
|
|
112
|
+
</DForm.Item>
|
|
113
|
+
|
|
114
|
+
<DForm.Item>
|
|
115
|
+
<button type="submit">提交</button>
|
|
116
|
+
</DForm.Item>
|
|
117
|
+
</DForm>
|
|
118
|
+
);
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
export default App;
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## 📖 详细文档
|
|
125
|
+
|
|
126
|
+
访问我们的[在线文档](https://frank17008.github.io/pcloud-components)查看完整的组件列表和使用示例。
|
|
127
|
+
|
|
128
|
+
## ⚙️ 环境支持
|
|
129
|
+
|
|
130
|
+
- React >= 17.0.2
|
|
131
|
+
- Ant Design <= 4.24.16
|
|
132
|
+
- Node >= 16.20.0
|
|
133
|
+
- Modern browsers
|
|
@@ -3,9 +3,10 @@ import { useLoading } from "./hooks/useLoading";
|
|
|
3
3
|
var loadingInstance = null;
|
|
4
4
|
export default {
|
|
5
5
|
open: function open(params) {
|
|
6
|
-
if (
|
|
7
|
-
|
|
6
|
+
if (loadingInstance) {
|
|
7
|
+
this.close();
|
|
8
8
|
}
|
|
9
|
+
loadingInstance = Loading.newInstance(params);
|
|
9
10
|
return loadingInstance;
|
|
10
11
|
},
|
|
11
12
|
close: function close() {
|