lucide-mui 0.0.1 → 0.263.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +13 -2
  2. package/package.json +8 -1
package/README.md CHANGED
@@ -1,5 +1,9 @@
1
+ <p align="center" dir="auto">
2
+ <img src="https://github.com/easyrent-club/lucide-mui/assets/39721828/1f05c0a2-040f-4e82-a6db-c41741f88fcb)" width="200" />
3
+ </p>
4
+
1
5
  # Lucide Icons for MUI
2
- 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.
6
+ 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.
3
7
 
4
8
  ## Installation
5
9
  You can use either npm or yarn:
@@ -35,4 +39,11 @@ They also support all props of the [`SvgIcon` Material UI component](https://mui
35
39
  ```
36
40
 
37
41
  ## Versioning
38
- This package follows the versioning of Lucide icons
42
+ We aim to keep the version in line with the corresponding version of `lucide`
43
+
44
+ ## FAQs
45
+ ### Whats the difference between this and lucide-react?
46
+ 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.
47
+
48
+ ### What icons are available?
49
+ 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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "lucide-mui",
3
- "version": "0.0.1",
3
+ "version": "0.263.0",
4
4
  "packageManager": "yarn@3.4.1",
5
5
  "sideEffects": false,
6
6
  "peerDependencies": {
@@ -8,6 +8,13 @@
8
8
  "react": "^17.0.0 || ^18.0.0",
9
9
  "react-dom": "^17.0.0 || ^18.0.0"
10
10
  },
11
+ "keywords": [
12
+ "lucide",
13
+ "react",
14
+ "icons",
15
+ "material-ui",
16
+ "mui"
17
+ ],
11
18
  "main": "cjs/index.js",
12
19
  "module": "esm/index.js",
13
20
  "types": "types/index.d.ts"