Repository files navigation

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

Bootstrap ·Themes ·Blog

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

For thoseusing Packagist, you can also install Bootstrap Icons via Composer:

composer require twbs/bootstrap-icons

Also available in Figma.

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.

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

git clone https://github.com/twbs/icons/cd iconsnpm inpm start

Then openhttp://localhost:4000 in your browser.

Here are some key scripts you'll use during development. Be sure to look to ourpackage.json ornpm run output for a complete list of scripts.

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 withfill (no stroke). Once a new SVG icon has been added to theicons directory, we use an npm script to:

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

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

Warning: Please exclude any auto-generated files, likefont/** andbootstrap-icons.svg from your branch because they cause conflicts, and we generally update the dist files before a release.

Documentation is published automatically when a new Git tag is published. See ourGitHub Actions andpackage.json for more information.

MIT

@mdo