Files
lucide/docs/guide/packages/lucide-preact.md

127 lines
3.2 KiB
Markdown
Raw Normal View History

---
title: Lucide Preact
---
# Lucide Preact
Implementation of the lucide icon library for preact applications.
## Installation
::: code-group
```sh [pnpm]
pnpm install lucide-preact
```
```sh [yarn]
yarn add lucide-preact
```
```sh [npm]
npm install lucide-preact
```
```sh [bun]
bun add 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;
```
## Props
Introducing `absoluteStrokeWidth` option on Lucide Components (#939) * Add more music icons and another mic icon (#746) * Revert "Add more music icons and another mic icon (#746)" (#750) This reverts commit 57cba6ae0ecc5ecdf355858935e18e1eac175d69. * add scale Stroke width * Added scaleStrokeWidth prop to all packages * Add scaleStrokeWidth to types * Rename scaleStrokeWidth to absoluteStrokeWidth * Adds common API elements to the Angular package (#949) * Almost complete rewrite of the Angular package * Update tsconfig.spec.json * fixes icon build export file name * Updates Angular documentation with the new properties + provider injection * Update lucide-angular.md * refactored scaleStrokeWidth to be absoluteStrokeWidth to match other packages * removed codelyzer from devDeps + added flexible angular core dependencies * Deprecates createElement helper in favour of Renderer2 to support SSR --------- Co-authored-by: Karsa <karsa@karsa.org> * Add absoluteStrokeWidth in docs * update snapshots * Manual merge of main * Fixed incorrectly merged pnpm-lock.yaml * Fixes lucide-angular build * [lucide-angular] Global configuration for properties + bugfix for legacy icon provider (#1012) * Almost complete rewrite of the Angular package * Update tsconfig.spec.json * fixes icon build export file name * Updates Angular documentation with the new properties + provider injection * Update lucide-angular.md * refactored scaleStrokeWidth to be absoluteStrokeWidth to match other packages * removed codelyzer from devDeps + added flexible angular core dependencies * Deprecates createElement helper in favour of Renderer2 to support SSR * Added global configuration and fixed undefined bug in legacy icon provider. Also updated README.md * Replaces removed line in README.md * Fixes merge error * Updates export template to use the non-deprecated type * downgrade building to ng-cli@13 * downgrade to es2020 --------- Co-authored-by: Karsa <karsa@karsa.org> * rename scaleStrokeWidth to absoluteStrokeWidth in readme --------- Co-authored-by: it-is-not <72697755+it-is-not@users.noreply.github.com> Co-authored-by: Karsa <contact@karsa.org> Co-authored-by: Eric Fennis <eric@dreamteam.nl> Co-authored-by: Karsa <karsa@karsa.org> Co-authored-by: Eric Fennis <eric.fennis@nac41112.nedap.local>
2023-04-20 16:08:34 +02:00
| name | type | default |
| --------------------- | --------- | ------------ |
| `size` | *number* | 24 |
| `color` | *string* | currentColor |
| `strokeWidth` | *number* | 2 |
| `absoluteStrokeWidth` | *boolean* | false |
### 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](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/Presentation).
```jsx
// 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](https://preactjs.com/guide/v10/differences-to-react/#svg-inside-jsx).
## With Lucide lab or custom icons
[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.
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';
import { burger } from '@lucide/lab';
const App = () => (
<Icon iconNode={burger} />
);
```
## 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;
```
#### Using the Icon Component
```jsx
import Icon from './Icon';
const App = () => {
return <Icon name="home" />;
};
export default App;
```