vue-sailor-icons
v1.0.0
Published
Nice open source icons as Vue functional components.
Downloads
107
Readme
vue-sailor-icons
Install
yarn add vue-sailor-icons
// or
npm i vue-sailor-icons --save
Usage
// Only import what you need!
import { AnchorIcon, BoatIcon, ... } from 'vue-sailor-icons'
See all icons and usage here: https://
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
.
<anchor-icon size="2.5x" class="custom-class"></anchor-icon>
You can also set a px
size directly by just passing an integer
<anchor-icon size="24" class="custom-class"></anchor-icon>
By default, icons' color is #000
.
You can set a custom color using the color
attribute.
<anchor-icon size="2.5x" color="blue"></anchor-icon>
Tree shaking
By using ES imports like import { AnchorIcon } from 'vue-sailor-icons'
with webpack + minifier or Rollup, unused exports in this module will be automatically eliminated.
To make webpack tree shaking work without using any minifier, you can use the per-file icons from icons
directory, e.g. import AnchorIcon from 'vue-sailor-icons/icons/AnchorIcon'
.
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
Author
vue-sailor-icons © katalonne, Released under the MIT License. Highly inspired by (vue-feather-icons).