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;

With Dynamic Imports ​

⚠️ This is experimental and only works with bundlers that support dynamic imports.

Lucide react exports a dynamic import map dynamicIconImports. 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.

When using client side rendering, it will fetch the icon component when it's needed. This will reduce the initial bundle size.

The keys of the dynamic import map are the lucide original icon names (kebab case).

Example with React suspense:

import React, { lazy, Suspense } from 'react';
import { dynamicIconImports, LucideProps } from 'lucide-react';

const fallback = <div style={{ background: '#ddd', width: 24, height: 24 }}/>

interface IconProps extends Omit<LucideProps, 'ref'> {
  name: keyof typeof dynamicIconImports;
}

const Icon = ({ name, ...props }: IconProps) => {
  const LucideIcon = lazy(dynamicIconImports[name]);

  return (
    <Suspense fallback={fallback}>
      <LucideIcon {...props} />
    </Suspense>
  );
}

export default Icon

NextJS Example ​

In NextJS the dynamic function can be used to load the icon component dynamically.

import dynamic from 'next/dynamic'
import { dynamicIconImports, LucideProps } from 'lucide-react';

interface IconProps extends LucideProps {
  name: keyof typeof dynamicIconImports;
}

const Icon = ({ name, ...props }: IconProps) => {
  const LucideIcon = dynamic(dynamicIconImports[name])

  return <LucideIcon {...props} />;
};

export default Icon;