Getting started

Install

Sparkle Icons are published to NPM, but they can also be manually downloaded if needed.

NPM

Install Sparkle Icons with npm.

npm install @sparkleui/icons

Download

Download the release from GitHub.

Download latest release

CDN

Include the library in your website from jsDelivr.

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@sparkleui/icons/dist/sparkle-icons.min.css" />

Import

css

@import url('@sparkleui/icons');

scss

@import '@sparkleui/icons';

js

import '@sparkleui/icons';

Usage

Sparkle Icons are SVGs, so you can include them into your HTML in a few ways.

Icon font

Sparkle Icons includes a class for every icons. Include the icon web fonts in your page via CSS, then reference the class names as needed in your HTML.

Use font-size and color to change the icon appearance.

<i class="si-icon-sparkle"></i>

CSS

Add the icon trough CSS, using pseudo elements (::before and ::after).

.foo::before {
    content: '\f164';
    font-family: 'sparkle-icons';
}