aboutsummaryrefslogtreecommitdiff
path: root/site/docs/4.3/utilities/image-replacement.md
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2019-02-11 11:15:34 -0800
committerGitHub <[email protected]>2019-02-11 11:15:34 -0800
commit1ded0d6a4eefb7daca62c44e4e735aec200f0b6f (patch)
treee0036e5068cfb8e2c17971c4e892bd6b502dda9a /site/docs/4.3/utilities/image-replacement.md
parent3aa0770b711f69c4dcf5858b8913794e81b32d80 (diff)
downloadbootstrap-4.3.0.tar.xz
bootstrap-4.3.0.zip
Release v4.3.0 (#28228)v4.3.0
* Prep for v4.3.0 * More updates for v4.3.0. * rerun to build docs source map
Diffstat (limited to 'site/docs/4.3/utilities/image-replacement.md')
-rw-r--r--site/docs/4.3/utilities/image-replacement.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/site/docs/4.3/utilities/image-replacement.md b/site/docs/4.3/utilities/image-replacement.md
new file mode 100644
index 000000000..4c7decac5
--- /dev/null
+++ b/site/docs/4.3/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 %}