Lucide React ​

Implementation of the lucide icon library for react applications

Installation ​

pnpm install lucide-react

yarn add lucide-react

npm install lucide-react

How to use ​

It's build with ES Modules so it's completely tree-shakable.

Each icon can be imported as a React component, what renders a 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:

import { Camera } from 'lucide-react';

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

export default App;

Props ​

Applying props ​

To apply custom props to change the look of the icon, this can be done by simply pass them as props to the component. All SVG attributes are available as props to style the SVGs. See the list of SVG Presentation Attributes on MDN.

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

One generic icon component ​

It is possible to create one generic icon component to load icons. It's not recommended.

Icon Component Example ​

import { icons } from 'lucide-react';

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

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

export default Icon;

Using the Icon Component ​

import Icon from './Icon';

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

export default App;