Source: https://lucide.dev/guide/packages/lucide-react

Skip to content

On this page

Lucide React ​

==============================================================================

React components for Lucide icons that integrate seamlessly into your React applications. Each icon is a fully-typed React component that renders as an optimized inline SVG, giving you the flexibility of components with the performance of vector graphics.

What you can accomplish:

• Import icons as React components with full TypeScript support
• Pass props to customize size, color, stroke width, and other SVG attributes
• Use icons in JSX with the same ease as any other React component
• Benefit from automatic tree-shaking to include only the icons you use
• Create dynamic icon components that respond to state and user interactions

Installation ​

---

pnpmyarnnpmbun

sh

pnpm add lucide-react

sh

yarn add lucide-react

sh

npm install lucide-react

sh

bun add lucide-react

How to use ​

---

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

Each icon can be imported as a React 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-react';

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

export default App;

Props ​

---

| 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 .

jsx

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

With Lucide lab or custom 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-react';
import { coconut } from '@lucide/lab';

const App = () => (
  <Icon iconNode={coconut} />
);

Dynamic Icon Component ​

---

It is possible to create one generic icon component to load icons. But it is not recommended, since it is importing all icons during the build. This increases build time and the different modules it will create.

DynamicIcon is useful for applications that want to show icons dynamically by icon name. For example, when using a content management system with where icon names are stored in a database.

For static use cases, it is recommended to import the icons directly.

The same props can be passed to adjust the icon appearance. The name prop is required to load the correct icon.

jsx

import { DynamicIcon } from 'lucide-react/dynamic';

const App = () => (
  <DynamicIcon name="camera" color="red" size={48} />
);