Files
lucide/packages/lucide-react
Eric Fennis cedf113b54 React package (#105)
* init new react package project

* setup react package

* Fix config for build

* update package

* Fix build

* update package

* fix package.json

* refactor and cleanup

* bumb beta version

* fix regex

* bump version

* Add hashing

* Add tests

* bump version

* Add peer dependecies

* Add docs

* Add readme link
2020-12-02 13:48:39 +01:00
..
2020-12-02 13:48:39 +01:00
2020-12-02 13:48:39 +01:00
2020-12-02 13:48:39 +01:00
2020-12-02 13:48:39 +01:00
2020-12-02 13:48:39 +01:00
2020-12-02 13:48:39 +01:00
2020-12-02 13:48:39 +01:00
2020-12-02 13:48:39 +01:00
2020-12-02 13:48:39 +01:00

Lucide React

Use the lucide icon library in you react app.

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

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;