Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.5 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.5 KB
Raw

Heroicons Heroicons

Qwik implementation of heroicons - Browse at Heroicons.com →

This is an implementation of Heroicons in the Qwik framework.

Both icon styles are preconfigured to be stylable by setting the color CSS property, either manually or using utility classes like text-gray-500 in a framework like Tailwind CSS.

Quick start

Install heroicons-qwik from npm:

npm install heroicons-qwik

Now each icon can be imported individually as a Qwik component:

import { component$ } from "@builder.io/qwik";
import { BeakerIcon } from "heroicons-qwik/24/solid";

export default component$(() => {
  return (
    <div>
      <BeakerIcon className="h-6 w-6 text-blue-500" />
      <p>...</p>
    </div>
  );
});

The 24x24 outline icons can be imported from heroicons-qwik/24/outline, the 24x24 solid icons can be imported from heroicons-qwik/24/solid, and the 20x20 solid icons can be imported from heroicons-qwik/20/solid.

Icons use an upper camel case naming convention and are always suffixed with the word Icon.

License

This library is MIT licensed.