sficons-svelte

Apple San Francisco Icons for Svelte

Note Remember to use dashes ("-") instead of periods (".") when referencing the icon names.

Installation

npm install @alexdev404/sficons-svelte

Usage

<script>
import SFIcon from "@alexdev404/sficons-svelte"
</script>

<SFIcon icon="video-circle-fill" />
<SFIcon rounded icon="video-circle-fill" />
<SFIcon rounded weight="ultralight" icon="video-circle-fill" />
<SFIcon rounded weight="ultralight" icon="video-circle-fill" color="#ff0000" />
<SFIcon rounded class="bg-gold" weight="ultralight" icon="video-circle-fill" color="#ff0000" size="2xl" />

`SFIcon` Properties

<SFIcon
  icon="video-circle-fill"
  class="bg-gold"
  size="2x"
  color="#ff0000"
  rounded={true | false}
  weight="bold"
/>

Searching for icons

There aren't really great ways of searching through this but you can totally use the code completion feature on VSCode to search for what you are looking for.

Or you can just use a web-based searching tool like andrewtavis/sf-symbols-online/ or hotpot.ai

Props and their corresponding descriptions

icon: icon from the SFIcons gallery
class: string values ${your preffered any css class}
size: string values xs, sm, lg or 2x, 3x, 4x, ..., 8x
weight: FontWeight Font weight of the icons. Possible values include:
- ultralight
- thin
- light
- regular
- medium
- semibold
- bold
- heavy
- black
color: string icon color, default currentColor. Note that only HEX color codes will be supported.
rounded: boolean Whether the icon should have rounded corners.