@vitejs/plugin-vue2-jsx
v1.1.1
Published
Provides Vue 2 JSX & TSX support with HMR.
Downloads
47,701
Readme
@vitejs/plugin-vue2-jsx
Provides Vue 2 JSX & TSX support with HMR.
// vite.config.js
import vueJsx from '@vitejs/plugin-vue2-jsx'
export default {
plugins: [
vueJsx({
// options are passed on to @vue/babel-preset-jsx
})
]
}
Options
include
Type: (string | RegExp)[] | string | RegExp | null
Default: /\.[jt]sx$/
A picomatch pattern, or array of patterns, which specifies the files the plugin should operate on.
exclude
Type: (string | RegExp)[] | string | RegExp | null
Default: undefined
A picomatch pattern, or array of patterns, which specifies the files to be ignored by the plugin.
See @vue/babel-preset-jsx for other options.
HMR Detection
This plugin supports HMR of Vue JSX components. The detection requirements are:
- The component must be exported.
- The component must be declared by calling
defineComponent
via a root-level statement, either variable declaration or export declaration.
Supported patterns
import { defineComponent } from 'vue'
// named exports w/ variable declaration: ok
export const Foo = defineComponent({})
// named exports referencing variable declaration: ok
const Bar = defineComponent({ render() { return <div>Test</div> }})
export { Bar }
// default export call: ok
export default defineComponent({ render() { return <div>Test</div> }})
// default export referencing variable declaration: ok
const Baz = defineComponent({ render() { return <div>Test</div> }})
export default Baz
Non-supported patterns
// not using `defineComponent` call
export const Bar = { ... }
// not exported
const Foo = defineComponent(...)
Unfinished Features
- SSR support
- Share the same HMR runtime with
@vitejs/plugin-vue2