docs: add zh-CN.md

This commit is contained in:
Amour1688 2020-07-02 13:30:17 +08:00
parent 290c56ae96
commit 33ff92fd87
2 changed files with 47 additions and 1 deletions

42
README-zh_CN.md Normal file
View File

@ -0,0 +1,42 @@
# Vue 3 Babel JSX 插件
以 JSX 的方式来编写 Vue 代码
## 安装
安装插件
```
npm install @ant-design-vue/babel-plugin-jsx -D
npm install @ant-design-vue/babel-helper-vue-transform-on
```
配置 Babel
```
{
"plugins": ["@ant-design-vue/babel-plugin-jsx"]
}
```
## 使用
### 参数
* transformOn
`on: { click: xx }` 转成 `onClick: xxx`
* compatibleProps
兼容大多数 Vue 2 的写法Vue 3 中,把所有属性都改成了顶级属性,意味这不需要再传递 propsattrs 这些属性。
开启这个参数意味着对 { attrs, props, on } 做了兼容处理,但是所有的属性外层都会有 `compatibleProps` 方法
## 兼容性
要求:
- **Babel 7+**
- **Vue 3+**

View File

@ -2,6 +2,8 @@
To add Vue JSX support.
English | [简体中文](./README-zh_CN.md)
## Installation
Install the plugin with:
@ -16,7 +18,7 @@ Then add the plugin to .babelrc:
```
{
"plugins": ["@ant-design-vue/babel-plugin-jsx", { "transformOn": true, "compatibleProps": true }]
"plugins": ["@ant-design-vue/babel-plugin-jsx"]
}
```
@ -31,6 +33,8 @@ transform `on: { click: xx }` to `onClick: xxx`
compatible with Vue 2.x
`{ props, on = {}, attrs, ...rest }` will be transformed to `{ ...props, ...attrs, ...transformOn(on), ...rest }`
## Compatibility
This repo is only compatible with: