Lucide

Appearance

Lucide Preact ​

Implementation of the lucide icon library for preact applications.

Installation ​

sh
pnpm install lucide-preact
pnpm install lucide-preact
sh
yarn add lucide-preact
yarn add lucide-preact
sh
npm install lucide-preact
npm install lucide-preact

How to use ​

Lucide is built with ES Modules, so it's completely tree-shakable.

Each icon can be imported as a Preact component, which renders an 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:

jsx
import { Camera } from 'lucide-preact';

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

export default App;
import { Camera } from 'lucide-preact';

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

export default App;

Props ​

nametypedefault
sizenumber24
colorstringcurrentColor
strokeWidthnumber2
absoluteStrokeWidthbooleanfalse

Applying props ​

To customize the appearance of an icon, you can pass custom properties as props directly to the component. The component accepts all SVG attributes as props, which allows flexible styling of the SVG elements. See the list of SVG Presentation Attributes on MDN.

jsx
// Usage
const App = () => {
  return <Camera fill="red" stroke-linejoin="bevel" />;
};
// 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, but it is not recommended.

DANGER

The example below imports all ES Modules, so exercise caution when using it. Importing all icons will significantly increase the build size of the application, negatively affecting its performance. This is especially important when using bundlers like Webpack, Rollup, or Vite.

Icon Component Example ​

jsx
import { icons } from 'lucide-preact';

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

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

export default Icon;
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 ​

jsx
import Icon from './Icon';

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

export default App;
import Icon from './Icon';

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

export default App;