aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/twbs/bootstrap/site/docs/4.1/utilities/image-replacement.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/twbs/bootstrap/site/docs/4.1/utilities/image-replacement.md')
-rw-r--r--vendor/twbs/bootstrap/site/docs/4.1/utilities/image-replacement.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/vendor/twbs/bootstrap/site/docs/4.1/utilities/image-replacement.md b/vendor/twbs/bootstrap/site/docs/4.1/utilities/image-replacement.md
new file mode 100644
index 000000000..0d5a4d30c
--- /dev/null
+++ b/vendor/twbs/bootstrap/site/docs/4.1/utilities/image-replacement.md
@@ -0,0 +1,33 @@
+---
+layout: docs
+title: Image replacement
+description: Swap text for background images with the image replacement class.
+group: utilities
+toc: true
+---
+
+{% 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.
+
+{% capture example %}
+<h1 class="text-hide" style="background-image: url('/docs/{{ site.docs_version }}/assets/brand/bootstrap-solid.svg'); width: 50px; height: 50px;">Bootstrap</h1>
+{% endcapture %}
+{% include example.html content=example %}