openvue README

项目的 README,来自 github.com/openvi-foundation/openvue。合并为一个 markdown 文件:README.md。

OpenVue

The Vue UI component library, continued.

License: MIT npm npm downloads

All Contributors

Documentation · Setup · Components · Migrate from PrimeVue · Changelog

About

OpenVue is a community-maintained fork of PrimeVue 4.5.5, one of the most widely adopted Vue.js component libraries, started after its original maintainers ended active open source development and moved new releases to a commercial license. The project is stewarded by openvi-foundation, an independent organization of experienced developers who use this library in production and are committed to keeping it maintained, stable, and open.

OpenVue is not affiliated with PrimeTek or PrimeUI. We started this project because a library with this much adoption, and this many teams depending on it, deserves a maintenance path that isn't tied to any single company's plans.

Migrating from PrimeVue

The migration tool is ready, try it out! One command moves an existing PrimeVue v4 project to OpenVue:

npx @openvue/migrate

It shows you a plan first (detected package manager, PrimeVue version, and every file it will change) and asks before writing anything. It renames dependencies, rewrites imports, and audits what's left, leaving a single reviewable diff. Use --dry for a preview that writes nothing.

Read the full guide at openvue.dev/migrate or the @openvue/migrate README.

Installation

npm install openvue @openvue/themes

Register a theme preset when installing the plugin:

import { createApp } from 'vue';
import OpenVue from 'openvue/config';
import Aura from '@openvue/themes/aura';
import App from './App.vue';

const app = createApp(App);

app.use(OpenVue, {
    theme: {
        preset: Aura
    }
});

app.mount('#app');

Additional packages (@openvue/forms, @openvue/nuxt-module, @openvue/mcp, ...) are opt-in. Install them only if you need form validation, Nuxt integration, or the MCP server.

Ecosystem

The fork spans the full toolchain, each piece maintained under the openvi-foundation organization.

Repository Description
openvue The core Vue UI component library (this repository)
openux Shared theming and design-token package
openicons Icon library
openvue-tailwind Components styled with Tailwind CSS

Roadmap

Our priority is stability first, growth second. In order:

  1. Publish to npm. Done: OpenVue packages are live under the @openvue org on the latest tag.
  2. Launch the OpenVue website. Done: openvue.dev is live with the full documentation and interactive component demos.
  3. Ship a PrimeVue migration tool. Done: npx @openvue/migrate moves a PrimeVue v4 project to OpenVue in one command.
  4. Stabilize and release. Done: 1.0.0 is out. The public API is stable and follows semantic versioning from here.
  5. Work through the backlog. Open issues, accessibility and performance come before new surface area.
  6. Bring Volt back. Done: OpenVolt is live, and npx openvolt-vue copies the Tailwind-native components into your own codebase.
  7. Ship a new theme. Done: Nide ships beside Aura, Lara, Material and Nora, and the Theme Builder builds a theme from any of them.
  8. Release 2.0. Composition API, Vapor mode and TypeScript at the source. Existing applications keep working: OpenVue is getting full Vapor compatibility, but traditional virtual DOM rendering and Options API support are not going anywhere.

Contributing

OpenVue is maintained by the openvi-foundation team together with a growing community of contributors. Bug reports, fixes, documentation improvements and feature proposals are all welcome.

Start with the contributing guide for the development setup and how changes get reviewed. Participation is covered by our code of conduct. To report a security issue, follow the security policy rather than opening an issue.

Contributors ✨

Everyone who has helped build OpenVue since the fork: code, docs, design, bug reports, and ideas.

Nikola Jevrić
Nikola Jevrić

💻 📖 🚧 🚇 👀 🎨 ⚠️ 🛡️
dekitriv
dekitriv

💻 🚇 🚧 🎨 🔧 ⚠️ 📖 👀
Srđan Sanadrović
Srđan Sanadrović

💻 🐛 📖
miske11
miske11

💻 🎨
Bharath Valaboju
Bharath Valaboju

💻 🐛
Quan Ming
Quan Ming

💻
AntekOlszewski
AntekOlszewski

💻
Tamás H.
Tamás H.

💻
Jakub Potocký
Jakub Potocký

💻
Artem
Artem

💻 🐛
Alessandro Riccadonna
Alessandro Riccadonna

💻
Sai Asish Y
Sai Asish Y

💻
Tobias Kainz
Tobias Kainz

💻
pupuking723
pupuking723

💻
Nicolas Granjon
Nicolas Granjon

🐛
Mettbrot
Mettbrot

🐛
Michael Withagen
Michael Withagen

🤔
Dylan
Dylan

🤔
José Antonio Postigo
José Antonio Postigo

🐛

License

MIT, unchanged. Every release under the MIT license stays exactly as it is. This fork doesn't affect that in any way.

openvue (openvi-foundation/openvue)

正在搜索数据库…

这是什么?OpenVue 是一个由社区维护的 PrimeVue 4.5.5 分支。PrimeVue 是一个 Vue 3 UI 组件库,拥有 80 多个组件,支持 Nuxt,并可通过一条命令从 PrimeVue 迁移。
它是一个库还是完整的应用?它是一个 UI 组件库,需要安装到你的 Vue 项目中,而不是独立应用。@openvue/forms、@openvue/nuxt-module 和 @openvue/mcp 等额外包均为可选安装。
怎么让它运行起来?安装插件,并在设置时注册一个主题预设。安装步骤见 README,完整的设置说明请参阅 openvue.dev 上的文档。
我需要先安装 Vue 3 或 Nuxt 吗?你需要一个 Vue 3 项目。Nuxt 是可选的,只有在想使用 @openvue/nuxt-module 集成时才需要。
它能直接替换 PrimeVue 吗?它是一个分支,因此迁移工具支持 PrimeVue v4 项目;但计划中的 2.0 版本将在源码层面引入 Composition API、Vapor mode 和 TypeScript。现有应用可继续运行,Options API 和虚拟 DOM 渲染也将继续支持。
它和 PrimeTek 有关系吗?没有。OpenVue 是一个独立的社区分支,与 PrimeTek 或 PrimeUI 没有关联。
为什么会创建这个分支?PrimeVue 的原作者停止了积极的开源开发,并将新版本改为商业许可。因此,一个社区团队对其进行了分支,以便在 MIT 许可下继续维护该库。
OpenVue 生态中还有哪些内容?配套仓库包括:用于共享主题和设计令牌的 openux、图标库 openicons,以及用于 Tailwind CSS 样式组件的 openvue-tailwind;此外还有 OpenVolt,它可以将 Tailwind 原生组件复制到你的代码库中。
2.0 路线图包含哪些内容?2.0 版本计划在源码层面引入 Composition API、Vapor mode 和 TypeScript,并预计现有应用可继续运行。
大小
159.4 MB
星标
448
时长
4个月
提交 · 90 天