diff options
| author | Mark Otto <[email protected]> | 2015-03-30 18:23:35 -0700 |
|---|---|---|
| committer | Mark Otto <[email protected]> | 2015-03-30 18:23:35 -0700 |
| commit | c86a8736c6334132e4cc5a7f50da8e8b43dc10df (patch) | |
| tree | 9733669b227d02577d06155ff8b2e6174c00216c /docs/components | |
| parent | 309264509df28a2d78dfa6a25a8e6e8887cca419 (diff) | |
| download | bootstrap-c86a8736c6334132e4cc5a7f50da8e8b43dc10df.tar.xz bootstrap-c86a8736c6334132e4cc5a7f50da8e8b43dc10df.zip | |
Consolidate dropdown docs into single page
Diffstat (limited to 'docs/components')
| -rw-r--r-- | docs/components/dropdowns.md | 113 |
1 files changed, 107 insertions, 6 deletions
diff --git a/docs/components/dropdowns.md b/docs/components/dropdowns.md index 4c4ad61d0..efb0f6309 100644 --- a/docs/components/dropdowns.md +++ b/docs/components/dropdowns.md @@ -3,9 +3,9 @@ layout: page title: Dropdowns --- -Toggleable, contextual menu for displaying lists of links. Made interactive with the [dropdown JavaScript plugin]({{ site.bsaeurl }}javascript/#dropdowns). +Toggleable, contextual menu for displaying lists of links. Made interactive with the included dropdown JavaScript plugin. -### Example +## Example Wrap the dropdown's trigger and the dropdown menu within `.dropdown`, or another element that declares `position: relative;`. Then add the menu's HTML. @@ -28,7 +28,7 @@ Wrap the dropdown's trigger and the dropdown menu within `.dropdown`, or another </div> {% endexample %} -### Alignment +## Alignment By default, a dropdown menu is automatically positioned 100% from the top and along the left side of its parent. Add `.dropdown-menu-right` to a `.dropdown-menu` to right align the dropdown menu. @@ -43,7 +43,7 @@ By default, a dropdown menu is automatically positioned 100% from the top and al </ul> {% endhighlight %} -### Menu headers +## Menu headers Add a header to label sections of actions in any dropdown menu. @@ -59,7 +59,7 @@ Add a header to label sections of actions in any dropdown menu. </ul> {% endexample %} -### Menu dividers +## Menu dividers Separate groups of related menu items with a divider. @@ -81,7 +81,7 @@ Separate groups of related menu items with a divider. </ul> {% endexample %} -### Disabled menu items +## Disabled menu items Add `.disabled` to a `<li>` in the dropdown to disable the link. @@ -98,3 +98,104 @@ Add `.disabled` to a `<li>` in the dropdown to disable the link. </li> </ul> {% endexample %} + +## Usage + +Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the `.open` class on the parent list item. + +On mobile devices, opening a dropdown adds a `.dropdown-backdrop` as a tap area for closing dropdown menus when tapping outside the menu, a requirement for proper iOS support. **This means that switching from an open dropdown menu to a different dropdown menu requires an extra tap on mobile.** + +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 %} +<div class="dropdown"> + <button id="dLabel" type="button" data-toggle="dropdown"> + Dropdown trigger + <span class="caret"></span> + </button> + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + ... + </ul> +</div> +{% endhighlight %} + +To keep URLs intact with link buttons, use the `data-target` attribute instead of `href="#"`. + +{% highlight html %} +<div class="dropdown"> + <a id="dLabel" data-target="#" href="http://example.com" data-toggle="dropdown"> + Dropdown trigger + <span class="caret"></span> + </a> + + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + ... + </ul> +</div> +{% endhighlight %} + +### Via JavaScript + +Call the dropdowns via JavaScript: + +{% highlight js %} +$('.dropdown-toggle').dropdown() +{% endhighlight %} + +<div class="bs-callout bs-callout-info"> + <h4><code>data-toggle="dropdown"</code> still required</h4> + <p>Regardless of whether you call your dropdown via JavaScript or instead use the data-api, <code>data-toggle="dropdown"</code> is always required to be present on the dropdown's trigger element.</p> +</div> + +### 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 and have a `relatedTarget` property, whose value is the toggling anchor element. + +<div class="table-responsive"> + <table class="table table-bordered table-striped"> + <thead> + <tr> + <th style="width: 150px;">Event Type</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>show.bs.dropdown</td> + <td>This event fires immediately when the show instance method is called.</td> + </tr> + <tr> + <td>shown.bs.dropdown</td> + <td>This event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete).</td> + </tr> + <tr> + <td>hide.bs.dropdown</td> + <td>This event is fired immediately when the hide instance method has been called.</td> + </tr> + <tr> + <td>hidden.bs.dropdown</td> + <td>This event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete).</td> + </tr> + </tbody> + </table> +</div> + +{% highlight js %} +$('#myDropdown').on('show.bs.dropdown', function () { + // do something… +}) +{% endhighlight %} |
