Skip to content

kiki-club/lucide-mui

Repository files navigation

Lucide Icons for MUI

This package provides Lucide icons as React components designed for use with 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:

npm install lucide-mui

Using yarn:

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, converted to PascalCase. For example, arrow-left-circle becomes ArrowLeftCircle

import { ArrowLeftCircle } from 'lucide-mui';

You can then use these icons anywhere as you would material icons

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

They also support all props of the SvgIcon Material UI component:

<ArrowLeftCircle color="primary" sx={{mx: 2}}/>

Versioning

The version is automatically ke