The lucide-react npm package is a collection of open-source icons for React applications. It provides a wide range of customizable SVG icons that can be easily integrated into React projects.

What are lucide-react's main functionalities?

Basic Icon Usage

This feature allows you to import and use a specific icon from the lucide-react package in your React application. The 'name' prop specifies which icon to render.

import { LucideIcon } from 'lucide-react';

function App() {
  return (
    <div>
      <LucideIcon name="home" />
    </div>
  );
}

Customizing Icon Size

You can customize the size of the icons by passing the 'size' prop. This example sets the icon size to 48 pixels.

import { LucideIcon } from 'lucide-react';

function App() {
  return (
    <div>
      <LucideIcon name="home" size={48} />
    </div>
  );
}

Customizing Icon Color

This feature allows you to change the color of the icons by passing the 'color' prop. In this example, the icon color is set to red.

import { LucideIcon } from 'lucide-react';

function App() {
  return (
    <div>
      <LucideIcon name="home" color="red" />
    </div>
  );
}

Other packages similar to lucide-react

Readme

Source

Lucide React

Implementation of the lucide icon library for react applications.

What is lucide? Read it here.

Installation

yarn add lucide-react

npm install lucide-react

How to use

It's built with ES modules so it's completely tree-shakable. Each icon can be imported as a react component.

Example

You can pass additional props to adjust the icon.

import { Camera } from 'lucide-react';

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

export default App;

Props

name	type	default
`size`	Number	24
`color`	String	currentColor
`strokeWidth`	Number	2

Custom props

You can also pass custom props that will be added in the svg as attributes.

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

Generic icon component

It is possible to create a generic icon component to load icons.

:warning: The example below is importing all ES modules. This is not recommended when you using a bundler since your application build size will grow substantially.

import * as icons from 'lucide-react';

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

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

export default Icon;

FAQs

What is lucide-react?

Is lucide-react popular?

Is lucide-react well maintained?

Package last updated on 12 Jun 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install