Add dispose methods in our documentation (#24396)

* Add dispose methods in our documentation

* Update buttons.md
This commit is contained in:
Johann-S 2017-10-16 16:51:42 +02:00 committed by GitHub
parent 658e81a084
commit 99eece1392
8 changed files with 23 additions and 1 deletions

View File

@ -92,6 +92,7 @@ Note that closing an alert will remove it from the DOM.
| --- | --- |
| `$().alert()` | Makes an alert listen for click events on descendant elements which have the `data-dismiss="alert"` attribute. (Not necessary when using the data-api's auto-initialization.) |
| `$().alert('close')` | Closes an alert by removing it from the DOM. If the `.fade` and `.show` classes are present on the element, the alert will fade out before it is removed. |
| `$().alert('dispose')` | Destroys an element's alert. |
{% highlight js %}$(".alert").alert('close'){% endhighlight %}

View File

@ -154,4 +154,5 @@ Note that pre-checked buttons require you to manually add the `.active` class to
| Method | Description |
| --- | --- |
| `$().button('toggle')` |Toggles push state. Gives the button the appearance that it has been activated. |
| `$().button('toggle')` | Toggles push state. Gives the button the appearance that it has been activated. |
| `$().button('dispose')` | Destroys an element's button. |

View File

@ -263,6 +263,10 @@ Cycles to the previous item. **Returns to the caller before the previous item ha
Cycles to the next item. **Returns to the caller before the next item has been shown** (i.e. before the `slid.bs.carousel` event occurs).
### `.carousel('dispose')`
Destroys an element's carousel.
### Events
Bootstrap's carousel class exposes two events for hooking into carousel functionality. Both events have the following additional properties:

View File

@ -226,6 +226,10 @@ Shows a collapsible element. **Returns to the caller before the collapsible elem
Hides a collapsible element. **Returns to the caller before the collapsible element has actually been hidden** (i.e. before the `hidden.bs.collapse` event occurs).
### `.collapse('dispose')`
Destroys an element's collapse.
### Events
Bootstrap's collapse class exposes a few events for hooking into collapse functionality.

View File

@ -607,6 +607,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
| --- | --- |
| `$().dropdown('toggle')` | Toggles the dropdown menu of a given navbar or tabbed navigation. |
| `$().dropdown('update')` | Updates the position of an element's dropdown. |
| `$().dropdown('dispose')` | Destroys an element's dropdown. |
### Events

View File

@ -575,6 +575,10 @@ Manually readjust the modal's position if the height of a modal changes while it
{% highlight js %}$('#myModal').modal('handleUpdate'){% endhighlight %}
### `.modal('dispose')`
Destroys an element's modal.
### Events
Bootstrap's modal class exposes a few events for hooking into modal functionality. All modal events are fired at the modal itself (i.e. at the `<div class="modal">`).

View File

@ -583,6 +583,10 @@ Selects the given tab and shows its associated pane. Any other tab that was prev
$('#someTab').tab('show')
{% endhighlight %}
### .tab('dispose')
Destroys an element's tab.
### Events
When showing a new tab, the events fire in the following order:

View File

@ -280,6 +280,9 @@ $('[data-spy="scroll"]').each(function () {
})
{% endhighlight %}
### `.scrollspy('dispose')`
Destroys an element's scrollspy.
### Options