From d40c100f05a29710c5626b96d6cccdec633b0d9f Mon Sep 17 00:00:00 2001 From: GeoSot Date: Mon, 16 May 2022 01:59:03 +0300 Subject: [PATCH 1/3] docs: Add more details on "getting-started -> javascript" page & group jQuery stuff --- .../docs/5.2/getting-started/javascript.md | 148 ++++++++++++------ 1 file changed, 102 insertions(+), 46 deletions(-) diff --git a/site/content/docs/5.2/getting-started/javascript.md b/site/content/docs/5.2/getting-started/javascript.md index fd676cf42344..cf7b1770160b 100644 --- a/site/content/docs/5.2/getting-started/javascript.md +++ b/site/content/docs/5.2/getting-started/javascript.md @@ -47,18 +47,19 @@ Some plugins and CSS components depend on other plugins. If you include plugins Our dropdowns, popovers and tooltips also depend on [Popper](https://popper.js.org/). -## Still want to use jQuery? It's possible! - -Bootstrap 5 is designed to be used without jQuery, but it's still possible to use our components with jQuery. **If Bootstrap detects `jQuery` in the `window` object** it'll add all of our components in jQuery's plugin system; this means you'll be able to do `$('[data-bs-toggle="tooltip"]').tooltip()` to enable tooltips. The same goes for our other components. - ## 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.) +Make sure to change the case type of the option name from camelCase to kebab-case when passing the options via data attributes. For example, use `data-bs-custom-class="beautifier"` instead of `data-bs-customClass="beautifier"`. + +As of Bootstrap 5.2.0, all components support an **experimental** reserved data attribute `data-bs-config` that can house simple component configuration as a JSON string. When an element has `data-bs-config='{"delay":0, "title":123}'` and `data-bs-title="456"` attributes, the final `title` value will be `456` and the separate data attributes will override values given on `data-bs-config`. In addition, existing data attributes are able to house JSON values like `data-bs-delay='{"show":0,"hide":150}'`. + + {{< callout warning >}} ## Selectors -Currently to query DOM elements we use the native methods `querySelector` and `querySelectorAll` for performance reasons, so you have to use [valid selectors](https://www.w3.org/TR/CSS21/syndata.html#value-def-identifier). +Currently, to query DOM elements we use the native methods `querySelector` and `querySelectorAll` for performance reasons, so you have to use [valid selectors](https://www.w3.org/TR/CSS21/syndata.html#value-def-identifier). If you use special selectors, for example: `collapse:Example` be sure to escape them. {{< /callout >}} @@ -69,7 +70,7 @@ Bootstrap provides custom events for most plugins' unique actions. Generally, th 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. Returning false from an event handler will also automatically call `preventDefault()`. ```js -const myModal = document.getElementById('myModal') +const myModal = document.querySelector('#myModal') myModal.addEventListener('show.bs.modal', event => { if (!data) { @@ -78,58 +79,57 @@ myModal.addEventListener('show.bs.modal', event => { }) ``` -{{< callout warning >}} -## jQuery events - -Bootstrap will detect jQuery if `jQuery` is present in the `window` object and there is no `data-bs-no-jquery` attribute set on ``. If jQuery is found, Bootstrap will emit events thanks to jQuery's event system. So if you want to listen to Bootstrap's events, you'll have to use the jQuery methods (`.on`, `.one`) instead of `addEventListener`. - -```js -$('#myTab a').on('shown.bs.tab', () => { - // do something... -}) -``` -{{< /callout >}} ## Programmatic API All constructors accept an optional options object or nothing (which initiates a plugin with its default behavior): ```js -const myModalEl = document.getElementById('myModal') +const myModalEl = document.querySelector('#myModal') const modal = new bootstrap.Modal(myModalEl) // initialized with defaults -const modal1 = new bootstrap.Modal(myModalEl, { keyboard: false }) // initialized with no keyboard + +const configObject = { keyboard: false } +const modal1 = new bootstrap.Modal(myModalEl, configObject) // initialized with no keyboard ``` If you'd like to get a particular plugin instance, each plugin exposes a `getInstance` method. In order to retrieve it directly from an element, do this: `bootstrap.Popover.getInstance(myPopoverEl)`. +This method will return `null` if an instance is not initiated over the requested element + +Alternatively `getOrCreateInstance` can be used to get the instance associated with a DOM element, or create a new one in case it wasn't initialized. `bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)`. +In case an instance wasn't initialized, it may accept and use an optional configuration object as second argument ### CSS selectors in constructors -You can also use a CSS selector as the first argument instead of a DOM element to initialize the plugin. Currently the element for the plugin is found by the `querySelector` method since our plugins support a single element only. +All plugin constructors, and in addition methods `getInstance` & `getOrCreateInstance`, can accept as first argument, a DOM element or a valid [CSS selector](#selectors). + +Currently, the element for the plugin is found by the `querySelector` method since our plugins support a single element only. ```js const modal = new bootstrap.Modal('#myModal') const dropdown = new bootstrap.Dropdown('[data-bs-toggle="dropdown"]') +const offcanvas = bootstrap.Offcanvas.getInstance('#myOffcanvas') +const alert = bootstrap.Alert.getOrCreateInstance('#myAlert') ``` ### Asynchronous functions and transitions -All programmatic API methods are **asynchronous** and return to the caller once the transition is started but **before it ends**. +All programmatic API methods are **asynchronous** and return 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. ```js -const myCollapseEl = document.getElementById('myCollapse') +const myCollapseEl = document.querySelector('#myCollapse') myCollapseEl.addEventListener('shown.bs.collapse', event => { // Action to execute once the collapsible area is expanded }) ``` -In addition a method call on a **transitioning component will be ignored**. +In addition, a method call on a **transitioning component will be ignored**. ```js -const myCarouselEl = document.getElementById('myCarousel') +const myCarouselEl = document.querySelector('#myCarousel') const carousel = bootstrap.Carousel.getInstance(myCarouselEl) // Retrieve a Carousel instance myCarouselEl.addEventListener('slid.bs.carousel', event => { @@ -140,41 +140,48 @@ carousel.to('1') // Will start sliding to the slide 1 and returns to the caller carousel.to('2') // !! Will be ignored, as the transition to the slide 1 is not finished !! ``` -### Default settings +{{< callout warning >}} +##### `dispose` method +Special care on `dispose` usage. It may seem right to use it directly after `hide()`, it will lead to wrong results -You can change the default settings for a plugin by modifying the plugin's `Constructor.Default` object: +So the proper use would be something like: ```js -// changes default for the modal plugin's `keyboard` option to false -bootstrap.Modal.Default.keyboard = false -``` - -## No conflict (only if you use jQuery) -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. +const myModal = document.querySelector('#myModal') +myModal.hide() // it is asynchronous -```js -const bootstrapButton = $.fn.button.noConflict() // return $.fn.button to previously assigned value -$.fn.bootstrapBtn = bootstrapButton // give $().bootstrapBtn the Bootstrap functionality +myModal.addEventListener('shown.bs.hidden', event => { + myModal.dispose() +}) ``` +{{< /callout >}} -## Version numbers +### Default settings -The version of each of Bootstrap's plugins can be accessed via the `VERSION` property of the plugin's constructor. For example, for the tooltip plugin: +You can change the default settings for a plugin by modifying the plugin's `Constructor.Default` object: ```js -bootstrap.Tooltip.VERSION // => "{{< param current_version >}}" +// changes default for the modal plugin's `keyboard` option to false +bootstrap.Modal.Default.keyboard = false ``` -## No special fallbacks when JavaScript is disabled +## Exposed Methods & Properties by all BS plugins -Bootstrap's plugins don't fall back particularly gracefully when JavaScript is disabled. If you care about the user experience in this case, use [`