@codexteam/nuxt-icons
v0.0.4
Published
Use CodeX Icons in your Nuxt project
Downloads
14
Keywords
Readme
CodeX Icons Nuxt module
This modules simplifies using of CodeX Icons pack in the Nuxt projects.
Features
- 💖 Dynamic loading
- 💝 Coloring
- 💞 HMR (reloading on update in dev mode)
Installation
- Get the package
yarn add @codexteam/nuxt-icons
- Add module to the
nuxt.config.ts
export default defineNuxtConfig({
modules: [
'@codexteam/nuxt-icons'
]
})
Usage
Use the codex-icon
component with the name
property which should be one of the list.
<codex-icon name="IconHeart" />
Properties
There are few properties available for component:
| prop | type | description |
| -- | -- | -- |
| name
| string | Required. Name of icon from CodeX Icons pack |
| class
| string | Class name to be added to the icon wrapper |
| size
| number | Icon width and height value |
About CodeX
CodeX is a team of digital specialists around the world interested in building high-quality open source products on a global market. We are open for young people who want to constantly improve their skills and grow professionally with experiments in cutting-edge technologies.
| 🌐 | Join 👋 | Twitter | Instagram | | -- | -- | -- | -- | | codex.so | codex.so/join |@codex_team | @codex_team |