ant-design-x-vue 0.0.1 → 0.0.2
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 +27 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,29 +1,27 @@
|
|
|
1
1
|
# wzc-init-vue
|
|
2
2
|
|
|
3
|
-
[](https://npmjs.org/package/ant-design-x-vue)
|
|
4
|
+
[](https://npmjs.org/package/ant-design-x-vue)
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
Ant Design X For Vue.（WIP） 疯狂研发中🔥
|
|
7
7
|
|
|
8
8
|
## Usage
|
|
9
9
|
|
|
10
|
-
First,
|
|
10
|
+
First, install ant-design-vue and ant-design-x-vue:
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
import 'wzc-init-vue/dist/style.css';
|
|
14
|
-
```
|
|
12
|
+
> pnpm add ant-design-vue ant-design-x-vue
|
|
15
13
|
|
|
16
|
-
Then, introduce
|
|
14
|
+
Then, introduce component:
|
|
17
15
|
|
|
18
|
-
```
|
|
16
|
+
```ts
|
|
19
17
|
<script setup lang="ts">
|
|
20
|
-
|
|
18
|
+
import { Bubble, XProvider } 'ant-design-x-vue';
|
|
21
19
|
</script>
|
|
22
|
-
```
|
|
23
20
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
21
|
+
<template>
|
|
22
|
+
<Bubble content="Hello AI" />
|
|
23
|
+
</template>
|
|
24
|
+
```
|
|
27
25
|
|
|
28
26
|
## Development
|
|
29
27
|
|
|
@@ -32,33 +30,34 @@ TODO
|
|
|
32
30
|
$ pnpm install
|
|
33
31
|
|
|
34
32
|
# develop library by docs demo
|
|
35
|
-
$ pnpm
|
|
33
|
+
$ pnpm docs:dev
|
|
36
34
|
|
|
37
35
|
# build library source code
|
|
38
36
|
$ pnpm run build
|
|
39
37
|
|
|
40
|
-
# build
|
|
41
|
-
$ pnpm run build:watch
|
|
42
|
-
|
|
43
|
-
# build docs
|
|
38
|
+
# build docs code
|
|
44
39
|
$ pnpm run docs:build
|
|
45
40
|
|
|
46
41
|
# Locally preview the production build.
|
|
47
42
|
$ pnpm run docs:preview
|
|
48
43
|
|
|
49
|
-
# check your project for potential problems
|
|
50
|
-
$ pnpm run doctor
|
|
51
|
-
|
|
52
|
-
# Test
|
|
53
|
-
$ pnpm test
|
|
54
|
-
|
|
55
|
-
# Coverage
|
|
56
|
-
$ pnpm test:cov
|
|
57
|
-
|
|
58
44
|
# Lint
|
|
59
45
|
$ pnpm lint
|
|
60
46
|
```
|
|
61
47
|
|
|
48
|
+
## Contributing
|
|
49
|
+
|
|
50
|
+
现在Ant Desgin X Vue正在全力同步Ant Desgin X 的组件，因此，协助我们同步组件是最好的贡献方式，在开始您的工作前，请遵照如下流程：
|
|
51
|
+
1. 在[Roadmap](https://github.com/wzc520pyfm/ant-design-x-vue/issues/1)中提及@wzc520pyfm认领一个组件，在得到答复后开始工作
|
|
52
|
+
2. Fork本仓库，并为你认领的组件创建一个开发分支，分支名和commit请遵守《通用提交规范》，建议在完成一个阶段性工作时就进行一次commit，不建议单个commit积累太多内容。
|
|
53
|
+
3. 目前完成一个新组件的大致工作如下：
|
|
54
|
+
1. 对照react版本同步组件代码为Vue，尽量保障目录一致、代码结构一致
|
|
55
|
+
2. 编写demo，与React版一致
|
|
56
|
+
3. 编写文档，与React版一致
|
|
57
|
+
4. 提交pr到本仓库main分支，等待审核
|
|
58
|
+
|
|
59
|
+
除此之外，我们仍有很多事要做，您也可以参考Roadmap，从中挑选您感兴趣的部分。
|
|
60
|
+
|
|
62
61
|
## LICENSE
|
|
63
62
|
|
|
64
63
|
MIT
|