{"_id":"@aautcq/nuxt-iconify-fontawesome","_rev":"1-dca32f28b93bacf8706d402f3494f8aa","name":"@aautcq/nuxt-iconify-fontawesome","description":"Use Font Awesome icons with popular Nuxt modules Nuxt Icon and NuxtUI","dist-tags":{"latest":"1.0.0-rc.2"},"versions":{"1.0.0-rc.1":{"name":"@aautcq/nuxt-iconify-fontawesome","version":"1.0.0-rc.1","keywords":["fontawesome","iconify","icons","nuxt"],"author":{"name":"Adrien Autricque","email":"adrien.autricque@gmail.com"},"license":"MIT","_id":"@aautcq/nuxt-iconify-fontawesome@1.0.0-rc.1","homepage":"https://github.com/aautcq/nuxt-iconify-fontawesome#readme","bugs":{"url":"https://github.com/aautcq/nuxt-iconify-fontawesome/issues"},"bin":{"nuxt-iconify-fontawesome":"dist/scripts/create-icon-set.js"},"dist":{"shasum":"96bd087f67037c8a829350ace457a97c36f57608","tarball":"https://registry.npmjs.org/@aautcq/nuxt-iconify-fontawesome/-/nuxt-iconify-fontawesome-1.0.0-rc.1.tgz","fileCount":19,"integrity":"sha512-mpqHvl76PRAooDaheNwdGninRKxZvFOX/dZ6j8x0vdxYved2t1mIKSPoE0BJtHNGuFsLQbb3uNYB7GYZp0ao9A==","signatures":[{"sig":"MEUCIF+OjeMujZ1Fm9uO4OPhjRLgy+fKVYCGfJCOSF2eTJPwAiEAmHREqqswE+o77+XEuykhhOXNx350mP74L72bJmQX9Ro=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14483949},"main":"dist/index.js","type":"module","_from":"file:aautcq-nuxt-iconify-fontawesome-1.0.0-rc.1.tgz","types":"dist/index.d.ts","private":false,"scripts":{"lint":"eslint . --fix","test":"echo \"Error: no test specified\" && exit 1","build":"npm run build:transpile && npm run build:sets","build:sets":"node ./dist/scripts/convert-icons.js","build:transpile":"tsc"},"_npmUser":{"name":"adrien-autcq","email":"adrien.autricque@gmail.com"},"_resolved":"/private/var/folders/wx/w5qwflw514n0tvfbvjf_49cm0000gn/T/f2ad4c21c00fb11e46dbecf8009bfcf5/aautcq-nuxt-iconify-fontawesome-1.0.0-rc.1.tgz","_integrity":"sha512-mpqHvl76PRAooDaheNwdGninRKxZvFOX/dZ6j8x0vdxYved2t1mIKSPoE0BJtHNGuFsLQbb3uNYB7GYZp0ao9A==","repository":{"url":"git+https://github.com/aautcq/nuxt-iconify-fontawesome.git","type":"git"},"_npmVersion":"10.5.0","description":"Use Font Awesome icons with popular Nuxt modules Nuxt Icon and NuxtUI","directories":{},"_nodeVersion":"21.7.3","dependencies":{"chalk":"~5.3.0","pathe":"~1.1.2","yargs":"~17.7.2","@types/yargs":"~17.0.32","cli-progress":"~3.12.0","@iconify/tools":"~4.0.4","@fortawesome/fontawesome-svg-core":"~6.5.2"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"~8.57.0","typescript":"~5.4.5","@types/cli-progress":"~3.11.5","@antfu/eslint-config":"~2.21.1","@fortawesome/free-solid-svg-icons":"~6.5.2","@fortawesome/free-brands-svg-icons":"~6.5.2","@fortawesome/free-regular-svg-icons":"~6.5.2"},"_npmOperationalInternal":{"tmp":"tmp/nuxt-iconify-fontawesome_1.0.0-rc.1_1718906830247_0.5098727622824375","host":"s3://npm-registry-packages"}},"1.0.0-rc.2":{"name":"@aautcq/nuxt-iconify-fontawesome","type":"module","version":"1.0.0-rc.2","private":false,"description":"Use Font Awesome icons with popular Nuxt modules Nuxt Icon and NuxtUI","author":{"name":"Adrien Autricque","email":"adrien.autricque@gmail.com"},"license":"MIT","homepage":"https://github.com/aautcq/nuxt-iconify-fontawesome#readme","repository":{"type":"git","url":"git+https://github.com/aautcq/nuxt-iconify-fontawesome.git"},"bugs":{"url":"https://github.com/aautcq/nuxt-iconify-fontawesome/issues"},"keywords":["fontawesome","iconify","icons","nuxt"],"main":"dist/index.js","types":"dist/index.d.ts","dependencies":{"@aautcq/svg-to-iconify":"1.0.0-rc.1","@fortawesome/fontawesome-svg-core":"~6.5.2","@iconify/tools":"~4.0.4","chalk":"~5.3.0","cli-progress":"~3.12.0","pathe":"~1.1.2"},"devDependencies":{"@antfu/eslint-config":"~2.21.1","@fortawesome/free-brands-svg-icons":"~6.5.2","@fortawesome/free-regular-svg-icons":"~6.5.2","@fortawesome/free-solid-svg-icons":"~6.5.2","@types/cli-progress":"~3.11.5","eslint":"~8.57.0","typescript":"~5.4.5"},"scripts":{"build:transpile":"tsc","build:sets":"node ./dist/scripts/convert-icons.js","build":"npm run build:transpile && npm run build:sets","test":"echo \"Error: no test specified\" && exit 1","lint":"eslint . --fix"},"_id":"@aautcq/nuxt-iconify-fontawesome@1.0.0-rc.2","_integrity":"sha512-+H2SRwL7BR/zs3ePw3T4/dSHxo0q+E4Esy2tr6EZiCH2PRgRtQAcWJf2BNk3Di7oh/Qodn1/xA/UYw/Icx3NPA==","_resolved":"/private/var/folders/wx/w5qwflw514n0tvfbvjf_49cm0000gn/T/bd6b95a43a3ee8dadf705605bb432f9d/aautcq-nuxt-iconify-fontawesome-1.0.0-rc.2.tgz","_from":"file:aautcq-nuxt-iconify-fontawesome-1.0.0-rc.2.tgz","_nodeVersion":"21.7.3","_npmVersion":"10.5.0","dist":{"integrity":"sha512-+H2SRwL7BR/zs3ePw3T4/dSHxo0q+E4Esy2tr6EZiCH2PRgRtQAcWJf2BNk3Di7oh/Qodn1/xA/UYw/Icx3NPA==","shasum":"f2743fed2200382e4a85677c78be49097b2935c2","tarball":"https://registry.npmjs.org/@aautcq/nuxt-iconify-fontawesome/-/nuxt-iconify-fontawesome-1.0.0-rc.2.tgz","fileCount":19,"unpackedSize":14479418,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFMQH6yW4subKOotCDB2NODUcEimwndSeBSp7iVDepDOAiEAlPO12s8wfaOlajM65giJEFptKk35IgQkqZUq7EurF2g="}]},"_npmUser":{"name":"adrien-autcq","email":"adrien.autricque@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nuxt-iconify-fontawesome_1.0.0-rc.2_1718955287404_0.8201427538738411"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-20T18:07:10.142Z","modified":"2024-06-21T07:34:47.969Z","1.0.0-rc.1":"2024-06-20T18:07:10.548Z","1.0.0-rc.2":"2024-06-21T07:34:47.780Z"},"maintainers":[{"name":"adrien-autcq","email":"adrien.autricque@gmail.com"}],"author":{"name":"Adrien Autricque","email":"adrien.autricque@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/aautcq/nuxt-iconify-fontawesome.git"},"keywords":["fontawesome","iconify","icons","nuxt"],"license":"MIT","homepage":"https://github.com/aautcq/nuxt-iconify-fontawesome#readme","bugs":{"url":"https://github.com/aautcq/nuxt-iconify-fontawesome/issues"},"readme":"# @aautcq/nuxt-iconify-fontawesome\n\n[![NPM version][npm-version-src]][npm-version-href]\n[![NPM downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n[![Nuxt][nuxt-src]][nuxt-href]\n\nConverts Font Awesome icons to Iconify JSON data, allowing the use of popular Nuxt modules such as [Nuxt Icon](https://nuxt.com/modules/icon) or [NuxtUI](https://nuxt.com/modules/ui).\n\nOne icon set is generated per Font Awesome collection. Here are the corresponding Iconify prefixes for each Font Awesome set:\n\n| Font Awesome set | Iconify prefix |\n| ---------------- | -------------- |\n| brands | `fab` |\n| regular | `far` |\n| solid | `fas` |\n\n## Installation\n\nUsing NPM or whatever your preferred package manager is\n\n```bash\nnpm i @aautcq/nuxt-iconify-fontawesome\n```\n\nThen you can get Iconify icon sets using the `getIconSubSet` function exposed by the package\n\n```js\nconst myIconSet = getIconSubSet('<icon-set-name>', ['<icon-1>', '<icon-2>'])\n```\n\n## Examples\n\n### Using Nuxt Icon\n\nIn your Nuxt config file, get an icon set and register it into Nuxt Icon\n\n```ts\n// nuxt.config.ts\nimport { getIconSubSet } from '@aautcq/nuxt-iconify-fontawesome'\n\nconst fasCollection = getIconSubSet('fas', ['check'])\n\nexport default defineNuxtConfig({\n  modules: ['@nuxt/icon'],\n  icon: {\n    customCollections: [\n      fasCollection.export(),\n    ],\n  },\n})\n```\n\nThen, in your .vue files\n\n```vue\n<template>\n  <Icon name=\"fas:check\" />\n</template>\n```\n\n### Using NuxtUI\n\nIn your Nuxt config file, get an icon set and register it into NuxtUI\n\n```ts\n// nuxt.config.ts\nimport { getIconSubSet } from '@aautcq/nuxt-iconify-fontawesome'\n\nconst fasCollection = getIconSubSet('fas', ['check'])\n\nexport default defineNuxtConfig({\n  modules: ['@nuxt/ui'],\n  ui: {\n    icons: {\n      collections: {\n        [fasCollection.prefix]: fasCollection.export(),\n      },\n    },\n  },\n})\n```\n\nThen, in your .vue files\n\n```vue\n<template>\n  <UIcon name=\"i-fas-check\" />\n</template>\n```\n\n## Font Awesome pro and kits\n\nYou might have access to Font Awesome pro or a Font Awesome kit and need to generate Iconify icon sets for these. To do so, you can follow these steps:\n\n- Fork this repository\n- Uninstall the free Font Awesome icon packages and install the ones you need\n- Update the `/src/scripts/convert-icons.ts` file to use the icon collections from the installed packages\n- Run the `build` script to generate the Iconify icon sets in the `/dist` folder\n\n## To do\n\n- Unit tests\n\n## License\n\n[MIT License](https://github.com/aautcq/nuxt-iconify-fontawesome/blob/master/LICENSE)\n\n<!-- Badges -->\n[npm-version-src]: https://img.shields.io/npm/v/@aautcq/nuxt-iconify-fontawesome/latest.svg?style=flat&colorA=18181B&colorB=28CF8D\n[npm-version-href]: https://npmjs.com/package/@aautcq/nuxt-iconify-fontawesome\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/@aautcq/nuxt-iconify-fontawesome.svg?style=flat&colorA=18181B&colorB=28CF8D\n[npm-downloads-href]: https://npmjs.com/package/@aautcq/nuxt-iconify-fontawesome\n\n[license-src]: https://img.shields.io/github/license/aautcq/nuxt-iconify-fontawesome.svg?style=flat&colorA=18181B&colorB=28CF8D\n[license-href]: https://github.com/aautcq/nuxt-iconify-fontawesome/blob/master/LICENSE\n\n[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js\n[nuxt-href]: https://nuxt.com\n","readmeFilename":"README.md"}