README.md

Svelte symbols

Include popular icons in your Svelte projects easily with Svelte-symbols.

Installation

npm install svelte-symbols --save
# or
yarn add svelte-symbols

How to use

<script>
   import FaBeer from "svelte-symbols/fa/FaBeer.svelte";
</script>

<FaBeer color="currentColor" size={24}/>

Props

Key	Default
color	currentColor
size	24px
class	undefined

Icons that can be used

Icon Library	License	Version	Count
Circum Icons	MPL-2.0 license	a2924cb1ee37b9fa39ef023a36f1c884b3492e9b	285
Font Awesome	CC BY 4.0 License	5.15.4	1612
Ionicons 4	MIT	4.6.3	696
Ionicons 5	MIT	5.5.0	1332
Material Design icons	Apache License Version 2.0	4.0.0-12-g63c5cb3060	3650
Typicons	CC BY-SA 3.0	2.1.2	336
Github Octicons icons	MIT	8.5.0	184
Feather	MIT	4.28.0	286
Game Icons	CC BY 3.0	12920d6565588f0512542a3cb0cdfd36a497f910	4040
Weather Icons	SIL OFL 1.1	2.0.12	219
Devicons	MIT	1.8.0	192
Ant Design Icons	MIT	4.2.1	789
Bootstrap Icons	MIT	1.5.0	1846
Remix Icon	Apache License Version 2.0	2.5.0	2271
Flat Color Icons	MIT	1.0.2	329
Grommet-Icons	Apache License Version 2.0	4.6.2	615
Heroicons	MIT	1.0.4	460
Heroicons 2	MIT	2.0.8	530
Simple Icons	CC0 1.0 Universal	5.16.0	2024
Simple Line Icons	MIT	2.5.5	189
IcoMoon Free	CC BY 4.0 License	d006795ede82361e1bac1ee76f215cf1dc51e4ca	491
BoxIcons	CC BY 4.0 License	2.0.9	757
css.gg	MIT	2.0.0	704
VS Code Icons	CC BY 4.0	0.0.23	383
Tabler Icons	MIT	1.68.0	1978
Themify Icons	MIT	v0.1.2	352
Radix Icons	MIT	@radix-ui/[email protected]	318

Contributing

Development

yarn
cd scripts

Preview

The preview site is the Svlete-symbols website, built in SvelteKit.

cd preview
npm i

This project is inspired by React-icons version 4.7.1