lucide-react
Advanced tools
Package description
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.
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>
);
}The react-icons package provides a comprehensive set of icons from various icon libraries such as Font Awesome, Material Design, and more. It offers a similar level of customization and ease of use as lucide-react, but with a broader selection of icon sets.
The @material-ui/icons package is a collection of Material Design icons for use with Material-UI components. It is specifically tailored for applications using Material-UI, offering seamless integration and consistent design language.
The @fortawesome/fontawesome-svg-core package is part of the Font Awesome icon library. It provides a wide range of icons and allows for extensive customization, including animation and layering. It is a robust alternative to lucide-react with a large community and extensive documentation.
Readme
Implementation of the lucide icon library for react applications.
What is lucide? Read it here.
yarn add lucide-react
or
npm install lucide-react
It's built with ES modules so it's completely tree-shakable. Each icon can be imported as a react component.
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;
| name | type | default |
|---|---|---|
size | Number | 24 |
color | String | currentColor |
strokeWidth | Number | 2 |
You can also pass custom props that will be added in the svg as attributes.
const App = () => {
return <Camera fill="red" />;
};
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
Unknown package
The npm package lucide-react receives a total of 894,313 weekly downloads. As such, lucide-react popularity was classified as popular.
We found that lucide-react demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
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.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.