0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-05 17:24:20 +01:00
Bootstrap/site/content/docs/4.3/extend/icons.md
Mark Otto 8d56c19b55
v5: Icons docs cleanup (#29450)
* Remove mention of icons from migration since they're not part of the core project

* Cleanup icons page to mention Bootstrap Icons
2019-10-18 11:06:12 -07:00

1.7 KiB

layout title description group
docs Icons Guidance and suggestions for using external icon libraries with Bootstrap. extend

While Bootstrap doesn't include an icon set by default, we do have our own comprehensive icon library called Bootstrap Icons. Feel free to use them or any other icon set in your project. We've included details for Bootstrap Icons and other preferred icon sets below.

While most icon sets include multiple file formats, we prefer SVG implementations for their improved accessibility and vector support.

Bootstrap Icons

Bootstrap Icons is a growing library of SVG icons that are designed by @mdo and maintained by the Bootstrap Team. The beginnings of this icon set come from Bootstrap's very own components—our forms, carousels, and more. Bootstrap has very few icon needs out of the box, so we didn't need much. However, once we got going, we couldn't stop making more.

Oh, and did we mention they're completely open source? Licensed under MIT, just like Bootstrap, our icon set is available to everyone.

Learn more about Bootstrap Icons, including how to install them and recommended usage.

Alternatives

We've tested and used these icon sets ourselves as preferred alternatives to Bootstrap Icons.

{{< markdown >}} {{< icons.inline >}} {{- $type := .Get "type" | default "preferred" -}}

{{- range (index .Site.Data.icons $type) }}

  • [{{ .name }}]({{ .website }}) {{- end }} {{< /icons.inline >}} {{< /markdown >}}

More options

While we haven't tried these out ourselves, they do look promising and provide multiple formats, including SVG.

{{< markdown >}} {{< icons.inline type="more" />}} {{< /markdown >}}