babel-plugin-jsx/README.md
2020-07-03 00:51:53 +08:00

169 lines
2.2 KiB
Markdown

# Babel Plugin JSX for Vue 3.0
To add Vue JSX support.
English | [简体中文](./README-zh_CN.md)
## Installation
Install the plugin with:
```
npm install @ant-design-vue/babel-plugin-jsx -D
npm install @ant-design-vue/babel-helper-vue-transform-on
```
Then add the plugin to .babelrc:
```
{
"plugins": ["@ant-design-vue/babel-plugin-jsx"]
}
```
## Usage
### options
* transformOn
transform `on: { click: xx }` to `onClick: xxx`
* compatibleProps
compatible with Vue 2.x
`{ props, on = {}, attrs, ...rest }` will be transformed to `{ ...props, ...attrs, ...transformOn(on), ...rest }`
## Syntax
### Content
functional component
```jsx
const App = () => <div></div>
```
with render
```jsx
const App = {
render() {
return <div>Vue 3.0</div>
}
}
```
```jsx
const App = defineComponent(() => {
const count = ref(0);
const inc = () => {
count.value++;
};
return () => (
<div onClick={inc}>
{count.value}
</div>
)
})
```
Fragment
```jsx
const App = () => (
<>
<span>I'm</span>
<span>Fragment</span>
</>
)
```
### Attributes/Props
```jsx
const App = () => <input type="email" />
```
with a dynamic binding:
```jsx
const placeholderText = 'email'
const App = () => (
<input
type="email"
placeholder={placeholderText}
/>
)
```
### Directives
> It is recommended to use camelCase version of it (`vModel`) in JSX, but you can use kebab-case too (`v-model`).
v-show
```jsx
const App = {
data() {
return { visible: true };
},
render() {
return <input vShow={this.visible} />;
},
};
```
v-model
* You should use underscore (`_`) instead of dot (`.`) for modifiers (`vModel_trim={this.test}`)
```jsx
export default {
data: () => ({
test: 'Hello World',
}),
render() {
return (
<>
<input type="text" vModel_trim={this.test} />
{this.test}
</>
)
},
}
```
custom directive
```jsx
const App = {
directives: { custom: customDirective },
setup() {
return () => (
<a
vCustom={{
value: 123,
modifiers: { modifier: true },
arg: 'arg',
}}
/>
);
},
}
```
### Slot
Why Not props ?
## Compatibility
This repo is only compatible with:
- **Babel 7+**
- **Vue 3+**