veaury

veaury

跨框架组件互操作利器,无缝融合Vue和React

Veaury是一款支持Vue3和React互操作的开源工具库。它提供上下文共享、跨框架Hooks和纯模式等功能,可用于混合开发、项目迁移和第三方组件集成。Veaury简化了Vue和React组件的互操作过程,为跨框架开发提供了便利。

VeauryVueReact跨框架组件组件转换跨框架开发Github开源项目
<div align=center> <img src="https://github.com/devilwjp/VueReact/assets/38802722/dd7ccd14-4e02-4f4c-bf59-bc0f95088d82"/> </div> <h1 align=center>Veaury</h1> <h2 align=center>Use React in Vue3 and Vue3 in React, And as perfect as possible!</h2> <p align="center"> <a href="https://coveralls.io/github/devilwjp/veaury?branch=master"><img src="https://coveralls.io/repos/github/devilwjp/veaury/badge.svg?branch=master" alt="Coverage Status"></a> <a href="https://www.npmjs.com/package/veaury"><img src="https://img.shields.io/npm/v/veaury" alt="Version"></a> <a href="https://npmcharts.com/compare/veaury?minimal=true"><img src="https://img.shields.io/npm/dm/veaury" alt="Downloads"></a> <a href="https://www.npmjs.com/package/veaury"><img src="https://img.shields.io/bundlephobia/minzip/veaury" alt="Size"></a> </p> <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- END doctoc generated TOC please keep comment here to allow auto update -->

商业合作

正在寻求商业合作的可能性(wechat: devilwjp_new / QQ: 9700616)

  • 帮助您的项目做兼容和迁移
  • 帮助您vue或react的组件库,同时存在另一种技术栈版本
  • 帮助您的sdk同时具备支持vue和react的项目
  • 开源的是免费版,可为企业和个人提供定制版需求

What is Veaury?

Veaury (pronounced /ˈvjuːri/, inspired by 'beauty') is a tool library. It is built on the Vue and React framework. It's use cases include using both Vue and React in one app, migrating from React to Vue or from Vue to React, and using third-party Vue and React Components, such as antd, element-ui, vuetify.

The greatest feature

  • 🌞 Support Vue3
  • 🌈 Support Context - Share the context of all vue and react components.
  • 💗 Support for using hooks across frameworks - You can use React's hooks in a Vue component, or you can use Vue's 'setup' function in a React component and use Vue's hooks in this function.
  • 🪂 Pure mode - The children of the converted component no longer have an extra element container. >>learn more about how the pure mode works

Legacy

The perfect tool library which can use React in Vue2 and Vue2 in React.

Latest documentation

View the latest documentation
中文文档

Use cases

  • 👨‍👩‍👧 Using both Vue and React in one app
  • 🏃 Migrating from React to Vue or from Vue to React
  • 📲 Using third-party Vue and React Components, such as antd, element-ui, vuetify

Installation

# Install with yarn: $ yarn add veaury # or with npm: $ npm i veaury -S

Do you want to preconfigure your project in advance?

In theory, you don't need to do additional configuration in a React project to support Vue, nor do you need to do additional configuration in a Vue project to support React.

If the React or Vue component you want to convert comes from a npm package, or has already been built (Not a direct vue file and does not contain jsx), you can use applyPureReactInVue or applyVueInReact directly.

If you need to develop both Vue and React in a project, instead of just using an existing npm component (There are both .vue files and react jsx files in a project source code), then you should do some configuration.

Webpack

How to configure React in the Vue project from '@vue/cli'
How to configure Vue in the React project from 'create-react-app'

Vite

If it is a project built by vite, the relevant configuration is as follows.
First install @vitejs/plugin-react, @vitejs/plugin-vue and @vitejs/plugin-vue-jsx.

  • The main project is Vue:
import { defineConfig } from 'vite' // if mode cjs, should use `veaury/vite/cjs` import veauryVitePlugins from 'veaury/vite/esm' export default defineConfig({ plugins: [ // Turn off vue and vuejsx plugins // vue(), // vueJsx(), // When the type of veauryVitePlugins is set to vue, // only jsx in files in the directory named 'react_app' will be parsed with react jsx, // and jsx in other files will be parsed with vue jsx veauryVitePlugins({ type: 'vue', // Configuration of @vitejs/plugin-vue // vueOptions: {...}, // Configuration of @vitejs/plugin-react // reactOptions: {...}, // Configuration of @vitejs/plugin-vue-jsx // vueJsxOptions: {...} }) ] })
  • The main project is React:
import { defineConfig } from 'vite' // if mode cjs, should use `veaury/vite/cjs` import veauryVitePlugins from 'veaury/vite/esm' export default defineConfig({ plugins: [ // Turn off react plugin // react(), // When the type of veauryVitePlugins is set to react, // only jsx in .vue files and files in a directory named "vue_app" will be parsed using vue jsx, // jsx in other files will be parsed with react jsx veauryVitePlugins({ type: 'react', // Configuration of @vitejs/plugin-vue // vueOptions: {...}, // Configuration of @vitejs/plugin-react // reactOptions: {...}, // Configuration of @vitejs/plugin-vue-jsx // vueJsxOptions: {...} }) ] })

If you want to customize the compilation scope of vueJsx, you can configure overrides by setting type to custom.
Use vueJsxInclude and vueJsxExclude to configure the file range to be parsed using vue jsx, the others will be parsed using react jsx.

