Installation
Get started with Hovue in minutes. Choose the installation method that best fits your project.
Package Managers
Install Hovue using your preferred package manager:
# npm
npm install @hovue/icons
# yarn
yarn add @hovue/icons
# pnpm
pnpm add @hovue/icons
# bun
bun add @hovue/icons
npm install @hovue/icons
# yarn
yarn add @hovue/icons
# pnpm
pnpm add @hovue/icons
# bun
bun add @hovue/icons
Vue 3
For Vue 3 projects, import icons directly in your components:
import { HoArrowRight, HoCheck } from '@hovue/icons'
export default {
components: {
HoArrowRight,
HoCheck
}
}
export default {
components: {
HoArrowRight,
HoCheck
}
}
Nuxt 3
For Nuxt 3 projects, use the Nuxt module for auto-imports:
1. Install the module
npm install @hovue/icons @hovue/nuxt
2. Add to nuxt.config.ts
export default defineNuxtConfig({
modules: ['@hovue/nuxt']
})
modules: ['@hovue/nuxt']
})
That's it! Icons are now auto-imported and ready to use in your templates.
Vite
Hovue works seamlessly with Vite. No additional configuration needed.
Note: Hovue requires Vue 3.3+ and supports both Composition API and Options API.
TypeScript
TypeScript definitions are included. No additional setup required.
import type { IconProps } from '@hovue/icons'
Tree Shaking
Hovue is fully tree-shakeable. Only import the icons you use:
// ✅ Good - only imports what you need
import { HoArrowRight } from '@hovue/icons'
// ❌ Bad - imports entire library
import * as Hovue from '@hovue/icons'
import { HoArrowRight } from '@hovue/icons'
// ❌ Bad - imports entire library
import * as Hovue from '@hovue/icons'
Next Steps
Now that you've installed Hovue, check out the Quick Start guide to learn how to use icons in your project.