# phoenix-wing

**Repository Path**: PhoenixWing321/phoenix-wing

## Basic Information

- **Project Name**: phoenix-wing
- **Description**: phoenix-wing npm 开源插件
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-01
- **Last Updated**: 2026-07-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# phoenix-wing

Phoenix Wing 跨语言共享核心与 UI 底座 — TypeScript 多包 · Rust CAD 源码 · Vue3 控件 · 壳层框架

## 按需安装

```bash
npm install @phoenix-wing/code-core
npm install @phoenix-wing/kt-codegen
npm install @phoenix-wing/cad-contracts @phoenix-wing/cad-core
npm install @phoenix-wing/workspace-schema
```

只有 Desk Web UI 或旧消费者需要 Vue 聚合包时才安装 `phoenix-wing`。参数驱动 CAA/Qt/C++ 代码生成使用 `@phoenix-wing/kt-codegen`。Node SQLite adapter 单独安装 `@phoenix-wing/db-node`；构建 Desk native tools 时单独安装 `@phoenix-wing/cad-rust-source`。`cad-contracts` 还提供无驱动的 Schema v13 只读查询核心，VS Code 可接宿主内置 SQLite 而不安装 Desk Tools。纯 Code/CAD/Codegen 小包不会带入 Vue、Element Plus、SQLite 或 Rust 二进制。

## 快速使用

详见 **[doc/快速使用.md](doc/快速使用.md)**

## 模块概览

| 分类 | 数量 | 说明 |
|------|------|------|
| 🧰 纯工具函数 | 7 | 异步进度、防抖、色彩方案、拖拽、存储等 |
| 🎨 Vue3 控件 | 5 | 模态框、选择对话框、组合输入框、进度浮层等 |
| 🏗 壳层布局组件 | 12 | Ribbon 工具栏、侧栏块、标签栏、欢迎页骨架等 |
| ⚙️ Composable/引擎 | 10 | 工作台引擎、URL 同步、属性表注册、侧栏布局等 |
| 📦 类型系统 | 6 | 属性面板、Ribbon 配置、工作台等类型定义 |
| 🗄 Store | 1 | 异步任务 Pinia store |

完整清单见 **[doc/overview.md](doc/overview.md)**

## 命名规则

所有公共 API 使用前缀防止冲突：

| 类型 | 前缀 | 示例 |
|------|------|------|
| Vue 组件 | `Pnw` | `PnwAppModalOverlay` |
| CSS 类名 | `pnw-` | `.pnw-modal-overlay` |
| 全局函数 | `pnw` | `pnwIsTerminal` |
| 类型 | `Pnw` | `PnwTaskKind` |
| 常量 | `PNW_` | `PNW_VERSION` |
| KtCodegen 领域 API | `KtCodegen` / `ktCodegen` / `KT_CODEGEN_` | `KtCodegenParam` |

`KtCodegen` 是参数代码生成领域的显式命名例外；其余 Phoenix Wing 公共 API 继续遵守 `Pnw` 前缀。

详见 **[doc/命名规则.md](doc/命名规则.md)**

## 文档

| 文档 | 内容 |
|------|------|
| [doc/快速使用.md](doc/快速使用.md) | 各类 API 快速上手示例 |
| [doc/架构图.md](doc/架构图.md) | 壳层组件树和引擎清单 |
| [doc/overview.md](doc/overview.md) | 模块总览与 API 说明 |
| [doc/命名规则.md](doc/命名规则.md) | 命名规则、前缀对照、违规示例 |
| [doc/框架迁移计划.md](doc/框架迁移计划.md) | 壳层框架迁移计划 |
| [doc/naming-checklist.md](doc/naming-checklist.md) | 命名点检清单 |
| [doc/三库共享核心整改计划.md](doc/三库共享核心整改计划.md) | `code-core`、`catdlg-core` 的跨仓库契约、阶段和验收 |
| [doc/跨语言多包架构与三库迁移计划.md](doc/跨语言多包架构与三库迁移计划.md) | **总计划**：多 npm 子包、Rust CAD 源码、数据库契约和三库迁移边界 |
| [doc/三库版本矩阵.md](doc/三库版本矩阵.md) | Wing 锁步版本、消费端允许依赖与发布门禁 |
| [doc/C++成员排序算法规范.md](doc/C++成员排序算法规范.md) | `code-core` 成员排序的唯一算法规范、锁定规则与回归契约 |
| [packages/kt-codegen/README.md](packages/kt-codegen/README.md) | `kt-codegen` 数据模型、17列兼容、32个生成块与类图 |

## Peer Dependencies

- `vue` ^3.0（可选，仅使用控件时需要）
- `pinia` ^2.0 \|\| ^3.0（可选，仅使用 store 时需要）
- `element-plus` ^2.0（可选，部分控件需要）

## 相关项目

| 项目 | 地址 | 说明 |
|------|------|------|
| **phoenix-wing** | [Gitee](https://gitee.com/PhoenixWing321/phoenix-wing) | 本仓库 — 共享 TypeScript 工具库与壳层框架 |
| **phoenix-desk-tools** | [Gitee](https://gitee.com/PhoenixWing321/phoenix-desk-tools) | 源项目 — FreeCAD 桌面辅助工具，phoenix-wing 的提炼来源 |
| **kt-auto-code** | [Gitee](https://gitee.com/PhoenixWing321/kt-auto-code) | VS Code 自动化扩展，按需消费 `@phoenix-wing/code-core` 的成员排序、UUID 与工作集能力 |
| **phoenix-open-issue** | [Gitee](https://gitee.com/PhoenixWing321/phoenix-open-issue) | 应用案例 — 基于 phoenix-wing 框架搭建的 Open Issue 管理应用 |

## 许可

Copyright © 2024–2026 上海锟钛。项目使用 [Apache License 2.0](LICENSE) 开源。