Lucide Qwik

An unofficial implementation of the lucide icon library for Qwik applications, continuing development from lucide-qwik to be up-to-date.

Installation

pnpm add lucide-icons-qwik

npm install lucide-icons-qwik

yarn add lucide-icons-qwik

bun add lucide-icons-qwik

Documentation

Include

You can import the icon(s) you need as usual:

import { ThumbsUp } from "lucide-icons-qwik";

or import them all at once:

import * as Icons from "lucide-icons-qwik";

export const App = component$(() => {
  return <div>
    <Icons.ThumbsUp />
    <Icons.BatteryCharging />
  </div>;
});

Props

Lucide Icon component have these optional props:

export interface IconProps extends QwikDOMAttributes {
  size?: number,            // default: 24
  color?: string,           // default: "currentColor"
  strokeWidth?: number,     // default: 2
  strokeLinecap?: "round" | "butt" | "square" | "inherit" | undefined,   // default: "round"
  strokeLinejoin?: "round" | "inherit" | "miter" | "bevel" | undefined   // default: "round"
}

Notice that IconProps extends QwikDOMAttributes so Icon component also have attributes like class, onClick$, key, etc.

Community

Lucide Discord server Join the Luminescent Discord server for support for this unofficial package

License

Lucide is licensed under the ISC license. See LICENSE. This library is licensed under MIT License.