Files

150 lines
4.1 KiB
Markdown
Raw Permalink Normal View History

2021-10-01 09:19:36 +02:00
---
title: Lucide Preact
---
# Lucide Preact
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:**
- Use icons as Preact components with React-like syntax and patterns
- Build lightweight applications with Preact's smaller runtime
- Create fast, responsive interfaces with minimal JavaScript overhead
- Maintain React compatibility while reducing bundle size
- Integrate with existing Preact applications and component libraries
2021-10-01 09:19:36 +02:00
## Installation
::: code-group
```sh [pnpm]
pnpm add lucide-preact
```
```sh [yarn]
2021-10-01 09:19:36 +02:00
yarn add lucide-preact
```
2021-10-01 09:19:36 +02:00
```sh [npm]
2021-10-01 09:19:36 +02:00
npm install lucide-preact
```
```sh [bun]
bun add lucide-preact
```
:::
2021-10-01 09:19:36 +02:00
## 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.
2021-10-01 09:19:36 +02:00
### Example
Additional props can be passed to adjust the icon:
2021-10-01 09:19:36 +02:00
```jsx
2021-10-01 09:19:36 +02:00
import { Camera } from 'lucide-preact';
// Usage
const App = () => {
return <Camera color="red" size={48} />;
2021-10-01 09:19:36 +02:00
};
export default App;
```
## Props
2021-10-01 09:19:36 +02:00
| name | type | default |
| --------------------- | --------- | ------------ |
| `size` | *number* | 24 |
| `color` | *string* | currentColor |
| `strokeWidth` | *number* | 2 |
| `absoluteStrokeWidth` | *boolean* | false |
2021-10-01 09:19:36 +02:00
### Applying props
2021-10-01 09:19:36 +02:00
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](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/Presentation).
2021-10-01 09:19:36 +02:00
```jsx
2021-10-01 09:19:36 +02:00
// Usage
const App = () => {
return <Camera fill="red" stroke-linejoin="bevel" />;
2021-10-01 09:19:36 +02:00
};
```
> 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](https://preactjs.com/guide/v10/differences-to-react/#svg-inside-jsx).
2021-10-01 09:19:36 +02:00
2026-03-20 17:04:28 +01:00
## With Lucide Lab or custom icons
2026-03-20 17:04:28 +01:00
[Lucide Lab](https://github.com/lucide-icons/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.
2026-03-20 17:04:28 +01:00
All props like regular Lucide icons can be passed to adjust the icon appearance.
### Using the `Icon` component
This creates a single icon based on the iconNode passed and renders a Lucide icon component.
```jsx
import { Icon } from 'lucide-preact';
2025-05-03 09:28:29 +02:00
import { coconut } from '@lucide/lab';
const App = () => (
2025-05-03 09:28:29 +02:00
<Icon iconNode={coconut} />
);
```
## One generic icon component
2021-10-01 09:19:36 +02:00
It is possible to create one generic icon component to load icons, but it is not recommended.
2021-10-01 09:19:36 +02:00
::: 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`.
:::
2021-10-01 09:19:36 +02:00
### Icon Component Example
2021-10-01 09:19:36 +02:00
```jsx
import { icons } from 'lucide-preact';
2021-10-01 09:19:36 +02:00
const Icon = ({ name, color, size }) => {
2021-10-01 09:19:36 +02:00
const LucideIcon = icons[name];
return <LucideIcon color={color} size={size} />;
2021-10-01 09:19:36 +02:00
};
export default Icon;
```
#### Using the Icon Component
```jsx
import Icon from './Icon';
const App = () => {
2025-05-03 09:28:29 +02:00
return <Icon name="house" />;
};
export default App;
```
## Accessibility
By default, we hide icons from screen readers using `aria-hidden="true"`.
You can add accessibility attributes using aria-labels.
```jsx
import { Check } from 'lucide-preact';
const App = () => {
return <Check aria-label="Task completed" />;
};
```
2026-03-20 17:04:28 +01:00
For best practices on accessibility, please see our [accessibility guide](../accessibility.md).