aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick H. Lauke <[email protected]>2020-12-07 16:57:33 +0000
committerGitHub <[email protected]>2020-12-07 18:57:33 +0200
commitab49e362a7f76c370bf5e66a4fda087eb50a32e8 (patch)
treebf42ea12d5360978d1433c95a60a008b67681987
parent63f3d939eaceeb84dcc77a7392953bcc8c5bc0a3 (diff)
downloadbootstrap-ab49e362a7f76c370bf5e66a4fda087eb50a32e8.tar.xz
bootstrap-ab49e362a7f76c370bf5e66a4fda087eb50a32e8.zip
Add a callout for the sanitizer in popovers and tooltips (#32272)
* Add a callout for the sanitizer in popovers and tooltips * Add second reference to sanitizer in the options Co-authored-by: XhmikosR <[email protected]>
-rw-r--r--site/content/docs/5.0/components/popovers.md6
-rw-r--r--site/content/docs/5.0/components/tooltips.md6
-rw-r--r--site/layouts/partials/callout-info-sanitizer.md1
3 files changed, 11 insertions, 2 deletions
diff --git a/site/content/docs/5.0/components/popovers.md b/site/content/docs/5.0/components/popovers.md
index fb0f92f4a..41b482d03 100644
--- a/site/content/docs/5.0/components/popovers.md
+++ b/site/content/docs/5.0/components/popovers.md
@@ -22,6 +22,10 @@ Things to know when using the popover plugin:
- Popovers can be triggered thanks to an element inside a shadow DOM.
{{< callout info >}}
+{{< partial "callout-info-sanitizer.md" >}}
+{{< /callout >}}
+
+{{< callout info >}}
{{< partial "callout-info-prefersreducedmotion.md" >}}
{{< /callout >}}
@@ -275,7 +279,7 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
<td><code>sanitize</code></td>
<td>boolean</td>
<td><code>true</code></td>
- <td>Enable or disable the sanitization. If activated <code>'template'</code>, <code>'content'</code> and <code>'title'</code> options will be sanitized.</td>
+ <td>Enable or disable the sanitization. If activated <code>'template'</code>, <code>'content'</code> and <code>'title'</code> options will be sanitized. See the <a href="{{< docsref "/getting-started/javascript#sanitizer" >}}">sanitizer section in our JavaScript documentation</a>.</td>
</tr>
<tr>
<td><code>allowList</code></td>
diff --git a/site/content/docs/5.0/components/tooltips.md b/site/content/docs/5.0/components/tooltips.md
index e2a45c3ed..6f02ac581 100644
--- a/site/content/docs/5.0/components/tooltips.md
+++ b/site/content/docs/5.0/components/tooltips.md
@@ -21,6 +21,10 @@ Things to know when using the tooltip plugin:
- Tooltips can be triggered thanks to an element inside a shadow DOM.
{{< callout info >}}
+{{< partial "callout-info-sanitizer.md" >}}
+{{< /callout >}}
+
+{{< callout info >}}
{{< partial "callout-info-prefersreducedmotion.md" >}}
{{< /callout >}}
@@ -274,7 +278,7 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
<td><code>sanitize</code></td>
<td>boolean</td>
<td><code>true</code></td>
- <td>Enable or disable the sanitization. If activated <code>'template'</code> and <code>'title'</code> options will be sanitized.</td>
+ <td>Enable or disable the sanitization. If activated <code>'template'</code> and <code>'title'</code> options will be sanitized. See the <a href="{{< docsref "/getting-started/javascript#sanitizer" >}}">sanitizer section in our JavaScript documentation</a>.</td>
</tr>
<tr>
<td><code>allowList</code></td>
diff --git a/site/layouts/partials/callout-info-sanitizer.md b/site/layouts/partials/callout-info-sanitizer.md
new file mode 100644
index 000000000..ee0eda48e
--- /dev/null
+++ b/site/layouts/partials/callout-info-sanitizer.md
@@ -0,0 +1 @@
+By default, this component uses the built-in content sanitizer, which strips out any HTML elements that are not explicitly allowed. See the [sanitizer section in our JavaScript documentation](/docs/{{ .Site.Params.docs_version }}/getting-started/javascript/#sanitizer) for more details.