v-simple-icons
v1.0.2
Published
Simply beautiful open source icons as Vue functional components.
Downloads
26
Readme
v-simple-icons
Install
yarn add v-simple-icons
Usage
// Only import what you need!
import { VueJsIcon, AirbnbIcon, ... } from 'v-simple-icons'
See all icons and usage here: https://v-simple-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
.
<vue-js-icon size="1.5x" class="custom-class"></vue-js-icon>
You can also set a px
size directly by just passing an integer
<vue-js-icon size="25" class="custom-class"></vue-js-icon>
Tree shaking
By using ES imports like import { VueJsIcon } from 'v-simple-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 VueJsIcon from 'v-simple-icons/icons/VueJsIcon'
.
Related
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'feat: Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
v-simple-icons amaury-tobias, Released under the MIT License. Authored and maintained by amaury-tobias with help from contributors
GitHub @amaury-tobias · Twitter @amaury-tobias