安装

npm install octicons-vue3

使用

<script setup lang="ts">
import { MarkGithubIcon, XIcon } from 'octicons-vue3'
import AccessibilityIcon from 'octicons-vue3/icons/accessibility'
</script>

<template>
  <MarkGithubIcon />
  <XIcon :size="20" color="#cf222e" />
  <AccessibilityIcon size="1.25em" />
</template>

每个图标组件都支持以下属性：

| 属性 | 类型 | 默认值 | | --- | --- | --- | | size | number \| string | 16 | | color | string | currentColor |

导入方式

可以从包根路径按带 Icon 后缀的名称进行命名导入：

import { CheckIcon, XIcon, MarkGithubIcon } from 'octicons-vue3'

也可以按需深度导入单个图标：

import CheckIcon from 'octicons-vue3/icons/check'

贡献

欢迎贡献！你可以添加或更新图标，但请确保新增内容遵循 Octicons 的视觉规范。

如果你觉得哪里有问题，请提交issue。

致谢

本项目基于开源的 Octicons 项目构建，其中约 98% 的图标 SVG 来源于 Octicons/icons。

在此真诚感谢设计师、GitHub 以及 Primer 团队。他们创造并持续维护了这样一套细致、清晰且可靠的开发者视觉语言，也为本项目提供了坚实的基础。

许可证与归属说明

本包基于 MIT 许可证发布。

图标路径数据基于 GitHub Primer Octicons，该项目同样采用 MIT 许可证。更多归属信息请参见 NOTICE。