mirror of
https://github.com/lucide-icons/lucide.git
synced 2026-11-12 13:38:32 +00:00
109 lines
2.8 KiB
Markdown
109 lines
2.8 KiB
Markdown
---
|
|||
|
|
description: Learn how to use SVG sprites with Lucide icons in your project, including basic usage and inline options.
|
||
|
|
---
|
||
|
|
<script setup>
|
||
|
|
import Sandpack from '~/.vitepress/theme/components/editors/Sandpack.vue'
|
||
|
|
</script>
|
||
|
|
# Using the SVG sprite
|
||
|
|
|
||
|
|
Learn how to use SVG sprites with Lucide icons in your project, including basic usage and inline options.
|
||
|
|
|
||
|
|
:::warning Not recommended for high traffic production use
|
||
|
|
The SVG sprite includes all icons, which can significantly increase your app's bundle size and load time. For production environments, we recommend using a bundler with tree-shaking support to include only the icons you actually use. Consider using one of the framework-specific [packages](../../packages.md).
|
||
|
|
:::
|
||
|
|
|
||
|
|
SVG sprites can be loaded as individual image, or used inline with the `<use>` element.
|
||
|
|
You may also need an additional SVG loader to handle node_modules imports in your project. Check out our [codesandbox example](https://codesandbox.io/s/using-the-svg-sprite-lz1kk) for a working example.
|
||
|
|
|
||
|
|
## Basic sprite usage
|
||
|
|
|
||
|
|
SVG sprites can be imported directory in img tags, and select the icon with <br>the `#{icon-name}` syntax:
|
||
|
|
|
||
|
|
```html
|
||
|
|
<img src="lucide-static/sprite.svg#house" />
|
||
|
|
```
|
||
|
|
|
||
|
|
## Inline usage
|
||
|
|
|
||
|
|
You can also use the sprite inline with the `<use>` element. This allows you to apply CSS styles directly to the SVG elements.
|
||
|
|
|
||
|
|
::: sandpack {template=vanilla showTabs=false editorHeight=480 editorWidthPercentage=60 dependencies="lucide-static"}
|
||
|
|
|
||
|
|
```html /index.html [active]
|
||
|
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<body>
|
||
|
|
<svg
|
||
|
|
width="24"
|
||
|
|
height="24"
|
||
|
|
fill="none"
|
||
|
|
stroke="currentColor"
|
||
|
|
stroke-width="2"
|
||
|
|
stroke-linecap="round"
|
||
|
|
stroke-linejoin="round"
|
||
|
|
>
|
||
|
|
<use href="#alarm-clock-check" />
|
||
|
|
</svg>
|
||
|
|
|
||
|
|
<div id="sprite" style="display: none;"></div>
|
||
|
|
|
||
|
|
<script src="index.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
```
|
||
|
|
|
||
|
|
```js /index.js
|
||
|
|
import "./styles.css";
|
||
|
|
import sprite from "lucide-static/sprite.svg";
|
||
|
|
|
||
|
|
document.getElementById('sprite').innerHTML = sprite;
|
||
|
|
```
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
## Inline with CSS helper class
|
||
|
|
|
||
|
|
If you'd prefer, you can use CSS to hold your base SVG properties:
|
||
|
|
|
||
|
|
::: sandpack {template=vanilla editorHeight=320 editorWidthPercentage=60 dependencies="lucide-static"}
|
||
|
|
|
||
|
|
```css /icon.css [active]
|
||
|
|
.lucide-icon {
|
||
|
|
width: 24px;
|
||
|
|
height: 24px;
|
||
|
|
stroke: currentColor;
|
||
|
|
fill: none;
|
||
|
|
stroke-width: 2;
|
||
|
|
stroke-linecap: round;
|
||
|
|
stroke-linejoin: round;
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
```html /index.html
|
||
|
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<body>
|
||
|
|
<svg
|
||
|
|
xmlns="http://www.w3.org/2000/svg"
|
||
|
|
class="lucide-icon"
|
||
|
|
>
|
||
|
|
<use href="#alarm-clock-check" />
|
||
|
|
</svg>
|
||
|
|
|
||
|
|
<div id="sprite" style="display: none;"></div>
|
||
|
|
|
||
|
|
<script src="index.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
```
|
||
|
|
|
||
|
|
```js /index.js
|
||
|
|
import "./styles.css";
|
||
|
|
import "./icon.css";
|
||
|
|
import sprite from "lucide-static/sprite.svg";
|
||
|
|
|
||
|
|
document.getElementById('sprite').innerHTML = sprite;
|
||
|
|
```
|
||
|
|
|
||
|
|
:::
|