Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.
/ vue-hero-icons Public archive

A set of free MIT-licensed high-quality SVG icons, sourced from @tailwindlabs/heroicons, as Vue 2 functional components.

License

Notifications You must be signed in to change notification settings

matschik/vue-hero-icons

Repository files navigation

vue-hero-icons

For Vue3, install the official package @heroicons/vue

A set of free MIT-licensed high-quality SVG icons, sourced from @tailwindlabs/heroicons, as Vue 2 functional components.

npm version license
Demo: https://vue-hero-icons.netlify.com/

Install

# Only outline icons
npm install @vue-hero-icons/outline

# Only solid icons
npm install @vue-hero-icons/solid

Usage

// Only import what you need!
import { AnnotationIcon, ArrowCircleUpIcon, ... } from '@vue-hero-icons/outline'

See all icons and usage here: https://vue-hero-icons.netlify.com

Sizing

By default, icons will be sized based on the font size of the parent element.

You can set a custom size using the size attribute. For multiple based sizing, pass the desired multiple followed by an x.

<AnnotationIcon size="1.5x" class="custom-class" />

You can also set a px size directly by just passing an integer

<AnnotationIcon size="25" class="custom-class" />

Tree shaking

By using ES imports like import { AnnotationIcon } from "@vue-hero-icons/outline" with webpack + minifier or Rollup, unused exports in this module will be automatically eliminated.

Inspiration

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Credits

heroicons © Refactoring UI, Released under the MIT License.

Author

vue-hero-icons © matschik, Released under the MIT License.

GitHub @matschik · Twitter @matschik_

About

A set of free MIT-licensed high-quality SVG icons, sourced from @tailwindlabs/heroicons, as Vue 2 functional components.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published