You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
241 lines
3.4 KiB
241 lines
3.4 KiB
4 years ago
|
# Babel Plugin JSX for Vue 3.0
|
||
|
|
||
|
[![CircleCI](https://circleci.com/gh/vuejs/jsx-next.svg?style=svg)](https://circleci.com/gh/vuejs/vue-next) [![npm package](https://img.shields.io/npm/v/@vue/babel-plugin-jsx.svg?style=flat-square)](https://www.npmjs.com/package/@vue/babel-plugin-jsx)
|
||
|
|
||
|
To add Vue JSX support.
|
||
|
|
||
|
English | [简体中文](/packages/babel-plugin-jsx/README-zh_CN.md)
|
||
|
|
||
|
## Installation
|
||
|
|
||
|
Install the plugin with:
|
||
|
|
||
|
```bash
|
||
|
npm install @vue/babel-plugin-jsx -D
|
||
|
```
|
||
|
|
||
|
Then add the plugin to .babelrc:
|
||
|
|
||
|
```js
|
||
|
{
|
||
|
"plugins": ["@vue/babel-plugin-jsx"]
|
||
|
}
|
||
|
```
|
||
|
|
||
|
## Usage
|
||
|
|
||
|
### options
|
||
|
|
||
|
#### transformOn
|
||
|
|
||
|
Type: `boolean`
|
||
|
|
||
|
Default: `false`
|
||
|
|
||
|
transform `on: { click: xx }` to `onClick: xxx`
|
||
|
|
||
|
#### optimize
|
||
|
|
||
|
Type: `boolean`
|
||
|
|
||
|
Default: `false`
|
||
|
|
||
|
enable optimization or not. It's not recommended to enable it If you are not familiar with Vue 3.
|
||
|
|
||
|
#### isCustomElement
|
||
|
|
||
|
Type: `(tag: string) => boolean`
|
||
|
|
||
|
Default: `undefined`
|
||
|
|
||
|
configuring custom elements
|
||
|
|
||
|
## Syntax
|
||
|
|
||
|
### Content
|
||
|
functional component
|
||
|
|
||
|
```jsx
|
||
|
const App = () => <div>Vue 3.0</div>;
|
||
|
```
|
||
|
|
||
|
with render
|
||
|
|
||
|
```jsx
|
||
|
const App = {
|
||
|
render() {
|
||
|
return <div>Vue 3.0</div>;
|
||
|
}
|
||
|
};
|
||
|
```
|
||
|
|
||
|
```jsx
|
||
|
import { withModifiers, defineComponent } from 'vue';
|
||
|
|
||
|
const App = defineComponent({
|
||
|
setup() {
|
||
|
const count = ref(0);
|
||
|
|
||
|
const inc = () => {
|
||
|
count.value++;
|
||
|
};
|
||
|
|
||
|
return () => (
|
||
|
<div onClick={withModifiers(inc, ['self'])}>
|
||
|
{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
|
||
|
|
||
|
v-show
|
||
|
|
||
|
```jsx
|
||
|
const App = {
|
||
|
data() {
|
||
|
return { visible: true };
|
||
|
},
|
||
|
render() {
|
||
|
return <input v-show={this.visible} />;
|
||
|
},
|
||
|
};
|
||
|
```
|
||
|
|
||
|
v-model
|
||
|
|
||
|
> Note: You should pass the second param as string for using `arg`.
|
||
|
|
||
|
```jsx
|
||
|
<input v-model={val} />
|
||
|
```
|
||
|
|
||
|
```jsx
|
||
|
<input v-model={[val, ['trim']]} />
|
||
|
```
|
||
|
|
||
|
```jsx
|
||
|
<A v-model={[val, 'foo', ['bar']]} />
|
||
|
```
|
||
|
|
||
|
Will compile to:
|
||
|
|
||
|
```js
|
||
|
h(A, {
|
||
|
'foo': val,
|
||
|
"fooModifiers": {
|
||
|
"bar": true
|
||
|
},
|
||
|
"onUpdate:foo": $event => val = $event
|
||
|
})
|
||
|
```
|
||
|
|
||
|
custom directive
|
||
|
|
||
|
```jsx
|
||
|
const App = {
|
||
|
directives: { custom: customDirective },
|
||
|
setup() {
|
||
|
return () => (
|
||
|
<a
|
||
|
v-custom={[val, 'arg', ['a', 'b']]}
|
||
|
/>
|
||
|
);
|
||
|
},
|
||
|
};
|
||
|
```
|
||
|
|
||
|
### Slot
|
||
|
|
||
|
```jsx
|
||
|
const App = {
|
||
|
setup() {
|
||
|
const slots = {
|
||
|
default: () => <div>A</div>,
|
||
|
foo: () => <span>B</span>
|
||
|
};
|
||
|
return () => <A v-slots={slots} />;
|
||
|
}
|
||
|
};
|
||
|
```
|
||
|
|
||
|
### In TypeScript
|
||
|
|
||
|
`tsconfig.json`:
|
||
|
|
||
|
```json
|
||
|
{
|
||
|
"compilerOptions": {
|
||
|
"jsx": "preserve"
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
## Who is using
|
||
|
|
||
|
<table>
|
||
|
<tbody>
|
||
|
<tr>
|
||
|
<td align="center">
|
||
|
<a target="_blank" href="https://www.antdv.com/">
|
||
|
<img
|
||
|
width="32"
|
||
|
src="https://qn.antdv.com/logo.png"
|
||
|
/>
|
||
|
<br>
|
||
|
<strong>Ant Design Vue</strong>
|
||
|
</a>
|
||
|
</td>
|
||
|
<td align="center">
|
||
|
<a target="_blank" href="https://youzan.github.io/vant/#/zh-CN/">
|
||
|
<img
|
||
|
width="32"
|
||
|
style="vertical-align: -0.32em; margin-right: 8px;"
|
||
|
src="https://img.yzcdn.cn/vant/logo.png"
|
||
|
/>
|
||
|
<br>
|
||
|
<strong>Vant</strong>
|
||
|
</a>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
## Compatibility
|
||
|
|
||
|
This repo is only compatible with:
|
||
|
|
||
|
- **Babel 7+**
|
||
|
- **Vue 3+**
|