Guide
Config
Plugin
API
Community
Guide
Config
Plugin
API
Community

Vue2 JSX Plugin

Source

The Vue plugin provides support for Vue 2 JSX / TSX syntax. The plugin internally integrates @vue/babel-preset-jsx.

TIP

The Vue2 JSX plugin relies on Babel transpilation and requires an additional Babel Plugin. At the same time, adding the Babel plugin will cause additional compilation overhead.

Quick Start

Install Plugin

You can install the plugin using the following command:

npm
yarn
pnpm
bun
npm add @rsbuild/plugin-babel @rsbuild/plugin-vue2-jsx -D

Register Plugin

You can register the plugin in the rsbuild.config.ts file:

rsbuild.config.ts
import { pluginBabel } from '@rsbuild/plugin-babel';
import { pluginVue2Jsx } from '@rsbuild/plugin-vue2-jsx';

export default {
  plugins: [
    pluginBabel({
      include: /\.(?:jsx|tsx)$/,
      exclude: /[\\/]node_modules[\\/]/,
    }),
    pluginVue2Jsx(),
  ],
};
TIP

Since the Vue JSX plugin relies on Babel for compilation, you need to additionally add the Babel plugin.

Babel compilation will introduce extra overhead, in the example above, we use include to match .jsx and .tsx files, thereby reducing the performance cost brought by Babel.

After registering the plugin, you can use Vue's JSX / TSX syntax in .jsx, .tsx, and .vue files.

Vue SFC

When using JSX in Vue SFC, you need to add lang="jsx" or lang="tsx" to the <script> tag.

  • JSX:
App.vue
<script lang="jsx">
  const vnode = <div>hello</div>;
</script>
  • TSX:
App.vue
<script lang="tsx">
  const vnode = <div>hello</div>;
</script>

Options

If you need to customize the compilation behavior of Vue JSX, you can use the following configs.

vueJsxOptions

Options passed to @vue/babel-preset-jsx, please refer to the @vue/babel-preset-jsx documentation for detailed usage.

  • Type:
type VueJSXPresetOptions = {
  compositionAPI?: boolean | string;
  functional?: boolean;
  injectH?: boolean;
  vModel?: boolean;
  vOn?: boolean;
};
  • Default:
const defaultOptions = {
  injectH: true,
};
  • Example:
pluginVue2Jsx({
  vueJsxOptions: {
    injectH: false,
  },
});