oh-vue-icons 使用教程

1. 项目介绍

oh-vue-icons 是一个 Vue 组件，用于轻松地从不同的流行图标包中导入内联 SVG 图标。它支持 Vue 2 和 Vue 3，并且可以通过 tree-shaking 只导入所需的图标，从而减少包的大小。目前支持超过 20 个流行的图标包，总共拥有 30,000 多个图标。

2. 项目快速启动

首先，您需要安装 oh-vue-icons。可以使用 npm 或 yarn：

npm install oh-vue-icons
# 或者
yarn add oh-vue-icons

对于 Vue 2 项目，还需要安装 @vue/composition-api：

npm install @vue/composition-api -D
# 或者
yarn add @vue/composition-api -D

如果使用 Nuxt 2，需要安装 @nuxtjs/composition-api 并在 nuxt.config.js 中配置：

npm install @nuxtjs/composition-api -D
# 或者
yarn add @nuxtjs/composition-api -D

然后在 nuxt.config.js 中添加：

export default {
  // ...
  buildModules: [
    // ...
    '@nuxtjs/composition-api/module'
  ]
}

在 Vue 3 中，您可以在 main.js 中全局导入和注册 oh-vue-icons：

import { createApp } from 'vue';
import App from './App.vue';
import { OhVueIcon, addIcons } from 'oh-vue-icons';
import { FaFlag, RiZhihuFill } from 'oh-vue-icons/icons';

addIcons(FaFlag, RiZhihuFill);

const app = createApp(App);
app.component('v-icon', OhVueIcon);
app.mount('#app');

在 Vue 2 中，注册方式稍有不同：

import Vue from 'vue';
import App from './App.vue';
import { OhVueIcon, addIcons } from 'oh-vue-icons';
import { FaFlag, RiZhihuFill } from 'oh-vue-icons/icons';

addIcons(FaFlag, RiZhihuFill);

Vue.component('v-icon', OhVueIcon);
new Vue({
  render: h => h(App)
}).$mount('#app');

3. 应用案例和最佳实践

使用 oh-vue-icons 的示例，您可以按照以下方式在模板中添加图标：

<template>
  <div>
    <v-icon name="fa-flag" />
    <v-icon name="ri-zhihu-fill" />
  </div>
</template>

对于 Font Awesome 5 的图标，如果图标来自 regular 包，则属性值应为 fa-regular-flag。来自 solid 和 brands 包的图标属性值分别为 fa-beer 和 fa-github。

更多关于图标属性和用法的信息，请查看官方文档。

4. 典型生态项目

oh-vue-icons 可以与 Vue 相关的许多生态项目一起使用，例如 Nuxt.js 和 Vite。以下是一些配置示例：

• 在 Nuxt.js 中使用： 将 oh-vue-icons 添加到 nuxt.config.js 的 build.transpile 选项中。

export default {
  // ...
  build: {
    transpile: ['oh-vue-icons']
  }
}

• 在 Vite 中使用： 排除 oh-vue-icons 从预打包中，以及在服务器端渲染时添加到 ssr.noExternal 选项中。

export default {
  // ...
  optimizeDeps: {
    exclude: ['oh-vue-icons/icons']
  },
  ssr: {
    noExternal: ['oh-vue-icons']
  }
}

通过以上步骤，您可以轻松地在项目中使用 oh-vue-icons，并利用其提供的丰富图标资源。