@solar-icons/js
v2.3.3
Published
Vanilla JavaScript runtime DOM injection for Solar Icons
Maintainers
Readme
@solar-icons/js
Vanilla JavaScript DOM injection library for Solar Icons. This package provides 8,706 SVG icons across 6 styles (Bold, Broken, Linear, Outline, Bold Duotone, Line Duotone), optimized for environments without a virtual DOM.
Features
- 8,706 SVGs: 1,451 unique icons in 6 styles. Designed by 480 Design.
- Tree-shakeable: Import only the icons you use.
- Vanilla DOM injection: Injects SVG markup into elements based on their
data-solarattributes. - Global configuration: Override size, color, and stroke width globally via CSS variables (
--solar-color,--solar-size). - Duotone support: Secondary color controls for
bold-duotoneandline-duotonestyles. - Zero dependencies: String-based rendering.
Install
npm install @solar-icons/jsUsage
First, define placeholders in your HTML. The default attribute is data-solar.
<i data-solar="home-linear"></i> <i data-solar="login-bold"></i>Then, import the specific icons you need and initialize the library. The createIcons function will parse the data-solar attributes, convert them to pascal case, and match them against the provided icons object.
import { createIcons } from '@solar-icons/js'
import { HomeLinearIcon } from '@solar-icons/js/linear/home'
import { LoginBoldIcon } from '@solar-icons/js/bold/login'
createIcons({
icons: {
HomeLinearIcon,
LoginBoldIcon,
},
})Documentation
For installation guides, API reference, and a searchable icon catalog, visit the JS Documentation.
License
MIT License. Icons by 480 Design (CC BY 4.0).
