https://github.com/Qonfucius/nuxt-fontawesome

Use fontawesome 5 as a nuxtJS module
https://github.com/Qonfucius/nuxt-fontawesome

List: nuxt-fontawesome

Last synced: 23 days ago
JSON representation

Use fontawesome 5 as a nuxtJS module

• Host: GitHub
• URL: https://github.com/Qonfucius/nuxt-fontawesome
• Owner: Qonfucius
• Created: 2017-10-10T22:11:38.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-30T16:12:04.000Z (over 5 years ago)
• Last Synced: 2024-04-10T03:36:47.410Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 11.7 KB
• Stars: 32
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Lists

• awesome-nuxt - Font-awesome 5 - Use fontawesome 5 as a nuxtJS module. (Uncategorized / Uncategorized)
• awesome-nuxt - Font-awesome 5 - Use fontawesome 5 as a nuxtJS module. (Uncategorized / Uncategorized)
• awesome-nuxt - Font-awesome 5 - Use fontawesome 5 as a nuxtJS module. (Uncategorized / Uncategorized)
• awesome-nuxt - Font-awesome 5 - Use fontawesome 5 as a nuxtJS module. (Uncategorized / Uncategorized)

README

        
# Nuxt Font Awesome 5

> With Nuxt Font Awesome 5 you can easily use 

## Should I use this module in production ?

Probably not. We don't have any unit test, and this module has not reached the 1.x.x maturity.

## Setup

- Add `qonfucius-nuxt-fontawesome` dependency using yarn or npm to your project

- Add `qonfucius-nuxt-fontawesome` to `modules` section of `nuxt.config.js`

- Add some fontawesome 5 packs as dependency using yarn or npm to your project

- Configure theses packs in configuration (please see `packs` option).

```js

{

  modules: [

    // Simple usage

    'qonfucius-nuxt-fontawesome',

    

    // With options

    ['qonfucius-nuxt-fontawesome', { componentName: 'fa-icon', packs: [], includeCss: true }],

  ]

}

````

## Usage

```vue

  

  

  

  

  

  

  

  


    
List icons

    
can be used

    
as bullets

    
in lists

  


```

## Options

### `componentName`

Default: `fa-icon`

Component name

### `includeCss`

Default: `true`

If you are already including fontawesome css somewhere in your code (sass ?), please pass false !

### `packs`

Default: `[]`

Packs to configure, with the list of icons to include in the project.

#### Example

- Add `@fortawesome/free-brands-svg-icons` as dependency

- Add configuration like this in `nuxt.config.js`

```js

{

  fontAwesome: {

    packs: [

      {

        package: '@fortawesome/free-brands-svg-icons',

        icons: ['faGithub', 'faFontAwesome'],

      },

    ],

  },

}

```

- Use it in template

```vue

  

  

```

## Contributors

Thank you to all our [contributors](https://github.com/Qonfucius/nuxt-fontawesome/graphs/contributors)!