From e4be0640eed2c98a8f0e1db3baa8c35a3de957ab Mon Sep 17 00:00:00 2001 From: Rohit Sharma Date: Fri, 2 Oct 2020 17:28:59 +0530 Subject: [PATCH] Explain the "dispose" method appropriately (#30838) --- site/content/docs/5.0/components/alerts.md | 2 +- site/content/docs/5.0/components/buttons.md | 2 +- site/content/docs/5.0/components/carousel.md | 2 +- site/content/docs/5.0/components/collapse.md | 2 +- site/content/docs/5.0/components/dropdowns.md | 2 +- site/content/docs/5.0/components/modal.md | 2 +- site/content/docs/5.0/components/popovers.md | 2 +- site/content/docs/5.0/components/scrollspy.md | 2 +- site/content/docs/5.0/components/tooltips.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/site/content/docs/5.0/components/alerts.md b/site/content/docs/5.0/components/alerts.md index a2f701267d..994c5b1a6b 100644 --- a/site/content/docs/5.0/components/alerts.md +++ b/site/content/docs/5.0/components/alerts.md @@ -127,7 +127,7 @@ This makes an alert listen for click events on descendant elements which have th dispose - Destroys an element's alert. + Destroys an element's alert. (Removes stored data on the DOM element) diff --git a/site/content/docs/5.0/components/buttons.md b/site/content/docs/5.0/components/buttons.md index eaede8f4eb..4b4522ab77 100644 --- a/site/content/docs/5.0/components/buttons.md +++ b/site/content/docs/5.0/components/buttons.md @@ -155,7 +155,7 @@ var bsButton = new bootstrap.Button(button) dispose - Destroys an element's button. + Destroys an element's button. (Removes stored data on the DOM element) diff --git a/site/content/docs/5.0/components/carousel.md b/site/content/docs/5.0/components/carousel.md index 3222e06b97..1ef2055496 100644 --- a/site/content/docs/5.0/components/carousel.md +++ b/site/content/docs/5.0/components/carousel.md @@ -368,7 +368,7 @@ var carousel = new bootstrap.Carousel(myCarousel, { dispose - Destroys an element's carousel. + Destroys an element's carousel. (Removes stored data on the DOM element) getInstance diff --git a/site/content/docs/5.0/components/collapse.md b/site/content/docs/5.0/components/collapse.md index 349d26da55..a6109e7f3e 100644 --- a/site/content/docs/5.0/components/collapse.md +++ b/site/content/docs/5.0/components/collapse.md @@ -224,7 +224,7 @@ var bsCollapse = new bootstrap.Collapse(myCollapse, { dispose - Destroys an element's collapse. + Destroys an element's collapse. (Removes stored data on the DOM element) getInstance diff --git a/site/content/docs/5.0/components/dropdowns.md b/site/content/docs/5.0/components/dropdowns.md index ca5064b508..fb200f267f 100644 --- a/site/content/docs/5.0/components/dropdowns.md +++ b/site/content/docs/5.0/components/dropdowns.md @@ -949,7 +949,7 @@ Note when `boundary` is set to any value other than `'scrollParent'`, the style dispose - Destroys an element's dropdown. + Destroys an element's dropdown. (Removes stored data on the DOM element) diff --git a/site/content/docs/5.0/components/modal.md b/site/content/docs/5.0/components/modal.md index d1815e1703..8064999ec9 100644 --- a/site/content/docs/5.0/components/modal.md +++ b/site/content/docs/5.0/components/modal.md @@ -928,7 +928,7 @@ Manually readjust the modal's position if the height of a modal changes while it #### dispose -Destroys an element's modal. +Destroys an element's modal. (Removes stored data on the DOM element) {{< highlight js >}}myModal.dispose(){{< /highlight >}} diff --git a/site/content/docs/5.0/components/popovers.md b/site/content/docs/5.0/components/popovers.md index 4af07a2232..ed7dfb1b2d 100644 --- a/site/content/docs/5.0/components/popovers.md +++ b/site/content/docs/5.0/components/popovers.md @@ -323,7 +323,7 @@ Toggles an element's popover. **Returns to the caller before the popover has act #### dispose -Hides and destroys an element's popover. Popovers that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements. +Hides and destroys an element's popover (Removes stored data on the DOM element). Popovers that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements. {{< highlight js >}}myPopover.dispose(){{< /highlight >}} diff --git a/site/content/docs/5.0/components/scrollspy.md b/site/content/docs/5.0/components/scrollspy.md index 245ac7aab2..2e2a513345 100644 --- a/site/content/docs/5.0/components/scrollspy.md +++ b/site/content/docs/5.0/components/scrollspy.md @@ -290,7 +290,7 @@ dataSpyList.forEach(function (dataSpyEl) { #### dispose -Destroys an element's scrollspy. +Destroys an element's scrollspy. (Removes stored data on the DOM element) #### getInstance diff --git a/site/content/docs/5.0/components/tooltips.md b/site/content/docs/5.0/components/tooltips.md index 21c952d466..a0a6f2a189 100644 --- a/site/content/docs/5.0/components/tooltips.md +++ b/site/content/docs/5.0/components/tooltips.md @@ -330,7 +330,7 @@ Toggles an element's tooltip. **Returns to the caller before the tooltip has act #### dispose -Hides and destroys an element's tooltip. Tooltips that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements. +Hides and destroys an element's tooltip (Removes stored data on the DOM element). Tooltips that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements. {{< highlight js >}}tooltip.dispose(){{< /highlight >}}