svelte-awesome

Svelte-Awesome

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

A list of all available embedded icons is available here

Installation

NPM

npm install --save svelte-awesome

Usage

<!-- basic -->
<Icon data={beer}/>
<!-- codeFork is camelCase, unlike the js file, code-fork.js -->
<Icon data={codeFork}/>


<!-- 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 { refresh, comment, codeFork, camera, ban } from 'svelte-awesome/icons';
  import beer from 'svelte-awesome/icons/beer'; // alternative, more efficient import
  import { faThumbsUp } from '@fortawesome/free-regular-svg-icons';

  // EDGECASE ICONS
  import fa500px from 'svelte-awesome/icons/fa500px'; // '500px' icon
  import faTry from 'svelte-awesome/icons/faTry'; // 'try' icon
</script>

Sapper Usage

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

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

Contributors

• dimfeld
• lucasnad27

Changelog

v3.0.0 - 2022-05-03

Merged

• BREAKING: restructure icon names and files to be more consistent and add icons index page #877
• chore(deps-dev): bump svelte-highlight from 5.2.2 to 6.0.1 #853
• chore(deps-dev): bump @sveltejs/kit from 1.0.0-next.295 to 1.0.0-next.324 #864
• chore(deps-dev): bump svelte-check from 2.4.5 to 2.4.6 #857
• chore(deps-dev): bump gh-release from 6.0.1 to 6.0.3 #855
• chore(deps): bump minimist from 1.2.5 to 1.2.6 #856
• chore(deps-dev): bump svelte from 3.46.4 to 3.46.6 #852
• chore(deps-dev): bump @typescript-eslint/parser from 5.13.0 to 5.17.0 #851

Commits

• fix example after highlight.js upgrade 3ad7b8f