# @birdycom/omniaui-vue 中文文档

规范地址：https://npmcn.com/package/%40birdycom/omniaui-vue/

版本：0\.14\.3
npm 元数据更新时间：2026-11-05T08:52:36.145Z
中文译文更新时间：2026-11-08T03:40:31.257Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40birdycom/omniaui-vue
原文对照：https://npmcn.com/package/%40birdycom/omniaui-vue/?lang=original
项目主页：https://omniaui.eu/
源码仓库：https://github.com/Birdycom/OmniaUI

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.7 MB，446 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：0 个
- peer 依赖：vue ^3\.4\.0
- 首次发布：2026-10-27T16:54:16.805Z
- 最新版本发布：2026-11-05T08:52:35.450Z
- 近 30 天下载量：2649（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

OmniaUI为Vue 3:每个OmniaUI组件和块有一个单文件组件,使CSS包的精确标记.

## 安装

```sh
npm install @birdycom/omniaui-vue
```

也可以使用：`pnpm add @birdycom/omniaui-vue`、`yarn add @birdycom/omniaui-vue`、`bun add @birdycom/omniaui-vue`

## README

# @birtycom/omniaui-vue (英语)

OmniaCSS的Vue 3组件:一个单文件组件(`<script setup lang="ts">`每个组成部分和每个区块。 标记和类是 HTML 片断中的 `@birdycom/omniaui` 财务报告和审定财务报表 `@birdycom/omniaui-blocks`; CSS 包拥有所有样式, SFC 没有样式.

```sh
npm install @birdycom/omniaui-vue @birdycom/omniaui @birdycom/omniaui-blocks vue
```

```ts
import { createApp } from 'vue'
import { OmniaVue } from '@birdycom/omniaui-vue'

createApp(App).use(OmniaVue).mount('#app') // registers every Oc* component globally
```

```vue
<script setup lang="ts">
import { ref } from 'vue'
import { OcButton, OcModal, OcToastContainer, useToast } from '@birdycom/omniaui-vue'
const open = ref(false)
const toast = useToast()
</script>

<template>
  <OcButton variant="outline" size="sm" @click="open = true">Open</OcButton>
  <OcModal v-model:open="open" title="Are you sure?">
    <template #footer="{ close }"><OcButton @click="close(); toast.success('Done')">OK</OcButton></template>
  </OcModal>
  <OcToastContainer />
</template>
```

-   向修饰者推荐映射 : `variant`, (中文(简体) ), `size` (sm / md / lg),布林为旗帜. 将映射到片段槽.
-   `v-model` 输入、选择、切换、复选框、分块、分页、标记输入、OTP、彩色字段、空投区; `v-model:open` 在模式,提醒对话框,工作表,可折叠,向导.
-   对话框的使用 `<dialog>` + 键 `showModal()`,菜单和弹出 `popover` 属性、手风琴 `<details name>`。 。 。 .
-   完全参考文件:文档网站中的Vue页(`ui/frameworks-vue.html`) (中文(简体) ).

## 拥有密码

`src/` 也已经公布。 复制 `src/components/OcButton.vue` (加上 `src/composables/*` 文件导入到您的项目中,或从 `@birdycom/omniaui-vue/src/components/OcButton.vue`。 。 。 . `manifest.json` 将每个项目列表为 `{ name, kind, file, snippet }`。 。 。 .

## 发展

```sh
npm run generate -w @birdycom/omniaui-vue   # rewrite src/index.ts and manifest.json from the SFC folders
npm run build -w @birdycom/omniaui-vue      # generate + vite library build + .d.ts
npm test -w @birdycom/omniaui-vue           # vitest + @vue/test-utils (jsdom)
```

## 常见问题

### @birdycom/omniaui-vue 是什么？

OmniaUI为Vue 3:每个OmniaUI组件和块有一个单文件组件,使CSS包的精确标记\.

### 如何安装 @birdycom/omniaui-vue？

在项目目录运行 npm install @birdycom/omniaui-vue，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^3\.4\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @birdycom/omniaui-vue 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @birdycom/omniaui-vue 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @birdycom/omniaui-vue 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @birdycom/omniaui-vue 可以商用吗？

@birdycom/omniaui-vue 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @birdycom/omniaui-vue 的下载量有多少？

根据 npm 官方下载统计，@birdycom/omniaui-vue 在 2026/10/08 – 2026/11/06 这 30 天内被下载 2,649 次，日均约 88 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @birdycom/omniaui-vue 还在维护吗？

最新版本 0\.14\.3 发布于 2026/11/05（3 天前）；至今共发布 16 个版本，其中过去 12 个月发布了 16 个；首次发布于 2026/10/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。