Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain the "dispose" method appropriately #30838

Merged
merged 4 commits into from Oct 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/alerts.md
Expand Up @@ -127,7 +127,7 @@ This makes an alert listen for click events on descendant elements which have th
<code>dispose</code>
</td>
<td>
Destroys an element's alert.
Destroys an element's alert. (Removes stored data on the DOM element)
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/buttons.md
Expand Up @@ -155,7 +155,7 @@ var bsButton = new bootstrap.Button(button)
<code>dispose</code>
</td>
<td>
Destroys an element's button.
Destroys an element's button. (Removes stored data on the DOM element)
</td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/carousel.md
Expand Up @@ -368,7 +368,7 @@ var carousel = new bootstrap.Carousel(myCarousel, {
</tr>
<tr>
<td><code>dispose</code></td>
<td>Destroys an element's carousel.</td>
<td>Destroys an element's carousel. (Removes stored data on the DOM element)</td>
</tr>
<tr>
<td><code>getInstance</code></td>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/collapse.md
Expand Up @@ -224,7 +224,7 @@ var bsCollapse = new bootstrap.Collapse(myCollapse, {
</tr>
<tr>
<td><code>dispose</code></td>
<td>Destroys an element's collapse.</td>
<td>Destroys an element's collapse. (Removes stored data on the DOM element)</td>
</tr>
<tr>
<td><code>getInstance</code></td>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/dropdowns.md
Expand Up @@ -949,7 +949,7 @@ Note when `boundary` is set to any value other than `'scrollParent'`, the style
<tr>
<td><code>dispose</code></td>
<td>
Destroys an element's dropdown.
Destroys an element's dropdown. (Removes stored data on the DOM element)
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/modal.md
Expand Up @@ -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 >}}

Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/popovers.md
Expand Up @@ -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 >}}

Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/scrollspy.md
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.0/components/tooltips.md
Expand Up @@ -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 >}}

Expand Down