From 6e7bf66de9dd22772a60e774bd5cf62ee36d161a Mon Sep 17 00:00:00 2001
From: dumb <github@dumb.ca>
Date: Mon, 16 May 2016 16:18:51 -0400
Subject: [PATCH] Fix issue #16941 - HTML example in tooltip docs
Added an example tooltip that uses HTML content, and expanded the
description of the html option to clarify usage.
---
docs/components/tooltips.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md
index fb8cb24ddf..7aad7a7871 100644
--- a/docs/components/tooltips.md
+++ b/docs/components/tooltips.md
@@ -85,6 +85,7 @@ Hover over the buttons below to see their tooltips.
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</button>
+ <button type="button" class="btn btn-secondary" data-toggle="tooltip" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">Tooltip with HTML</button>
</div>
</div>
@@ -101,6 +102,9 @@ Hover over the buttons below to see their tooltips.
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="left" title="Tooltip on left">
Tooltip on left
</button>
+<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
+ Tooltip with HTML
+</button>
{% endhighlight %}
## Usage
@@ -179,7 +183,11 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
<td>html</td>
<td>boolean</td>
<td>false</td>
- <td>Insert HTML into the tooltip. If false, jQuery's <code>text</code> method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.</td>
+ <td>
+ <p>Allow HTML in the tooltip.</p>
+ <p>If true, HTML tags in the tooltip's <code>title</code> will be rendered in the tooltip. If false, jQuery's <code>text</code> method will be used to insert content into the DOM.</p>
+ <p>Use text if you're worried about XSS attacks.</p>
+ </td>
</tr>
<tr>
<td>placement</td>
--
GitLab