@composy/keyboard-vue 0.0.1 → 0.0.2

package/README.md

@@ -1,45 +1,69 @@
 # @composy/keyboard-vue
 
-高性能虚拟键盘组件库，支持 Vue 3，提供字母、数字、车牌号等多种键盘布局（Vue 3 适配层）
-
-## 功能特性
-
-- 🧩 Vue 3 组件
-- 🪝 组合式函数 (Composables)
-- ⚡ 响应式数据绑定
+`@composy/keyboard-vue` 是 `@composy/keyboard-core` 的 Vue
+3 适配层，导出虚拟键盘组件、组合式函数、指令和插件，并重新导出 Core 的布局、类型、主题与工具 API。
 
 ## 安装
 
 ```bash
-npm install @composy/keyboard-vue
+pnpm add @composy/keyboard-vue vue
 ```
 
-## 快速开始
+## 组件用法
 
 ```vue
-<template>
-  <!-- 使用组件 -->
-</template>
+<script setup lang="ts">
+import { KeyboardPopup, LicensePlateKeyboard, VirtualKeyboard } from '@composy/keyboard-vue'
+import { ref } from 'vue'
 
-<script setup>
-// import { /* 组件 */ } from '@composy/keyboard-vue'
+const value = ref('')
+const plate = ref('京A')
 </script>
+
+<template>
+  <VirtualKeyboard v-model="value" type="qwerty" />
+  <LicensePlateKeyboard v-model="plate" />
+  <KeyboardPopup v-model="value" type="number" />
+</template>
 ```
 
-## 目录结构
+如需显式引入组件样式，可使用 `@composy/keyboard-vue/index.css`。
 
+## 插件、指令与组合式函数
+
+```ts
+import { KeyboardVuePlugin, useKeyboard } from '@composy/keyboard-vue'
+import { createApp } from 'vue'
+
+const app = createApp(App)
+app.use(KeyboardVuePlugin, { prefix: 'L' })
+
+const keyboard = useKeyboard({ type: 'number' })
+keyboard.show()
 ```
-packages/vue/
-├── src/              # 源码
-├── package.json
-├── tsconfig.json     # ESM 构建配置
-└── tsconfig.cjs.json # CJS 构建配置
-```
 
-## 依赖
+插件全局注册 `LKeyboard`、`LKeyboardPopup`、`LLicensePlateKeyboard` 和 `v-keyboard`。也可以按需使用
+`vKeyboard`、`useKeyboardPopup`，或直接从适配包导入 Core API。
+
+## 公开入口
+
+- 组件：`VirtualKeyboard`、`KeyboardKey`、`KeyboardPopup`、`LicensePlateKeyboard`
+- Composables：`useKeyboard`、`useKeyboardPopup`
+- 插件：`KeyboardVuePlugin`（兼容别名 `KeyboardPlugin`）
+- 指令：`vKeyboard`
+- Core：布局注册、键盘管理器、DOM 渲染器、主题、格式化函数、随机键盘工具及对应类型
 
-- `@composy/keyboard-core` — 核心引擎
-- `vue` ^3.3.0 (peerDependency)
+## 构建产物
+
+包使用 `@composy/builder`（rolldown）。发布目录为
+`dist/`（UMD 与 CSS）、`es/`（ESM 和声明）、`esm/`（独立 ESM 输出）及 `lib/`（CJS 和声明）；包的
+`exports`、`style`、`main`、`module` 与 `types` 指向这些实际产物。
+
+```bash
+pnpm --dir libraries/keyboard run build
+pnpm --dir libraries/keyboard/packages/vue run type-check
+pnpm --dir libraries/keyboard/packages/vue run type-check:cjs
+```
 
 ## License