From ff8d28cf2501773ff6f7833865c8e2b2ebb76a3f Mon Sep 17 00:00:00 2001 From: Quy Date: Sat, 31 Dec 2016 16:12:28 -0800 Subject: Move .table-responsive from wrapper to .table --- docs/components/tooltips.md | 254 ++++++++++++++++++++++---------------------- 1 file changed, 125 insertions(+), 129 deletions(-) (limited to 'docs/components/tooltips.md') diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md index 31fb2c1c7..deb84b778 100644 --- a/docs/components/tooltips.md +++ b/docs/components/tooltips.md @@ -146,107 +146,105 @@ You should only add tooltips to HTML elements that are traditionally keyboard-fo Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-animation=""`. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
animationbooleantrueApply a CSS fade transition to the tooltip
containerstring | element | falsefalse -

Appends the tooltip to a specific element. Example: container: 'body'. 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.

-
delaynumber | object0 -

Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type

-

If a number is supplied, delay is applied to both hide/show

-

Object structure is: delay: { "show": 500, "hide": 100 }

-
htmlbooleanfalse -

Allow HTML in the tooltip.

-

If true, HTML tags in the tooltip's title will be rendered in the tooltip. If false, jQuery's text method will be used to insert content into the DOM.

-

Use text if you're worried about XSS attacks.

-
placementstring | function'top' -

How to position the tooltip - top | bottom | left | right.

-

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 this context is set to the tooltip instance.

-
selectorstringfalseIf 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 this and an informative example.
templatestring'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>' -

Base HTML to use when creating the tooltip.

-

The tooltip's title will be injected into the .tooltip-inner.

-

.tooltip-arrow will become the tooltip's arrow.

-

The outermost wrapper element should have the .tooltip class.

-
titlestring | element | function'' -

Default title value if title attribute isn't present.

-

If a function is given, it will be called with its this reference set to the element that the tooltip is attached to.

-
triggerstring'hover focus'How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
constraintsArray[]An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offsetstring'0 0'Offset of the popover relative to its target. For more information refer to Tether's offset docs.
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
animationbooleantrueApply a CSS fade transition to the tooltip
containerstring | element | falsefalse +

Appends the tooltip to a specific element. Example: container: 'body'. 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.

+
delaynumber | object0 +

Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type

+

If a number is supplied, delay is applied to both hide/show

+

Object structure is: delay: { "show": 500, "hide": 100 }

+
htmlbooleanfalse +

Allow HTML in the tooltip.

+

If true, HTML tags in the tooltip's title will be rendered in the tooltip. If false, jQuery's text method will be used to insert content into the DOM.

+

Use text if you're worried about XSS attacks.

+
placementstring | function'top' +

How to position the tooltip - top | bottom | left | right.

+

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 this context is set to the tooltip instance.

+
selectorstringfalseIf 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 this and an informative example.
templatestring'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>' +

Base HTML to use when creating the tooltip.

+

The tooltip's title will be injected into the .tooltip-inner.

+

.tooltip-arrow will become the tooltip's arrow.

+

The outermost wrapper element should have the .tooltip class.

+
titlestring | element | function'' +

Default title value if title attribute isn't present.

+

If a function is given, it will be called with its this reference set to the element that the tooltip is attached to.

+
triggerstring'hover focus'How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
constraintsArray[]An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offsetstring'0 0'Offset of the popover relative to its target. For more information refer to Tether's offset docs.
{% callout info %} #### Data attributes for individual tooltips @@ -286,34 +284,32 @@ Hides and destroys an element's tooltip. Tooltips that use delegation (which are ### Events -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.tooltipThis event fires immediately when the show instance method is called.
shown.bs.tooltipThis event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.tooltipThis event is fired immediately when the hide instance method has been called.
hidden.bs.tooltipThis event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
-
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Event TypeDescription
show.bs.tooltipThis event fires immediately when the show instance method is called.
shown.bs.tooltipThis event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.tooltipThis event is fired immediately when the hide instance method has been called.
hidden.bs.tooltipThis event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
{% highlight js %} $('#myTooltip').on('hidden.bs.tooltip', function () { -- cgit v1.2.3 From 98e55484e73aeac37fedd9cc260f4b16f9c04698 Mon Sep 17 00:00:00 2001 From: Quy Date: Thu, 5 Jan 2017 14:24:40 -0800 Subject: Doc updates (#21542) * Change it's to its. * Fix links * Fix typos --- docs/components/tooltips.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/components/tooltips.md') diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md index deb84b778..825782ac2 100644 --- a/docs/components/tooltips.md +++ b/docs/components/tooltips.md @@ -203,7 +203,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap selector string false - 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 this and an informative example. + If a selector is provided, tooltip objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See this and an informative example. template @@ -241,7 +241,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap offset string '0 0' - Offset of the popover relative to its target. For more information refer to Tether's offset docs. + Offset of the tooltip relative to its target. For more information refer to Tether's offset docs. -- cgit v1.2.3 From d2b919143c3fdb736ba7efae6bfb34937993db71 Mon Sep 17 00:00:00 2001 From: Sid Date: Fri, 24 Mar 2017 06:32:39 -0400 Subject: Add missing v4 docs for tooltip/popover methods (#22246) Add missing v4 docs for tooltip/popover methods --- docs/components/tooltips.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'docs/components/tooltips.md') diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md index 825782ac2..eaab24da5 100644 --- a/docs/components/tooltips.md +++ b/docs/components/tooltips.md @@ -282,6 +282,24 @@ Hides and destroys an element's tooltip. Tooltips that use delegation (which are {% highlight js %}$('#element').tooltip('dispose'){% endhighlight %} +#### `.tooltip('enable')` + +Gives an element's tooltip the ability to be shown. **Tooltips are enabled by default.** + +{% highlight js %}$('#element').tooltip('enable'){% endhighlight %} + +#### `.tooltip('disable')` + +Removes the ability for an element's tooltip to be shown. The tooltip will only be able to be shown if it is re-enabled. + +{% highlight js %}$('#element').tooltip('disable'){% endhighlight %} + +#### `.tooltip('toggleEnabled')` + +Toggles the ability for an element's tooltip to be shown or hidden. + +{% highlight js %}$('#element').tooltip('toggleEnabled'){% endhighlight %} + ### Events -- cgit v1.2.3 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/components/tooltips.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/components/tooltips.md') diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md index eaab24da5..a8b251c09 100644 --- a/docs/components/tooltips.md +++ b/docs/components/tooltips.md @@ -254,6 +254,9 @@ Options for individual tooltips can alternatively be specified through the use o ### Methods +{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} +{{ callout-include | markdownify }} + #### `$().tooltip(options)` Attaches a tooltip handler to an element collection. -- cgit v1.2.3 From 31a21044e021a591d0e9d6eba9ee17d2000e17ac Mon Sep 17 00:00:00 2001 From: Johann-S Date: Fri, 7 Apr 2017 14:23:26 +0200 Subject: Documentation - Add inserted event for Tooltip and Popover --- docs/components/tooltips.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/components/tooltips.md') diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md index a8b251c09..7c7f9af8b 100644 --- a/docs/components/tooltips.md +++ b/docs/components/tooltips.md @@ -329,6 +329,10 @@ Toggles the ability for an element's tooltip to be shown or hidden. + + + +
hidden.bs.tooltip This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
inserted.bs.tooltipThis event is fired after the show.bs.tooltip event when the tooltip template has been added to the DOM.
-- cgit v1.2.3 From f7f644a4e52a7e875d5c8574d2a8b7fd919e5005 Mon Sep 17 00:00:00 2001 From: "Patrick H. Lauke" Date: Thu, 27 Apr 2017 23:57:10 +0100 Subject: Documentation cleanup (inc. use of for static form controls example) * Fix incorrect code indentation * Remove unnecessary vendor prefix for `box-sizing` - all modern browsers now support this unprefixed * Remove incorrect `