mirror of
https://github.com/twbs/bootstrap.git
synced 2024-12-01 13:24:25 +01:00
Add code to method/property tables (#31130)
Co-authored-by: XhmikosR <xhmikosr@gmail.com>
This commit is contained in:
Patrick H. Lauke
GitHub
parent
22f32415c0
commit
2c38800ea2
@ -239,40 +239,40 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>interval</td>
|
||||
<td><code>interval</code></td>
|
||||
<td>number</td>
|
||||
<td>5000</td>
|
||||
<td><code>5000</code></td>
|
||||
<td>The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>keyboard</td>
|
||||
<td><code>keyboard</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Whether the carousel should react to keyboard events.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pause</td>
|
||||
<td><code>pause</code></td>
|
||||
<td>string | boolean</td>
|
||||
<td>"hover"</td>
|
||||
<td><code>"hover"</code></td>
|
||||
<td><p>If set to <code>"hover"</code>, pauses the cycling of the carousel on <code>mouseenter</code> and resumes the cycling of the carousel on <code>mouseleave</code>. If set to <code>false</code>, hovering over the carousel won't pause it.</p>
|
||||
<p>On touch-enabled devices, when set to <code>"hover"</code>, cycling will pause on <code>touchend</code> (once the user finished interacting with the carousel) for two intervals, before automatically resuming. Note that this is in addition to the above mouse behavior.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>slide</td>
|
||||
<td><code>slide</code></td>
|
||||
<td>string | boolean</td>
|
||||
<td>false</td>
|
||||
<td><code>false</code></td>
|
||||
<td>Autoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>wrap</td>
|
||||
<td><code>wrap</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Whether the carousel should cycle continuously or have hard stops.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>touch</td>
|
||||
<td><code>touch</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Whether the carousel should support left/right swipe interactions on touchscreen devices.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -171,15 +171,15 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>parent</td>
|
||||
<td><code>parent</code></td>
|
||||
<td>selector | jQuery object | DOM element </td>
|
||||
<td>false</td>
|
||||
<td><code>false</code></td>
|
||||
<td>If parent is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the <code>card</code> class). The attribute has to be set on the target collapsible area.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>toggle</td>
|
||||
<td><code>toggle</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Toggles the collapsible element on invocation</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -246,19 +246,19 @@ Bootstrap's collapse class exposes a few events for hooking into collapse functi
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>show.bs.collapse</td>
|
||||
<td><code>show.bs.collapse</code></td>
|
||||
<td>This event fires immediately when the <code>show</code> instance method is called.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>shown.bs.collapse</td>
|
||||
<td><code>shown.bs.collapse</code></td>
|
||||
<td>This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hide.bs.collapse</td>
|
||||
<td><code>hide.bs.collapse</code></td>
|
||||
<td>This event is fired immediately when the <code>hide</code> method has been called.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hidden.bs.collapse</td>
|
||||
<td><code>hidden.bs.collapse</code></td>
|
||||
<td>This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -822,9 +822,9 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>offset</td>
|
||||
<td><code>offset</code></td>
|
||||
<td>number | string | function</td>
|
||||
<td>0</td>
|
||||
<td><code>0</code></td>
|
||||
<td>
|
||||
<p>Offset of the dropdown relative to its target.</p>
|
||||
<p>When a function is used to determine the offset, it is called with an object containing the offset data as its first argument. The function must return an object with the same structure. The triggering element DOM node is passed as the second argument.</p>
|
||||
@ -832,33 +832,33 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>flip</td>
|
||||
<td><code>flip</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Allow Dropdown to flip in case of an overlapping on the reference element. For more information refer to Popper.js's <a href="https://popper.js.org/docs/v1/#modifiers..flip.enabled">flip docs</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>boundary</td>
|
||||
<td><code>boundary</code></td>
|
||||
<td>string | element</td>
|
||||
<td>'scrollParent'</td>
|
||||
<td><code>'scrollParent'</code></td>
|
||||
<td>Overflow constraint boundary of the dropdown menu. Accepts the values of <code>'viewport'</code>, <code>'window'</code>, <code>'scrollParent'</code>, or an HTMLElement reference (JavaScript only). For more information refer to Popper.js's <a href="https://popper.js.org/docs/v1/#modifiers..preventOverflow.boundariesElement">preventOverflow docs</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>reference</td>
|
||||
<td><code>reference</code></td>
|
||||
<td>string | element</td>
|
||||
<td>'toggle'</td>
|
||||
<td><code>'toggle'</code></td>
|
||||
<td>Reference element of the dropdown menu. Accepts the values of <code>'toggle'</code>, <code>'parent'</code>, or an HTMLElement reference. For more information refer to Popper.js's <a href="https://popper.js.org/docs/v1/#referenceObject">referenceObject docs</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>display</td>
|
||||
<td><code>display</code></td>
|
||||
<td>string</td>
|
||||
<td>'dynamic'</td>
|
||||
<td><code>'dynamic'</code></td>
|
||||
<td>By default, we use Popper.js for dynamic positioning. Disable this with <code>static</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>popperConfig</td>
|
||||
<td><code>popperConfig</code></td>
|
||||
<td>null | object</td>
|
||||
<td>null</td>
|
||||
<td><code>null</code></td>
|
||||
<td>To change Bootstrap's default Popper.js config, see <a href="https://popper.js.org/docs/v1/#Popper.Defaults">Popper.js's configuration</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -445,19 +445,19 @@ If no tab was already active, the `hide.bs.tab` and `hidden.bs.tab` events will
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>show.bs.tab</td>
|
||||
<td><code>show.bs.tab</code></td>
|
||||
<td>This event fires on tab show, but before the new tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>shown.bs.tab</td>
|
||||
<td><code>shown.bs.tab</code></td>
|
||||
<td>This event fires on tab show after a tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hide.bs.tab</td>
|
||||
<td><code>hide.bs.tab</code></td>
|
||||
<td>This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use <code>event.target</code> and <code>event.relatedTarget</code> to target the current active tab and the new soon-to-be-active tab, respectively.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hidden.bs.tab</td>
|
||||
<td><code>hidden.bs.tab</code></td>
|
||||
<td>This event fires after a new tab is shown (and thus the previous active tab is hidden). Use <code>event.target</code> and <code>event.relatedTarget</code> to target the previous active tab and the new active tab, respectively.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -699,19 +699,19 @@ Another override is the option to pop up a modal that covers the user viewport,
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>.modal-fullscreen-sm-down</code></td>
|
||||
<td><code>Below 576px</code></td>
|
||||
<td>Below <code>576px</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>.modal-fullscreen-md-down</code></td>
|
||||
<td><code>Below 768px</code></td>
|
||||
<td>Below <code>768px</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>.modal-fullscreen-lg-down</code></td>
|
||||
<td><code>Below 992px</code></td>
|
||||
<td>Below <code>992px</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>.modal-fullscreen-xl-down</code></td>
|
||||
<td><code>Below 1200px</code></td>
|
||||
<td>Below <code>1200px</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -878,27 +878,27 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>backdrop</td>
|
||||
<td><code>backdrop</code></td>
|
||||
<td>boolean or the string <code>'static'</code></td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Includes a modal-backdrop element. Alternatively, specify <code>static</code> for a backdrop which doesn't close the modal on click.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>keyboard</td>
|
||||
<td><code>keyboard</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Closes the modal when escape key is pressed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>focus</td>
|
||||
<td><code>focus</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Puts the focus on the modal when initialized.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>show</td>
|
||||
<td><code>show</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Shows the modal when initialized.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -972,23 +972,23 @@ Bootstrap's modal class exposes a few events for hooking into modal functionalit
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>show.bs.modal</td>
|
||||
<td><code>show.bs.modal</code></td>
|
||||
<td>This event fires immediately when the <code>show</code> instance method is called. If caused by a click, the clicked element is available as the <code>relatedTarget</code> property of the event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>shown.bs.modal</td>
|
||||
<td><code>shown.bs.modal</code></td>
|
||||
<td>This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the <code>relatedTarget</code> property of the event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hide.bs.modal</td>
|
||||
<td><code>hide.bs.modal</code></td>
|
||||
<td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hidden.bs.modal</td>
|
||||
<td><code>hidden.bs.modal</code></td>
|
||||
<td>This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hidePrevented.bs.modal</td>
|
||||
<td><code>hidePrevented.bs.modal</code></td>
|
||||
<td>This event is fired when the modal is shown, its backdrop is <code>static</code> and a click outside the modal or an escape key press is performed with the keyboard option or <code>data-keyboard</code> set to <code>false</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -645,19 +645,19 @@ If no tab was already active, then the `hide.bs.tab` and `hidden.bs.tab` events
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>show.bs.tab</td>
|
||||
<td><code>show.bs.tab</code></td>
|
||||
<td>This event fires on tab show, but before the new tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>shown.bs.tab</td>
|
||||
<td><code>shown.bs.tab</code></td>
|
||||
<td>This event fires on tab show after a tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hide.bs.tab</td>
|
||||
<td><code>hide.bs.tab</code></td>
|
||||
<td>This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use <code>event.target</code> and <code>event.relatedTarget</code> to target the current active tab and the new soon-to-be-active tab, respectively.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hidden.bs.tab</td>
|
||||
<td><code>hidden.bs.tab</code></td>
|
||||
<td>This event fires after a new tab is shown (and thus the previous active tab is hidden). Use <code>event.target</code> and <code>event.relatedTarget</code> to target the previous active tab and the new active tab, respectively.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -164,32 +164,32 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>animation</td>
|
||||
<td><code>animation</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Apply a CSS fade transition to the popover</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container</td>
|
||||
<td><code>container</code></td>
|
||||
<td>string | element | false</td>
|
||||
<td>false</td>
|
||||
<td><code>false</code></td>
|
||||
<td>
|
||||
<p>Appends the popover to a specific element. Example: <code>container: 'body'</code>. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>content</td>
|
||||
<td><code>content</code></td>
|
||||
<td>string | element | function</td>
|
||||
<td>''</td>
|
||||
<td><code>''</code></td>
|
||||
<td>
|
||||
<p>Default content value if <code>data-content</code> attribute isn't present.</p>
|
||||
<p>If a function is given, it will be called with its <code>this</code> reference set to the element that the popover is attached to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>delay</td>
|
||||
<td><code>delay</code></td>
|
||||
<td>number | object</td>
|
||||
<td>0</td>
|
||||
<td><code>0</code></td>
|
||||
<td>
|
||||
<p>Delay showing and hiding the popover (ms) - does not apply to manual trigger type</p>
|
||||
<p>If a number is supplied, delay is applied to both hide/show</p>
|
||||
@ -197,28 +197,28 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>html</td>
|
||||
<td><code>html</code></td>
|
||||
<td>boolean</td>
|
||||
<td>false</td>
|
||||
<td><code>false</code></td>
|
||||
<td>Insert HTML into the popover. If false, <code>innerText</code> property will be used to insert content into the DOM. Use text if you're worried about XSS attacks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>placement</td>
|
||||
<td><code>placement</code></td>
|
||||
<td>string | function</td>
|
||||
<td>'right'</td>
|
||||
<td><code>'right'</code></td>
|
||||
<td>
|
||||
<p>How to position the popover - auto | top | bottom | left | right.<br>When <code>auto</code> is specified, it will dynamically reorient the popover.</p>
|
||||
<p>When a function is used to determine the placement, it is called with the popover DOM node as its first argument and the triggering element DOM node as its second. The <code>this</code> context is set to the popover instance.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>selector</td>
|
||||
<td><code>selector</code></td>
|
||||
<td>string | false</td>
|
||||
<td>false</td>
|
||||
<td><code>false</code></td>
|
||||
<td>If a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See <a href="{{< param repo >}}/issues/4215">this</a> and <a href="https://codepen.io/Johann-S/pen/djJYPb">an informative example</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>template</td>
|
||||
<td><code>template</code></td>
|
||||
<td>string</td>
|
||||
<td><code>'<div class="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>'</code></td>
|
||||
<td>
|
||||
@ -230,61 +230,61 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>title</td>
|
||||
<td><code>title</code></td>
|
||||
<td>string | element | function</td>
|
||||
<td>''</td>
|
||||
<td><code>''</code></td>
|
||||
<td>
|
||||
<p>Default title value if <code>title</code> attribute isn't present.</p>
|
||||
<p>If a function is given, it will be called with its <code>this</code> reference set to the element that the popover is attached to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>trigger</td>
|
||||
<td><code>trigger</code></td>
|
||||
<td>string</td>
|
||||
<td>'click'</td>
|
||||
<td><code>'click'</code></td>
|
||||
<td>How popover is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. <code>manual</code> cannot be combined with any other trigger.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>offset</td>
|
||||
<td><code>offset</code></td>
|
||||
<td>number | string</td>
|
||||
<td>0</td>
|
||||
<td><code>0</code></td>
|
||||
<td>Offset of the popover relative to its target. For more information refer to Popper.js's <a href="https://popper.js.org/docs/v1/#modifiers..offset.offset">offset docs</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fallbackPlacement</td>
|
||||
<td><code>fallbackPlacement</code></td>
|
||||
<td>string | array</td>
|
||||
<td>'flip'</td>
|
||||
<td><code>'flip'</code></td>
|
||||
<td>Allow to specify which position Popper will use on fallback. For more information refer to
|
||||
Popper.js's <a href="https://popper.js.org/docs/v1/#modifiers..flip.behavior">behavior docs</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>boundary</td>
|
||||
<td><code>boundary</code></td>
|
||||
<td>string | element</td>
|
||||
<td>'scrollParent'</td>
|
||||
<td><code>'scrollParent'</code></td>
|
||||
<td>Overflow constraint boundary of the popover. Accepts the values of <code>'viewport'</code>, <code>'window'</code>, <code>'scrollParent'</code>, or an HTMLElement reference (JavaScript only). For more information refer to Popper.js's <a href="https://popper.js.org/docs/v1/#modifiers..preventOverflow.boundariesElement">preventOverflow docs</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sanitize</td>
|
||||
<td><code>sanitize</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Enable or disable the sanitization. If activated <code>'template'</code>, <code>'content'</code> and <code>'title'</code> options will be sanitized.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>allowList</td>
|
||||
<td><code>allowList</code></td>
|
||||
<td>object</td>
|
||||
<td><a href="{{< docsref "/getting-started/javascript#sanitizer" >}}">Default value</a></td>
|
||||
<td>Object which contains allowed attributes and tags</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sanitizeFn</td>
|
||||
<td><code>sanitizeFn</code></td>
|
||||
<td>null | function</td>
|
||||
<td>null</td>
|
||||
<td><code>null</code></td>
|
||||
<td>Here you can supply your own sanitize function. This can be useful if you prefer to use a dedicated library to perform sanitization.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>popperConfig</td>
|
||||
<td><code>popperConfig</code></td>
|
||||
<td>null | object</td>
|
||||
<td>null</td>
|
||||
<td><code>null</code></td>
|
||||
<td>To change Bootstrap's default Popper.js config, see <a href="https://popper.js.org/docs/v1/#Popper.Defaults">Popper.js's configuration</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -311,19 +311,19 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>offset</td>
|
||||
<td><code>offset</code></td>
|
||||
<td>number</td>
|
||||
<td>10</td>
|
||||
<td><code>10</code></td>
|
||||
<td>Pixels to offset from top when calculating position of scroll.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>method</td>
|
||||
<td><code>method</code></td>
|
||||
<td>string</td>
|
||||
<td>auto</td>
|
||||
<td><code>auto</code></td>
|
||||
<td>Finds which section the spied element is in. <code>auto</code> will choose the best method to get scroll coordinates. <code>offset</code> will use the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect"><code>Element.getBoundingClientRect()</code></a> method to get scroll coordinates. <code>position</code> will use the <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/offsetTop"><code>HTMLElement.offsetTop</code></a> and <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/offsetLeft"><code>HTMLElement.offsetLeft</code></a> properties to get scroll coordinates.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>target</td>
|
||||
<td><code>target</code></td>
|
||||
<td>string | jQuery object | DOM element</td>
|
||||
<td></td>
|
||||
<td>Specifies element to apply Scrollspy plugin.</td>
|
||||
@ -342,7 +342,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>activate.bs.scrollspy</td>
|
||||
<td><code>activate.bs.scrollspy</code></td>
|
||||
<td>This event fires on the scroll element whenever a new item becomes activated by the scrollspy.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -294,19 +294,19 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>animation</td>
|
||||
<td><code>animation</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Apply a CSS fade transition to the toast</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>autohide</td>
|
||||
<td><code>autohide</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Auto hide the toast</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>delay</td>
|
||||
<td><code>delay</code></td>
|
||||
<td>number</td>
|
||||
<td>
|
||||
<code>500</code>
|
||||
@ -352,19 +352,19 @@ Hides an element's toast. Your toast will remain on the DOM but won't show anymo
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>show.bs.toast</td>
|
||||
<td><code>show.bs.toast</code></td>
|
||||
<td>This event fires immediately when the <code>show</code> instance method is called.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>shown.bs.toast</td>
|
||||
<td><code>shown.bs.toast</code></td>
|
||||
<td>This event is fired when the toast has been made visible to the user.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hide.bs.toast</td>
|
||||
<td><code>hide.bs.toast</code></td>
|
||||
<td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hidden.bs.toast</td>
|
||||
<td><code>hidden.bs.toast</code></td>
|
||||
<td>This event is fired when the toast has finished being hidden from the user.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -170,23 +170,23 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>animation</td>
|
||||
<td><code>animation</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Apply a CSS fade transition to the tooltip</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>container</td>
|
||||
<td><code>container</code></td>
|
||||
<td>string | element | false</td>
|
||||
<td>false</td>
|
||||
<td><code>false</code></td>
|
||||
<td>
|
||||
<p>Appends the tooltip to a specific element. Example: <code>container: 'body'</code>. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>delay</td>
|
||||
<td><code>delay</code></td>
|
||||
<td>number | object</td>
|
||||
<td>0</td>
|
||||
<td><code>0</code></td>
|
||||
<td>
|
||||
<p>Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type</p>
|
||||
<p>If a number is supplied, delay is applied to both hide/show</p>
|
||||
@ -194,9 +194,9 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>html</td>
|
||||
<td><code>html</code></td>
|
||||
<td>boolean</td>
|
||||
<td>false</td>
|
||||
<td><code>false</code></td>
|
||||
<td>
|
||||
<p>Allow HTML in the tooltip.</p>
|
||||
<p>If true, HTML tags in the tooltip's <code>title</code> will be rendered in the tooltip. If false, <code>innerText</code> property will be used to insert content into the DOM.</p>
|
||||
@ -204,22 +204,22 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>placement</td>
|
||||
<td><code>placement</code></td>
|
||||
<td>string | function</td>
|
||||
<td>'top'</td>
|
||||
<td><code>'top'</code></td>
|
||||
<td>
|
||||
<p>How to position the tooltip - auto | top | bottom | left | right.<br>When <code>auto</code> is specified, it will dynamically reorient the tooltip.</p>
|
||||
<p>When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The <code>this</code> context is set to the tooltip instance.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>selector</td>
|
||||
<td><code>selector</code></td>
|
||||
<td>string | false</td>
|
||||
<td>false</td>
|
||||
<td><code>false</code></td>
|
||||
<td>If a selector is provided, tooltip objects will be delegated to the specified targets. In practice, this is used to also apply tooltips to dynamically added DOM elements (<code>jQuery.on</code> support). See <a href="{{< param repo >}}/issues/4215">this</a> and <a href="https://codepen.io/Johann-S/pen/djJYPb">an informative example</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>template</td>
|
||||
<td><code>template</code></td>
|
||||
<td>string</td>
|
||||
<td><code>'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>'</code></td>
|
||||
<td>
|
||||
@ -230,18 +230,18 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>title</td>
|
||||
<td><code>title</code></td>
|
||||
<td>string | element | function</td>
|
||||
<td>''</td>
|
||||
<td><code>''</code></td>
|
||||
<td>
|
||||
<p>Default title value if <code>title</code> attribute isn't present.</p>
|
||||
<p>If a function is given, it will be called with its <code>this</code> reference set to the element that the tooltip is attached to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>trigger</td>
|
||||
<td><code>trigger</code></td>
|
||||
<td>string</td>
|
||||
<td>'hover focus'</td>
|
||||
<td><code>'hover focus'</code></td>
|
||||
<td>
|
||||
<p>How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.</p>
|
||||
<p><code>'manual'</code> indicates that the tooltip will be triggered programmatically via the <code>.tooltip('show')</code>, <code>.tooltip('hide')</code> and <code>.tooltip('toggle')</code> methods; this value cannot be combined with any other trigger.</p>
|
||||
@ -249,9 +249,9 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>offset</td>
|
||||
<td><code>offset</code></td>
|
||||
<td>number | string | function</td>
|
||||
<td>0</td>
|
||||
<td><code>0</code></td>
|
||||
<td>
|
||||
<p>Offset of the tooltip relative to its target.</p>
|
||||
<p>When a function is used to determine the offset, it is called with an object containing the offset data as its first argument. The function must return an object with the same structure. The triggering element DOM node is passed as the second argument.</p>
|
||||
@ -259,40 +259,40 @@ Note that for security reasons the `sanitize`, `sanitizeFn`, and `allowList` opt
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fallbackPlacement</td>
|
||||
<td><code>fallbackPlacement</code></td>
|
||||
<td>string | array</td>
|
||||
<td>'flip'</td>
|
||||
<td><code>'flip'</code></td>
|
||||
<td>Allow to specify which position Popper will use on fallback. For more information refer to
|
||||
Popper.js's <a href="https://popper.js.org/docs/v1/#modifiers..flip.behavior">behavior docs</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>boundary</td>
|
||||
<td><code>boundary</code></td>
|
||||
<td>string | element</td>
|
||||
<td>'scrollParent'</td>
|
||||
<td><code>'scrollParent'</code></td>
|
||||
<td>Overflow constraint boundary of the tooltip. Accepts the values of <code>'viewport'</code>, <code>'window'</code>, <code>'scrollParent'</code>, or an HTMLElement reference (JavaScript only). For more information refer to Popper.js's <a href="https://popper.js.org/docs/v1/#modifiers..preventOverflow.boundariesElement">preventOverflow docs</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sanitize</td>
|
||||
<td><code>sanitize</code></td>
|
||||
<td>boolean</td>
|
||||
<td>true</td>
|
||||
<td><code>true</code></td>
|
||||
<td>Enable or disable the sanitization. If activated <code>'template'</code> and <code>'title'</code> options will be sanitized.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>allowList</td>
|
||||
<td><code>allowList</code></td>
|
||||
<td>object</td>
|
||||
<td><a href="{{< docsref "/getting-started/javascript#sanitizer" >}}">Default value</a></td>
|
||||
<td>Object which contains allowed attributes and tags</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sanitizeFn</td>
|
||||
<td><code>sanitizeFn</code></td>
|
||||
<td>null | function</td>
|
||||
<td>null</td>
|
||||
<td><code>null</code></td>
|
||||
<td>Here you can supply your own sanitize function. This can be useful if you prefer to use a dedicated library to perform sanitization.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>popperConfig</td>
|
||||
<td><code>popperConfig</code></td>
|
||||
<td>null | object</td>
|
||||
<td>null</td>
|
||||
<td><code>null</code></td>
|
||||
<td>To change Bootstrap's default Popper.js config, see <a href="https://popper.js.org/docs/v1/#Popper.Defaults">Popper.js's configuration</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -369,23 +369,23 @@ Updates the position of an element's tooltip.
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>show.bs.tooltip</td>
|
||||
<td><code>show.bs.tooltip</code></td>
|
||||
<td>This event fires immediately when the <code>show</code> instance method is called.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>shown.bs.tooltip</td>
|
||||
<td><code>shown.bs.tooltip</code></td>
|
||||
<td>This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hide.bs.tooltip</td>
|
||||
<td><code>hide.bs.tooltip</code></td>
|
||||
<td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>hidden.bs.tooltip</td>
|
||||
<td><code>hidden.bs.tooltip</code></td>
|
||||
<td>This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>inserted.bs.tooltip</td>
|
||||
<td><code>inserted.bs.tooltip</code></td>
|
||||
<td>This event is fired after the <code>show.bs.tooltip</code> event when the tooltip template has been added to the DOM.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user