From f98883fc442145de1067d68a37c6353f2db31038 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Mon, 30 Mar 2015 20:55:00 -0700 Subject: move more js stuff to components section --- docs/javascript/popovers.md | 332 -------------------------------------------- 1 file changed, 332 deletions(-) delete mode 100644 docs/javascript/popovers.md (limited to 'docs/javascript/popovers.md') diff --git a/docs/javascript/popovers.md b/docs/javascript/popovers.md deleted file mode 100644 index e1e2c9664..000000000 --- a/docs/javascript/popovers.md +++ /dev/null @@ -1,332 +0,0 @@ ---- -layout: page -title: Popovers ---- - -Add small overlays of content, like those on the iPad, to any element for housing secondary information. - -Popovers whose both title and content are zero-length are never displayed. - -
-

Plugin dependency

-

Popovers require the tooltip plugin to be included in your version of Bootstrap.

-
-
-

Opt-in functionality

-

For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning you must initialize them yourself.

-

One way to initialize all popovers on a page would be to select them by their data-toggle attribute:

-{% highlight js %} -$(function () { - $('[data-toggle="popover"]').popover() -}) -{% endhighlight %} -
-
-

Popovers in button groups and input groups require special setting

-

When using popovers on elements within a .btn-group or an .input-group, you'll have to specify the option container: 'body' (documented below) to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the popover is triggered).

-
-
-

Don't try to show popovers on hidden elements

-

Invoking $(...).popover('show') when the target element is display: none; will cause the popover to be incorrectly positioned.

-
-
-

Popovers on disabled elements require wrapper elements

-

To add a popover to a disabled or .disabled element, put the element inside of a <div> and apply the popover to that <div> instead.

-
-
-

Multiple-line links

-

Sometimes you want to add a popover to a hyperlink that wraps multiple lines. The default behavior of the popover plugin is to center it horizontally and vertically. Add white-space: nowrap; to your anchors to avoid this.

-
- -### Static popover - -Four options are available: top, right, bottom, and left aligned. - -
-
-
-

Popover top

-
-

Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

-
-
- -
-
-

Popover right

-
-

Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

-
-
- -
-
-

Popover bottom

- -
-

Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

-
-
- -
-
-

Popover left

-
-

Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

-
-
- -
-
- -### Live demo - -{% example html %} - -{% endexample %} - -#### Four directions - -
-
- - - - -
-
- -{% highlight html %} - - - - - - - -{% endhighlight %} - -#### Dismiss on next click - -Use the `focus` trigger to dismiss popovers on the next click that the user makes. - -
-

Specific markup required for dismiss-on-next-click

-

For proper cross-browser and cross-platform behavior, you must use the <a> tag, not the <button> tag, and you also must include a tabindex attribute.

-
- -{% example html %} -Dismissible popover -{% endexample %} - -{% highlight js %} -$('.popover-dismiss').popover({ - trigger: 'focus' -}) -{% endhighlight %} - - - -## Usage - -Enable popovers via JavaScript: - -{% highlight js %}$('#example').popover(options){% endhighlight %} - -### Options - -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 popover
containerstring | falsefalse -

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

-
contentstring | function'' -

Default content value if data-content attribute isn't present.

-

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

-
delaynumber | object0 -

Delay showing and hiding the popover (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 }

-
htmlbooleanfalseInsert HTML into the popover. 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'right' -

How to position the popover - top | bottom | left | right | auto.
When "auto" is specified, it will dynamically reorient the popover. For example, if placement is "auto left", the popover will display to the left when possible, otherwise it will display right.

-

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 this context is set to the popover 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="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-title"></h3><div class="popover-content"></div></div>' -

Base HTML to use when creating the popover.

-

The popover's title will be injected into the .popover-title.

-

The popover's content will be injected into the .popover-content.

-

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

-

The outermost wrapper element should have the .popover class.

-
titlestring | 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 popover is attached to.

-
triggerstring'click'How popover is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.
viewportstring | object{ selector: 'body', padding: 0 } -

Keeps the popover within the bounds of this element. Example: viewport: '#viewport' or { "selector": "#viewport", "padding": 0 }

-
-
- -
-

Data attributes for individual popovers

-

Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.

-
- -### Methods - -#### $().popover(options) - -Initializes popovers for an element collection. - -#### .popover('show') - -Reveals an element's popover. **Returns to the caller before the popover has actually been shown** (i.e. before the `shown.bs.popover` event occurs). This is considered a "manual" triggering of the popover. Popovers whose both title and content are zero-length are never displayed. - -{% highlight js %}$('#element').popover('show'){% endhighlight %} - -#### .popover('hide') - -Hides an element's popover. **Returns to the caller before the popover has actually been hidden** (i.e. before the `hidden.bs.popover` event occurs). This is considered a "manual" triggering of the popover. - -{% highlight js %}$('#element').popover('hide'){% endhighlight %} - -#### .popover('toggle') - -Toggles an element's popover. **Returns to the caller before the popover has actually been shown or hidden** (i.e. before the `shown.bs.popover` or `hidden.bs.popover` event occurs). This is considered a "manual" triggering of the popover. - -{% highlight js %}$('#element').popover('toggle'){% endhighlight %} - -#### .popover('destroy') - -Hides and destroys an element's popover. Popvoers that use delegation (which are created using [the `selector` option](#popovers-options)) cannot be individually destroyed on descendant trigger elements. - - -{% highlight js %}$('#element').popover('destroy'){% endhighlight %} - -### Events - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.popoverThis event fires immediately when the show instance method is called.
shown.bs.popoverThis event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.popoverThis event is fired immediately when the hide instance method has been called.
hidden.bs.popoverThis event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).
-
- -{% highlight js %} -$('#myPopover').on('hidden.bs.popover', function () { - // do something… -}) -{% endhighlight %} -- cgit v1.2.3