Lucide Preact ​

Implementation of the lucide icon library for preact applications.

Installation ​

pnpm install lucide-preact

yarn add lucide-preact

npm install lucide-preact

How to use ​

It's build with ES Modules so it's completely tree-shakable.

Each icon can be imported as a Preact component, what renders a inline SVG Element. This way only the icons that are imported into your project are included in the final bundle. The rest of the icons are tree-shaken away.

Example ​

Additional props can be passed to adjust the icon:

import { Camera } from 'lucide-preact';

// Usage
const App = () => {
  return <Camera color="red" size={48} />;
};

export default App;

Props ​

Applying props ​

To apply custom props to change the look of the icon, this can be done by simply pass them as props to the component. All SVG attributes are available as props to style the SVGs. See the list of SVG Presentation Attributes on MDN.

// Usage
const App = () => {
  return <Camera fill="red" stroke-linejoin="bevel" />;
};

SVG attributes in Preact aren't transformed, so if you want to change for example the stroke-linejoin you need to pass it in kebabcase. Basically how the SVG spec want you to write it. See this topic in the Preact documentation.

One generic icon component ​

It is possible to create one generic icon component to load icons. It's not recommended.

Icon Component Example ​

import { icons } from 'lucide-preact';

const Icon = ({ name, color, size }) => {
  const LucideIcon = icons[name];

  return <LucideIcon color={color} size={size} />;
};

export default Icon;

Using the Icon Component ​

import Icon from './Icon';

const App = () => {
  return <Icon name="home" />;
};

export default App;