From 2a43e7e78a59c70e217383c12c9ef0482cabb163 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 16 Mar 2014 19:03:53 -0700 Subject: Break up docs into includes --- docs/_includes/js/dropdowns.html | 177 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 177 insertions(+) create mode 100644 docs/_includes/js/dropdowns.html (limited to 'docs/_includes/js/dropdowns.html') diff --git a/docs/_includes/js/dropdowns.html b/docs/_includes/js/dropdowns.html new file mode 100644 index 000000000..6b8c26ed5 --- /dev/null +++ b/docs/_includes/js/dropdowns.html @@ -0,0 +1,177 @@ +
+

Dropdowns dropdown.js

+ + +

Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.

+ +

Within a navbar

+
+ +
+ +

Within pills

+
+ +
+ + + +

Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the .open class on the parent list item. When opened, the plugin also adds .dropdown-backdrop as a click area for closing dropdown menus when clicking outside the menu. Note: The data-toggle=dropdown attribute is relied on for closing dropdown menus at an application level, so it's a good idea to always use it.

+ +

Via data attributes

+

Add data-toggle="dropdown" to a link or button to toggle a dropdown.

+{% highlight html %} +
+ Dropdown trigger + +
+{% endhighlight %} +

To keep URLs intact, use the data-target attribute instead of href="#".

+{% highlight html %} +
+ + Dropdown + + + + +
+{% endhighlight %} + +

Via JavaScript

+

Call the dropdowns via JavaScript:

+{% highlight js %} +$('.dropdown-toggle').dropdown() +{% endhighlight %} +
+

data-toggle="dropdown" still required

+

Regardless of whether you call your dropdown via JavaScript or instead use the data-api, data-toggle="dropdown" is always required to be present on the dropdown's trigger element.

+
+ +

Options

+

None

+ +

Methods

+

$().dropdown('toggle')

+

Toggles the dropdown menu of a given navbar or tabbed navigation.

+ +

Events

+

All dropdown events are fired at the .dropdown-menu's parent element.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Event TypeDescription
show.bs.dropdownThis event fires immediately when the show instance method is called. The toggling anchor element is available as the relatedTarget property of the event.
shown.bs.dropdownThis event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete). The toggling anchor element is available as the relatedTarget property of the event.
hide.bs.dropdownThis event is fired immediately when the hide instance method has been called. The toggling anchor element is available as the relatedTarget property of the event.
hidden.bs.dropdownThis event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete). The toggling anchor element is available as the relatedTarget property of the event.
+
+{% highlight js %} +$('#myDropdown').on('show.bs.dropdown', function () { + // do something… +}) +{% endhighlight %} +
-- cgit v1.2.3