sh

@amoutonbrady/solid-heroicons

Heroicons for Solid

Showing:

Popularity

Downloads/wk

139

GitHub Stars

8

Maintenance

Last Commit

3mos ago

Contributors

2

Package

Dependencies

1

Size (min+gzip)

0.5KB

License

MIT

Type Definitions

Built-In

Tree-Shakeable

Yes?

Categories

Readme

Solid Heroicons

Heroicons intergration for solid-js.

Demo

Installation

$ npm install @amoutonbrady/solid-heroicons
$ yarn add @amoutonbrady/solid-heroicons
$ pnpm add @amoutonbrady/solid-heroicons

Usage

You can import every icon from heroicons solid or outline from @amoutonbrady/solid-heroicons/solid and @amoutonbrady/solid-heroicons/outline respectively. They are exported as camel case. Everything exported from those packages are just an object with the SVG path and a metadata to know whether it's been exported from solid or outline. Those packages are generated automatically from the heroicon repo.

You can import the Icon component helper from @amoutonbrady/solid-heroicons. This is just a SVGElement wrapper that accepts any props a regular SVG would plus a special props path for the icon you want to load in.

By default the stroke | fill attribute of the SVG is set to currentColor which means you can give any color you want to the SVG by setting the css color attribute on SVG or any parent higher.

import { render } from 'solid-js/dom'
import { Icon } from '@amoutonbrady/solid-heroicons';
import { arrowLeft } from '@amoutonbrady/solid-heroicons/solid';
import { arrowRight } from '@amoutonbrady/solid-heroicons/outline';

const App = () => <>
    <Icon path={arrowLeft} />
    <Icon path={arrowRight} />
</>

render(() => App, document.getElementById('app'))

Troubleshoot

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial