# @compodium/core 中文文档

规范地址：https://npmcn.com/package/%40compodium/core/

版本：0\.1\.0-beta\.14
npm 元数据更新时间：2026-08-26T14:23:40.955Z
中文译文更新时间：2026-11-10T13:44:44.484Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4.4 MB，106 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：18 个
- peer 依赖：typescript \>=5\.8 \<7，vite \>=7，vue \>=3
- 首次发布：2025-03-13T15:04:22.432Z
- 最新版本发布：2026-08-26T14:23:40.617Z
- 近 30 天下载量：11966（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 2 个）

## 中文简介

用于Vue和Nuxt的插头和播放组件游乐场.

## 安装

```sh
npm install @compodium/core
```

也可以使用：`pnpm add @compodium/core`、`yarn add @compodium/core`、`bun add @compodium/core`

## README

# 复数

[![npm version](https://img.shields.io/npm/v/%40compodium%2Fcore/latest.svg?style=flat&colorA=020420&colorB=00DC82)](https://npmjs.com/package/%40compodium%2Fcore) [![npm downloads](https://img.shields.io/npm/dm/compodium.svg?style=flat&colorA=020420&colorB=00DC82)](https://npm.chart.dev/%40compodium%2Fcore) [![License](https://img.shields.io/npm/l/compodium.svg?style=flat&colorA=020420&colorB=00DC82)](https://npmjs.com/package/compodium) [![Nuxt](https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js)](https://nuxt.com/)

用于Vue和Nuxt的插头和播放组件游乐场.

[文档](https://compodium.dev/getting-started)

> \[尖叫声\] 该项目尚处于初期阶段,并将不断发展。 期望经常更新和可能的改变。 欢迎反馈!

## 特征

-   **无力设置**:简单设置过程和最小维护,允许您专注于建筑组件.
-   **没有必须写的故事**:直接分析您的组件代码,消除了写故事的需要.
-   **快点**:为快速发展和即时反馈而搭建于Vite上方,可提高生产力.
-   **DevTools 集成软件**: 与Vue和Nuxt编舞工具相结合,以取得协调一致的发展经验.
-   **UI 图书馆集成**: 与受欢迎的UI库相融合,显示本地安装组件的示例.
-   **代码生成**:根据组件道具生成最新的模板代码,随时可以复制并使用.

## 安装

### 坚果

```bash
npx nuxi@latest module add --dev compodium
```

### 阴道

1.  安装 `@compodium/vue`

```bash
pnpm add -D @compodium/vue
```

```bash
yarn add --dev @compodium/vue
```

```bash
npm install --save-dev @compodium/vue
```

```bash
bun add -D @compodium/vue
```

2.  在您中添加Compodium插件 `vite.config.ts`数字 :

```ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import vueDevTools from 'vite-plugin-vue-devtools'
import { compodium } from '@compodium/vue'

export default defineConfig({
  plugins: [
    vue(),
    vueDevTools(),
    compodium()
  ]
})
```

3.  在您的 `tsconfig.app.json`

```json
{
  "include": [
    "src/**/*.ts",
    "src/**/*.tsx",
    "src/**/*.vue",
    "node_modules/@compodium/vue/dist/index.d.ts"
  ],
}
```

## 捐款

欢迎捐款

目前,您可以贡献的一种方法是为您最喜爱的组件库添加示例. 您可以找到 Nuxt 用户界面收藏和示例 [这里](https://github.com/romhml/compodium/tree/main/packages/examples/src/index.ts)。 。 。 .

**地方发展**

```bash
# Install dependencies
pnpm install

# Generate type stubs
pnpm dev:prepare

# Develop with the playground
pnpm dev

# Run ESLint
pnpm lint

# Run typechecks 
pnpm typechecks 

# Run Vitest
pnpm test
```

## 常见问题

### @compodium/core 是什么？

用于Vue和Nuxt的插头和播放组件游乐场\.

### 如何安装 @compodium/core？

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

### @compodium/core 支持 TypeScript 吗？

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

### @compodium/core 支持 ESM 还是 CommonJS？

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

### @compodium/core 可以商用吗？

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

### @compodium/core 的下载量有多少？

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

### @compodium/core 还在维护吗？

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