# @boxicons/vue 中文文档

规范地址：https://npmcn.com/package/%40boxicons/vue/

版本：1\.0\.1
npm 元数据更新时间：2026-02-16T00:48:26.797Z
中文译文更新时间：2026-11-08T13:00:25.388Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：27.7 MB，13101 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：vue \>=3\.0\.0
- 首次发布：2026-02-12T00:50:52.888Z
- 最新版本发布：2026-02-16T00:48:26.628Z
- 近 30 天下载量：2821（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

Boxicons 的 Vue 组件

## 安装

```sh
npm install @boxicons/vue
```

也可以使用：`pnpm add @boxicons/vue`、`yarn add @boxicons/vue`、`bun add @boxicons/vue`

## README

# @ boxicons/ vue (帮助)

Vue 3 图标库由 Boxicons SVG 文件所建,全树摇动支持.

## 安装

```bash
npm install @boxicons/vue
# or
yarn add @boxicons/vue
# or
pnpm add @boxicons/vue
```

## 使用量

### 基本用途

```vue
<script setup>
import { Alarm, Twitter, Home } from '@boxicons/vue';
</script>

<template>
  <Alarm />
  <Twitter />
  <Home />
</template>
```

### 图标包

-   **基础** - 大纲/正则样式图标(默认)
-   **已填满** - 固态/填充式图标
-   **品牌** - 品牌/标志

```vue
<template>
  <Alarm />
  <Alarm pack="filled" />
</template>
```

### 大小

#### 大小预设

```vue
<template>
  <Alarm size="xs" />   <!-- 16px -->
  <Alarm size="sm" />   <!-- 20px -->
  <Alarm size="base" /> <!-- 24px (default) -->
  <Alarm size="md" />   <!-- 36px -->
  <Alarm size="lg" />   <!-- 48px -->
  <Alarm size="xl" />   <!-- 64px -->
  <Alarm size="2xl" />  <!-- 96px -->
  <Alarm size="3xl" />  <!-- 128px -->
  <Alarm size="4xl" />  <!-- 256px -->
  <Alarm size="5xl" />  <!-- 512px -->
</template>
```

#### 自定义大小

```vue
<template>
  <Alarm :width="32" :height="32" />
  <Alarm width="2rem" height="2rem" />
</template>
```

### 颜色

```vue
<template>
  <Alarm fill="#ff0000" />
  <Alarm fill="currentColor" />
</template>
```

### 不透明度

```vue
<template>
  <Alarm :opacity="0.5" />
</template>
```

### 翻转

```vue
<template>
  <Alarm flip="horizontal" />
  <Alarm flip="vertical" />
</template>
```

### 旋转

```vue
<template>
  <Alarm :rotate="45" />
  <Alarm rotate="90deg" />
</template>
```

### 删除铺设

```vue
<template>
  <Alarm remove-padding />
</template>
```

### 组合道具

```vue
<template>
  <Alarm 
    pack="filled"
    fill="#ffffff"
    :opacity="0.8"
    size="lg"
    flip="horizontal"
    :rotate="45"
    class="my-icon"
  />
</template>
```

## 树摇

只有导入的图标被捆绑 :

```js
// ✅ Only Alarm is bundled
import { Alarm } from '@boxicons/vue';
```

## 可用图标

-   **1884 (英语)** 基本(外线)图标
-   **1884 (英语)** 已填入图标
-   **295个** 品牌图标

## 类型脚本

```ts
import type { BoxIconProps, IconPack, IconSize, FlipDirection } from '@boxicons/vue';
```

## 许可证

麻省理工学院

## 常见问题

### @boxicons/vue 是什么？

Boxicons 的 Vue 组件

### 如何安装 @boxicons/vue？

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

### @boxicons/vue 支持 TypeScript 吗？

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

### @boxicons/vue 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @boxicons/vue 可以商用吗？

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

### @boxicons/vue 的下载量有多少？

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

### @boxicons/vue 还在维护吗？

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