Back to Lucide

Lucide Static

packages/lucide-static/README.md

1.14.04.0 KB
Original Source
<p align="center"> <a href="https://github.com/lucide-icons/lucide"> </a> </p> <p align="center"> Lucide icon library with static assets for web applications. </p> <div align="center">

</div> <p align="center"> <a href="https://lucide.dev/guide/">About</a> ยท <a href="https://lucide.dev/icons/">Icons</a> ยท <a href="https://lucide.dev/guide/static">Documentation</a> ยท <a href="https://lucide.dev/license">License</a> </p>

Lucide Static

This package include the following Lucide implementations:

  • All svg files
  • Javascript library containing strings of svgs.
  • Icon fonts
  • Svg sprite

What is lucide? Read it here.

Why lucide-static?

This package is suitable for very specific use cases for example if you want to use icon fonts, svg sprites, normal svgs or Common.js Svg strings in your javascript project.

[!WARNING] It is not recommended to use this package for svg sprites or icon fonts for web pages/applications, for prototyping it is ok. We recommend to bundlers for web applications to make sure you only bundle the used icons from this icon library (Threeshaking). Otherwise it will load all the icons, making you webpage loading slower. Threeshaking is only available in the packages: lucide, lucide-react, lucide-vue, lucide-vue-next, lucide-angular, lucide-preact

Installation

sh
pnpm add lucide-static
sh
npm install lucide-static
sh
yarn add lucide-static
sh
bun add lucide-static

Documentation

For full documentation, visit lucide.dev

Community

Join the Discord server to chat with the maintainers and other users.

License

Lucide is licensed under the ISC license. See LICENSE.

Sponsors

<a href="https://vercel.com?utm_source=lucide&utm_campaign=oss"> </a>

<a href="https://www.digitalocean.com/?refcode=b0877a2caebd&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge"></a>

Hero backers ๐Ÿฆธ

<a href="https://https://zephyr-cloud.io/"></a>

Awesome backers ๐Ÿบ

<a href="https://github.com/pdfme/pdfme"></a> <a href="https://www.paxhistoria.co/"></a>

Backers โ˜•

<a href="https://www.fina.money/"></a>

Other contributors ๐Ÿ’ธ

You can find all our past and non-recurring financial contributors at our Open Collective page.