JavaScript API

Overview

The SDK exposes a global window.IconSDK object with useful methods.

Check if an icon exists in your project.

IconSDK.hasIcon('home') // → true
IconSDK.hasIcon('nonexistent') // → false

Get list of all available icons.

const icons = IconSDK.getAvailableIcons()
// → ['home', 'search', 'user', ...]

Preload icons for better performance.

await IconSDK.preload('home')  // Single icon
await IconSDK.preload(['home', 'search', 'user'])  // Multiple icons

Preload icons that appear above the fold for instant display.

Use cases:

Manually load a specific icon element.

const element = document.querySelector('[data-icon="home"]')
await IconSDK.load(element)

Clear the in-memory icon cache.

IconSDK.clearCache()

When to use:

Force refresh the SDK script (useful for development).

IconSDK.reload()

This will reload the entire SDK. Use only when needed.

Manually initialize all icons on the page.

IconSDK.init()

Note: This is called automatically on page load. Only use if you need to re-scan the DOM.

Control the MutationObserver.

// Stop watching for new icons
IconSDK.stopObserver()

// Resume watching
IconSDK.startObserver()

Use cases:

Get the SDK version.

console.log(IconSDK.version)  // → "1.0.0"

Access the internal icons map.

console.log(IconSDK.icons)
// → { "home": "https://cdn.icon.dev/...", ... }

Access the internal cache.

console.log(IconSDK.cache)
// → Map { "home" => "<svg>...</svg>", ... }