1.3.0-alpha.0 • Published 3 years ago

@icon/bootstrap-icons v1.3.0-alpha.0

Weekly downloads
149
License
MIT
Repository
github
Last release
3 years ago

@icon/bootstrap-icons

npm version

This repository is a module of the full standard-icons repository.

Install

This repository is distributed with npm. After installing npm, you can install @icon/bootstrap-icons with this command.

npm install --save @icon/bootstrap-icons

Usage

There are many ways/formats of how to use bootstrap-icons. The fastest and recommended way is via SVG directly. Or use the webfont version if you want to include all icons at once:

SVG icons -- when you need just a few icons in your project

1 . If you want to use just a few icons. Find the icons you need in "icons" folder. Then use them as regular images:

<img height="32" width="32" src="@icon/bootstrap-icons/icons/airplane.svg" />

2 . Icons can be served from a CDN such as Unpkg. Simply use the @icon/bootstrap-icons npm package in the URL like the following:

<img height="32" width="32" src="https://unpkg.com/@icon/bootstrap-icons/icons/airplane.svg" />

Icons font -- ideal when you want to include all icons at once

1 . Install @icon/bootstrap-icons with this command. In the <head> of your html, reference the location to your bootstrap-icons.css.

<head>
...
<link rel="stylesheet" href="@icon/bootstrap-icons/bootstrap-icons.css">
...
</head>

2 . Use unpkg.com to load directly bootstrap-icons without installing anything:

<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/bootstrap-icons/bootstrap-icons.css">
...
</head>

Place bootstrap-icons with <i> tag in your html like this. Icon class names are to be used with the bi class prefix.

<i class="bi bi-airplane"></i>

Bugs, Ideas, Pull Requests

If you have any ideas or found bugs, please send me Pull Requests or let me know with GitHub Issues.

License

bootstrap-icons is copyright by mdo, licensed under the MIT.