1299b163c7
* Tweak callout for icon link - no need to talk about `alt` for `<img>` since these don't use `<img>` - make start of sentence more readable * Tweak language of dropdown warning callout * Tweak popover warning callout * Tweak rtl warning callouts * Tweak color warning callout * Add/move accessibility callout for color to relevant pages * Update site/content/docs/5.3/helpers/icon-link.md * Update site/layouts/partials/callouts/warning-color-assistive-technologies.md Co-authored-by: Mark Otto <markd.otto@gmail.com>
2.4 KiB
| layout | title | description | group | aliases | toc | added |
|---|---|---|---|---|---|---|
| docs | Icon link | Quickly create stylized hyperlinks with Bootstrap Icons or other icons. | helpers | /docs/5.3/icon-link/ | true | 5.3 |
The icon link helper component modifies our default link styles to enhance their appearance and quickly align any pairing of icon and text. Alignment is set via inline flexbox styling and a default gap value. We stylize the underline with a custom offset and color. Icons are automatically sized to 1em to best match their associated text's font-size.
Icon links assume Bootstrap Icons are being used, but you can use any icon or image you like.
{{< callout >}}
When icons are purely decorative, they should be hidden from assistive technologies using aria-hidden="true", as we've done in our examples. For icons that convey meaning, provide an appropriate text alternative by adding role="img" and an appropriate aria-label="..." to the SVGs.
{{< /callout >}}
Example
Take a regular <a> element, add .icon-link, and insert an icon on either the left or right of your link text. The icon is automatically sized, placed, and colored.
{{< example >}} Icon link {{< /example >}}
{{< example >}} Icon link {{< /example >}}
Style on hover
Add .icon-link-hover to move the icon to the right on hover.
{{< example >}} Icon link {{< /example >}}
Customize the hover transform by overriding the --bs-icon-link-transform CSS variable:
{{< example >}} Icon link {{< /example >}}
Pairs with link utilities
Modify icon links with any of [our link utilities]({{< docsref "/utilities/link/" >}}) for modifying underline color and offset.
{{< example >}} Icon link {{< /example >}}