mirror of
https://github.com/lucide-icons/lucide.git
synced 2026-11-12 13:38:32 +00:00
* feat(packages): extract build logic to @lucide/shared, still wip * feat(): unify icon build logic some more, add nonScalingStroke option, marking absoluteStrokeWidth as deprecated * feat(): unify icon build logic some more, add nonScalingStroke option, marking absoluteStrokeWidth as deprecated * feat(packages): extract build logic to @lucide/shared, still wip * feat(): unify icon build logic some more, add nonScalingStroke option, marking absoluteStrokeWidth as deprecated * feat(): unify icon build logic some more, add nonScalingStroke option, marking absoluteStrokeWidth as deprecated * chore(icons): revert git hook changes made to icons * fix(packages/astro,react-native,vue): fix iconNode type fix(packages/vue): fix hasA11yProp * fix(packages/solid): make component reactive & add unit tests for checking prop changes * test(packages/vue): add reactivity tests to @lucide/vue * fix(packages): replace cpy-cli, accidentally removed during main merge * docs(packages): upgrade react documentation with nonScalingStroke * fix(tests): update snapshots for lucide-react * feat(docs): upgraded package guides with nonScalingStroke, dropping absoluteStrokeWidth * fix(vue,react-native): fix linting issues * fix(icons): add proper fallback for icon width in calculatedStrokeWidth * fix(packages/svelte): add globalProps.class to icons * fix(packages/shared): wrap width, height & size in isDefined * Update types.ts * fix(packages/svelte): do not pass propsClass to mergeClasses --------- Co-authored-by: Eric Fennis <eric.fennis@gmail.com>
162 lines
3.8 KiB
Markdown
162 lines
3.8 KiB
Markdown
---
|
|
title: Global Styling - React
|
|
description: Learn how to style all Lucide icons globally in your React application using CSS or the Lucide context provider.
|
|
---
|
|
<script setup>
|
|
import Sandpack from '~/.vitepress/theme/components/editors/Sandpack.vue';
|
|
</script>
|
|
|
|
# Global Styling
|
|
|
|
Adjusting icons can be done by using [color](../basics/color.md), [size](../basics/sizing.md) and [stroke width](../basics/stroke-width.md).
|
|
To style all icons globally, you can either use CSS, or use a context provider.
|
|
|
|
We recommend using CSS for global styling, as it is the most straightforward way to achieve this.
|
|
But using CSS prevents you from using props like `size`, `color` and `strokeWidth` on individual icons, since CSS specificity will override these props, to be able to use the props on individual ones you need to use the Lucide context provider.
|
|
|
|
## Context Provider
|
|
|
|
For global styling using a context provider, you can use the `LucideProvider` component that is provided by the `lucide-react` package.
|
|
|
|
<!-- TODO: Add codesandbox example -->
|
|
```tsx
|
|
import { LucideProvider, Home } from 'lucide-react';
|
|
|
|
const App = () => (
|
|
<LucideProvider
|
|
color="red"
|
|
size={48}
|
|
strokeWidth={2}
|
|
>
|
|
<Home />
|
|
</LucideProvider>
|
|
);
|
|
```
|
|
|
|
This will apply the `color`, `size` and `strokeWidth` props to all icons that are children of the `LucideProvider`.
|
|
|
|
|
|
## Style by using CSS
|
|
Styling icons is easy to accomplish using CSS.
|
|
|
|
Every icon has a class attribute applied called `lucide`. This class name can be used in the CSS file to target all icons that are being used within the app.
|
|
|
|
- The **color** of the icons can be changed using the [`color`](https://developer.mozilla.org/en-US/docs/Web/CSS/color) CSS property.
|
|
- The **size** of the icons can be changed using [`width`](https://developer.mozilla.org/en-US/docs/Web/CSS/width) and [`height`](https://developer.mozilla.org/en-US/docs/Web/CSS/height) CSS properties.
|
|
- The **stroke width** of the icons can be changed using the [`stroke-width`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width) CSS property.
|
|
|
|
::: sandpack {template=react editorHeight=300 dependencies="lucide-react"}
|
|
|
|
```css icon.css [active]
|
|
.lucide {
|
|
/* Change this! */
|
|
color: #ffadff;
|
|
width: 56px;
|
|
height: 56px;
|
|
stroke-width: 1px;
|
|
}
|
|
|
|
.app {
|
|
display: grid;
|
|
grid-template-columns: 1fr 1fr 1fr;
|
|
grid-template-rows: 1fr 1fr 1fr;
|
|
gap: 6px;
|
|
}
|
|
```
|
|
|
|
```jsx App.js
|
|
import {
|
|
CakeSlice,
|
|
Candy,
|
|
Apple,
|
|
Cookie,
|
|
Martini,
|
|
IceCream2,
|
|
Sandwich,
|
|
Wine,
|
|
Dessert,
|
|
} from "lucide-react";
|
|
import "./icon.css";
|
|
|
|
function App() {
|
|
return (
|
|
<div className="app">
|
|
<CakeSlice />
|
|
<Candy />
|
|
<Apple />
|
|
<Cookie />
|
|
<Martini />
|
|
<IceCream2 />
|
|
<Sandwich />
|
|
<Wine />
|
|
<Dessert />
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export default App;
|
|
```
|
|
|
|
:::
|
|
|
|
### Non-scaling strokes
|
|
|
|
For global non-scaling stroke width styling the `vector-effect: non-scaling-stroke` CSS property can be applied to the children. This will keep the stroke-width the same size no matter the size of the icon. See [non-scaling strokes](../basics/stroke-width.md#non-scaling-strokes) for more info.
|
|
|
|
::: sandpack {template=react editorHeight=300 dependencies="lucide-react"}
|
|
|
|
```css icon.css [active]
|
|
.lucide {
|
|
width: 48px;
|
|
height: 48px;
|
|
stroke-width: 1.5;
|
|
}
|
|
|
|
.lucide * {
|
|
vector-effect: non-scaling-stroke;
|
|
}
|
|
|
|
.app {
|
|
display: grid;
|
|
grid-template-columns: 1fr 1fr 1fr;
|
|
grid-template-rows: 1fr 1fr 1fr;
|
|
gap: 6px;
|
|
}
|
|
|
|
```
|
|
|
|
```jsx App.js
|
|
import {
|
|
TentTree,
|
|
Caravan,
|
|
FlameKindling,
|
|
MountainSnow,
|
|
Trees,
|
|
Axe,
|
|
Map,
|
|
CloudMoon,
|
|
Sparkles,
|
|
} from "lucide-react";
|
|
import "./icon.css";
|
|
|
|
function App() {
|
|
return (
|
|
<div className="app">
|
|
<TentTree />
|
|
<Caravan />
|
|
<FlameKindling />
|
|
<MountainSnow />
|
|
<Trees />
|
|
<Axe />
|
|
<Map />
|
|
<CloudMoon />
|
|
<Sparkles />
|
|
</div>
|
|
);
|
|
}
|
|
|
|
export default App;
|
|
```
|
|
|
|
:::
|