4.5.0 • Published 6 years ago

featherish v4.5.0

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

featherish

npm license stars deps status

Description

Framework-agnostic Web Components vector icons for modern web applications. Design of the icons by Cole Bemis.

Demos

No frameworkAngularReactVue
DemoDemoDemoDemo

Usage

1. Install the package

npm install featherish

2. Import icons you need

import 'featherish/icons/github';
import 'featherish/icons/gitlab';
import 'featherish/icons/heart';
import 'featherish/icons/moon';

3. Use

<i-github></i-github>
<i-gitlab></i-gitlab>
<i-heart></i-heart>
<i-moon></i-moon>

Note that you might need to add a polyfill. For that, npm install @webcomponents/custom-elements and import the polyfill before importing the icons.

import '@webcomponents/custom-elements/src/native-shim';

Styling icons

Icons can be customised with any CSS property that you can apply on a SVG element.

<i-heart class="big fill-red"></i-heart>
.big {
  height: 50px;
  width: 50px;
}

.fill-red {
  fill: red;
}

Available icons

Refer to the table below for the list of all available icons.

activity <i-activity>airplay <i-airplay>alert-circle <i-alert-circle>alert-octagon <i-alert-octagon>alert-triangle <i-alert-triangle>
align-center <i-align-center>align-justify <i-align-justify>align-left <i-align-left>align-right <i-align-right>anchor <i-anchor>
aperture <i-aperture>arrow-down-circle <i-arrow-down-circle>arrow-down-left <i-arrow-down-left>arrow-down-right <i-arrow-down-right>arrow-down <i-arrow-down>
arrow-left-circle <i-arrow-left-circle>arrow-left <i-arrow-left>arrow-right-circle <i-arrow-right-circle>arrow-right <i-arrow-right>arrow-up-circle <i-arrow-up-circle>
arrow-up-left <i-arrow-up-left>arrow-up-right <i-arrow-up-right>arrow-up <i-arrow-up>at-sign <i-at-sign>award <i-award>
bar-chart-2 <i-bar-chart-2>bar-chart <i-bar-chart>battery-charging <i-battery-charging>battery <i-battery>bell-off <i-bell-off>
bell <i-bell>bluetooth <i-bluetooth>bold <i-bold>book-open <i-book-open>book <i-book>
bookmark <i-bookmark>box <i-box>briefcase <i-briefcase>calendar <i-calendar>camera-off <i-camera-off>
camera <i-camera>cast <i-cast>check-circle <i-check-circle>check-square <i-check-square>check <i-check>
chevron-down <i-chevron-down>chevron-left <i-chevron-left>chevron-right <i-chevron-right>chevron-up <i-chevron-up>chevrons-down <i-chevrons-down>
chevrons-left <i-chevrons-left>chevrons-right <i-chevrons-right>chevrons-up <i-chevrons-up>chrome <i-chrome>circle <i-circle>
clipboard <i-clipboard>clock <i-clock>cloud-drizzle <i-cloud-drizzle>cloud-lightning <i-cloud-lightning>cloud-off <i-cloud-off>
cloud-rain <i-cloud-rain>cloud-snow <i-cloud-snow>cloud <i-cloud>code <i-code>codepen <i-codepen>
command <i-command>compass <i-compass>copy <i-copy>corner-down-left <i-corner-down-left>corner-down-right <i-corner-down-right>
corner-left-down <i-corner-left-down>corner-left-up <i-corner-left-up>corner-right-down <i-corner-right-down>corner-right-up <i-corner-right-up>corner-up-left <i-corner-up-left>
corner-up-right <i-corner-up-right>cpu <i-cpu>credit-card <i-credit-card>crop <i-crop>crosshair <i-crosshair>
database <i-database>delete <i-delete>disc <i-disc>dollar-sign <i-dollar-sign>download-cloud <i-download-cloud>
download <i-download>droplet <i-droplet>edit-2 <i-edit-2>edit-3 <i-edit-3>edit <i-edit>
external-link <i-external-link>eye-off <i-eye-off>eye <i-eye>facebook <i-facebook>fast-forward <i-fast-forward>
feather <i-feather>file-minus <i-file-minus>file-plus <i-file-plus>file-text <i-file-text>file <i-file>
film <i-film>filter <i-filter>flag <i-flag>folder-minus <i-folder-minus>folder-plus <i-folder-plus>
folder <i-folder>git-branch <i-git-branch>git-commit <i-git-commit>git-merge <i-git-merge>git-pull-request <i-git-pull-request>
github <i-github>gitlab <i-gitlab>globe <i-globe>grid <i-grid>hard-drive <i-hard-drive>
hash <i-hash>headphones <i-headphones>heart <i-heart>help-circle <i-help-circle>home <i-home>
image <i-image>inbox <i-inbox>info <i-info>instagram <i-instagram>italic <i-italic>
layers <i-layers>layout <i-layout>life-buoy <i-life-buoy>link-2 <i-link-2>link <i-link>
linkedin <i-linkedin>list <i-list>loader <i-loader>lock <i-lock>log-in <i-log-in>
log-out <i-log-out>mail <i-mail>map-pin <i-map-pin>map <i-map>maximize-2 <i-maximize-2>
maximize <i-maximize>menu <i-menu>message-circle <i-message-circle>message-square <i-message-square>mic-off <i-mic-off>
mic <i-mic>minimize-2 <i-minimize-2>minimize <i-minimize>minus-circle <i-minus-circle>minus-square <i-minus-square>
minus <i-minus>monitor <i-monitor>moon <i-moon>more-horizontal <i-more-horizontal>more-vertical <i-more-vertical>
move <i-move>music <i-music>navigation-2 <i-navigation-2>navigation <i-navigation>octagon <i-octagon>
package <i-package>paperclip <i-paperclip>pause-circle <i-pause-circle>pause <i-pause>percent <i-percent>
phone-call <i-phone-call>phone-forwarded <i-phone-forwarded>phone-incoming <i-phone-incoming>phone-missed <i-phone-missed>phone-off <i-phone-off>
phone-outgoing <i-phone-outgoing>phone <i-phone>pie-chart <i-pie-chart>play-circle <i-play-circle>play <i-play>
plus-circle <i-plus-circle>plus-square <i-plus-square>plus <i-plus>pocket <i-pocket>power <i-power>
printer <i-printer>radio <i-radio>refresh-ccw <i-refresh-ccw>refresh-cw <i-refresh-cw>repeat <i-repeat>
rewind <i-rewind>rotate-ccw <i-rotate-ccw>rotate-cw <i-rotate-cw>rss <i-rss>save <i-save>
scissors <i-scissors>search <i-search>send <i-send>server <i-server>settings <i-settings>
share-2 <i-share-2>share <i-share>shield-off <i-shield-off>shield <i-shield>shopping-bag <i-shopping-bag>
shopping-cart <i-shopping-cart>shuffle <i-shuffle>sidebar <i-sidebar>skip-back <i-skip-back>skip-forward <i-skip-forward>
slack <i-slack>slash <i-slash>sliders <i-sliders>smartphone <i-smartphone>speaker <i-speaker>
square <i-square>star <i-star>stop-circle <i-stop-circle>sun <i-sun>sunrise <i-sunrise>
sunset <i-sunset>tablet <i-tablet>tag <i-tag>target <i-target>terminal <i-terminal>
thermometer <i-thermometer>thumbs-down <i-thumbs-down>thumbs-up <i-thumbs-up>toggle-left <i-toggle-left>toggle-right <i-toggle-right>
trash-2 <i-trash-2>trash <i-trash>trending-down <i-trending-down>trending-up <i-trending-up>triangle <i-triangle>
truck <i-truck>tv <i-tv>twitter <i-twitter>type <i-type>umbrella <i-umbrella>
underline <i-underline>unlock <i-unlock>upload-cloud <i-upload-cloud>upload <i-upload>user-check <i-user-check>
user-minus <i-user-minus>user-plus <i-user-plus>user-x <i-user-x>user <i-user>users <i-users>
video-off <i-video-off>video <i-video>voicemail <i-voicemail>volume-1 <i-volume-1>volume-2 <i-volume-2>
volume-x <i-volume-x>volume <i-volume>watch <i-watch>wifi-off <i-wifi-off>wifi <i-wifi>
wind <i-wind>x-circle <i-x-circle>x-square <i-x-square>x <i-x>zap-off <i-zap-off>
zap <i-zap>zoom-in <i-zoom-in>zoom-out <i-zoom-out>

FAQ

...

License

MIT © Michael Bazos