lucide-static

    0.16.19-rc.0 • Public • Published

    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.

    ⚠️ 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

    Package Managers

    yarn add lucide-static
    
    # or
    
    npm install lucide-static

    CDN

    <!-- Svg File -->
    <img src="https://unpkg.com/lucide-static@latest/icons/home.svg">
    
    <!-- Icon Font -->
    <style>
      @font-face {
        font-family: "LucideIcons";
        src: url(https://unpkg.com/lucide-static@latest/font/Lucide.ttf) format("truetype");
      }
    </style>

    Usage

    Checkout the codesandbox examples.

    SVG Files

    Svg file as image

    To use it in for example html:

    <!-- Svg File -->
    <img src="~lucide-static/icons/home.svg">
    .home-icon {
      background-image: url(~lucide-static/icons/home.svg)
    }

    Make sure you have the correct webpack loaders to make this work. url-loader

    Svg file Inline

    You can simply import each svg by targeting lucide-static/icons/{icon-name}.svg. To use svgs in your project you can for example use a svg loader.

    import arrowRightIcon from 'lucide-static/icons/arrow-right'
    
    // return string of a svg

    SVG Sprite

    You may need additional loader for this.

    <!-- Icon Sprite, not recommended for production! -->
    <img src="lucide-static/sprite.svg#home">
    
    <!-- or -->
    <svg
      width="24"
      height="24"
      fill="none"
      stroke="currentColor"
      stroke-width="2"
      stroke-linecap="round"
      stroke-linejoin="round"
    >
      <use href="#alert-triangle" />
    </svg>
    
    <svg>
      ...sprite svg
    </svg>

    If you'd prefer, you can use CSS to hold your base SVG properties

    .lucide-icon {
        width: 24px;
        height: 24px;
        stroke: currentColor;
        fill: none;
        stroke-width: 2;
        stroke-linecap: round;
        stroke-linejoin: round;
    }

    and update the svg as follows

    <svg
      xmlns="http://www.w3.org/2000/svg"
      class="lucide-icon"
    >
    <use
        href="#alert-triangle"
      />
    </svg>
    <svg>
      ...sprite svg
    </svg>

    Icon Font

    @import("~lucide-static/font/Lucide.css")
    <div class="icon-home"></div>

    Node.js

    To use lucide icons in your Nodejs project you can import each icon as:

    const { messageSquare } = require('lucide-static/lib')

    Note: Each icon name is in camelCase.

    Example in node.js project

    const express = require('express')
    const { messageSquare } = require('lucide-static/lib')
    const app = express()
    const port = 3000
    
    app.get('/', (req, res) => {
      res.send(`
        <!DOCTYPE html>
        <html>
          <head>
            <title>Page Title</title>
          </head>
          <body>
            <h1>Lucide Icons</h1>
            <p>This is a lucide icon ${messageSquare}</p>
    
          </body>
        </html>
      `)
    })
    
    app.listen(port, () => {
      console.log(`Example app listening at http://localhost:${port}`)
    })

    Contributing

    For more info on how to contribute please see the contribution guidelines.

    Caught a mistake or want to contribute to the documentation? Edit this page on Github

    Community

    Join the community on our Discord server!

    License

    Lucide is totally free for commercial use and personally use, this software is licensed under the ISC License.

    Keywords

    none

    Install

    npm i lucide-static

    Homepage

    lucide.dev/

    DownloadsWeekly Downloads

    1,200

    Version

    0.16.19-rc.0

    License

    ISC

    Unpacked Size

    3.46 MB

    Total Files

    1045

    Last publish

    Collaborators

    • ericfennis