# @codex-app-sdk/vue 中文文档

规范地址：https://npmcn.com/package/%40codex-app-sdk/vue/

版本：0\.23\.0
npm 元数据更新时间：2026-11-09T21:42:46.072Z
中文译文更新时间：2026-11-10T08:22:37.299Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40codex-app-sdk/vue
原文对照：https://npmcn.com/package/%40codex-app-sdk/vue/?lang=original
项目主页：https://github.com/codex-app-sdk/codex-app-sdk#readme
源码仓库：https://github.com/codex-app-sdk/codex-app-sdk

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

- 包体积（解压后）：2.7 MB，274 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：11 个
- peer 依赖：vue ^3\.5\.0
- 首次发布：2026-10-06T12:47:05.953Z
- 最新版本发布：2026-11-09T21:42:45.709Z
- 近 30 天下载量：6944（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 45 个）

## 中文简介

Vue 对话组件和 Codex 应用程序的相容性.

## 安装

```sh
npm install @codex-app-sdk/vue
```

也可以使用：`pnpm add @codex-app-sdk/vue`、`yarn add @codex-app-sdk/vue`、`bun add @codex-app-sdk/vue`

## README

# `@codex-app-sdk/vue`

重用 Vue 3 对话的侧边栏、平板、作曲、信息、工具、, composables, 以及 Codex 应用程序的范围化主题.

```bash
npm install @codex-app-sdk/core @codex-app-sdk/vue vue
```

```vue
<script setup lang="ts">
import { CodexConversationPane, useCodexSurface } from '@codex-app-sdk/vue';
import '@codex-app-sdk/vue/styles.css';

const surface = useCodexSurface(rendererApi);
</script>

<template>
  <CodexConversationPane :surface="surface" />
</template>
```

`rendererApi` 可能来自电子预装或 `createCodexWebSurfaceClient()`。这个软件包只依赖于渲染器安全的核心 并且不导入后端、 Electron 或 Web 服务器包.

股票面板包括快速召回、可编辑队列的提示、双逃 中断, 复制代码块的状态反馈, 渲染器安全图像 轻箱/下载,以及主机拥有的图像或可视化动作.

对于东道国,使用 `createCodexConversationPaneController()`。 。 提交/提交收到的行动 `CodexRendererSendMessageOptions`; 附件为 不透明 `{ type, reference }` 值,从不主机文件系统路径. 被控制的主机也拥有队列持续通过 `updateQueuedPrompt` 财务报告和审定财务报表 `steerQueuedPrompt`; 窗格拥有编辑互动,但从未变异 控制器后面的主机队列 .

见 [向导](https://codex-app-sdk.github.io/codex-app-sdk/guide/vue.html), (中文(简体) ), [对话框窗格向导](https://codex-app-sdk.github.io/codex-app-sdk/guide/conversation-pane.html), (中文(简体) ), 财务报告和审定财务报表 [虚拟 API](https://codex-app-sdk.github.io/codex-app-sdk/api/vue.html)。 。 。 .

## 常见问题

### @codex-app-sdk/vue 是什么？

Vue 对话组件和 Codex 应用程序的相容性\.

### 如何安装 @codex-app-sdk/vue？

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

### @codex-app-sdk/vue 支持 TypeScript 吗？

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

### @codex-app-sdk/vue 支持 ESM 还是 CommonJS？

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

### @codex-app-sdk/vue 可以商用吗？

@codex-app-sdk/vue 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @codex-app-sdk/vue 的下载量有多少？

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

### @codex-app-sdk/vue 还在维护吗？

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