From 93c82122225d90db39457b5ac708a9d1d484954e Mon Sep 17 00:00:00 2001 From: Johann-S Date: Mon, 16 Oct 2017 14:29:06 +0200 Subject: [PATCH] Add dispose methods in our documentation --- docs/4.0/components/alerts.md | 1 + docs/4.0/components/buttons.md | 3 ++- docs/4.0/components/carousel.md | 4 ++++ docs/4.0/components/collapse.md | 4 ++++ docs/4.0/components/dropdowns.md | 1 + docs/4.0/components/modal.md | 4 ++++ docs/4.0/components/navs.md | 4 ++++ docs/4.0/components/scrollspy.md | 3 +++ 8 files changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/4.0/components/alerts.md b/docs/4.0/components/alerts.md index b8bb0c2168ef..4fdaed41b26a 100644 --- a/docs/4.0/components/alerts.md +++ b/docs/4.0/components/alerts.md @@ -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 %} diff --git a/docs/4.0/components/buttons.md b/docs/4.0/components/buttons.md index fac603e7e122..5aeb8664135d 100644 --- a/docs/4.0/components/buttons.md +++ b/docs/4.0/components/buttons.md @@ -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. | diff --git a/docs/4.0/components/carousel.md b/docs/4.0/components/carousel.md index 4919e1ac28ea..ac6299f6f885 100644 --- a/docs/4.0/components/carousel.md +++ b/docs/4.0/components/carousel.md @@ -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: diff --git a/docs/4.0/components/collapse.md b/docs/4.0/components/collapse.md index a34ffeb7ba28..cd0a7d4e5f56 100644 --- a/docs/4.0/components/collapse.md +++ b/docs/4.0/components/collapse.md @@ -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. diff --git a/docs/4.0/components/dropdowns.md b/docs/4.0/components/dropdowns.md index d38b410c78b5..2c467166e530 100644 --- a/docs/4.0/components/dropdowns.md +++ b/docs/4.0/components/dropdowns.md @@ -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 diff --git a/docs/4.0/components/modal.md b/docs/4.0/components/modal.md index 491bd3fb8f7a..3586f461ca6f 100644 --- a/docs/4.0/components/modal.md +++ b/docs/4.0/components/modal.md @@ -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 `