dimfeld / svelte-awesome

Awesome SVG icon component for Svelte JS, built with Font Awesome icons. Based on Justineo/vue-awesome

Home Page:https://robbrazier.github.io/svelte-awesome/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Svelte-Awesome

Semaphore CI npm bundlephobia Code Climate PRs Welcome

Awesome SVG icon component for Svelte JS, built with Font Awesome icons. Based on Justineo/vue-awesome

Svelte-Awesome supports Font-Awesome v4.7.0 (icons inbuilt) and v5 (via @fortawesome npm packages)

A demo is available here

Installation

NPM

$ npm install --save svelte-awesome

Usage

<!-- basic -->
<Icon data={beer}/>

<!-- with options -->
<Icon data={refresh} scale="2"/>
<Icon data={comment} flip="horizontal"/>
<Icon data={codeFork} label="Forked Repository"/>

<!-- stacked icons [WIP] -->
<Icon label="No Photos">
  <Icon data={camera}/>
  <Icon name={ban} scale="2" class="alert"/>
</Icon>

<!-- FontAwesome v5 Icons!! -->
<Icon data={faThumbsUp}/>

<script>
  import Icon from 'svelte-awesome';
  import { beer, refresh, comment, codeFork, camera, ban } from 'svelte-awesome/icons';
  import { faThumbsUp } from '@fortawesome/free-regular-svg-icons';
</script>

Sapper Usage

For Sapper, you may need to import the Icon component explicitly as below:

import Icon from 'svelte-awesome/components/Icon.svelte'

About

Awesome SVG icon component for Svelte JS, built with Font Awesome icons. Based on Justineo/vue-awesome

https://robbrazier.github.io/svelte-awesome/

License:MIT License


Languages

Language:JavaScript 79.1%Language:HTML 20.3%Language:Shell 0.6%