Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@fortawesome/vue-fontawesome

FortAwesome1.2mMIT3.0.8TypeScript support: included

Official Vue component for Font Awesome 6

readme

Official Javascript Component

vue-fontawesome (with Vue 3)

npm GitHub Actions Status

Font Awesome Vue 3 component using SVG with JS


Documentation

Official documentation is hosted at docs.fontawesome.com

Helpful Vue links:

How to Help

Review the following docs before diving in:

And then:

  • Check the existing issues and see if you can help!

Contributors

The following contributors have either helped to start this project, have contributed code, are actively maintaining it (including documentation), or in other ways being awesome contributors to this project. We'd like to take a moment to recognize them.

| | Name | GitHub | | :------------------------------------------------------------: | ----------------- | --------------------------------------------------------- | | | SirLamer | @SirLamer | | | Liu Xinyu | @meteorlxy | | | Xaver Schulz | @schulz3000 | | | Yannick Ihmels | @ihmels | | | btaens | @btaens | | | David Driscoll | @david-driscoll | | | Tyranteon | @tyranteon | | | Romain Failla | @rigma | | | Vinicius Rangel | @viniciuslrangel | | | Okke Tijhuis | @otijhuis | | | Aaron Parker | @parkeyparker | | | Brandon Mork | @brandon-mork | | | Michael Cozzolino | @michaelcozzolino |

If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.

The Font Awesome team:

| | Name | GitHub | | :--------------------------------------------------------: | -------------- | -------------------------------------------------- | | | Travis Chase | @supercodepoet | | | Rob Madole | @robmadole | | | Mike Wilkerson | @mlwilkerson | | | Brian Talbot | @talbs | | | Jason Lundien | @jasonlundien |

Releasing this project (only project owners can do this)

See DEVELOPMENT.md

changelog

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

3.0.8 - 2024-05-21

Changed

  • Updated package-lock.json to help fix faililng tests

3.0.7 - 2024-05-21

Changed

  • Updated nodejs version in .tool-versions
  • Updated Jest configuration for local testing
  • Removed an unused import in FontAwesomeLayers.test.js
  • Updated node-versions in ci.yml
  • Added additional exports in index.d.ts
  • Updated README.md for new Font Awesome Doc link

3.0.6 - 2024-01-29

Changed

  • Added missing exports to TS definition in index.d.ts

3.0.5 - 2023-11-06

Changed

  • Removed .tgz file

3.0.4 - 2023-11-06

Added

  • Tests for Sharp Family
  • Ability to include a title prop (github issue #181)
  • Prettier config file

3.0.3 - 2023-01-24

Changed

  • NPM download @fortawesome/vue-fontawesome-latest is now set to Vue 3; to download the Vue 2 package you will have to use @fortawesome/vue-fontawesome-latest-2, which is described in our Vue setup docs
  • CI workflow updated for testing
  • README.md and package.json updated for new contributor

Added

  • Missing TypeScript animations added (github issue #428)
  • Missing TypeScript sizes added (github issue #415)

3.0.2 - 2022-11-07

Changed

  • Vue 3 Composition API TypeScript support (github issue #276)
  • Updated README.md with a spelling correction, linter fixes, and new contributor
  • Updated icon example in App.vue to use fixed-width rather than full-width

Added

  • Missing tests

3.0.1 - 2022-06-17

Changed


3.0.0 - 2022-06-07

Added

  • New animations for bounce and shake
  • Feature to call icons using a string format

Fixed

  • Animations for beat, fade, beat-fade, flash, spin-pulse, and spin-reverse
  • Tee-shirt sizes to include 2xs, lg, xl, and 2xl
  • Flip animation when used by itself

3.0.0-5 - 2021-10-18

Fixed

  • Include 1.3.0-beta versions in peer dependencies

3.0.0-4 - 2021-05-23

Fixed

  • Fix reactivity #297

3.0.0-3 - 2020-12-09

Fixed

  • Allow for non-RC releases of Vue 3

3.0.0-2 - 2020-10-09

Fixed

  • Make Vue as an external dependency #258 #260

3.0.0-1 - 2020-09-01

Added

  • Support for Vue 3.x RC's and betas #246 #249

See the CHANGELOG prior to version 3.