Getting started

Install

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

WARNING

To make this library work you need to install also Sparkle Icons.

NPM

Install Sparkle with npm.

# Install Sparkle, Sparkle Icons
npm install @sparkleui/sparkle @sparkleui/icons

Download

Download the release from GitHub.

Download latest release

CDN

Include the library in your website from jsDelivr.

CSS

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

JS

<script src="https://cdn.jsdelivr.net/npm/@sparkleui/sparkle/dist/sparkle.umd.cjs"></script>

Import

1. Import Sparkle's CSS.

css

@import url('@sparkleui/sparkle/css');

scss

// Import the compiled version
@import '@sparkleui/sparkle/css';

// or the source version
@import '@sparkleui/sparkle/scss';

js

import '@sparkleui/sparkle/css';

TIP

You can also import the stylesheets individually if you want. Read Advanced Usage for details.

2. Load the CSS and import Sparkle's JS.

// Import Sparkle Icons
import '@sparkleui/icons';

// Import your custom CSS
import './style.scss';

// Import all Sparkle's JS
import * as sparkleUi from '@sparkleui/sparkle';

TIP

You can also import the components individually if you want. Read Advanced Usage for details.