Nascent Plasticine Materialist
    Have ideas to improve npm?Join in the discussion! »

    bootstrap-icons

    1.5.0 • Public • Published

    Bootstrap logo

    Bootstrap Icons

    Official open source SVG icon library for Bootstrap with over 1,300 icons.
    Explore Bootstrap Icons »

    Bootstrap · Themes · Blog

    Bootstrap Icons preview

    Install

    Bootstrap Icons are packaged up and published to npm. We only include the processed SVGs in this package—it's up to you and your team to implement. Read our docs for usage instructions.

    npm i bootstrap-icons

    Also available in Figma.

    Usage

    Depending on your setup, you can include Bootstrap Icons in a handful of ways.

    • Copy-paste SVGs as embedded HTML
    • Reference via <img> element
    • Use the SVG sprite
    • Include via CSS

    See the docs for more information.

    Development

    Build Status

    Clone the repo, install dependencies, and start the Hugo server locally.

    git clone https://github.com/twbs/icons/
    cd icons
    npm i
    npm start

    Then open http://localhost:4000 in your browser.

    npm scripts

    Here are some key scripts you'll use during development. Be sure to look to our package.json for a complete list of scripts.

    Script Description
    start Alias for running docs-serve
    docs-serve Starts a local Hugo server
    pages Generates permalink pages for each icon with template Markdown
    icons Processes and optimizes SVGs in icons directory

    Adding SVGs

    Icons are typically only added by @mdo, but exceptions can be made. New glyphs are designed in Figma first on a 16x16px grid, then exported as flattened SVGs with fill (no stroke). Once a new SVG icon has been added to the icons directory, we use an npm script to:

    1. Optimize our SVGs with SVGO.
    2. Modify the SVGs source HTML, removing all attributes before setting new attributes and values in our preferred order.

    Use npm run icons to run the script, run npm run pages to build permalink pages, complete those pages, and, finally, commit the results in a new branch for updating.

    Publishing

    Documentation is published automatically when a new Git tag is published. See our GitHub Actions and package.json for more information.

    License

    MIT

    Author

    @mdo

    Install

    npm i bootstrap-icons

    DownloadsWeekly Downloads

    72,738

    Version

    1.5.0

    License

    MIT

    Unpacked Size

    1.97 MB

    Total Files

    1379

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar