docs/guide/packages/lucide-preact.md
Preact components for Lucide icons that provide React-like development experience with a smaller footprint. Each icon is a lightweight Preact component that renders as an inline SVG, perfect for applications that need React compatibility with minimal bundle size.
What you can accomplish:
::: code-group
pnpm add lucide-preact
yarn add lucide-preact
npm install lucide-preact
bun add lucide-preact
:::
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.
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;
| name | type | default |
|---|---|---|
size | number | 24 |
color | string | currentColor |
strokeWidth | number | 2 |
absoluteStrokeWidth | boolean | false |
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.
// 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-linejoinyou need to pass it in kebabcase. Basically how the SVG spec want you to write it. See this topic in the Preact documentation.
Lucide Lab is a collection of icons that are not part of the Lucide main library.
They can be used by using the Icon component.
All props like regular Lucide icons can be passed to adjust the icon appearance.
Icon componentThis creates a single icon based on the iconNode passed and renders a Lucide icon component.
import { Icon } from 'lucide-preact';
import { coconut } from '@lucide/lab';
const App = () => (
<Icon iconNode={coconut} />
);
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.
:::
import { icons } from 'lucide-preact';
const Icon = ({ name, color, size }) => {
const LucideIcon = icons[name];
return <LucideIcon color={color} size={size} />;
};
export default Icon;
import Icon from './Icon';
const App = () => {
return <Icon name="house" />;
};
export default App;
By default, we hide icons from screen readers using aria-hidden="true".
You can add accessibility attributes using aria-labels.
import { Check } from 'lucide-preact';
const App = () => {
return <Check aria-label="Task completed" />;
};
For best practices on accessibility, please see our accessibility guide.