Nuxt-fontawesome · Nuxt 模块

在你的 Nuxt 3 项目中使用 Font Awesome 6 图标的模块。

此模块不使用 vue-fontawesome 作为底层依赖，但包含其部分源代码，以实现其在 Nuxt 通用渲染（也称为配置中的 ssr: true）下的功能。

与官方组件的主要区别在于，在 template 中创建真实的标签，而不是在浏览器中渲染节点。这就是它能在服务器端工作的原因。

我尝试实现尽可能多的功能（如 mask、transform 和 symbol），但不确定是否所有功能都与 vue-fontawesome 中的方式相同。

请使用 issues 来报告问题。

设置

将依赖项添加到你的项目中

npx nuxi@latest module add @vesp/nuxt-fontawesome

添加一些图标包

npm i -D @fortawesome/free-solid-svg-icons @fortawesome/free-regular-svg-icons @fortawesome/free-brands-svg-icons

将 @vesp/nuxt-fontawesome 添加到你的 nuxt.config.ts 中的 modules 中
配置加载的图标

使用 fontawesome 键

  // nuxt.config.ts
  modules: [
    '@vesp/nuxt-fontawesome',
  ],
  fontawesome: {
    icons: {
      solid: ['cog', ...],
      ...
    }
  }
}

模块选项

`component`

默认值：font-awesome

默认组件名称为 <font-awesome icon="" ... />，你可以在此处更改它。例如，如果你指定 fa，它将变为 <fa icon="" ... />。另请参阅 suffix。

`useLayers`

默认值：true

一个布尔值，指示是否应全局注册 layers 组件。组件名称将为 ${options.component}-layers，默认为 <font-awesome-layers ... />。

`useLayersText`

默认值：true

一个布尔值，指示是否应全局注册 layers 组件。组件名称将为 ${options.component}-layers-text，默认为 <font-awesome-layers-text ... />。

`icons`

你将使用哪些图标。FontAwesome 目前支持 3 个系列中的最多 5 种图标样式。

此选项是一个对象，以样式名称作为属性，并包含你希望从这些样式中使用的所有图标名称的数组。

  icons: {
    solid: ['coffee', 'child', ... ],
    regular: ['comment', ... ],
    brands: ['twitter', ... ],
  },
  proIcons: {
    solid: [],
    regular: [],
    light: [],
    thin: [],
    duotone: [],
  },
  sharpIcons: {
    solid: [], 
    regular: [],
    light: [],
    thin: [],
  }

`addCss`

默认值：true

模块是否应自动将 fontawesome 样式添加到全局 css 配置。它的工作方式是将 @fortawesome/fontawesome-svg-core/styles.css 放置到 Nuxt 的 css 属性上。

`suffix`

默认值：true

一个布尔值，用于确定是否在图标组件名称后附加 -icon。此选项存在的原因是组件名称选项也用于层组件，你可能不想将 '-icon' 添加到这些组件。

  // config
  component: 'fa',
  suffix: true

  // usage
  <fa-icon />
  <fa-layers />
  <fa-layers-text />

  // config
  component: 'fa',
  suffix: false

  // usage
  <fa />
  <fa-layers />
  <fa-layers-text />

用法

你可以在 playground 文件夹下找到更多详细信息。

确保你已安装图标包 npm i -D @fortawesome/free-solid-svg-icons
并将模块配置添加到你的 nuxt.config.js 中

默认组件名称为

<font-awesome>
<font-awesome-layers>
<font-awesome-layers-text>

你可以通过组件选项更改这些名称。

  // nuxt.config
  fontawesome: {
    icons: {
      solid: ['dollar-sign', 'cog', 'circle', 'check', 'calendar'],
      regular: ['user']
    }
  }

使用全局图标

<template>
  <div>
    <font-awesome :icon="['far', 'user']" />
    <font-awesome icon="dollar-sign" style="font-size: 30px" />
    <font-awesome icon="cog" />

    <font-awesome-layers class="fa-4x">
      <font-awesome icon="circle" />
      <font-awesome icon="check" transform="shrink-6" :style="{color: 'white'}" />
    </font-awesome-layers>

    <font-awesome-layers full-width class="fa-4x">
      <font-awesome icon="calendar" />
      <font-awesome-layers-text transform="shrink-8 down-3" value="27" class="fa-inverse" />
    </font-awesome-layers>
  </div>
</template>

<script></script>

使用本地导入的图标

<template>
  <div>
    <font-awesome-layers full-width size="4x">
      <font-awesome :icon="faCircle" />
      <font-awesome-layers-text transform="shrink-12" value="GALSD" class="fa-inverse" />
    </font-awesome-layers>

    <font-awesome :icon="faAddressBook" />
    <font-awesome :icon="faGithub" />
  </div>
</template>

<script setup>
import {faCircle, faAddressBook} from '@fortawesome/free-solid-svg-icons'
import {faGithub} from '@fortawesome/free-brands-svg-icons'
</script>

许可证

MIT 许可证

此模块的灵感来自 Nuxt Community 的官方 Nuxt 2 模块。

部分代码和功能取自 vue-fontawesome 存储库，以实现其在服务器渲染下的功能。