# @celestia-island/hikari 中文文档

规范地址：https://npmcn.com/package/%40celestia-island/hikari/

版本：0\.55\.261
npm 元数据更新时间：2026-10-31T17:31:06.229Z
中文译文更新时间：2026-10-31T18:25:22.598Z
软件包许可：SySL-1\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40celestia-island/hikari
原文对照：https://npmcn.com/package/%40celestia-island/hikari/?lang=original
项目主页：https://github.com/celestia-island/hikari
源码仓库：https://github.com/celestia-island/hikari

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

- 包体积（解压后）：8.1 MB，977 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：vue ^\*，three ^0\.185，@types/three ^\*
- 首次发布：2026-08-04T01:17:08.811Z
- 最新版本发布：2026-10-31T17:31:05.775Z
- 已发布版本数：382（近 12 个月 382 个）

## 中文简介

Hikari UI库，Vue 3运行时-一个Vue 3和Rust/WASM应用程序的设计系统

## 安装

```sh
npm install @celestia-island/hikari
```

也可以使用：`pnpm add @celestia-island/hikari`、`yarn add @celestia-island/hikari`、`bun add @celestia-island/hikari`

## README

# “光之轮”@celestia-island /

Vue 3组件库与hikari Rust/WASM渲染器共享SCSS样式。

## 安装

```bash
npm install @celestia-island/hikari
pnpm add @celestia-island/hikari
```

## 建立需求

这个包裹是 **源分布**tarball装载TypeScript， TSX和SCSS源下 `src/`，您的构建管道将它们编译为 自身的代码。没有什么是预先捆绑的，所以消费项目必须提供：

| 要求 | 为什么 |
| --- | --- |
| `vue` (同行依赖) | 组件是为Vue 3编写的，并在运行时导入Vue。 |
| TypeScript-aware打包机 | 组件和可组合入口点解析为 `.ts`/`.tsx` 来源(`main`/`types` → `src/index.ts`）。 |
| 我们支持JSX | 组件被编写为 `.tsx` 渲染函数，而不是sfc -启用 `@vitejs/plugin-vue-jsx` （或您的捆绑商的等效）。 |
| `sass` 在你的工具链中 | 样式分布为SCSS； `@celestia-island/hikari/styles` 解析为 `.scss` 聚合您的打包器编译。安装 `sass` 作为消费项目的devDependency。 |

最小Vite配置：

```ts
// vite.config.ts
import vue from '@vitejs/plugin-vue'
import vueJsx from '@vitejs/plugin-vue-jsx'

export default {
  plugins: [vue(), vueJsx()],
}
```

## 使用

在你的应用入口点导入样式：

```ts
// main.ts
import "@celestia-island/hikari/styles";
import { createApp } from "vue";
import App from "./App.vue";

createApp(App).mount("#app");
```

在模板中使用组件：

```vue
<script setup lang="ts">
import { HkButton, HkCard, HkInput } from "@celestia-island/hikari";
</script>

<template>
  <HkCard>
    <HkInput v-model="text" placeholder="Type..." />
    <HkButton variant="primary">Submit</HkButton>
  </HkCard>
</template>
```

## 组件

-   **HkButton** -主要/次要/危险/幽灵变体
-   **HkCard** -可悬浮卡片容器
-   **HkInput** -文本输入与v-model
-   **HkModal** -传送对话
-   **HkSidebar** -可折叠的边栏
-   **HkTabs** -选项卡导航
-   **HkToast** -吐司通知
-   **HkAvatar** -图像/备用头像
-   和更多的……

## 开发

`packages/vue` 是它自己的PNPM工作区。后 `corepack pnpm install`：

```bash
pnpm test        # Vitest suite (colocated *.test.ts(x), happy-dom)
pnpm test:watch  # Vitest in watch mode
pnpm lint        # vue-tsc --noEmit type check
```

## 许可证

根据 [合成源License (SySL)， 1.0版本](https://npmcn.com/package/LICENSE).

## 常见问题

### @celestia-island/hikari 是什么？

Hikari UI库，Vue 3运行时-一个Vue 3和Rust/WASM应用程序的设计系统

### 如何安装 @celestia-island/hikari？

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

### @celestia-island/hikari 支持 TypeScript 吗？

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

### @celestia-island/hikari 支持 ESM 还是 CommonJS？

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

### @celestia-island/hikari 可以商用吗？

@celestia-island/hikari 使用 SySL-1\.0 许可。声明的许可为 SySL-1\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @celestia-island/hikari 还在维护吗？

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