Package Exports

lucide-react

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (lucide-react) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Lucide React

Implementation of the lucide icon library for react applications.

What is lucide? Read it here.

Installation

yarn add lucide-react

# or

npm install lucide-react

How to use

It's build with ESmodules so it's completely threeshakable. Each icon can be imported as a react component.

Example

You can pass additional props to adjust the icon.

import { Camera } from 'lucide-react';
// Returns ReactComponent

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

Custom props

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

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

One generic icon component

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

⚠️ Example below importing all EsModules, caution using this example, not recommended when you using bundlers, your application build size will grow strongly.

Icon Component Example

import * as icons from 'lucide-react';

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

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

export default Icon;