novaicons-vue
v1.1.102
Published
Vue icon components for Novaicons.
Readme
Novaicons Vue is the official Vue 3 package for Novaicons — a free, open-source SVG icon library featuring 2674+ handcrafted, grid-aligned icons. Every component is tree-shakeable, fully TypeScript-ready, and ships with zero dependencies.
| 🔗 Resource | Link | |---|---| | 🌐 Website & icon browser | novaicons.dev | | 📖 Documentation | novaicons.dev/docs | | 📦 Core package (vanilla JS) | novaicons | | 🎨 Figma plugin | novaicons.dev/docs/figma |
Install
npm i novaicons-vue
# or
bun add novaicons-vue
# or
yarn add novaicons-vue- Vue ≥ 3.0 (Composition API)
- No other dependencies required.
Usage
Basic
<script setup>
import { Home, ShieldCheck, AltArrowDown } from 'novaicons-vue';
</script>
<template>
<div>
<Home />
<ShieldCheck :size="32" color="#d97757" />
<AltArrowDown weight="Filled" />
</div>
</template>Weights
Every icon ships in two weights — Outline (default) and Filled:
<Home /> <!-- Outline (default) -->
<Home weight="Filled" /> <!-- Filled -->Sizing & coloring
<Home :size="32" /> <!-- 32×32px -->
<Home :size="48" color="#d97757" /> <!-- Custom size and color -->
<Home color="currentColor" /> <!-- Inherits parent text color -->Direct icon import (smallest bundle)
For the absolute minimum bundle size, import icons directly from the sub-path:
import Home from 'novaicons-vue/icons/Home';
import ShieldCheck from 'novaicons-vue/icons/ShieldCheck';All SVG attributes are supported
Pass any standard SVG attribute — class, style, onClick, aria-*, etc.:
<Home
:size="48"
color="red"
class="my-icon"
:style="{ marginRight: 8 }"
@click="console.log('clicked')"
aria-label="Home"
/>Props
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| size | number | string | 24 | Icon width & height (number = px) |
| color | string | — | Primary icon stroke/fill color. Leave unset to use CSS class. |
| weight | 'Outline' | 'Filled' | 'Outline' | Icon style variant |
| strokeWidth | number | string | — | Override the default stroke width |
| class | string | array | object | — | Additional CSS class on the <svg> element |
| style | string | array | object | — | Additional inline styles |
Any valid SVG attribute (e.g. id, aria-*) is forwarded to the underlying <svg> element.
Tree-shaking
Every icon is a standalone ES module. Modern bundlers — Vite, Webpack, Rollup, esbuild — automatically tree-shake unused icons, keeping only what you import.
// ✅ Only Home is included in your production bundle
import { Home } from 'novaicons-vue';
// ✅ Even smaller — direct path import skips the barrel file entirely
import Home from 'novaicons-vue/icons/Home';The package is marked "sideEffects": false for optimal dead-code elimination.
Icon Names
Icons use PascalCase, derived from their original kebab-case file names:
| Original name | PascalCase import |
|---------------|-------------------|
| home | Home |
| shield-check | ShieldCheck |
| alt-arrow-down | AltArrowDown |
| shopping-cart | ShoppingCart |
| user-circle | UserCircle |
Browse and search all 2674+ icons at novaicons.dev.
TypeScript
Full type declarations ship with the package — no separate @types/ installation needed.
import { Home, type IconProps, type IconWeight } from 'novaicons-vue';
const weight: IconWeight = 'Filled';
const props: IconProps = { size: 32, color: '#d97757', weight };Exported types
| Type | Description |
|------|-------------|
| IconProps | Combined icon props + Vue SVG attributes |
| IconWeight | 'Outline' | 'Filled' |
Features
- 2674+ icons — Handcrafted, pixel-perfect SVGs across a wide range of categories
- Two weights — Outline and Filled, with consistent 24×24 grid alignment
- Tree-shakeable — Import only what you use; every icon is a standalone ES module
- Zero dependencies — No runtime overhead beyond Vue itself
- TypeScript-ready — Full type declarations included, no extra packages needed
- SVG attribute passthrough — All standard SVG props (
class,style,aria-*, etc.) are forwarded - MIT licensed — Free for personal and commercial use
Related packages
| Package | Description |
|---------|-------------|
| novaicons | Core vanilla JS + CDN runtime. No framework required. |
| novaicons-react | React components for 2674+ icons. |
| novaicons-vue | You are here. Vue 3 components for 2674+ icons. |
| novaicons-svelte | Svelte components for 2674+ icons. |
Links
- 🌐 Website: novaicons.dev
- 📖 Documentation: novaicons.dev/docs
- 📦 npm: npmjs.com/package/novaicons-vue
- 🐙 GitHub: github.com/dqev/novaicons
- 🐛 Issues: github.com/dqev/novaicons/issues
License
MIT © KayodeDcreative
Free to use in personal and commercial projects. Attribution is appreciated but not required.
