参考:https://blog.csdn.net/qq_26373925/article/details/108405038

如何在Nuxt.js中使用svg图标

首先介绍一下Nuxt.js:Nuxt.js是一个基于 Vue.js的轻量级框架,可用来创建服务端渲染 (SSR) 应用,也可用于生成静态站点。
官网:https://nuxtjs.org/

使用Nuxt.js进行服务端渲染更利于SEO,这是我使用Nuxt.js的最大理由。

但是Nuxt.js的项目结构以及一些配置写法与我平常编写的vue-cli项目还是存在不少区别,所以写下这篇文章记录下在Nuxt.js中使用svg图标的过程。

去哪里找免费的svg图标资源?
阿里巴巴矢量图标库:https://www.iconfont.cn/

首先,在nuxt中使用svg总共分为三步:

1.创建vue组件

首先在nuxt项目目录中的components中建立SvgIcon.vue,代码如下

  1. <template>
  2. <svg
  3. :class="svgClass"
  4. aria-hidden="true"
  5. >
  6. <use :xlink:href="iconName" />
  7. </svg>
  8. </template>
  9. <script>
  10. // 使用 <svg-icon icon-class="add"></svg-icon>
  11. export default {
  12. name: 'SvgIcon',
  13. props: {
  14. iconClass: {
  15. type: String,
  16. required: true
  17. },
  18. className: {
  19. type: String,
  20. default: ''
  21. }
  22. },
  23. computed: {
  24. iconName () {
  25. return `#icon-${this.iconClass}`
  26. },
  27. svgClass () {
  28. return this.className ? 'svg-icon ' + this.className : 'svg-icon'
  29. }
  30. }
  31. }
  32. </script>
  33. <style scoped>
  34. .svg-icon {
  35. width: 1em;
  36. height: 1em;
  37. font-size: 1.2em;
  38. vertical-align: -0.15em;
  39. fill: currentColor;
  40. overflow: hidden;
  41. }
  42. </style>

2.创建Nuxt插件文件

在项目目录下建立plugins目录,然后在其中创建icons.js文件,代码如下:

  1. import Vue from 'vue'
  2. // 引用组件
  3. import SvgIcon from '@/components/SvgIcon'
  4. // 注册全局组件,组建名为svg-icon
  5. Vue.component('svg-icon', SvgIcon)
  6. // 引用svg图标
  7. const requireAll = requireContext => requireContext.keys().map(requireContext)
  8. // 引用项目 assets/svg 目录下的所有 .svg 文件
  9. // 如果第二个参数为 true ,程序将会遍历 assets/svg 目录下的子目录,并引用其中的 .svg 文件
  10. // 如果不需要遍历子目录,可设为 false
  11. const req = require.context('@/icons/svg', true, /\.svg$/)
  12. requireAll(req)

3.配置nuxt.config.js

此步骤用到svg-sprite-loader这个依赖,先使用npm安装:

  1. npm install svg-sprite-loader --save-dev

接着打开nuxt.config.js,在顶部加入

  1. // eslint-disable-next-line nuxt/no-cjs-in-config
  2. const path = require('path')

然后修改build部分,配置webpack:

  1. /*
  2. ** Build configuration
  3. ** See https://nuxtjs.org/api/configuration-build/
  4. */
  5. build: {
  6. extend (config, ctx) {
  7. // todo svg
  8. const svgRule = config.module.rules.find(rule => rule.test.test('.svg'))
  9. svgRule.exclude = [path.resolve(__dirname, 'icons/svg')]
  10. // Includes /icons/svg for svg-sprite-loader
  11. config.module.rules.push({
  12. test: /\.svg$/,
  13. include: [path.resolve(__dirname, 'icons/svg')],
  14. loader: 'svg-sprite-loader',
  15. options: {
  16. symbolId: 'icon-[name]'
  17. }
  18. })
  19. }
  20. }

最后修改plugins部分:

  1. /*
  2. ** Plugins to load before mounting the App
  3. ** https://nuxtjs.org/guide/plugins
  4. */
  5. plugins: [
  6. { src: '@/plugins/icons', ssr: true }
  7. ],

重启项目,在icons/svg目录下放置你的.svg文件,即可在项目中引用。
引用方式:
此处icon-class就是你的.svg文件名称,直接在.vue文件中调用就可以了(记得先在icons/svg目录下放好.svg图标)

与vue-cli项目的不同:

主要是第二步创建Nuxt插件文件和第三步配置nuxt.config.js与配置vue-cli项目时有些区别。
vue-cli项目中,我们可以直接在main.js文件中使用Vue.component('svg-icon', SvgIcon)进行全局组件注册
而在nuxt项目中,我们不但需要在plugins目录下建立插件文件进行组件注册,而且还需要在nuxt.config.js中的plugins配置项添加插件文件

在第三步配置webpack时,在vue-cli项目中我通常这么写:

vue.config.js:

  1. module.exports = {
  2. chainWebpack: config => {
  3. // svg config
  4. const svgRule = config.module.rule('assets/svg')
  5. svgRule.uses.clear()
  6. svgRule.use('svg-sprite-loader').loader('svg-sprite-loader')
  7. .options({
  8. symbolId: 'icon-[name]'
  9. })
  10. }
  11. }

而在nuxt.js项目中,则变成了:
nuxt.config.js:

  1. build: {
  2. extend (config, ctx) {
  3. // ...
  4. const svgRule = config.module.rules.find(rule => rule.test.test('.svg'))
  5. svgRule.exclude = [path.resolve(__dirname, 'assets/svg')]
  6. // Includes /icons/svg for svg-sprite-loader
  7. config.module.rules.push({
  8. test: /\.svg$/,
  9. include: [path.resolve(__dirname, 'assets/svg')],
  10. loader: 'svg-sprite-loader',
  11. options: {
  12. symbolId: 'icon-[name]'
  13. }
  14. })
  15. }
  16. }