Flux Icons Documentation

Everything you need to know to build stunning, animated interfaces with the world's most versatile icon library.

Why Flux Icons?

Flux Icons is not just another SVG pack. It is a comprehensive design system built specifically for modern frameworks like Vue 3 and Nuxt 3. Unlike traditional icon fonts, Flux Icons leverages the power of components to deliver:

  • Tree-Shaking: Only the icons you use are included in your bundle.
  • Performance: Zero runtime overhead with optimized SVGs.
  • Interactivity: Built-in micro-animations on hover.
  • Versatility: 1500+ icons in Solid, Outline, and Liquid styles.

Installation

Install the package via your favorite package manager:

npm install flux-icons-pro-pack

Setup in Nuxt 3

Register the plugin in your plugins/flux-icons.ts file:

import { defineNuxtPlugin } from '#app'
import FluxIcons from 'flux-icons-pro-pack'
import 'flux-icons-pro-pack/dist-font/flux-icons.css' // Import CSS for animations

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.use(FluxIcons)
})

Flux Motion

Bring your UI to life with our built-in micro-interactions. No extra CSS or JS required. Just add the animation prop to any icon.

shake
beat
bounce-y
pop
wiggle
drive
spin-pulse
glow
<FluxIcon name="bell" animation="shake" />

Icon Mixer

Why settle for standard icons? With our exclusive Icon Mixer, you can combine any two icons to create unique, meaningful symbols for your application.

+
=

Create combinations like "Secure Folder", "User Pro", "Add to Cart" and more.

Try Mixer Now

Liquid Glass Style

Elevate your design with our premium Liquid Glass icons. These are not just SVGs; they are crafted with gradients, opacity layers, and blur effects.

Component Props

PropTypeDefaultDescription
nameString-Icon name (e.g. "home").
sizeNumber | String24Size in pixels.
animationString""Hover effect.
colorStringcurrentColorFill or stroke color.

Frequently Asked Questions

Is Flux Icons free to use?

Yes! Flux Icons is open-source and free for both personal and commercial projects. You can use it in your apps, websites, and designs without any cost.

Can I use it with React or Svelte?

Currently, we have a dedicated Vue 3 / Nuxt 3 component. However, you can easily use the raw SVG code (available in our library) in React, Svelte, or vanilla HTML projects.

Does it support Tree-Shaking?

Absolutely. The library is designed to be tree-shakeable, meaning only the icons you actually use will be included in your final JavaScript bundle, keeping your app fast and lightweight.

How can I customize the icons?

You can change the color using standard Tailwind classes (like `text-red-500`) or the `color` prop. The `size` prop adjusts the dimensions, and the `stroke-width` (for outline icons) is also customizable.