lucide-mui

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #golang #deep-learning #nodejs #java #cli #awesome-list #security #ios #mcp #open-source

(★ 13)

Lucide Icon set, compatible with the Material UI System

lucide-mui Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Lucide Icons for MUI

[![npm](https://img.shields.io/npm/v/lucide-mui?color=blue)](https://www.npmjs.com/package/lucide-mui)
[![Types](https://img.shields.io/npm/types/lucide-mui.svg)](https://www.npmjs.com/package/lucide-mui)
[![Downloads](https://img.shields.io/npm/dt/lucide-mui.svg)](https://www.npmjs.com/package/lucide-mui)
[![GitHub](https://img.shields.io/github/license/lucide-icons/lucide)](https://lucide.dev/license)

This package provides [Lucide icons](https://lucide.dev/) as React components designed for use with [Material UI](https://mui.com/material-ui/), so that they can be used in the same way icons from `@mui/icons-material` are used.

## Installation
You can use either npm or yarn:

Using npm:

```bash
npm install lucide-mui
```
Using yarn:

```bash
yarn add lucide-mui
```
## Usage
`lucide-mui` is built with ES modules so it's completely tree-shakable. Each icon can be imported as a react component.

All icons can be imported using their names from the [Lucide documentation](https://lucide.dev/), converted to PascalCase.
For example, `arrow-left-circle` becomes `ArrowLeftCircle`
```jsx
import { ArrowLeftCircle } from 'lucide-mui';
```
You can then use these icons anywhere as you would material icons

```jsx
<Button startIcon={<ArrowLeftCircle/>}>Click me</Button>
```

They also support all props of the [`SvgIcon` Material UI component](https://mui.com/material-ui/api/svg-icon/):
```jsx
<ArrowLeftCircle color="primary" sx={{mx: 2}}/>
```

## Versioning
The version is automatically kept in sync with `lucide`

## Contributing
All contributions welcome. Contributions/requests for new/updated icons should be directed to the lucide project: https://github.com/lucide-icons/lucide

## FAQs
### Whats the difference between this and lucide-react?
Lucide-react provides React components, however these components don't integrate seamlessly with Material UI, requiring extra work to use them in place of material icons.

### What icons are available?
All lucide icons are available, and this package will be updated whenever new icons are added to lucide. This package is not intended to add any additional or custom icons.

lucide-mui

lucide-mui Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

lucide-mui

lucide-mui Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README