import { defineConfig } from 'vite' // if mode cjs, should use `veaury/vite/cjs` import veauryVitePlugins from 'veaury/vite/esm' export default defineConfig({ plugins: [ veauryVitePlugins({ type: 'custom', // Only jsx in .vue files and files in a directory named "react_app" will be parsed using vue jsx , others will be parsed using react jsx. vueJsxInclude: [/vue&type=script&lang\.[tj]sx$/i, /vue&type=script&setup=true&lang\.[tj]sx$/i, /[/\\]vue_app[\\/][\w\W]+\.[tj]sx$/], // vueJsxExclude: [], // Configuration of @vitejs/plugin-vue // vueOptions: {...}, // Configuration of @vitejs/plugin-react // reactOptions: {...}, // Configuration of @vitejs/plugin-vue-jsx // vueJsxOptions: {...} }) ] })

Usage

Vue in React - Basic usage

import {applyVueInReact, applyPureVueInReact} from 'veaury' // This is a Vue component import BasicVueComponent from './Basic.vue' import {useState} from 'react' // Use HOC 'applyVueInReact' const BasicWithNormal = applyVueInReact(BasicVueComponent) // Use HOC 'applyPureVueInReact' const BasicWithPure = applyPureVueInReact(BasicVueComponent) export default function () { const [foo] = useState('Hello!') return <> <BasicWithNormal foo={foo}> <div> the default slot </div> </BasicWithNormal> <BasicWithPure foo={foo}> <div> the default slot </div> </BasicWithPure> </> }

React in Vue - Basic usage

applyPureReactInVue is recommended. Learn about the difference between applyPureReactInVue and applyReactInVue.

<template> <BasicPure :foo="foo"> <div> the children </div> </BasicPure> </template> <script> import {applyReactInVue, applyPureReactInVue} from 'veaury' // This is a React component import BasicReactComponent from './react_app/Basic.jsx' import {ref} from 'vue' export default { components: { // Use HOC 'applyReactInVue' or 'applyPureReactInVue' Basic: applyReactInVue(BasicReactComponent), BasicPure: applyPureReactInVue(BasicReactComponent) }, setup() { return { foo: ref('Hello!') } } } </script>

[!NOTE]

When using applyPureReactInVue or applyReactInVue to perform two-way binding on some react components, if the values are modified frequently, the modification may not be timely.

Veury provides a method injectSyncUpdateForPureReactInVue to solve this problem

>> The related issue

Let's see an example.

(React component Input.js)

import React from 'react' export default function Input(props) { return <input value={props.value} onChange={props.onChange}/> }

(Vue page Example.vue)

<template> <SimpleInput :value="value" @change="value = $event.target.value"/> </template> <script setup> import { applyPureReactInVue, injectSyncUpdateForPureReactInVue} from 'veaury' import ReactSimpleInput from "./Input"; // The component only needs to be injected globally once. If injected multiple times, it is equivalent to appending and overwriting function hooks. injectSyncUpdateForPureReactInVue(ReactSimpleInput, { // The name of the hook function that determines the content update of the Input component onChange(args) { return { value: args.target.value } } }) const SimpleInput = applyPureReactInVue(ReactSimpleInput) const value = ref(""); </script>

Vue in React - Usage of events

import {applyVueInReact} from 'veaury' import BasicVue from './Basic.vue' import {useState} from 'react' const Basic = applyVueInReact(BasicVue) export default function () { function onClickForVue() { console.log('clicked!') } return <div> {/*Trigger with $emit('click') in Vue component*/} <Basic onClick={onClickForVue}/> </div> }

React in Vue - Usage of events

<template> <!-- Trigger with 'props.onClick()' in React component --> <ReactButton @click="onClickForReact"/> </template> <script> import {ref} from 'vue' import {applyPureReactInVue} from 'veaury' // This is a React Component import ReactButton from "./react_app/Button.jsx" export default { components: { ReactButton: applyPureReactInVue(ReactButton) }, setup() { function onClickForReact() { console.log('clicked!') } return { onClickForReact, } } } </script>

Vue in React - Usage of slots

The usage of 'slots' is similar to the usage of 'v-slots' of Vue's jsx.

import {applyVueInReact} from 'veaury' import BasicVue from './Basic.vue' const Basic = applyVueInReact(BasicVue) export default function () { const vSlots = { // Render with '<slot name="slot1" />' in Vue Component slot1: <div>this is slot1(namedSlot)</div>, // Render with '<slot name="slot2" value="xxxxxx"/>' in Vue Component slot2: ({value}) => <div>this is slot2(scopedSlot), and receive value: {value}</div>, // Render with '<slot/>' in Vue Component default: <div>this is children</div> } return <div> {/*just send children*/} <Basic> {/* Render with '<slot/>' in Vue Component */} <div>this is children</div> </Basic> {/*send v-slots*/} <Basic v-slots={vSlots}/> {/*another usage*/} <Basic> {vSlots} </Basic> </div> }

React in Vue - Usage of render props and React node

Named slots & scoped slots of Vue = React render props.
Default slots $ children of Vue = React props.children.
A named slot has a name prefixed with node: = React Node

<template> <Basic> <!-- Render with 'props.slot1()' in React component --> <template v-slot:slot1> <div> this is slot1 (render props) </div> </template> <!-- Render with 'props.slot2("xxxxx")' in React component --> <template v-slot:slot2="bar">

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多