aboutsummaryrefslogtreecommitdiff
path: root/site/docs/4.4/utilities/image-replacement.md
diff options
context:
space:
mode:
authorXhmikosR <[email protected]>2019-11-26 19:12:00 +0200
committerGitHub <[email protected]>2019-11-26 19:12:00 +0200
commit593574d510050dc2d5eeafe70a58ae182f020480 (patch)
tree043a163d6c712121ca0fe1f34c419ab592b03185 /site/docs/4.4/utilities/image-replacement.md
parentd61bba584f89c7df0d780a9ff214a58f7b58cb94 (diff)
downloadbootstrap-4.4.0.tar.xz
bootstrap-4.4.0.zip
Release v4.4.0 (#29735)v4.4.0
Diffstat (limited to 'site/docs/4.4/utilities/image-replacement.md')
-rw-r--r--site/docs/4.4/utilities/image-replacement.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/site/docs/4.4/utilities/image-replacement.md b/site/docs/4.4/utilities/image-replacement.md
new file mode 100644
index 000000000..4c7decac5
--- /dev/null
+++ b/site/docs/4.4/utilities/image-replacement.md
@@ -0,0 +1,36 @@
+---
+layout: docs
+title: Image replacement
+description: Swap text for background images with the image replacement class.
+group: utilities
+---
+
+{% capture callout %}
+##### Warning
+
+The `text-hide()` class and mixin has been deprecated as of v4.1. It will be removed entirely in v5.
+{% endcapture %}
+{% include callout.html content=callout type="warning" %}
+
+Utilize the `.text-hide` class or mixin to help replace an element's text content with a background image.
+
+{% highlight html %}
+<h1 class="text-hide">Custom heading</h1>
+{% endhighlight %}
+
+{% highlight scss %}
+// Usage as a mixin
+.heading {
+ @include text-hide;
+}
+{% endhighlight %}
+
+Use the `.text-hide` class to maintain the accessibility and SEO benefits of heading tags, but want to utilize a `background-image` instead of text.
+
+<div class="bd-example">
+ <h1 class="text-hide" style="background-image: url('{{ site.baseurl }}/docs/{{ site.docs_version }}/assets/brand/bootstrap-solid.svg'); width: 50px; height: 50px;">Bootstrap</h1>
+</div>
+
+{% highlight html %}
+<h1 class="text-hide" style="background-image: url('...');">Bootstrap</h1>
+{% endhighlight %}