icons/icons-1.8.0/docs/content/_index.md

In valentin-schwind/studydesignplanner: StudyDesignPlanner

---

Install

Bootstrap Icons are published to npm, but they can also be manually downloaded if needed.

{{< md >}} ### npm Install [Bootstrap Icons](https://www.npmjs.com/package/bootstrap-icons)—including SVGs, icon sprite, and icon fonts—with npm. Then, choose how you'd like to include the icons with the [usage instructions](#usage). {{< highlight sh >}} npm i bootstrap-icons {{< /highlight >}} {{< /md >}}

{{< md >}} ### Download [Releases are published on GitHub](https://github.com/twbs/icons/releases/) and include icon SVGs, fonts, license, and readme. Our `package.json` is also included, though our npm scripts are primarily available for our development workflows. Download latest ZIP {{< /md >}}

{{< md >}} ### CDN Include the icon fonts stylesheet—in your website `` or via `@import` in CSS—from our CDN and get started in seconds. [See icon font docs](#icon-font) for examples. {{< highlight html >}} {{< /highlight >}} {{< highlight css >}} @import url("https://cdn.jsdelivr.net/npm/bootstrap-icons@{{< param version >}}/font/bootstrap-icons.css"); {{< /highlight >}} {{< /md >}}

Usage

Bootstrap Icons are SVGs, so you can include them into your HTML in a few ways depending on how your project is setup. We recommend using a width: 1em (and optionally height: 1em) for easy resizing via font-size.

{{< md >}} ### Embedded Embed your icons within the HTML of your page (as opposed to an external image file). Here we've used a custom `width` and `height`. {{< /md >}}

{{< example >}}{{< /example >}}

{{< md >}} ### Sprite Use the SVG sprite to insert any icon through the `` element. Use the icon's filename as the fragment identifier (e.g., `toggles` is `#toggles`). SVG sprites allow you to reference an external file similar to an `` element, but with the power of `currentColor` for easy theming. **Heads up!** There's an issue with Chrome where [`` doesn't work across domains](https://bugs.chromium.org/p/chromium/issues/detail?id=470601). {{< /md >}}

{{< example >}} {{< /example >}}

{{< md >}} ### External image Copy the Bootstrap Icons SVGs to your directory of choice and reference them like normal images with the `` element. {{< /md >}}

{{< example >}}{{< /example >}}

{{< md >}} ### Icon font Icon fonts with classes for every icon are also included for Bootstrap Icons. Include the icon web fonts in your page via CSS, then reference the class names as needed in your HTML (e.g., ``). Use `font-size` and `color` to change the icon appearance. {{< /md >}}

{{< example >}}{{< /example >}} {{< example >}}{{< /example >}}

{{< md >}} ### CSS You can also use the SVG within your CSS (**be sure to escape any characters**, such as `#` to `%23` when specifying hex color values). When no dimensions are specified via `width` and `height` on the ``, the icon will fill the available space. The `viewBox` attribute is required if you wish to resize icons with `background-size`. Note that the `xmlns` attribute is required. {{< /md >}}

{{< highlight css >}} .bi::before { display: inline-block; content: ""; vertical-align: -.125em; background-image: url("data:image/svg+xml,"); background-repeat: no-repeat; background-size: 1rem 1rem; } {{< /highlight >}}

{{< md >}} ## Styling Color can be changed by setting a `.text-*` class or custom CSS: {{< /md >}}

{{< highlight html >}} ... {{< /highlight >}}

{{< md >}} ## Accessibility For purely decorative icons, add `aria-hidden="true"`. Otherwise, provide an appropriate text alternative. Depending on which method you're using to add the icons, and where you're using them (e.g. as standalone images, or as the only content of a button or similar control), there are various possible approaches. Here are a few examples: {{< /md >}}

{{< highlight html >}} {{< /highlight >}}

{{< highlight html >}} {{< /highlight >}}

{{< highlight html >}} {{< /highlight >}}

{{< highlight html >}} ... {{< /highlight >}}

{{< md >}} ## Working with SVGs SVGs are awesome to work with, but they do have some known quirks to work around. Given the numerous ways in which SVGs can be used, we haven't included these attributes and workarounds in our code. {{< /md >}}

{{< md >}} Known issues include: - **SVGs receive focus by default in Internet Explorer and Edge Legacy.** When embedding your SVGs, add `focusable="false"` to the `` element. [Learn more on Stack Overflow.](https://stackoverflow.com/questions/18646111/disable-onfocus-event-for-svg-element) - **When using SVGs with `` elements, screen readers may not announce them as images, or skip the image completely.** Include an additional `role="img"` on the `` element to avoid any issues. [See this article for details.](https://simplyaccessible.com/article/7-solutions-svgs/#acc-heading-2) - **External SVG sprites may not function correctly in Internet Explorer.** Use the [svg4everybody](https://github.com/jonathantneal/svg4everybody) polyfill as needed. Found another issue with SVGs we should note? Please open [an issue]({{< param repo >}}/issues) to share details. {{< /md >}}

valentin-schwind/studydesignplanner documentation built on Jan. 31, 2024, 5:11 p.m.