Minor edits to react readme. (#520)

* Minor edits to react readme.

* Update packages/lucide-react/README.md

Co-authored-by: hornta <4553604+hornta@users.noreply.github.com>

Co-authored-by: hornta <4553604+hornta@users.noreply.github.com>
This commit is contained in:
Austin Gatlin
2022-03-10 12:49:44 +01:00
committed by GitHub
co-authored by hornta
parent a17c37e389
commit 2502207a1e
+4 -9
View File
@@ -16,7 +16,7 @@ npm install lucide-react
## How to use
It's build with ESmodules so it's completely threeshakable.
It's built with ES modules so it's completely threeshakable.
Each icon can be imported as a react component.
### Example
@@ -25,9 +25,7 @@ You can pass additional props to adjust the icon.
``` js
import { Camera } from 'lucide-react';
// Returns ReactComponent
// Usage
const App = () => {
return <Camera color="red" size={48}/>
};
@@ -48,19 +46,16 @@ export default App;
You can also pass custom props that will be added in the svg as attributes.
``` js
// Usage
const App = () => {
return <Camera fill="red"/>
};
```
### One generic icon component
### Generic icon component
It is possible to create one generic icon component to load icons.
It is possible to create a generic icon component to load icons.
> :warning: Example below importing all EsModules, caution using this example, not recommended when you using bundlers, your application build size will grow strongly.
#### Icon Component Example
> :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.
``` js
import * as icons from 'lucide-react';