From 48c5efa4c3c439d8720b8475ec3e372c6974a12a Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Tue, 28 Mar 2017 17:43:16 -0400 Subject: Fix JS components console error "Error: is transitioning" --- docs/getting-started/javascript.md | 55 ++++++++++++++++++++++++++------------ 1 file changed, 38 insertions(+), 17 deletions(-) (limited to 'docs/getting-started/javascript.md') diff --git a/docs/getting-started/javascript.md b/docs/getting-started/javascript.md index b6a38fb7a..d65fba098 100644 --- a/docs/getting-started/javascript.md +++ b/docs/getting-started/javascript.md @@ -36,6 +36,18 @@ Alternatively, to target a specific plugin, just include the plugin's name as a $(document).off('.alert.data-api') {% endhighlight %} +## Events + +Bootstrap provides custom events for most plugins' unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. `show`) is triggered at the start of an event, and its past participle form (ex. `shown`) is triggered on the completion of an action. + +All infinitive events provide [`preventDefault()`](https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault) functionality. This provides the ability to stop the execution of an action before it starts. + +{% highlight js %} +$('#myModal').on('show.bs.modal', function (e) { + if (!data) return e.preventDefault() // stops modal from being shown +}) +{% endhighlight %} + ## Programmatic API We also believe you should be able to use all Bootstrap plugins purely through the JavaScript API. All public APIs are single, chainable methods, and return the collection acted upon. @@ -54,32 +66,41 @@ $('#myModal').modal('show') // initializes and invokes show immed Each plugin also exposes its raw constructor on a `Constructor` property: `$.fn.popover.Constructor`. If you'd like to get a particular plugin instance, retrieve it directly from an element: `$('[rel="popover"]').data('popover')`. -### Default settings -You can change the default settings for a plugin by modifying the plugin's `Constructor.DEFAULTS` object: +### Asynchronous functions and transitions + +All programmatic API methods are **asynchronous** and returns to the caller once the transition is started but **before it ends**. +In order to execute an action once the transition is complete, you can listen to the corresponding event. {% highlight js %} -$.fn.modal.Constructor.DEFAULTS.keyboard = false // changes default for the modal plugin's `keyboard` option to false +$('#myCollapse').on('shown.bs.collapse', function (e) { + // Action to execute once the collapsible area is expanded +}) {% endhighlight %} -## No conflict +In addition a method call on a **transitioning component will be ignored**. +{% highlight js %} +$('#myCarousel').on('slid.bs.carousel', function (e) { + $('#myCarousel').carousel('2') // Will slide to the slide 2 as soon as the transition to slide 1 is finished +}) -Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call `.noConflict` on the plugin you wish to revert the value of. +$('#myCarousel').carousel('1') // Will start sliding to the slide 1 and returns to the caller +$('#myCarousel').carousel('2') // !! Will be ignored, as the transition to the slide 1 is not finished !! +{% endhighlight %} + +### Default settings +You can change the default settings for a plugin by modifying the plugin's `Constructor.Default` object: {% highlight js %} -var bootstrapButton = $.fn.button.noConflict() // return $.fn.button to previously assigned value -$.fn.bootstrapBtn = bootstrapButton // give $().bootstrapBtn the Bootstrap functionality +$.fn.modal.Constructor.Default.keyboard = false // changes default for the modal plugin's `keyboard` option to false {% endhighlight %} -## Events - -Bootstrap provides custom events for most plugins' unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. `show`) is triggered at the start of an event, and its past participle form (ex. `shown`) is triggered on the completion of an action. +## No conflict -All infinitive events provide [`preventDefault()`](https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault) functionality. This provides the ability to stop the execution of an action before it starts. +Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call `.noConflict` on the plugin you wish to revert the value of. {% highlight js %} -$('#myModal').on('show.bs.modal', function (e) { - if (!data) return e.preventDefault() // stops modal from being shown -}) +var bootstrapButton = $.fn.button.noConflict() // return $.fn.button to previously assigned value +$.fn.bootstrapBtn = bootstrapButton // give $().bootstrapBtn the Bootstrap functionality {% endhighlight %} ## Version numbers @@ -100,8 +121,8 @@ Bootstrap's plugins don't fall back particularly gracefully when JavaScript is d **Bootstrap does not officially support third-party JavaScript libraries** like Prototype or jQuery UI. Despite `.noConflict` and namespaced events, there may be compatibility problems that you need to fix on your own. {% endcallout %} -## Transitions +## Util -For simple transition effects, include `transition.js` once alongside the other JS files. If you're using the compiled (or minified) `bootstrap.js`, there is no need to include this—it's already there. +All Bootstrap Javascript depend on `util.js` and it has to be included alongside the other JS files. If you're using the compiled (or minified) `bootstrap.js`, there is no need to include this—it's already there. -Transition.js is a basic helper for `transitionEnd` events as well as a CSS transition emulator. It's used by the other plugins to check for CSS transition support and to catch hanging transitions. +`util.js` includes utility functions and a basic helper for `transitionEnd` events as well as a CSS transition emulator. It's used by the other plugins to check for CSS transition support and to catch hanging transitions. -- cgit v1.2.3 From 1f43d9c066f1ffd008f2cb4b00907165d905f3fc Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 27 May 2017 22:03:48 -0700 Subject: revamp getting started docs to use new toc --- docs/getting-started/javascript.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) (limited to 'docs/getting-started/javascript.md') diff --git a/docs/getting-started/javascript.md b/docs/getting-started/javascript.md index d65fba098..c4fb2366a 100644 --- a/docs/getting-started/javascript.md +++ b/docs/getting-started/javascript.md @@ -1,17 +1,11 @@ --- layout: docs title: JavaScript -description: Learn about Bootstrap's JavaScript—how to include it, our data and programmatic API options, and more. +description: Bring Bootstrap to life with our JavaScript plugins built on jQuery. Learn about each plugin, our data and programmatic API options, and more. group: getting-started +toc: true --- -Bootstrap includes a handful of JavaScript to help bring some of our components to life. Learn more about how to include it, our data and programmatic API options, and more. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - ## Individual or compiled Plugins can be included individually (using Bootstrap's individual `*.js` files), or all at once using `bootstrap.js` or the minified `bootstrap.min.js` (don't include both). -- cgit v1.2.3 From 3e76d6565603fafa2c85ad81d7b6345c4e279c72 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 28 May 2017 22:50:57 -0700 Subject: Rearrange all the docs to allow for a docs/major.minor/ setup --- docs/getting-started/javascript.md | 122 ------------------------------------- 1 file changed, 122 deletions(-) delete mode 100644 docs/getting-started/javascript.md (limited to 'docs/getting-started/javascript.md') diff --git a/docs/getting-started/javascript.md b/docs/getting-started/javascript.md deleted file mode 100644 index c4fb2366a..000000000 --- a/docs/getting-started/javascript.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -layout: docs -title: JavaScript -description: Bring Bootstrap to life with our JavaScript plugins built on jQuery. Learn about each plugin, our data and programmatic API options, and more. -group: getting-started -toc: true ---- - -## Individual or compiled - -Plugins can be included individually (using Bootstrap's individual `*.js` files), or all at once using `bootstrap.js` or the minified `bootstrap.min.js` (don't include both). - -## Dependencies - -Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs. Also note that all plugins depend on jQuery (this means jQuery must be included **before** the plugin files). [Consult our `bower.json`]({{ site.repo }}/blob/v{{ site.current_version }}/bower.json) to see which versions of jQuery are supported. - -## Data attributes - -Nearly all Bootstrap plugins can be enabled and configured through HTML alone with data attributes (our preferred way of using JavaScript functionality). Be sure to **only use one set of data attributes on a single element** (e.g., you cannot trigger a tooltip and modal from the same button.) - -However, in some situations it may be desirable to disable this functionality. To disable the data attribute API, unbind all events on the document namespaced with `data-api` like so: - -{% highlight js %} -$(document).off('.data-api') -{% endhighlight %} - -Alternatively, to target a specific plugin, just include the plugin's name as a namespace along with the data-api namespace like this: - -{% highlight js %} -$(document).off('.alert.data-api') -{% endhighlight %} - -## Events - -Bootstrap provides custom events for most plugins' unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. `show`) is triggered at the start of an event, and its past participle form (ex. `shown`) is triggered on the completion of an action. - -All infinitive events provide [`preventDefault()`](https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault) functionality. This provides the ability to stop the execution of an action before it starts. - -{% highlight js %} -$('#myModal').on('show.bs.modal', function (e) { - if (!data) return e.preventDefault() // stops modal from being shown -}) -{% endhighlight %} - -## Programmatic API - -We also believe you should be able to use all Bootstrap plugins purely through the JavaScript API. All public APIs are single, chainable methods, and return the collection acted upon. - -{% highlight js %} -$('.btn.danger').button('toggle').addClass('fat') -{% endhighlight %} - -All methods should accept an optional options object, a string which targets a particular method, or nothing (which initiates a plugin with default behavior): - -{% highlight js %} -$('#myModal').modal() // initialized with defaults -$('#myModal').modal({ keyboard: false }) // initialized with no keyboard -$('#myModal').modal('show') // initializes and invokes show immediately -{% endhighlight %} - -Each plugin also exposes its raw constructor on a `Constructor` property: `$.fn.popover.Constructor`. If you'd like to get a particular plugin instance, retrieve it directly from an element: `$('[rel="popover"]').data('popover')`. - -### Asynchronous functions and transitions - -All programmatic API methods are **asynchronous** and returns to the caller once the transition is started but **before it ends**. - -In order to execute an action once the transition is complete, you can listen to the corresponding event. -{% highlight js %} -$('#myCollapse').on('shown.bs.collapse', function (e) { - // Action to execute once the collapsible area is expanded -}) -{% endhighlight %} - -In addition a method call on a **transitioning component will be ignored**. -{% highlight js %} -$('#myCarousel').on('slid.bs.carousel', function (e) { - $('#myCarousel').carousel('2') // Will slide to the slide 2 as soon as the transition to slide 1 is finished -}) - -$('#myCarousel').carousel('1') // Will start sliding to the slide 1 and returns to the caller -$('#myCarousel').carousel('2') // !! Will be ignored, as the transition to the slide 1 is not finished !! -{% endhighlight %} - -### Default settings -You can change the default settings for a plugin by modifying the plugin's `Constructor.Default` object: - -{% highlight js %} -$.fn.modal.Constructor.Default.keyboard = false // changes default for the modal plugin's `keyboard` option to false -{% endhighlight %} - -## No conflict - -Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call `.noConflict` on the plugin you wish to revert the value of. - -{% highlight js %} -var bootstrapButton = $.fn.button.noConflict() // return $.fn.button to previously assigned value -$.fn.bootstrapBtn = bootstrapButton // give $().bootstrapBtn the Bootstrap functionality -{% endhighlight %} - -## Version numbers - -The version of each of Bootstrap's jQuery plugins can be accessed via the `VERSION` property of the plugin's constructor. For example, for the tooltip plugin: - -{% highlight js %} -$.fn.tooltip.Constructor.VERSION // => "{{ site.current_version }}" -{% endhighlight %} - -## No special fallbacks when JavaScript is disabled - -Bootstrap's plugins don't fall back particularly gracefully when JavaScript is disabled. If you care about the user experience in this case, use [`