Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that tooltip+popover show+hide methods are async #15580

Merged
merged 1 commit into from
Jan 16, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/_includes/js/popovers.html
Original file line number Diff line number Diff line change
Expand Up @@ -252,20 +252,21 @@ <h4>$().popover(options)</h4>
<p>Initializes popovers for an element collection.</p>

<h4>.popover('show')</h4>
<p>Reveals an element's popover. This is considered a "manual" triggering of the popover. Popovers whose both title and content are zero-length are never displayed.</p>
<p>Reveals an element's popover. <strong>Returns to the caller before the popover has actually been shown</strong> (i.e. before the <code>shown.bs.popover</code> event occurs). This is considered a "manual" triggering of the popover. Popovers whose both title and content are zero-length are never displayed.</p>
{% highlight js %}$('#element').popover('show'){% endhighlight %}

<h4>.popover('hide')</h4>
<p>Hides an element's popover. This is considered a "manual" triggering of the popover.</p>
<p>Hides an element's popover. <strong>Returns to the caller before the popover has actually been hidden</strong> (i.e. before the <code>hidden.bs.popover</code> event occurs). This is considered a "manual" triggering of the popover.</p>
{% highlight js %}$('#element').popover('hide'){% endhighlight %}

<h4>.popover('toggle')</h4>
<p>Toggles an element's popover. This is considered a "manual" triggering of the popover.</p>
<p>Toggles an element's popover. <strong>Returns to the caller before the popover has actually been shown or hidden</strong> (i.e. before the <code>shown.bs.popover</code> or <code>hidden.bs.popover</code> event occurs). This is considered a "manual" triggering of the popover.</p>
{% highlight js %}$('#element').popover('toggle'){% endhighlight %}

<h4>.popover('destroy')</h4>
<p>Hides and destroys an element's popover.</p>
{% highlight js %}$('#element').popover('destroy'){% endhighlight %}

<h3 id="popovers-events">Events</h3>
<div class="table-responsive">
<table class="table table-bordered table-striped bs-events-table">
Expand Down
6 changes: 3 additions & 3 deletions docs/_includes/js/tooltips.html
Original file line number Diff line number Diff line change
Expand Up @@ -213,15 +213,15 @@ <h4>$().tooltip(options)</h4>
<p>Attaches a tooltip handler to an element collection.</p>

<h4>.tooltip('show')</h4>
<p>Reveals an element's tooltip. This is considered a "manual" triggering of the tooltip. Tooltips with zero-length titles are never displayed.</p>
<p>Reveals an element's tooltip. <strong>Returns to the caller before the tooltip has actually been shown</strong> (i.e. before the <code>shown.bs.tooltip</code> event occurs). This is considered a "manual" triggering of the tooltip. Tooltips with zero-length titles are never displayed.</p>
{% highlight js %}$('#element').tooltip('show'){% endhighlight %}

<h4>.tooltip('hide')</h4>
<p>Hides an element's tooltip. This is considered a "manual" triggering of the tooltip.</p>
<p>Hides an element's tooltip. <strong>Returns to the caller before the tooltip has actually been hidden</strong> (i.e. before the <code>hidden.bs.tooltip</code> event occurs). This is considered a "manual" triggering of the tooltip.</p>
{% highlight js %}$('#element').tooltip('hide'){% endhighlight %}

<h4>.tooltip('toggle')</h4>
<p>Toggles an element's tooltip. This is considered a "manual" triggering of the tooltip.</p>
<p>Toggles an element's tooltip. <strong>Returns to the caller before the tooltip has actually been shown or hidden</strong> (i.e. before the <code>shown.bs.tooltip</code> or <code>hidden.bs.tooltip</code> event occurs). This is considered a "manual" triggering of the tooltip.</p>
{% highlight js %}$('#element').tooltip('toggle'){% endhighlight %}

<h4>.tooltip('destroy')</h4>
Expand Down