From ea9f846e0f3f192fded759c8ba40ceee96cb66c9 Mon Sep 17 00:00:00 2001 From: Starsam80 Date: Sun, 4 Dec 2016 17:46:57 -0700 Subject: Remove `.float-left` from card header nav (#21292) --- docs/components/card.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/components') diff --git a/docs/components/card.md b/docs/components/card.md index 7d350708c..efce231ce 100644 --- a/docs/components/card.md +++ b/docs/components/card.md @@ -226,12 +226,12 @@ Card headers can be styled by adding `.card-header` to `` elements. ## Header nav -Use Bootstrap's nav pills or tabs within a card header. Be sure to always include a `.float-*-*` utility class for proper alignment. +Use Bootstrap's nav pills or tabs within a card header. {% example html %}

Active

Active

Date: Sun, 4 Dec 2016 19:53:37 -0800 Subject: update left/right classes on controls and add img classes --- docs/components/carousel.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 3942309f0..025edd4cc 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -25,20 +25,20 @@ When building carousels, be sure your slides are the same size as one another. T - + - + -- cgit v1.2.3 From d57ec902434406534530168547de5db0963011d5 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 4 Dec 2016 20:06:45 -0800 Subject: clear up docs intro --- docs/components/carousel.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 025edd4cc..03194cdf2 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -5,7 +5,11 @@ description: A slideshow component for cycling through elements—images or slid group: components --- -A slideshow component for cycling through elements—images or slides of text—like a carousel. In browsers where the [Page Visibility API](https://www.w3.org/TR/page-visibility/) is supported, the carousel will avoid sliding when the webpage is not visible to the user (such as when the browser tab is inactive, the browser window is minimized, etc.). **Nested carousels are not supported.** +The carousel is a slideshow for cycling through a series of content, built with CSS 3D transforms and a bit of JavaScript. It works with a series of images, text, or custom markup. It also includes support for previous/next controls and indicators. + +In browsers where the [Page Visibility API](https://www.w3.org/TR/page-visibility/) is supported, the carousel will avoid sliding when the webpage is not visible to the user (such as when the browser tab is inactive, the browser window is minimized, etc.). + +**Nested carousels are not supported.** ## Contents -- cgit v1.2.3 From b0db5788dfee52cf0d52971938b5b1cbc4b7d3b9 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 4 Dec 2016 20:07:01 -0800 Subject: break up example into three separate examples to show flexibility --- docs/components/carousel.md | 69 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 62 insertions(+), 7 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 03194cdf2..12c638be8 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -18,14 +18,68 @@ In browsers where the [Page Visibility API](https://www.w3.org/TR/page-visibilit ## Example -When building carousels, be sure your slides are the same size as one another. The carousel doesn't automatically crop images to the same dimensions for you across slides. +While carousels support previous/next controls and indicators, they're not explicitly required. Add and customize as you see fit. + +Please be aware the carousel doesn't automatically normalize carousel slide dimensions. As such, you may need to use additional utilities or custom styles to appropriately size content. + +### Slides only + +Here's a carousel with slides only. Note the presence of the `.d-block` and `.img-fluid` on carousel images to prevent browser default image alignment. + +{% example html %} +

+ +

+{% endexample %} + +### With controls + +Adding in the previous and next controls: + +{% example html %} +

+ + + + + + + + + +

+{% endexample %} + +### With indicators + +You can also add the indicators to the carousel, alongside the controls, too. {% example html %} -

- + - +

{% endexample %} + {% callout warning %} #### Transition animations not supported in Internet Explorer 9 -- cgit v1.2.3 From 5abd0ed521fe4eb0dd6c44c24ebde7029bf5fe33 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 4 Dec 2016 20:37:21 -0800 Subject: move multiple carousels section up, add responsive classes there, reformat some stuff --- docs/components/carousel.md | 47 +++++++++++++++++---------------------------- 1 file changed, 18 insertions(+), 29 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 12c638be8..9b16a3729 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -9,7 +9,7 @@ The carousel is a slideshow for cycling through a series of content, built with In browsers where the [Page Visibility API](https://www.w3.org/TR/page-visibility/) is supported, the carousel will avoid sliding when the webpage is not visible to the user (such as when the browser tab is inactive, the browser window is minimized, etc.). -**Nested carousels are not supported.** +Please be aware that nested carousels are not supported, and carousels are generally not compliant with accessibility standards. ## Contents @@ -18,9 +18,9 @@ In browsers where the [Page Visibility API](https://www.w3.org/TR/page-visibilit ## Example -While carousels support previous/next controls and indicators, they're not explicitly required. Add and customize as you see fit. +Carousels don't automatically normalize slide dimensions. As such, you may need to use additional utilities or custom styles to appropriately size content. While carousels support previous/next controls and indicators, they're not explicitly required. Add and customize as you see fit. -Please be aware the carousel doesn't automatically normalize carousel slide dimensions. As such, you may need to use additional utilities or custom styles to appropriately size content. +Be sure to set a unique id on the `.carousel` for optional controls, especially if you're using multiple carousels on a single page. ### Slides only @@ -103,7 +103,6 @@ You can also add the indicators to the carousel, alongside the controls, too.

{% endexample %} - {% callout warning %} #### Transition animations not supported in Internet Explorer 9 @@ -116,45 +115,45 @@ Bootstrap exclusively uses CSS3 for its animations, but Internet Explorer 9 does The `.active` class needs to be added to one of the slides. Otherwise, the carousel will not be visible. {% endcallout %} -### Optional captions +### With captions -Add captions to your slides easily with the `.carousel-caption` element within any `.carousel-item`. Place just about any optional HTML within there and it will be automatically aligned and formatted. +Add captions to your slides easily with the `.carousel-caption` element within any `.carousel-item`. They can be easily hidden on smaller viewports, as shown below, with optional [display utilities]({{ site.baseurl }}/utilities/display-property/). We hide them initially with `.d-none` and bring them back on medium-sized devices with `.d-md-block`.

- - + + - - + +

@@ -92,12 +92,12 @@ You can also add the indicators to the carousel, alongside the controls, too. Third slide

- - + + - - + +

Date: Sun, 4 Dec 2016 23:19:54 -0800 Subject: drop the .carousel-control base class --- docs/components/carousel.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 6bcd8f796..8dd819fba 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -59,11 +59,11 @@ Adding in the previous and next controls:

- + - + @@ -92,11 +92,11 @@ You can also add the indicators to the carousel, alongside the controls, too.

- + - + -- cgit v1.2.3 From bf39bb3ac3d2aef4687b3cd4762015d5f218e2bc Mon Sep 17 00:00:00 2001 From: Starsam80 Date: Thu, 27 Oct 2016 16:13:17 -0600 Subject: Rename `.active` to `.show` --- docs/components/alerts.md | 6 +++--- docs/components/collapse.md | 8 ++++---- docs/components/dropdowns.md | 8 ++++---- 3 files changed, 11 insertions(+), 11 deletions(-) (limited to 'docs/components') diff --git a/docs/components/alerts.md b/docs/components/alerts.md index b1ac0d845..da72e322e 100644 --- a/docs/components/alerts.md +++ b/docs/components/alerts.md @@ -73,12 +73,12 @@ Using the alert JavaScript plugin, it's possible to dismiss any alert inline. He - Be sure you've loaded the alert plugin, or the compiled Bootstrap JavaScript. - Add a dismiss button and the `.alert-dismissible` class, which adds extra padding to the right of the alert and positions the `.close` button. - On the dismiss button, add the `data-dismiss="alert"` attribute, which triggers the JavaScript functionality. Be sure to use the ` @@ -111,7 +111,7 @@ Note that closing an alert will remove it from the DOM. | Method | Description | | --- | --- | | `$().alert()` | Makes an alert listen for click events on descendant elements which have the `data-dismiss="alert"` attribute. (Not necessary when using the data-api's auto-initialization.) | -| `$().alert('close')` | Closes an alert by removing it from the DOM. If the `.fade` and `.in` classes are present on the element, the alert will fade out before it is removed. | +| `$().alert('close')` | Closes an alert by removing it from the DOM. If the `.fade` and `.show` classes are present on the element, the alert will fade out before it is removed. | {% highlight js %}$(".alert").alert('close'){% endhighlight %} diff --git a/docs/components/collapse.md b/docs/components/collapse.md index 0ece9e453..5b3430118 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -18,7 +18,7 @@ Click the buttons below to show and hide another element via class changes: - `.collapse` hides content - `.collapsing` is applied during transitions -- `.collapse.active` shows content +- `.collapse.show` shows content You can use a link with the `href` attribute, or a button with the `data-target` attribute. In both cases, the `data-toggle="collapse"` is required. @@ -53,7 +53,7 @@ Extend the default collapse behavior to create an accordion. -

Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.

@@ -101,14 +101,14 @@ Additionally, if your control element is targeting a single collapsible element The collapse plugin utilizes a few classes to handle the heavy lifting: - `.collapse` hides the content -- `.collapse.active` shows the content +- `.collapse.show` shows the content - `.collapsing` is added when the transition starts, and removed when it finishes These classes can be found in `_animation.scss`. ### Via data attributes -Just add `data-toggle="collapse"` and a `data-target` to the element to automatically assign control of a collapsible element. The `data-target` attribute accepts a CSS selector to apply the collapse to. Be sure to add the class `collapse` to the collapsible element. If you'd like it to default open, add the additional class `active`. +Just add `data-toggle="collapse"` and a `data-target` to the element to automatically assign control of a collapsible element. The `data-target` attribute accepts a CSS selector to apply the collapse to. Be sure to add the class `collapse` to the collapsible element. If you'd like it to default open, add the additional class `show`. To add accordion-like group management to a collapsible control, add the data attribute `data-parent="#selector"`. Refer to the demo to see this in action. diff --git a/docs/components/dropdowns.md b/docs/components/dropdowns.md index 3e9948b3d..d26de6eef 100644 --- a/docs/components/dropdowns.md +++ b/docs/components/dropdowns.md @@ -21,7 +21,7 @@ Wrap the dropdown's toggle (your button or link) and the dropdown menu within `. Any single `.btn` can be turned into a dropdown toggle with some markup changes. Here's how you can put them to work with either ` @@ -36,7 +36,7 @@ Any single `.btn` can be turned into a dropdown toggle with some markup changes. And with `` elements: {% example html %} - @@ -356,8 +356,8 @@ Theming the navbar has never been easier thanks to the combination of theming cl

@@ -449,9 +449,9 @@ With no `.navbar-brand` shown in lowest breakpoint: Disabled -

@@ -478,9 +478,9 @@ With a brand name shown on the left and toggler on the right: Disabled - -- cgit v1.2.3 From 9fd339bdc82b5426b43f02b80e7921dcd9e862eb Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Thu, 22 Dec 2016 23:05:31 -0800 Subject: better/more form spacing in navbars --- docs/components/navbar.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 5fa6a1fd5..57e0bad7a 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -57,7 +57,7 @@ Here's an example of all the sub-components included in a responsive light-theme Disabled - @@ -449,7 +449,7 @@ With no `.navbar-brand` shown in lowest breakpoint: Disabled - @@ -478,7 +478,7 @@ With a brand name shown on the left and toggler on the right: Disabled - -- cgit v1.2.3 From 9979827cd367050bab29fa10642bf4ca517cf896 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Fri, 23 Dec 2016 11:02:14 -0800 Subject: Revamp navs docs - Reorganize things, leading with the base nav first instead of an accessibility note, and then moving the rest to a new available styles section. - Add horizontal alignment options thanks to new flex utils (these new utils will be documented later in another commit). - Dropped `.nav-stacked` for a flex util and added additional alignment options, so document those, too. --- docs/components/navs.md | 167 ++++++++++++++++++++++-------------------------- 1 file changed, 75 insertions(+), 92 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navs.md b/docs/components/navs.md index 3b4b697a6..fed519e8e 100644 --- a/docs/components/navs.md +++ b/docs/components/navs.md @@ -12,15 +12,9 @@ Navigation available in Bootstrap share general markup and styles, from the base * Will be replaced with the ToC, excluding the "Contents" header {:toc} -## Regarding accessibility - -If you are using navs to provide a navigation bar, be sure to add a `role="navigation"` to the most logical parent container of the `

` element around the whole navigation. Do not add the role to the `

@@ -39,7 +33,7 @@ Roll your own navigation style by extending the base `.nav` component. All Boots

` element. The change in nav item display below **is intentional** as `

`s have a different default `display` than regular `` elements. +Classes are used throughout, so your markup can be super flexible. Use `

`s like above, or roll your own with say a `

` element. Because the `.nav` uses `display: flex`, the nav links behave the same as nav items would, but without the extra markup. {% example html %} {% endexample %} -### Inline - -Space out nav links in a horizontal band with `.nav-inline`. Longer series of links will wrap to a new line. - -{% example html %} - -{% endexample %} +## Available styles -The same works for a navigation built with lists. +Change the style of `.nav`s component with modifiers and utilities. Mix and match as needed, or build your own. -{% example html %} -

- Active -
- Link -
- Link -
- Disabled -

-{% endexample %} +### Horizontal alignment -### Tabs +Change the horizontal alignment of your nav with [flexbox utilities]({{ site.baseurl }}/layout/grid/#horizontal-alignment). By default, navs are left-aligned, but you can easily change them to center or right aligned. -Takes the basic nav from above and adds the `.nav-tabs` class to generate a tabbed interface. Use them to create tabbable regions with our [tab JavaScript plugin](#javascript-behavior). +Centered with `.justify-content-center`: {% example html %} -

Active

Active

Active

+ {% endexample %} -## Using dropdowns - -Add dropdown menus with a little extra HTML and the [dropdowns JavaScript plugin]({{ site.baseurl }}/components/dropdowns/#usage). +### Tabs -### Tabs with dropdowns +Takes the basic nav from above and adds the `.nav-tabs` class to generate a tabbed interface. Use them to create tabbable regions with our [tab JavaScript plugin](#javascript-behavior). {% example html %}

Active
- Dropdown -
- Action - Another action - Something else here -
- Separated link -
+
+ Link
Link @@ -186,22 +143,17 @@ Add dropdown menus with a little extra HTML and the [dropdowns JavaScript plugin

{% endexample %} -### Pills with dropdowns +### Pills + +Take that same HTML, but use `.nav-pills` instead: {% example html %}

Active
- Dropdown -
- Action - Another action - Something else here -
- Separated link -
+
+ Link
Link @@ -212,19 +164,17 @@ Add dropdown menus with a little extra HTML and the [dropdowns JavaScript plugin

{% endexample %} -## Justified nav +### Fill and justify -Create equal-width links in a navigation component by adding `.nav-justified` to a `.nav` component. This works with the inline, tab, and pill variants. - -Using the inline nav: +Force your `.nav`'s contents to extend the full available width one of two modifier classes. To proportionately fill all available space with your `.nav-item`s, use `.nav-fill`. Notice that all horizontal space is occupied, but not every nav item has the same width. {% example html %} -

Active
- Link + Longer nav link
Link @@ -235,15 +185,15 @@ Using the inline nav:

Active
- Link + Longer nav link
Link @@ -254,15 +204,43 @@ You can also use it on tabs:

` element around the whole navigation. Do not add the role to the `

Active
- Link +
+ Dropdown +
+ Action + Another action + Something else here +
+ Separated link +
Link @@ -273,17 +251,22 @@ And pills, too:

Active
- Link +
+ Dropdown +
+ Action + Another action + Something else here +
+ Separated link +
Link -- cgit v1.2.3 From 9d13fd3fe3d1a4578dde8b2cf0a8c74b1e41405b Mon Sep 17 00:00:00 2001 From: Mark Otto
Date: Fri, 23 Dec 2016 13:31:09 -0800 Subject: remove old flex utils, update docs to match --- docs/components/list-group.md | 8 ++++---- docs/components/navbar.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/components') diff --git a/docs/components/list-group.md b/docs/components/list-group.md index 1c1384724..0e06d3a7f 100644 --- a/docs/components/list-group.md +++ b/docs/components/list-group.md @@ -27,19 +27,19 @@ The most basic list group is simply an unordered list with list items, and the p ## Badge -Add badges to any list group item to show unread counts, activity, and more with the help of some utilities. Note the [`flex-items-between` utility class]({{ site.baseurl }}/layout/grid/#horizontal-alignment), the badge's placement, and the lack of a float and margin utilities on the badges. +Add badges to any list group item to show unread counts, activity, and more with the help of some utilities. Note the [`justify-content-between` utility class]({{ site.baseurl }}/layout/grid/#horizontal-alignment), the badge's placement, and the lack of a float and margin utilities on the badges. {% highlight html %}
- +
- Cras justo odio 14
- +
- Dapibus ac facilisis in 2
- +
- Morbi leo risus 1

{% endexample %} + +## Alignment + +Change the alignment of pagination components with [flexbox utilities]({{ site.baseurl }}/utilities/flexbox). + +{% example html %} + +{% endexample %} + +{% example html %} + -- cgit v1.2.3 From d2906950d9d0e675f27fa52e9685b7e5c5785e0d Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 28 Dec 2016 16:36:55 -0800 Subject: consistent punctuation it's important, yo --- docs/components/navbar.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index d2553de79..b0ad95ab9 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -28,8 +28,8 @@ Read on for an example and list of supported sub-components. Navbars come with built-in support for a handful of sub-components. Choose from the following as needed: -- `.navbar-brand` for your company, product, or project name -- `.navbar-nav` for a full-height and lightweight navigation (including support for dropdowns) +- `.navbar-brand` for your company, product, or project name. +- `.navbar-nav` for a full-height and lightweight navigation (including support for dropdowns). - `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#collapsible-content) behaviors. - Inline forms with `.float-` utilities for form controls and components. - `.navbar-text` for adding vertically centered strings of text. -- cgit v1.2.3 From 2c8675bbf6241724bc2ef775526d8b65f7965b7a Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 28 Dec 2016 16:37:04 -0800 Subject: better describe example --- docs/components/navbar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index b0ad95ab9..4248e46d6 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -36,7 +36,7 @@ Navbars come with built-in support for a handful of sub-components. Choose from - `.form-inline` for form controls and more. - `.collapse.navbar-collapse` for grouping and hiding navbar contents by a parent breakpoint. -Here's an example of all the sub-components included in a responsive light-themed navbar. +Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `md` (medium) breakpoint. {% example html %}

-- cgit v1.2.3 From 15310771408bb91eebdc677d1ecf56842f3dc2ad Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 28 Dec 2016 16:37:13 -0800 Subject: no float utils, use class name --- docs/components/navbar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 4248e46d6..09d4f1932 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -31,7 +31,7 @@ Navbars come with built-in support for a handful of sub-components. Choose from - `.navbar-brand` for your company, product, or project name. - `.navbar-nav` for a full-height and lightweight navigation (including support for dropdowns). - `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#collapsible-content) behaviors. -- Inline forms with `.float-` utilities for form controls and components. +- `.form-inline` for any form controls and actions. - `.navbar-text` for adding vertically centered strings of text. - `.form-inline` for form controls and more. - `.collapse.navbar-collapse` for grouping and hiding navbar contents by a parent breakpoint. -- cgit v1.2.3 From 2f52b3aee8c73a176f86bfe9e6814d793ac82d32 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 28 Dec 2016 16:38:50 -0800 Subject: drop the .nav base class from .navbar-nav --- docs/components/navbar.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 09d4f1932..8fc4a2a64 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -46,7 +46,7 @@ Here's an example of all the sub-components included in a responsive light-theme

Home (current)

Home (current)

Home Features Pricing @@ -161,7 +161,7 @@ You may also utilize dropdowns in your navbar nav. Dropdown menus require a wrap

Home (current)

Home (current)

Home (current)

Home (current)

Home (current)

Home (current)

Home (current)

Date: Wed, 28 Dec 2016 16:39:52 -0800 Subject: drop the flex-grow: 10 in favor of auto margin utils --- docs/components/navbar.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 8fc4a2a64..147f98084 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -46,7 +46,7 @@ Here's an example of all the sub-components included in a responsive light-theme

Home (current)

Home (current)

Home (current)

Home (current)

Home (current)

Home (current)

Home (current)

Date: Wed, 28 Dec 2016 17:03:25 -0800 Subject: clarify need for .navbar-toggleable classes --- docs/components/navbar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 147f98084..a933ddf7a 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -16,7 +16,7 @@ The navbar is a wrapper that positions branding, navigation, and other elements Here's what you need to know before getting started with the navbar: -- Navbars require a wrapping `.navbar` and [color scheme](#color-schemes) classes. +- Navbars require a wrapping `.navbar` with `.navbar-toggleable-*` for responsive collapsing and [color scheme](#color-schemes) classes. - Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width. - Navbars and their contents are built with flexbox, providing easy alignment options via utility classes. - Navbars are responsive by default, but you can easily modify them to change that. Responsive behavior depends on our Collapse JavaScript plugin. -- cgit v1.2.3 From a41d241ecc9cb70e4ad611d706d66affb7c64c4b Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 28 Dec 2016 17:03:28 -0800 Subject: dedupe --- docs/components/navbar.md | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index a933ddf7a..74f19609b 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -33,7 +33,6 @@ Navbars come with built-in support for a handful of sub-components. Choose from - `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#collapsible-content) behaviors. - `.form-inline` for any form controls and actions. - `.navbar-text` for adding vertically centered strings of text. -- `.form-inline` for form controls and more. - `.collapse.navbar-collapse` for grouping and hiding navbar contents by a parent breakpoint. Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `md` (medium) breakpoint. -- cgit v1.2.3 From 0e26b14ffbcaa6cdec7dd7ca36e1abf08c6e0129 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 28 Dec 2016 17:04:07 -0800 Subject: reorder classes because i like it this way :p --- docs/components/navbar.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 74f19609b..ea4245b46 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -38,7 +38,7 @@ Navbars come with built-in support for a handful of sub-components. Choose from Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `md` (medium) breakpoint. {% example html %} -

@@ -108,7 +108,7 @@ Navbar navigation links build on our `.nav` options with their own modifier clas Active states—with `.active`—to indicate the current page can be applied directly to `.nav-link`s or their immediate parent `.nav-item`s. {% example html %} -

@@ -135,7 +135,7 @@ Active states—with `.active`—to indicate the current page can be applied dir And because we use classes for our navs, you can avoid the list-based approach entirely if you like. {% example html %} -

@@ -154,7 +154,7 @@ And because we use classes for our navs, you can avoid the list-based approach e You may also utilize dropdowns in your navbar nav. Dropdown menus require a wrapping element for positioning, so be sure to use separate and nested elements for `.nav-item` and `.nav-link` as shown below. {% example html %} -

@@ -249,7 +249,7 @@ Navbars may contain bits of text with the help of `.navbar-text`. This class adj Mix and match with other components and utilities as needed. {% example html %} -

@@ -278,7 +278,7 @@ Mix and match with other components and utilities as needed. Theming the navbar has never been easier thanks to the combination of theming classes and `background-color` utilities. Choose from `.navbar-light` for use with light background colors, or `.navbar-inverse` for dark background colors. Then, customize with `.bg-*` utilities.

@@ -383,7 +383,7 @@ Although it's not required, you can wrap a navbar in a `.container` to center it {% example html %}

@@ -392,7 +392,7 @@ Although it's not required, you can wrap a navbar in a `.container` to center it When the container is within your navbar, its horizontal padding is removed at breakpoints lower than your specified `.navbar-toggleable-*` class. This ensures we're not doubling up on padding unnecessarily on lower viewports when your navbar is collapsed. {% example html %} -

@@ -432,7 +432,7 @@ Navbar togglers can be left or right aligned with `.navbar-toggler-left` or `.na With no `.navbar-brand` shown in lowest breakpoint: {% example html %} -

@@ -460,7 +460,7 @@ With no `.navbar-brand` shown in lowest breakpoint: With a brand name shown on the left and toggler on the right: {% example html %} -

-- cgit v1.2.3 From de1eaef35bfe01ac5ba7f1a40187b381a3155a49 Mon Sep 17 00:00:00 2001 From: Quy Date: Thu, 29 Dec 2016 09:18:59 -0800 Subject: Drop IE9 callout --- docs/components/carousel.md | 6 ------ 1 file changed, 6 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 8dd819fba..619ea780f 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -103,12 +103,6 @@ You can also add the indicators to the carousel, alongside the controls, too. {% endexample %} -{% callout warning %} -#### Transition animations not supported in Internet Explorer 9 - -Bootstrap exclusively uses CSS3 for its animations, but Internet Explorer 9 doesn't support the necessary CSS properties. Thus, there are no slide transition animations when using that browser. We have intentionally decided not to include jQuery-based fallbacks for the transitions. -{% endcallout %} - {% callout warning %} #### Initial active element required -- cgit v1.2.3 From a0141aa38e74108b4b5f805f8af65cb618236823 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Thu, 29 Dec 2016 14:56:28 -0800 Subject: Rewrite progress component without element - element didn't allow animation, labels overlaid, multiple bars, etc. - Revamps CSS to use something more similar to v3's implementation - Ditches variant mixin for `bg-` utils - Rebuilds docs to match, including adding a new Height section for customizing that. Only potential remaining todo is adding `.sr-only` instances to within the bar. Unsure if that's necessary. --- docs/components/progress.md | 128 +++++++++++++++++++++++++++++++++----------- 1 file changed, 98 insertions(+), 30 deletions(-) (limited to 'docs/components') diff --git a/docs/components/progress.md b/docs/components/progress.md index d137fad14..29436c365 100644 --- a/docs/components/progress.md +++ b/docs/components/progress.md @@ -5,71 +5,139 @@ description: Documentation and examples for using Bootstrap progress bars. group: components --- -Stylize [the HTML5 `` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress) with a few extra classes and some crafty browser-specific CSS. Be sure to read up on the browser support. +Use our custom progress component for displaying simple or complex progress bars. We don't use [the HTML5 `` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress), ensuring you can stack progress bars, animate them, and place text labels over them. ## Contents * Will be replaced with the ToC, excluding the "Contents" header {:toc} -## Example +## How it works -To caption a progress bar, simply add a `

` with your caption text, [align the text using a utility class]({{ site.baseurl }}/utilities/typography/#text-alignment), and associate the caption with the `` element using the `aria-describedby` attribute. +Progress components are built with two HTML elements, some CSS to set the width, and a few attributes. + +- We use the `.progress` as a wrapper to indicate the max value of the progress bar. +- We use the inner `.progress-bar` to indicate the progress so far. +- The `.progress-bar` requires an inline style or custom CSS to set their width. +- The `.progress-bar` also requires some `role` and `aria` attributes to make it accessible. + +Put that all together, and you have the following examples. {% example html %} +

+{% endexample %} -

Reticulating splines… 0%

- +## Customizing -

Reticulating splines… 25%

- +Customize the appearance of your progress bars with custom CSS, background utilities, stripes, and more. -

Reticulating splines… 50%

- +### Labels -

Reticulating splines… 75%

- +Add labels to your progress bars by placing text within the `.progress-bar`. -

Reticulating splines… 100%

- +{% example html %} +

25%

{% endexample %} -## Contextual alternatives +### Height -Progress bars use some of the same button and alert classes for consistent styles. +We only set a `height` value on the `.progress-bar`, so if you change that value the outer `.progress` will automatically resize accordingly. {% example html %} - - - - +

+{% endexample %} + +### Backgrounds + +Use background utility classes to change the appearance of individual progress bars. + +{% example html %} +

+{% endexample %} + +### Multiple bars + +Include multiple progress bars in a progress component if you need. + +{% example html %} +

{% endexample %} ### Striped -Uses a gradient to create a striped effect. +Add `.progress-bar-striped` to any `.progress-bar` to apply a stripe via CSS gradient over the progress bar's background color. {% example html %} - - - - - +

{% endexample %} ### Animated stripes -The striped gradient can also be animated. Add `.progress-animated` to `.progress` to animate the stripes right to left via CSS3 animations. +The striped gradient can also be animated. Add `.progress-bar-animated` to `.progress-bar` to animate the stripes right to left via CSS3 animations. -**Animated progress bars don't work in Opera 12**—as they don't support CSS3 animations. They also **don't work in IE10+ and Microsoft Edge** as those browsers currently don't support CSS3 animations on the [`::-ms-fill` pseudo-element](https://msdn.microsoft.com/en-us/library/windows/apps/hh465757.aspx). +**Animated progress bars don't work in Opera 12**—as they don't support CSS3 animations.

- -

{% highlight html %} - +

{% endhighlight %} -- cgit v1.2.3 From a7931f0c1e85d0e795877ddca78acce240047aff Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Fri, 30 Dec 2016 21:43:16 -0800 Subject: add example of width util --- docs/components/progress.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/progress.md b/docs/components/progress.md index 29436c365..e475f416f 100644 --- a/docs/components/progress.md +++ b/docs/components/progress.md @@ -18,7 +18,7 @@ Progress components are built with two HTML elements, some CSS to set the width, - We use the `.progress` as a wrapper to indicate the max value of the progress bar. - We use the inner `.progress-bar` to indicate the progress so far. -- The `.progress-bar` requires an inline style or custom CSS to set their width. +- The `.progress-bar` requires an inline style, utility class, or custom CSS to set their width. - The `.progress-bar` also requires some `role` and `aria` attributes to make it accessible. Put that all together, and you have the following examples. @@ -41,6 +41,14 @@ Put that all together, and you have the following examples.

{% endexample %} +Bootstrap provides a handful of [utilities for setting width]({{ site.baseurl }}/utilities/sizing-and-positioning/#width-and-height). Depending on your needs, these may help with quickly configuring progress. + +{% example html %} +

+{% endexample %} + ## Customizing Customize the appearance of your progress bars with custom CSS, background utilities, stripes, and more. -- cgit v1.2.3 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/carousel.md | 124 ++++++++++---------- docs/components/collapse.md | 108 +++++++++--------- docs/components/modal.md | 128 ++++++++++----------- docs/components/popovers.md | 266 +++++++++++++++++++++---------------------- docs/components/scrollspy.md | 69 ++++++----- docs/components/tooltips.md | 254 ++++++++++++++++++++--------------------- 6 files changed, 463 insertions(+), 486 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 619ea780f..eac86ef81 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -184,50 +184,48 @@ $('.carousel').carousel() Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-interval=""`. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
interval	number	5000	The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
keyboard	boolean	true	Whether the carousel should react to keyboard events.
pause	string \| null	"hover"	If set to `"hover"`, pauses the cycling of the carousel on `mouseenter` and resumes the cycling of the carousel on `mouseleave`. If set to `null`, hovering over the carousel won't pause it.
ride	string	false	Autoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load.
wrap	boolean	true	Whether the carousel should cycle continuously or have hard stops.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Default	Description
interval	number	5000	The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
keyboard	boolean	true	Whether the carousel should react to keyboard events.
pause	string \| null	"hover"	If set to `"hover"`, pauses the cycling of the carousel on `mouseenter` and resumes the cycling of the carousel on `mouseleave`. If set to `null`, hovering over the carousel won't pause it.
ride	string	false	Autoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load.
wrap	boolean	true	Whether the carousel should cycle continuously or have hard stops.

### Methods @@ -270,26 +268,24 @@ Bootstrap's carousel class exposes two events for hooking into carousel function All carousel events are fired at the carousel itself (i.e. at the `

`). -

- - - - - - - - - - - - - - - - - -

Event Type	Description
slide.bs.carousel	This event fires immediately when the `slide` instance method is invoked.
slid.bs.carousel	This event is fired when the carousel has completed its slide transition.

+ + + + + + + + + + + + + + + + + +

Event Type	Description
slide.bs.carousel	This event fires immediately when the `slide` instance method is invoked.
slid.bs.carousel	This event is fired when the carousel has completed its slide transition.

{% highlight js %} $('#myCarousel').on('slide.bs.carousel', function () { diff --git a/docs/components/collapse.md b/docs/components/collapse.md index e3172fa75..11017c234 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -124,32 +124,30 @@ $('.collapse').collapse() Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-parent=""`. -

- - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
parent	selector	false	If a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the `panel` class)
toggle	boolean	true	Toggles the collapsible element on invocation

+ + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Default	Description
parent	selector	false	If a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the `panel` class)
toggle	boolean	true	Toggles the collapsible element on invocation

### Methods @@ -179,36 +177,34 @@ Hides a collapsible element. Bootstrap's collapse class exposes a few events for hooking into collapse functionality. -

- - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.collapse	This event fires immediately when the `show` instance method is called.
shown.bs.collapse	This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.collapse	- This event is fired immediately when the `hide` method has been called. -
hidden.bs.collapse	This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Event Type	Description
show.bs.collapse	This event fires immediately when the `show` instance method is called.
shown.bs.collapse	This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.collapse	+ This event is fired immediately when the `hide` method has been called. +
hidden.bs.collapse	This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).

{% highlight js %} $('#myCollapsible').on('hidden.bs.collapse', function () { diff --git a/docs/components/modal.md b/docs/components/modal.md index b311ebf35..5ace1ac58 100644 --- a/docs/components/modal.md +++ b/docs/components/modal.md @@ -508,44 +508,42 @@ Call a modal with id `myModal` with a single line of JavaScript: Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-backdrop=""`. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
backdrop	boolean or the string `'static'`	true	Includes a modal-backdrop element. Alternatively, specify `static` for a backdrop which doesn't close the modal on click.
keyboard	boolean	true	Closes the modal when escape key is pressed
focus	boolean	true	Puts the focus on the modal when initialized.
show	boolean	true	Shows the modal when initialized.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Default	Description
backdrop	boolean or the string `'static'`	true	Includes a modal-backdrop element. Alternatively, specify `static` for a backdrop which doesn't close the modal on click.
keyboard	boolean	true	Closes the modal when escape key is pressed
focus	boolean	true	Puts the focus on the modal when initialized.
show	boolean	true	Shows the modal when initialized.

### Methods @@ -581,34 +579,32 @@ Manually hides a modal. **Returns to the caller before the modal has actually be Bootstrap's modal class exposes a few events for hooking into modal functionality. All modal events are fired at the modal itself (i.e. at the `

`). -

- - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.modal	This event fires immediately when the `show` instance method is called. If caused by a click, the clicked element is available as the `relatedTarget` property of the event.
shown.bs.modal	This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the `relatedTarget` property of the event.
hide.bs.modal	This event is fired immediately when the `hide` instance method has been called.
hidden.bs.modal	This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Event Type	Description
show.bs.modal	This event fires immediately when the `show` instance method is called. If caused by a click, the clicked element is available as the `relatedTarget` property of the event.
shown.bs.modal	This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the `relatedTarget` property of the event.
hide.bs.modal	This event is fired immediately when the `hide` instance method has been called.
hidden.bs.modal	This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).

{% highlight js %} $('#myModal').on('hidden.bs.modal', function (e) { diff --git a/docs/components/popovers.md b/docs/components/popovers.md index 1cd96da49..e4ace2ed9 100644 --- a/docs/components/popovers.md +++ b/docs/components/popovers.md @@ -163,113 +163,111 @@ Enable popovers via JavaScript: Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-animation=""`. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
animation	boolean	true	Apply a CSS fade transition to the popover
container	string \| false	false	- 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. -
content	string \| element \| 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. -
delay	number \| object	0	- 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 }` -
html	boolean	false	Insert 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.
placement	string \| function	'right'	- How to position the popover - top \| bottom \| left \| 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. -
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.
template	string	`'<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. -
title	string \| 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 popover is attached to. -
trigger	string	'click'	How popover is triggered - click \| hover \| focus \| manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
constraints	Array	'hover focus'	An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offset	string	'0 0'	Offset of the popover relative to its target. For more information refer to Tether's offset docs.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Default	Description
animation	boolean	true	Apply a CSS fade transition to the popover
container	string \| false	false	+ 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. +
content	string \| element \| 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. +
delay	number \| object	0	+ 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 }` +
html	boolean	false	Insert 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.
placement	string \| function	'right'	+ How to position the popover - top \| bottom \| left \| 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. +
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.
template	string	`'<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. +
title	string \| 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 popover is attached to. +
trigger	string	'click'	How popover is triggered - click \| hover \| focus \| manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
constraints	Array	'hover focus'	An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offset	string	'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 popovers @@ -310,34 +308,32 @@ Hides and destroys an element's popover. Popovers that use delegation (which are ### Events -

- - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.popover	This event fires immediately when the `show` instance method is called.
shown.bs.popover	This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.popover	This event is fired immediately when the `hide` instance method has been called.
hidden.bs.popover	This event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Event Type	Description
show.bs.popover	This event fires immediately when the `show` instance method is called.
shown.bs.popover	This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.popover	This event is fired immediately when the `hide` instance method has been called.
hidden.bs.popover	This 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 () { diff --git a/docs/components/scrollspy.md b/docs/components/scrollspy.md index 74829267e..a1f04ad9c 100644 --- a/docs/components/scrollspy.md +++ b/docs/components/scrollspy.md @@ -117,45 +117,42 @@ $('[data-spy="scroll"]').each(function () { Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-offset=""`. -

- - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
offset	number	10	Pixels to offset from top when calculating position of scroll.

+ + + + + + + + + + + + + + + + + +

Name	Type	Default	Description
offset	number	10	Pixels to offset from top when calculating position of scroll.

### Events -

- - - - - - - - - - - - - -

Event Type	Description
activate.bs.scrollspy	This event fires whenever a new item becomes activated by the scrollspy.

+ + + + + + + + + + + + + +

Event Type	Description
activate.bs.scrollspy	This event fires whenever a new item becomes activated by the scrollspy.

+ {% highlight js %} $('#myScrollspy').on('activate.bs.scrollspy', function () { // do something… 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=""`. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
animation	boolean	true	Apply a CSS fade transition to the tooltip
container	string \| element \| false	false	- 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. -
delay	number \| object	0	- 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 }` -
html	boolean	false	- 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. -
placement	string \| 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. -
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.
template	string	`'<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. -
title	string \| 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. -
trigger	string	'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.
constraints	Array	[]	An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offset	string	'0 0'	Offset of the popover relative to its target. For more information refer to Tether's offset docs.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Type	Default	Description
animation	boolean	true	Apply a CSS fade transition to the tooltip
container	string \| element \| false	false	+ 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. +
delay	number \| object	0	+ 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 }` +
html	boolean	false	+ 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. +
placement	string \| 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. +
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.
template	string	`'<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. +
title	string \| 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. +
trigger	string	'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.
constraints	Array	[]	An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offset	string	'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 Type	Description
show.bs.tooltip	This event fires immediately when the `show` instance method is called.
shown.bs.tooltip	This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.tooltip	This event is fired immediately when the `hide` instance method has been called.
hidden.bs.tooltip	This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Event Type	Description
show.bs.tooltip	This event fires immediately when the `show` instance method is called.
shown.bs.tooltip	This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.tooltip	This event is fired immediately when the `hide` instance method has been called.
hidden.bs.tooltip	This 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 7d48a5b27c5de16604d5d747e88322b65f1524b5 Mon Sep 17 00:00:00 2001 From: Quy Date: Sat, 31 Dec 2016 23:09:45 -0800 Subject: Fix carousel markup --- docs/components/carousel.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index eac86ef81..ea22f3ef9 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -143,12 +143,12 @@ Add captions to your slides easily with the `.carousel-caption` element within a

- - + + - - + + -- cgit v1.2.3 From c2ff9b73870057b0d5aec0d067313ba61671dd6e Mon Sep 17 00:00:00 2001 From: Quy Date: Sun, 1 Jan 2017 12:00:55 -0800 Subject: Change .in to .show (#21500) --- docs/components/collapse.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/collapse.md b/docs/components/collapse.md index 11017c234..f48efd9cc 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -92,7 +92,7 @@ Extend the default collapse behavior to create an accordion. ## Accessibility -Be sure to add `aria-expanded` to the control element. This attribute explicitly defines the current state of the collapsible element to screen readers and similar assistive technologies. If the collapsible element is closed by default, it should have a value of `aria-expanded="false"`. If you've set the collapsible element to be open by default using the `in` class, set `aria-expanded="true"` on the control instead. The plugin will automatically toggle this attribute based on whether or not the collapsible element has been opened or closed. +Be sure to add `aria-expanded` to the control element. This attribute explicitly defines the current state of the collapsible element to screen readers and similar assistive technologies. If the collapsible element is closed by default, it should have a value of `aria-expanded="false"`. If you've set the collapsible element to be open by default using the `show` class, set `aria-expanded="true"` on the control instead. The plugin will automatically toggle this attribute based on whether or not the collapsible element has been opened or closed. Additionally, if your control element is targeting a single collapsible element – i.e. the `data-target` attribute is pointing to an `id` selector – you may add an additional `aria-controls` attribute to the control element, containing the `id` of the collapsible element. Modern screen readers and similar assistive technologies make use of this attribute to provide users with additional shortcuts to navigate directly to the collapsible element itself. -- cgit v1.2.3 From b6b6deff57cca550960a5eff0a1ccabc43c4d31e Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Mon, 2 Jan 2017 10:58:48 -0800 Subject: fixes #21509: remove reference to .card-deck-wrapper --- docs/components/card.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/card.md b/docs/components/card.md index 4e8c11026..3ac7c425f 100644 --- a/docs/components/card.md +++ b/docs/components/card.md @@ -565,7 +565,7 @@ When using card groups with footers, their content will automatically line up. ### Card decks -Need a set of equal width and height cards that aren't attached to one another? Use card decks. By default, card decks require two wrapping elements: `.card-deck-wrapper` and a `.card-deck`. We use table styles for the sizing and the gutters on `.card-deck`. The `.card-deck-wrapper` is used to negative margin out the `border-spacing` on the `.card-deck`. +Need a set of equal width and height cards that aren't attached to one another? Use card decks. {% example html %}

-- cgit v1.2.3 From 4dc6f44796c2b73d40f72fff0f809cc3f87b7343 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Mon, 2 Jan 2017 11:48:05 -0800 Subject: update docs and examples to use new utils --- docs/components/navbar.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index ea4245b46..5c6f95198 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -401,7 +401,7 @@ When the container is within your navbar, its horizontal padding is removed at b ## Placement -Navbars can be statically placed (their default behavior), static without rounded corners, or fixed to the top or bottom of the viewport. +Use our position utilities to place navbars in non-static positions. Choose from fixed to the top, fixed to the bottom, or stickied to the top. **Note that `position: sticky`, used for `.sticky-top`, isn't fully supported in every browser.** {% example html %}

@@ -410,17 +410,23 @@ Navbars can be statically placed (their default behavior), static without rounde {% endexample %} {% example html %} -

+ {% endexample %} {% example html %} -

+ {% endexample %} +{% example html %} + +{% endexample %} + ## Responsive behaviors Navbars can utilize `.navbar-toggler`, `.navbar-collapse`, and `.navbar-toggleable-*` classes to change when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements. -- cgit v1.2.3 From 8f0ac7193e6df889ad8d40c9167238e8a60d1522 Mon Sep 17 00:00:00 2001 From: Quy Date: Tue, 3 Jan 2017 09:38:25 -0800 Subject: Update sizing links --- docs/components/card.md | 2 +- docs/components/progress.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/components') diff --git a/docs/components/card.md b/docs/components/card.md index 3ac7c425f..f84383847 100644 --- a/docs/components/card.md +++ b/docs/components/card.md @@ -208,7 +208,7 @@ Using the grid, wrap cards in columns and rows as needed. ### Using utilities -Use our handful of [available sizing utilities]({{ site.baseurl }}/utilities/sizing-and-positioning/#width-and-height) to quickly set a card's width. +Use our handful of [available sizing utilities]({{ site.baseurl }}/utilities/sizing/) to quickly set a card's width. {% example html %}

diff --git a/docs/components/progress.md b/docs/components/progress.md index e475f416f..9f8bcf607 100644 --- a/docs/components/progress.md +++ b/docs/components/progress.md @@ -41,7 +41,7 @@ Put that all together, and you have the following examples.

{% endexample %} -Bootstrap provides a handful of [utilities for setting width]({{ site.baseurl }}/utilities/sizing-and-positioning/#width-and-height). Depending on your needs, these may help with quickly configuring progress. +Bootstrap provides a handful of [utilities for setting width]({{ site.baseurl }}/utilities/sizing/). Depending on your needs, these may help with quickly configuring progress. {% example html %}

-- cgit v1.2.3 From f3d0fee91ec30aa6cde08de821b06fd6f337a3a3 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Tue, 3 Jan 2017 19:24:24 -0800 Subject: fixes #21454 by revamping some docs styles for dropdowns --- docs/components/dropdowns.md | 60 +++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 31 deletions(-) (limited to 'docs/components') diff --git a/docs/components/dropdowns.md b/docs/components/dropdowns.md index d26de6eef..3c68f9453 100644 --- a/docs/components/dropdowns.md +++ b/docs/components/dropdowns.md @@ -21,7 +21,7 @@ Wrap the dropdown's toggle (your button or link) and the dropdown menu within `. Any single `.btn` can be turned into a dropdown toggle with some markup changes. Here's how you can put them to work with either ` @@ -252,7 +252,7 @@ Button dropdowns work with buttons of all sizes, including default and split dro

- +

+ + +

- - - +

+ + +

@@ -407,7 +405,7 @@ Trigger dropdown menus above elements by adding `.dropup` to the parent element. Historically dropdown menu contents *had* to be links, but that's no longer the case with v4. Now you can optionally use ` @@ -510,7 +508,7 @@ $('.dropdown-toggle').dropdown() {% endhighlight %} {% callout info %} -#### `data-toggle="dropdown"` still required +##### `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. {% endcallout %} -- cgit v1.2.3 From b2121d499c8ca4240fdbf4a4ae0ce8792cad411e Mon Sep 17 00:00:00 2001 From: Pierre-Denis Vanduynslager Date: Wed, 4 Jan 2017 12:04:07 -0500 Subject: Fix progress doc markup --- docs/components/progress.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/progress.md b/docs/components/progress.md index 9f8bcf607..802a42a29 100644 --- a/docs/components/progress.md +++ b/docs/components/progress.md @@ -122,7 +122,7 @@ Add `.progress-bar-striped` to any `.progress-bar` to apply a stripe via CSS gra

-- cgit v1.2.3 From f93930199ea3db27ed4dc258e4bf5a38d00bf653 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Tue, 3 Jan 2017 20:08:10 -0800 Subject: Update custom content example for list group to use utils so the layout doesn't break --- docs/components/list-group.md | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) (limited to 'docs/components') diff --git a/docs/components/list-group.md b/docs/components/list-group.md index 3b30f7d8d..4316516ae 100644 --- a/docs/components/list-group.md +++ b/docs/components/list-group.md @@ -137,21 +137,33 @@ Add badges to any list group item to show unread counts, activity, and more with ## Custom content -Add nearly any HTML within, even for linked list groups like the one below. +Add nearly any HTML within, even for linked list groups like the one below, with the help of [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). {% example html %}

- -

List group item heading

- Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit. + +

List group item heading

+ 3 days ago +

Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.

+ Donec id elit non mi porta. - -

List group item heading

- Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit. + +

List group item heading

+ 3 days ago +

Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.

+ Donec id elit non mi porta. - -

List group item heading

- Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit. + +

List group item heading

+ 3 days ago +

Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.

+ Donec id elit non mi porta.

{% endexample %} -- cgit v1.2.3 From e4c0311626befc89c9462e675059edf9d52b9bb1 Mon Sep 17 00:00:00 2001 From: Bardi Harborow Date: Thu, 5 Jan 2017 11:11:50 +1100 Subject: Update broken links. --- docs/components/forms.md | 2 +- docs/components/navbar.md | 2 +- docs/components/pagination.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/components') diff --git a/docs/components/forms.md b/docs/components/forms.md index 88bd37dc2..9f1e231c7 100644 --- a/docs/components/forms.md +++ b/docs/components/forms.md @@ -331,7 +331,7 @@ Assistive technologies such as screen readers will have trouble with your forms ### Using the Grid -For more structured form layouts that are also responsive, you can utilize Bootstrap's [predefined grid classes]({{ site.baseurl }}/layout/grid/#predefined-classes) or [mixins]({{ site.baseurl }}/layout/grid/#sass-mixins) to create horizontal forms. Add the `.row` class to form groups and use the `.col-*-*` classes to specify the width of your labels and controls. +For more structured form layouts that are also responsive, you can utilize Bootstrap's [predefined grid classes]({{ site.baseurl }}/layout/grid/) or [mixins]({{ site.baseurl }}/layout/grid/#sass-mixins) to create horizontal forms. Add the `.row` class to form groups and use the `.col-*-*` classes to specify the width of your labels and controls. Be sure to add `.col-form-label` to your ``s as well so they're vertically centered with their associated form controls. For `` elements, you can use `.col-form-legend` to make them appear similar to regular `` elements. diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 5c6f95198..993661558 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -30,7 +30,7 @@ Navbars come with built-in support for a handful of sub-components. Choose from - `.navbar-brand` for your company, product, or project name. - `.navbar-nav` for a full-height and lightweight navigation (including support for dropdowns). -- `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#collapsible-content) behaviors. +- `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#responsive-behaviors) behaviors. - `.form-inline` for any form controls and actions. - `.navbar-text` for adding vertically centered strings of text. - `.collapse.navbar-collapse` for grouping and hiding navbar contents by a parent breakpoint. diff --git a/docs/components/pagination.md b/docs/components/pagination.md index 0273e8efe..03c3a56ec 100644 --- a/docs/components/pagination.md +++ b/docs/components/pagination.md @@ -141,7 +141,7 @@ Fancy larger or smaller pagination? Add `.pagination-lg` or `.pagination-sm` for ## Alignment -Change the alignment of pagination components with [flexbox utilities]({{ site.baseurl }}/utilities/flexbox). +Change the alignment of pagination components with [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). {% example html %}

-- 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/card.md | 6 +++--- docs/components/forms.md | 2 +- docs/components/modal.md | 2 +- docs/components/navs.md | 2 +- docs/components/tooltips.md | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) (limited to 'docs/components') diff --git a/docs/components/card.md b/docs/components/card.md index f84383847..b45d13463 100644 --- a/docs/components/card.md +++ b/docs/components/card.md @@ -1,7 +1,7 @@ --- layout: docs title: Cards -description: Bootstrap Cards provide a flexible and extensible content container with multiple variants and options. +description: Bootstrap's cards provide a flexible and extensible content container with multiple variants and options. group: components --- @@ -18,7 +18,7 @@ If you're familiar with Bootstrap 3, cards replace our old panels, wells, and th Cards are built with as little markup and styles as possible, but still manage to deliver a ton of control and customization. Built with flexbox, they offer easy alignment and mix well with other Bootstrap components. -Below is an example of a basic card with mixed content and a fixed width. Cards have no fixed width to start, so they'll naturally fill the full width of it's parent element. This is easily customized with our various [sizing options](#sizing). +Below is an example of a basic card with mixed content and a fixed width. Cards have no fixed width to start, so they'll naturally fill the full width of its parent element. This is easily customized with our various [sizing options](#sizing). {% example html %}

@@ -51,7 +51,7 @@ The building block of a card is the `.card-block`. Use it whenever you need a pa Card titles are used by adding `.card-title` to a `` tag. In the same way, links are added and placed next to each other by adding `.card-link` to a `` tag. -Subtitles are used by adding a `.card-subtitle` to an `` tag. If the `.card-title` and the `.card-subtitle` items are placed in a `.card-block` item, the card title and subtitle are aligned nicely. +Subtitles are used by adding a `.card-subtitle` to a `` tag. If the `.card-title` and the `.card-subtitle` items are placed in a `.card-block` item, the card title and subtitle are aligned nicely. {% example html %}

diff --git a/docs/components/forms.md b/docs/components/forms.md index 9f1e231c7..17a96a113 100644 --- a/docs/components/forms.md +++ b/docs/components/forms.md @@ -1,7 +1,7 @@ --- layout: docs title: Forms -description: Examples and usage guidelines for from controls, form layouts, and custom forms. +description: Examples and usage guidelines for form controls, form layouts, and custom forms. group: components --- diff --git a/docs/components/modal.md b/docs/components/modal.md index 5ace1ac58..d61151f8f 100644 --- a/docs/components/modal.md +++ b/docs/components/modal.md @@ -19,7 +19,7 @@ Before getting started with Bootstrap's modal component, be sure to read the fol - Modals are built with HTML, CSS, and JavaScript. They're positioned over everything else in the document and remove scroll from the `` so that modal content scrolls instead. - Clicking on the modal "backdrop" will automatically close the modal. - Bootstrap only supports one modal window at a time. Nested modals aren't supported as we believe them to be poor user experiences. -- Modal's use `position: fixed`, which can sometimes be a bit particular about it's rendering. Whenever possible, place your modal HTML in a top-level position to avoid potential interference from other elements. You'll likely run into issues when nesting a `.modal` within another fixed element. +- Modals use `position: fixed`, which can sometimes be a bit particular about its rendering. Whenever possible, place your modal HTML in a top-level position to avoid potential interference from other elements. You'll likely run into issues when nesting a `.modal` within another fixed element. - One again, due to `position: fixed`, there are some caveats with using modals on mobile devices. [See our browser support docs]({{ site.baseurl }}/getting-started/browsers-devices/#modals-and-dropdowns-on-mobile) for details. - Lastly, the `autofocus` HTML attribute has no affect in modals. Here's how you can achieve the same effect with custom JavaScript. diff --git a/docs/components/navs.md b/docs/components/navs.md index fed519e8e..5b9397fc1 100644 --- a/docs/components/navs.md +++ b/docs/components/navs.md @@ -206,7 +206,7 @@ For equal-width elements, use `.nav-justified`. All horizontal space will be occ ## Working with flex utilities -If you need responsive nav variations, consider using a series of [flex utilities](). While more verbose, these utilities offer greater customization across responsive breakpoints. In the example below, our nav will be stacked on the lowest breakpoint, then adapt to a horizontal layout that fills the available width starting from the small breakpoint. +If you need responsive nav variations, consider using a series of [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). While more verbose, these utilities offer greater customization across responsive breakpoints. In the example below, our nav will be stacked on the lowest breakpoint, then adapt to a horizontal layout that fills the available width starting from the small breakpoint. {% example html %}

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 a98fb3c83a0afaaa1e018eb383077dc16ad9ac9b Mon Sep 17 00:00:00 2001 From: Pierre-Denis Vanduynslager Date: Wed, 11 Jan 2017 18:30:48 -0500 Subject: Fix modal id in doc --- docs/components/modal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/modal.md b/docs/components/modal.md index d61151f8f..16689f6ae 100644 --- a/docs/components/modal.md +++ b/docs/components/modal.md @@ -121,7 +121,7 @@ Toggle a working modal demo by clicking the button below. It will slide down and -

{% endexample %} +Similar to the `.nav-fill` example using a `

`-based navigation, be sure to include `.nav-item` on the anchors. + +{% example html %} + + +{% endexample %} ## Working with flex utilities If you need responsive nav variations, consider using a series of [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). While more verbose, these utilities offer greater customization across responsive breakpoints. In the example below, our nav will be stacked on the lowest breakpoint, then adapt to a horizontal layout that fills the available width starting from the small breakpoint. -- cgit v1.2.3 From b83637152562b5ffd509eec66742d0436cb66bd1 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 19 Mar 2017 19:03:29 -0700 Subject: document it --- docs/components/collapse.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'docs/components') diff --git a/docs/components/collapse.md b/docs/components/collapse.md index 8942c85a4..c44daad29 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -90,6 +90,33 @@ Using the [card]({{ site.baseurl }}/components/card/) component, you can extend {% endexample %} +You can also create accordions with custom markup. Add the `data-children` attribute and specify a set of sibling elements to toggle (e.g., `.item`). Then, use the same attributes and classes as shown above for connectinh toggles to their associated content. + +{% example html %} +

+ + Toggle item + +

+ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed pretium lorem non vestibulum scelerisque. Proin a vestibulum sem, eget tristique massa. Aliquam lacinia rhoncus nibh quis ornare. +

+ + Toggle item 2 + +

+ Donec at ipsum dignissim, rutrum turpis scelerisque, tristique lectus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vivamus nec dui turpis. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. +

+{% endexample %} + ## Accessibility Be sure to add `aria-expanded` to the control element. This attribute explicitly defines the current state of the collapsible element to screen readers and similar assistive technologies. If the collapsible element is closed by default, it should have a value of `aria-expanded="false"`. If you've set the collapsible element to be open by default using the `show` class, set `aria-expanded="true"` on the control instead. The plugin will automatically toggle this attribute based on whether or not the collapsible element has been opened or closed. -- cgit v1.2.3 From 38f89726b957030de241631ea6fe06460af497e5 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 19 Mar 2017 20:51:35 -0700 Subject: fixes #21920 --- docs/components/navbar.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 44c1bfddd..7d0c4586e 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -16,7 +16,7 @@ The navbar is a wrapper that positions branding, navigation, and other elements Here's what you need to know before getting started with the navbar: -- Navbars require a wrapping `.navbar` with `.navbar-toggleable-*` for responsive collapsing and [color scheme](#color-schemes) classes. +- Navbars require a wrapping `.navbar` with `.navbar-toggleable{-sm|-md|-lg|-xl}` for responsive collapsing and [color scheme](#color-schemes) classes. - Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width. - Navbars and their contents are built with flexbox, providing easy alignment options via utility classes. - Navbars are responsive by default, but you can easily modify them to change that. Responsive behavior depends on our Collapse JavaScript plugin. @@ -389,7 +389,7 @@ Although it's not required, you can wrap a navbar in a `.container` to center it {% endexample %} -When the container is within your navbar, its horizontal padding is removed at breakpoints lower than your specified `.navbar-toggleable-*` class. This ensures we're not doubling up on padding unnecessarily on lower viewports when your navbar is collapsed. +When the container is within your navbar, its horizontal padding is removed at breakpoints lower than your specified `.navbar-toggleable{-sm|-md|-lg|-xl}` class. This ensures we're not doubling up on padding unnecessarily on lower viewports when your navbar is collapsed. {% example html %}

@@ -429,7 +429,7 @@ Use our position utilities to place navbars in non-static positions. Choose from ## Responsive behaviors -Navbars can utilize `.navbar-toggler`, `.navbar-collapse`, and `.navbar-toggleable-*` classes to change when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements. +Navbars can utilize `.navbar-toggler`, `.navbar-collapse`, and `.navbar-toggleable{-sm|-md|-lg|-xl}` classes to change when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements. ### Toggler -- cgit v1.2.3 From c72a315740c852152c1bc6a34bf2b4c2372fe389 Mon Sep 17 00:00:00 2001 From: Johann Date: Wed, 22 Mar 2017 22:42:13 +0100 Subject: Carousel - Add attributes from and to for Slid and Slide events (#21668) Carousel - Add attributes from and to for Slid and Slide events --- docs/components/carousel.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index ea22f3ef9..24a42a617 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -265,6 +265,8 @@ Bootstrap's carousel class exposes two events for hooking into carousel function - `direction`: The direction in which the carousel is sliding (either `"left"` or `"right"`). - `relatedTarget`: The DOM element that is being slid into place as the active item. +- `from`: The index of the current item +- `to`: The index of the next item All carousel events are fired at the carousel itself (i.e. at the `

`). -- cgit v1.2.3 From 7c4ed09da25fbb1bcf74900473ef335fce34fe75 Mon Sep 17 00:00:00 2001 From: Gifford Nowland Date: Wed, 22 Mar 2017 15:02:56 -0700 Subject: fix data-pause documentation for carousel (#21938) fix data-pause documentation for carousel --- docs/components/carousel.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 24a42a617..5649dfac9 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -208,9 +208,9 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap pause - string | null + string | boolean "hover" - If set to "hover", pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave. If set to null, hovering over the carousel won't pause it. + If set to "hover", pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave. If set to false, hovering over the carousel won't pause it. ride -- cgit v1.2.3 From 37f438910fc50ca0b7b9959357fd302b4daf6930 Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Thu, 23 Mar 2017 16:15:41 -0400 Subject: Accordion behavior with JQuery interface (#21726) Fix accordion behavior with JQuery interface --- docs/components/collapse.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'docs/components') diff --git a/docs/components/collapse.md b/docs/components/collapse.md index c44daad29..370cb760e 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -47,13 +47,13 @@ Using the [card]({{ site.baseurl }}/components/card/) component, you can extend

- + Collapsible Group Item #1

@@ -62,12 +62,12 @@ Using the [card]({{ site.baseurl }}/components/card/) component, you can extend

- + Collapsible Group Item #2

@@ -76,12 +76,12 @@ Using the [card]({{ site.baseurl }}/components/card/) component, you can extend

- + Collapsible Group Item #3

@@ -137,7 +137,7 @@ These classes can be found in `_transitions.scss`. Just add `data-toggle="collapse"` and a `data-target` to the element to automatically assign control of a collapsible element. The `data-target` attribute accepts a CSS selector to apply the collapse to. Be sure to add the class `collapse` to the collapsible element. If you'd like it to default open, add the additional class `show`. -To add accordion-like group management to a collapsible control, add the data attribute `data-parent="#selector"`. Refer to the demo to see this in action. +To add accordion-like group management to a collapsible area, add the data attribute `data-parent="#selector"`. Refer to the demo to see this in action. ### Via JavaScript @@ -165,7 +165,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap parent selector false - If a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the panel class) + If a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the card class). The attribute has to be set on the target collapsible area. toggle -- cgit v1.2.3 From 3f247a42f2a113f9e04184987eae9019abcac778 Mon Sep 17 00:00:00 2001 From: Johann Date: Thu, 23 Mar 2017 22:22:09 +0100 Subject: Fix Modal documentation about _handleUpdate method + move to public scope (#21877) Fix Modal documentation about _handleUpdate method + move to public scope --- docs/components/modal.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/modal.md b/docs/components/modal.md index deb25c4dc..96a11e1a2 100644 --- a/docs/components/modal.md +++ b/docs/components/modal.md @@ -410,7 +410,7 @@ For modals that simply appear rather than fade in to view, remove the `.fade` cl ### Dynamic heights -If the height of a modal changes while it is open, you should call `$('#myModal').data('bs.modal').handleUpdate()` to readjust the modal's position in case a scrollbar appears. +If the height of a modal changes while it is open, you should call `$('#myModal').data('bs.modal').handleUpdate()` or `$('#myModal').modal('handleUpdate')` to readjust the modal's position in case a scrollbar appears. ### Accessibility @@ -575,6 +575,12 @@ Manually hides a modal. **Returns to the caller before the modal has actually be {% highlight js %}$('#myModal').modal('hide'){% endhighlight %} +#### `.modal('handleUpdate')` + +Manually readjust the modal's position if the height of a modal changes while it is open (i.e. in case a scrollbar appears). + +{% highlight js %}$('#myModal').modal('handleUpdate'){% endhighlight %} + ### Events Bootstrap's modal class exposes a few events for hooking into modal functionality. All modal events are fired at the modal itself (i.e. at the ` {% highlight html %} -

-- cgit v1.2.3 From c1325a756ef1c19c197566f6889d49410b1dadf5 Mon Sep 17 00:00:00 2001 From: Pierre-Denis Vanduynslager Date: Fri, 13 Jan 2017 23:05:33 -0500 Subject: Generate correct breakpoints for navbar-toggleable-* and generate toggleable without media query to never collapse --- docs/components/navbar.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 7d0c4586e..b8eb0e2d4 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -35,10 +35,10 @@ Navbars come with built-in support for a handful of sub-components. Choose from - `.navbar-text` for adding vertically centered strings of text. - `.collapse.navbar-collapse` for grouping and hiding navbar contents by a parent breakpoint. -Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `md` (medium) breakpoint. +Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `lg` (large) breakpoint. {% example html %} -

@@ -249,7 +249,7 @@ Navbars may contain bits of text with the help of `.navbar-text`. This class adj Mix and match with other components and utilities as needed. {% example html %} -

@@ -383,7 +383,7 @@ Although it's not required, you can wrap a navbar in a `.container` to center it {% example html %}

@@ -392,7 +392,7 @@ Although it's not required, you can wrap a navbar in a `.container` to center it When the container is within your navbar, its horizontal padding is removed at breakpoints lower than your specified `.navbar-toggleable{-sm|-md|-lg|-xl}` class. This ensures we're not doubling up on padding unnecessarily on lower viewports when your navbar is collapsed. {% example html %} -

@@ -431,6 +431,10 @@ Use our position utilities to place navbars in non-static positions. Choose from Navbars can utilize `.navbar-toggler`, `.navbar-collapse`, and `.navbar-toggleable{-sm|-md|-lg|-xl}` classes to change when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements. +In order to never collapse the content, add the `.navbar-toggleable` class on the navbar. + +In order to always collapse the content, do not add any of the `.navbar-toggleable-*` class on the navbar. + ### Toggler Navbar togglers can be left or right aligned with `.navbar-toggler-left` or `.navbar-toggler-right` modifiers. These are absolutely positioned within the navbar to avoid interference with the collapsed state. You can also use your own styles to position togglers. Below are examples of different toggle styles. @@ -438,7 +442,7 @@ Navbar togglers can be left or right aligned with `.navbar-toggler-left` or `.na With no `.navbar-brand` shown in lowest breakpoint: {% example html %} -

@@ -466,14 +470,14 @@ With no `.navbar-brand` shown in lowest breakpoint: With a brand name shown on the left and toggler on the right: {% example html %} -

Home (current)

Date: Mon, 20 Mar 2017 23:10:15 -0700 Subject: update docs --- docs/components/navbar.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index b8eb0e2d4..8da2b9acd 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -431,13 +431,11 @@ Use our position utilities to place navbars in non-static positions. Choose from Navbars can utilize `.navbar-toggler`, `.navbar-collapse`, and `.navbar-toggleable{-sm|-md|-lg|-xl}` classes to change when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements. -In order to never collapse the content, add the `.navbar-toggleable` class on the navbar. - -In order to always collapse the content, do not add any of the `.navbar-toggleable-*` class on the navbar. +For navbars that never collapse, add the `.navbar-toggleable` class on the navbar. For navbars that always collapse, don't add any `.navbar-toggleable` class. ### Toggler -Navbar togglers can be left or right aligned with `.navbar-toggler-left` or `.navbar-toggler-right` modifiers. These are absolutely positioned within the navbar to avoid interference with the collapsed state. You can also use your own styles to position togglers. Below are examples of different toggle styles. +Navbar togglers are left-aligned by default, but should they follow a sibling element like a `.navbar-brand`, they'll automatically be aligned to the far right. Reversing your markup will reverse the placement of the toggler. Below are examples of different toggle styles. With no `.navbar-brand` shown in lowest breakpoint: @@ -471,10 +469,10 @@ With a brand name shown on the left and toggler on the right: {% example html %} {% endexample %} +With a toggler on the left and brand name on the right: + +{% example html %} + +{% endexample %} + ### External content Sometimes you want to use the collapse plugin to trigger hidden content elsewhere on the page. Because our plugin works on the `id` and `data-target` matching, that's easily done! -- cgit v1.2.3 From 11ba308b2fdfb396abd45069526d25a07571238c Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Mon, 20 Mar 2017 23:13:34 -0700 Subject: more docs updates --- docs/components/navbar.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 8da2b9acd..005d830c7 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -39,10 +39,10 @@ Here's an example of all the sub-components included in a responsive light-theme {% example html %}

- -

@@ -136,10 +136,10 @@ And because we use classes for our navs, you can avoid the list-based approach e {% example html %}

- -

Home @@ -155,10 +155,10 @@ You may also utilize dropdowns in your navbar nav. Dropdown menus require a wrap {% example html %}

- -

@@ -250,10 +250,10 @@ Mix and match with other components and utilities as needed. {% example html %}

- -

@@ -279,10 +279,10 @@ Theming the navbar has never been easier thanks to the combination of theming cl

- -

- @@ -498,10 +498,10 @@ With a toggler on the left and brand name on the right: {% example html %}

- -

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/popovers.md | 18 ++++++++++++++++++ docs/components/tooltips.md | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) (limited to 'docs/components') diff --git a/docs/components/popovers.md b/docs/components/popovers.md index e4ace2ed9..ec5b4970d 100644 --- a/docs/components/popovers.md +++ b/docs/components/popovers.md @@ -306,6 +306,24 @@ Hides and destroys an element's popover. Popovers that use delegation (which are {% highlight js %}$('#element').popover('dispose'){% endhighlight %} +#### `.popover('enable')` + +Gives an element's popover the ability to be shown. **Popovers are enabled by default.** + +{% highlight js %}$('#element').popover('enable'){% endhighlight %} + +#### `.popover('disable')` + +Removes the ability for an element's popover to be shown. The popover will only be able to be shown if it is re-enabled. + +{% highlight js %}$('#element').popover('disable'){% endhighlight %} + +#### `.popover('toggleEnabled')` + +Toggles the ability for an element's popover to be shown or hidden. + +{% highlight js %}$('#element').popover('toggleEnabled'){% endhighlight %} + ### Events 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 1ad0496724dfdd338614deb4cb4a1087bef1c26f Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 26 Mar 2017 11:07:42 -0700 Subject: fix broken fieldset grid, workaround for flexbug 9 --- docs/components/forms.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) (limited to 'docs/components') diff --git a/docs/components/forms.md b/docs/components/forms.md index 313835f6f..44cb1ed0d 100644 --- a/docs/components/forms.md +++ b/docs/components/forms.md @@ -350,26 +350,28 @@ Be sure to add `.col-form-label` to your ``s as well so they're verticall -

- Radios -

- - - Option one is this and that—be sure to include why it's great - -

- - - Option two can be something else and selecting it will deselect option one - -

- - - Option three is disabled - +

+ Radios +

+ + + Option one is this and that—be sure to include why it's great + +

+ + + Option two can be something else and selecting it will deselect option one + +

+ + + Option three is disabled + +

-- cgit v1.2.3 From fe3acc097ac9def6569f471ef25d444020c30057 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Mon, 27 Mar 2017 22:52:24 -0700 Subject: Card image fixes (#22288) * fix image stretching due to flexbox * fix broke text-muted on dark bg * no img-fluid needed --- docs/components/card.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/components') diff --git a/docs/components/card.md b/docs/components/card.md index dc8a921b8..74debae44 100644 --- a/docs/components/card.md +++ b/docs/components/card.md @@ -359,7 +359,7 @@ Turn an image into a card background and overlay your card's text. Depending on

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

Last updated 3 mins ago

{% endexample %} @@ -644,7 +644,7 @@ Cards can be organized into [Masonry](http://masonry.desandro.com)-like columns {% example html %}

Card title that wraps to a new line

This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

@@ -661,7 +661,7 @@ Cards can be organized into [Masonry](http://masonry.desandro.com)-like columns

Card title

This card has supporting text below as a natural lead-in to additional content.

@@ -686,7 +686,7 @@ Cards can be organized into [Masonry](http://masonry.desandro.com)-like columns

-- 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/carousel.md | 9 ++++++--- docs/components/collapse.md | 9 ++++++--- docs/components/modal.md | 3 +++ docs/components/navs.md | 3 +++ docs/components/popovers.md | 3 +++ docs/components/tooltips.md | 3 +++ 6 files changed, 24 insertions(+), 6 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 5649dfac9..405aee18c 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -229,6 +229,9 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap ### Methods +{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} +{{ callout-include | markdownify }} + #### `.carousel(options)` Initializes the carousel with an optional options `object` and starts cycling through items. @@ -249,15 +252,15 @@ Stops the carousel from cycling through items. #### `.carousel(number)` -Cycles the carousel to a particular frame (0 based, similar to an array). +Cycles the carousel to a particular frame (0 based, similar to an array). **Returns to the caller before the target item has been shown** (i.e. before the `slid.bs.carousel` event occurs). #### `.carousel('prev')` -Cycles to the previous item. +Cycles to the previous item. **Returns to the caller before the previous item has been shown** (i.e. before the `slid.bs.carousel` event occurs). #### `.carousel('next')` -Cycles to the next item. +Cycles to the next item. **Returns to the caller before the next item has been shown** (i.e. before the `slid.bs.carousel` event occurs). ### Events diff --git a/docs/components/collapse.md b/docs/components/collapse.md index 370cb760e..0a49db562 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -178,6 +178,9 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap ### Methods +{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} +{{ callout-include | markdownify }} + #### `.collapse(options)` Activates your content as a collapsible element. Accepts an optional options `object`. @@ -190,15 +193,15 @@ $('#myCollapsible').collapse({ #### `.collapse('toggle')` -Toggles a collapsible element to shown or hidden. +Toggles a collapsible element to shown or hidden. **Returns to the caller before the collapsible element has actually been shown or hidden (i.e. before the `shown.bs.collapse` or `hidden.bs.collapse` event occurs). #### `.collapse('show')` -Shows a collapsible element. +Shows a collapsible element. **Returns to the caller before the collapsible element has actually been shown** (i.e. before the `shown.bs.collapse` event occurs). #### `.collapse('hide')` -Hides a collapsible element. +Hides a collapsible element. **Returns to the caller before the collapsible element has actually been hidden** (i.e. before the `hidden.bs.collapse` event occurs). ### Events diff --git a/docs/components/modal.md b/docs/components/modal.md index a4e28bcec..19254b880 100644 --- a/docs/components/modal.md +++ b/docs/components/modal.md @@ -547,6 +547,9 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap ### Methods +{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} +{{ callout-include | markdownify }} + #### `.modal(options)` Activates your content as a modal. Accepts an optional options `object`. diff --git a/docs/components/navs.md b/docs/components/navs.md index 047eb2205..e47a5a9e6 100644 --- a/docs/components/navs.md +++ b/docs/components/navs.md @@ -404,6 +404,9 @@ To make tabs fade in, add `.fade` to each `.tab-pane`. The first tab pane must a ### Methods +{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} +{{ callout-include | markdownify }} + #### $().tab Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the DOM. diff --git a/docs/components/popovers.md b/docs/components/popovers.md index ec5b4970d..5f26e4bbd 100644 --- a/docs/components/popovers.md +++ b/docs/components/popovers.md @@ -277,6 +277,9 @@ Options for individual popovers can alternatively be specified through the use o ### Methods +{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} +{{ callout-include | markdownify }} + #### `$().popover(options)` Initializes popovers for an element collection. 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 63cd4e96b3511853361b1c47dff05496e62c4e9a Mon Sep 17 00:00:00 2001 From: "Patrick H. Lauke" Date: Thu, 30 Mar 2017 22:45:36 +0100 Subject: Add explicit aria-label to placeholder-only inputs While `placeholder` is nominally valid per spec http://rawgit.com/w3c/html-api-map/master/index.html#accessible-name-and-description-calculation it is inelegant, a fallback, and not supported in ios/safari/voiceover and android/chrome/talkback, to name a few combinations `aria-describedby` is also not really the right tool for providing a name/label equivalent, so remove that from the list of possible alternative methods / clarify how it can be used --- docs/components/button-group.md | 4 ++-- docs/components/input-group.md | 16 ++++++++-------- docs/components/navbar.md | 18 +++++++++--------- 3 files changed, 19 insertions(+), 19 deletions(-) (limited to 'docs/components') diff --git a/docs/components/button-group.md b/docs/components/button-group.md index 59a18e262..5c21e51f7 100644 --- a/docs/components/button-group.md +++ b/docs/components/button-group.md @@ -59,7 +59,7 @@ Feel free to mix input groups with button groups in your toolbars. Similar to th

@ - +

@@ -72,7 +72,7 @@ Feel free to mix input groups with button groups in your toolbars. Similar to th

@ - +

{% endexample %} diff --git a/docs/components/input-group.md b/docs/components/input-group.md index 0869b70e7..f84cb2453 100644 --- a/docs/components/input-group.md +++ b/docs/components/input-group.md @@ -19,11 +19,11 @@ Place one add-on or button on either side of an input. You may also place one on {% example html %}

@ - +

- + @example.com

@@ -53,12 +53,12 @@ Add the relative form sizing classes to the `.input-group` itself and contents w {% example html %}

@ - +

{% endexample %} @@ -124,12 +124,12 @@ Buttons in input groups must wrapped in a `.input-group-btn` for proper alignmen - +

- + @@ -143,7 +143,7 @@ Buttons in input groups must wrapped in a `.input-group-btn` for proper alignmen - + @@ -240,4 +240,4 @@ Buttons in input groups must wrapped in a `.input-group-btn` for proper alignmen Screen readers will have trouble with your forms if you don't include a label for every input. For these input groups, ensure that any additional label or functionality is conveyed to assistive technologies. -The exact technique to be used (`` elements hidden using the `.sr-only` class, or use of the `aria-label`, `aria-labelledby`, `aria-describedby`, `title` or `placeholder` attribute) and what additional information will need to be conveyed will vary depending on the exact type of interface widget you're implementing. The examples in this section provide a few suggested, case-specific approaches. +The exact technique to be used (`` elements hidden using the `.sr-only` class, or use of the `aria-label` and `aria-labelledby` attributes, possibly in combination with `aria-describedby`) and what additional information will need to be conveyed will vary depending on the exact type of interface widget you're implementing. The examples in this section provide a few suggested, case-specific approaches. diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 005d830c7..569673575 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -57,7 +57,7 @@ Here's an example of all the sub-components included in a responsive light-theme - +

@@ -192,7 +192,7 @@ Place various form controls and components within a navbar with `.form-inline`. {% example html %} @@ -204,7 +204,7 @@ Align the contents of your inline forms with utilities as needed. @@ -217,7 +217,7 @@ Input groups work, too:

@ - +

@@ -300,7 +300,7 @@ Theming the navbar has never been easier thanks to the combination of theming cl - +

@@ -328,7 +328,7 @@ Theming the navbar has never been easier thanks to the combination of theming cl - + @@ -356,7 +356,7 @@ Theming the navbar has never been easier thanks to the combination of theming cl - + @@ -458,7 +458,7 @@ With no `.navbar-brand` shown in lowest breakpoint: - + @@ -516,7 +516,7 @@ With a toggler on the left and brand name on the right: - + -- cgit v1.2.3 From 91b62941afb7115807fc2925398ebccfc68f5377 Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Sun, 2 Apr 2017 05:21:04 -0400 Subject: Tabs/Scrollspy/.nav/.list-group/.active independent of markup (

, .nav-item,

etc...) --- docs/components/list-group.md | 192 +++++++++++++++++++++++++++++++++++++ docs/components/navs.md | 214 ++++++++++++++++++++++++++++++++++++++---- docs/components/scrollspy.md | 208 ++++++++++++++++++++++++++++++++++++++-- 3 files changed, 587 insertions(+), 27 deletions(-) (limited to 'docs/components') diff --git a/docs/components/list-group.md b/docs/components/list-group.md index f3b5b7c89..5dbb6db40 100644 --- a/docs/components/list-group.md +++ b/docs/components/list-group.md @@ -167,3 +167,195 @@ Add nearly any HTML within, even for linked list groups like the one below, with {% endexample %} + +## JavaScript behavior + +Use the tab JavaScript plugin—include it individually or through the compiled `bootstrap.js` file—to extend our list group to create tabbable panes of local content. + +

+ Home + Profile + Messages + Settings +

Velit aute mollit ipsum ad dolor consectetur nulla officia culpa adipisicing exercitation fugiat tempor. Voluptate deserunt sit sunt nisi aliqua fugiat proident ea ut. Mollit voluptate reprehenderit occaecat nisi ad non minim tempor sunt voluptate consectetur exercitation id ut nulla. Ea et fugiat aliquip nostrud sunt incididunt consectetur culpa aliquip eiusmod dolor. Anim ad Lorem aliqua in cupidatat nisi enim eu nostrud do aliquip veniam minim.

Cupidatat quis ad sint excepteur laborum in esse qui. Et excepteur consectetur ex nisi eu do cillum ad laborum. Mollit et eu officia dolore sunt Lorem culpa qui commodo velit ex amet id ex. Officia anim incididunt laboris deserunt anim aute dolor incididunt veniam aute dolore do exercitation. Dolor nisi culpa ex ad irure in elit eu dolore. Ad laboris ipsum reprehenderit irure non commodo enim culpa commodo veniam incididunt veniam ad.

Ut ut do pariatur aliquip aliqua aliquip exercitation do nostrud commodo reprehenderit aute ipsum voluptate. Irure Lorem et laboris nostrud amet cupidatat cupidatat anim do ut velit mollit consequat enim tempor. Consectetur est minim nostrud nostrud consectetur irure labore voluptate irure. Ipsum id Lorem sit sint voluptate est pariatur eu ad cupidatat et deserunt culpa sit eiusmod deserunt. Consectetur et fugiat anim do eiusmod aliquip nulla laborum elit adipisicing pariatur cillum.

Irure enim occaecat labore sit qui aliquip reprehenderit amet velit. Deserunt ullamco ex elit nostrud ut dolore nisi officia magna sit occaecat laboris sunt dolor. Nisi eu minim cillum occaecat aute est cupidatat aliqua labore aute occaecat ea aliquip sunt amet. Aute mollit dolor ut exercitation irure commodo non amet consectetur quis amet culpa. Quis ullamco nisi amet qui aute irure eu. Magna labore dolor quis ex labore id nostrud deserunt dolor eiusmod eu pariatur culpa mollit in irure.

+ +{% highlight html %} +

+ Home + Profile + Messages + Settings +

...

+{% endhighlight %} + +### Using data attributes + +You can activate a list group navigation without writing any JavaScript by simply specifying `data-toggle="list"` or on an element. Use these data attributes on `.list-group-item`. + +

+{% highlight html %} + +

+ Home + Profile + Messages + Settings +

+ + +

...

+{% endhighlight %} +

+ +### Via JavaScript + +Enable tabbable list item via JavaScript (each list item needs to be activated individually): + +{% highlight js %} +$('#myList a').click(function (e) { + e.preventDefault() + $(this).tab('show') +}) +{% endhighlight %} + +You can activate individual list item in several ways: + +{% highlight js %} +$('#myList a[href="#profile"]').tab('show') // Select tab by name +$('#myList a:first').tab('show') // Select first tab +$('#myList a:last').tab('show') // Select last tab +$('#myList li:eq(2) a').tab('show') // Select third tab (0-indexed) +{% endhighlight %} + +### Fade effect + +To make tabs panel fade in, add `.fade` to each `.tab-pane`. The first tab pane must also have `.show` to make the initial content visible. + +{% highlight html %} +

...

+{% endhighlight %} + +### Methods + +#### $().tab + +Activates a list item element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the DOM. + +{% highlight html %} +

+ Home + Profile + Messages + Settings +

+ +

...

+ + +{% endhighlight %} + +#### .tab('show') + +Selects the given list item and shows its associated pane. Any other list item that was previously selected becomes unselected and its associated pane is hidden. **Returns to the caller before the tab pane has actually been shown** (i.e. before the `shown.bs.tab` event occurs). + +{% highlight js %} +$('#someListItem').tab('show') +{% endhighlight %} + +### Events + +When showing a new tab, the events fire in the following order: + +1. `hide.bs.tab` (on the current active tab) +2. `show.bs.tab` (on the to-be-shown tab) +3. `hidden.bs.tab` (on the previous active tab, the same one as for the `hide.bs.tab` event) +4. `shown.bs.tab` (on the newly-active just-shown tab, the same one as for the `show.bs.tab` event) + +If no tab was already active, then the `hide.bs.tab` and `hidden.bs.tab` events will not be fired. + +

+ + + + + + + + + + + + + + + + + + + + + + + + +

Event Type	Description
show.bs.tab	This event fires on tab show, but before the new tab has been shown. Use `event.target` and `event.relatedTarget` to target the active tab and the previous active tab (if available) respectively.
shown.bs.tab	This event fires on tab show after a tab has been shown. Use `event.target` and `event.relatedTarget` to target the active tab and the previous active tab (if available) respectively.
hide.bs.tab	This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use `event.target` and `event.relatedTarget` to target the current active tab and the new soon-to-be-active tab, respectively.
hidden.bs.tab	This event fires after a new tab is shown (and thus the previous active tab is hidden). Use `event.target` and `event.relatedTarget` to target the previous active tab and the new active tab, respectively.

+ +{% highlight js %} +$('a[data-toggle="list"]').on('shown.bs.tab', function (e) { + e.target // newly activated tab + e.relatedTarget // previous active tab +}) +{% endhighlight %} diff --git a/docs/components/navs.md b/docs/components/navs.md index e47a5a9e6..05a2bfa41 100644 --- a/docs/components/navs.md +++ b/docs/components/navs.md @@ -199,20 +199,12 @@ When using a `

`-based navigation, be sure to include `.nav-item` on the anc For equal-width elements, use `.nav-justified`. All horizontal space will be occupied by nav links, but unlike the `.nav-fill` above, every nav item will be the same width. {% example html %} -

- Active -
- Longer nav link -
- Link -
- Disabled -

+ {% endexample %} Similar to the `.nav-fill` example using a `

Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.

Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.

Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.

Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.

+{% highlight html %} +

+ Home +
+ Profile +
+ + Dropdown + +
+ @fat + @mdo +
+

...

+{% endhighlight %} + +To help fit your needs, this works with `

`-based markup shown below. + +

+ Home + Profile + +

Et et consectetur ipsum labore excepteur est proident excepteur ad velit occaecat qui minim occaecat veniam. Fugiat veniam incididunt anim aliqua enim pariatur veniam sunt est aute sit dolor anim. Velit non irure adipisicing aliqua ullamco irure incididunt irure non esse consectetur nostrud minim non minim occaecat. Amet duis do nisi duis veniam non est eiusmod tempor incididunt tempor dolor ipsum in qui sit. Exercitation mollit sit culpa nisi culpa non adipisicing reprehenderit do dolore. Duis reprehenderit occaecat anim ullamco ad duis occaecat ex.

Nulla est ullamco ut irure incididunt nulla Lorem Lorem minim irure officia enim reprehenderit. Magna duis labore cillum sint adipisicing exercitation ipsum. Nostrud ut anim non exercitation velit laboris fugiat cupidatat. Commodo esse dolore fugiat sint velit ullamco magna consequat voluptate minim amet aliquip ipsum aute laboris nisi. Labore labore veniam irure irure ipsum pariatur mollit magna in cupidatat dolore magna irure esse tempor ad mollit. Dolore commodo nulla minim amet ipsum officia consectetur amet ullamco voluptate nisi commodo ea sit eu.

Sint sit mollit irure quis est nostrud cillum consequat Lorem esse do quis dolor esse fugiat sunt do. Eu ex commodo veniam Lorem aliquip laborum occaecat qui Lorem esse mollit dolore anim cupidatat. Deserunt officia id Lorem nostrud aute id commodo elit eiusmod enim irure amet eiusmod qui reprehenderit nostrud tempor. Fugiat ipsum excepteur in aliqua non et quis aliquip ad irure in labore cillum elit enim. Consequat aliquip incididunt ipsum et minim laborum laborum laborum et cillum labore. Deserunt adipisicing cillum id nulla minim nostrud labore eiusmod et amet. Laboris consequat consequat commodo non ut non aliquip reprehenderit nulla anim occaecat. Sunt sit ullamco reprehenderit irure ea ullamco Lorem aute nostrud magna.

Proident incididunt esse qui ea nisi ullamco aliquip nostrud velit sint duis. Aute culpa aute cillum sit consectetur mollit minim non reprehenderit tempor. Occaecat amet consectetur aute esse ad ullamco ad commodo mollit reprehenderit esse in consequat. Mollit minim do consectetur pariatur irure non id ea dolore occaecat adipisicing consectetur est aute magna non.

+ +{% highlight html %} +

+ Home + Profile + +

...

+{% endhighlight %} + +The tabs plugin also works with pills. + +

+ Home +
+ Profile +
+ Dropdown +
+ @fat + @mdo +
+

Consequat occaecat ullamco amet non eiusmod nostrud dolore irure incididunt est duis anim sunt officia. Fugiat velit proident aliquip nisi incididunt nostrud exercitation proident est nisi. Irure magna elit commodo anim ex veniam culpa eiusmod id nostrud sit cupidatat in veniam ad. Eiusmod consequat eu adipisicing minim anim aliquip cupidatat culpa excepteur quis. Occaecat sit eu exercitation irure Lorem incididunt nostrud.

Ad pariatur nostrud pariatur exercitation ipsum ipsum culpa mollit commodo mollit ex. Aute sunt incididunt amet commodo est sint nisi deserunt pariatur do. Aliquip ex eiusmod voluptate exercitation cillum id incididunt elit sunt. Qui minim sit magna Lorem id et dolore velit Lorem amet exercitation duis deserunt. Anim id labore elit adipisicing ut in id occaecat pariatur ut ullamco ea tempor duis.

Est quis nulla laborum officia ad nisi ex nostrud culpa Lorem excepteur aliquip dolor aliqua irure ex. Nulla ut duis ipsum nisi elit fugiat commodo sunt reprehenderit laborum veniam eu veniam. Eiusmod minim exercitation fugiat irure ex labore incididunt do fugiat commodo aliquip sit id deserunt reprehenderit aliquip nostrud. Amet ex cupidatat excepteur aute veniam incididunt mollit cupidatat esse irure officia elit do ipsum ullamco Lorem. Ullamco ut ad minim do mollit labore ipsum laboris ipsum commodo sunt tempor enim incididunt. Commodo quis sunt dolore aliquip aute tempor irure magna enim minim reprehenderit. Ullamco consectetur culpa veniam sint cillum aliqua incididunt velit ullamco sunt ullamco quis quis commodo voluptate. Mollit nulla nostrud adipisicing aliqua cupidatat aliqua pariatur mollit voluptate voluptate consequat non.

Tempor anim aliquip qui nisi sit minim ex in cupidatat ipsum adipisicing. Ad non magna anim id ullamco do dolor sit adipisicing nulla exercitation. Qui Lorem eiusmod sint in laboris pariatur est adipisicing non sunt occaecat in mollit culpa sit. Aliquip id duis do do quis mollit ut duis. Non dolor reprehenderit do esse nostrud deserunt non eiusmod minim anim sit voluptate ipsum. Nulla elit aliqua do sunt labore velit anim nisi dolor nostrud consectetur fugiat ex qui velit ex tempor. Do cillum qui anim aliquip id cillum duis ex laboris tempor incididunt sint dolor ullamco tempor. Fugiat laboris enim anim veniam aliquip cillum irure.

+ +{% highlight html %} +

+ Home +
+ Profile +
+ Dropdown +
+ @fat + @mdo +
+

...

+{% endhighlight %} + +And with vertical pills. + +

+ Home + Profile + Messages + Settings +

Cillum ad ut irure tempor velit nostrud occaecat ullamco aliqua anim Lorem sint. Veniam sint duis incididunt do esse magna mollit excepteur laborum qui. Id id reprehenderit sit est eu aliqua occaecat quis et velit excepteur laborum mollit dolore eiusmod. Ipsum dolor in occaecat commodo et voluptate minim reprehenderit mollit pariatur. Deserunt non laborum enim et cillum eu deserunt excepteur ea incididunt minim occaecat.

Culpa dolor voluptate do laboris laboris irure reprehenderit id incididunt duis pariatur mollit aute magna pariatur consectetur. Eu veniam duis non ut dolor deserunt commodo et minim in quis laboris ipsum velit id veniam. Quis ut consectetur adipisicing officia excepteur non sit. Ut et elit aliquip labore Lorem enim eu. Ullamco mollit occaecat dolore ipsum id officia mollit qui esse anim eiusmod do sint minim consectetur qui.

Fugiat id quis dolor culpa eiusmod anim velit excepteur proident dolor aute qui magna. Ad proident laboris ullamco esse anim Lorem Lorem veniam quis Lorem irure occaecat velit nostrud magna nulla. Velit et et proident Lorem do ea tempor officia dolor. Reprehenderit Lorem aliquip labore est magna commodo est ea veniam consectetur.

Eu dolore ea ullamco dolore Lorem id cupidatat excepteur reprehenderit consectetur elit id dolor proident in cupidatat officia. Voluptate excepteur commodo labore nisi cillum duis aliqua do. Aliqua amet qui mollit consectetur nulla mollit velit aliqua veniam nisi id do Lorem deserunt amet. Culpa ullamco sit adipisicing labore officia magna elit nisi in aute tempor commodo eiusmod.

+ +{% highlight html %} +

+ Home + Profile + Messages + Settings +

...

+{% endhighlight %} + ### Using data attributes You can activate a tab or pill navigation without writing any JavaScript by simply specifying `data-toggle="tab"` or `data-toggle="pill"` on an element. Use these data attributes on `.nav-tabs` or `.nav-pills`. @@ -344,7 +520,7 @@ You can activate a tab or pill navigation without writing any JavaScript by simp

{% highlight html %} -

Home

` and `

+ Item +

@fat

...

@mdo

...

one

...

two

...

three

...

+ +

Item 1

Ex consequat commodo adipisicing exercitation aute excepteur occaecat ullamco duis aliqua id magna ullamco eu. Do aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur labore. Fugiat laborum incididunt tempor eu consequat enim dolore proident. Qui laborum do non excepteur nulla magna eiusmod consectetur in. Aliqua et aliqua officia quis et incididunt voluptate non anim reprehenderit adipisicing dolore ut consequat deserunt mollit dolore. Aliquip nulla enim veniam non fugiat id cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.

Item 1-1

Amet tempor mollit aliquip pariatur excepteur commodo do ea cillum commodo Lorem et occaecat elit qui et. Aliquip labore ex ex esse voluptate occaecat Lorem ullamco deserunt. Aliqua cillum excepteur irure consequat id quis ea. Sit proident ullamco aute magna pariatur nostrud labore. Reprehenderit aliqua commodo eiusmod aliquip est do duis amet proident magna consectetur consequat eu commodo fugiat non quis. Enim aliquip exercitation ullamco adipisicing voluptate excepteur minim exercitation minim minim commodo adipisicing exercitation officia nisi adipisicing. Anim id duis qui consequat labore adipisicing sint dolor elit cillum anim et fugiat.

Item 2-2

Cillum nisi deserunt magna eiusmod qui eiusmod velit voluptate pariatur laborum sunt enim. Irure laboris mollit consequat incididunt sint et culpa culpa incididunt adipisicing magna magna occaecat. Nulla ipsum cillum eiusmod sint elit excepteur ea labore enim consectetur in labore anim. Proident ullamco ipsum esse elit ut Lorem eiusmod dolor et eiusmod. Anim occaecat nulla in non consequat eiusmod velit incididunt.

Item 2

Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor laborum mollit labore officia laborum excepteur commodo non commodo dolor excepteur commodo. Ipsum fugiat ex est consectetur ipsum commodo tempor sunt in proident.

Item 3

Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.

Item 3-1

Deserunt quis elit Lorem eiusmod amet enim enim amet minim Lorem proident nostrud. Ea id dolore anim exercitation aute fugiat labore voluptate cillum do laboris labore. Ex velit exercitation nisi enim labore reprehenderit labore nostrud ut ut. Esse officia sunt duis aliquip ullamco tempor eiusmod deserunt irure nostrud irure. Ullamco proident veniam laboris ea consectetur magna sunt ex exercitation aliquip minim enim culpa occaecat exercitation. Est tempor excepteur aliquip laborum consequat do deserunt laborum esse eiusmod irure proident ipsum esse qui.

Item 3-2

Labore sit culpa commodo elit adipisicing sit aliquip elit proident voluptate minim mollit nostrud aute reprehenderit do. Mollit excepteur eu Lorem ipsum anim commodo sint labore Lorem in exercitation velit incididunt. Occaecat consectetur nisi in occaecat proident minim enim sunt reprehenderit exercitation cupidatat et do officia. Aliquip consequat ad labore labore mollit ut amet. Sit pariatur tempor proident in veniam culpa aliqua excepteur elit magna fugiat eiusmod amet officia.

Item 1

...

Item 1-1

...

Item 2-2

...

Item 2

...

Item 3

...

Item 3-1

...

Item 3-2

...

+ Item 1 + Item2 + Item 3 + Item 4 +

Item 1

Item 2

Item 3

Item 4

+ Item 1 + Item2 + Item 3 + Item 4 +

Item 1

...

Item 2

...

Item 3

...

Item 4

...

Date: Sun, 2 Apr 2017 15:44:38 -0400 Subject: Rename navbar-toggleable to navbar-expand in docs (#22309) --- docs/components/navbar.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'docs/components') diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 005d830c7..1aa83ae1c 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -16,7 +16,7 @@ The navbar is a wrapper that positions branding, navigation, and other elements Here's what you need to know before getting started with the navbar: -- Navbars require a wrapping `.navbar` with `.navbar-toggleable{-sm|-md|-lg|-xl}` for responsive collapsing and [color scheme](#color-schemes) classes. +- Navbars require a wrapping `.navbar` with `.navbar-expand{-sm|-md|-lg|-xl}` for responsive collapsing and [color scheme](#color-schemes) classes. - Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width. - Navbars and their contents are built with flexbox, providing easy alignment options via utility classes. - Navbars are responsive by default, but you can easily modify them to change that. Responsive behavior depends on our Collapse JavaScript plugin. @@ -38,7 +38,7 @@ Navbars come with built-in support for a handful of sub-components. Choose from Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `lg` (large) breakpoint. {% example html %} -

@@ -468,7 +468,7 @@ With no `.navbar-brand` shown in lowest breakpoint: With a brand name shown on the left and toggler on the right: {% example html %} -

{% endexample %} -## JavaScript behavior for dynamic tabbed interfaces +## JavaScript behavior Use the tab JavaScript plugin—include it individually or through the compiled `bootstrap.js` file—to extend our navigational tabs and pills to create tabbable panes of local content, even via dropdown menus. diff --git a/docs/components/pagination.md b/docs/components/pagination.md index 03c3a56ec..0ea749e30 100644 --- a/docs/components/pagination.md +++ b/docs/components/pagination.md @@ -1,17 +1,11 @@ --- layout: docs title: Pagination -description: Documentation and examples for showing pagination links. +description: Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages. group: components +toc: true --- -Pagination links indicate a series of related content exists across multiple pages. Typically these are used where a multi-page approach to long lists of content improves general performance, such as in search results or inboxes. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - ## Overview We use a large block of connected links for our pagination, making links hard to miss and easily scalable—all while providing large hit areas. Pagination is built with list HTML elements so screen readers can announce the number of available links. Use a wrapping `

` element to identify it as a navigation section to screen readers and other assistive technologies. diff --git a/docs/components/popovers.md b/docs/components/popovers.md index 614be7e2b..a7750d635 100644 --- a/docs/components/popovers.md +++ b/docs/components/popovers.md @@ -1,17 +1,11 @@ --- layout: docs title: Popovers -description: Documentation and examples for adding Bootstrap popovers to your site. +description: Documentation and examples for adding Bootstrap popovers, like those found in iOS, to any element on your site. group: components +toc: true --- -Add small overlay content, like those found in iOS, to any element for housing secondary information. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - ## Overview Things to know when using the popover plugin: diff --git a/docs/components/progress.md b/docs/components/progress.md index 802a42a29..5b9fcd924 100644 --- a/docs/components/progress.md +++ b/docs/components/progress.md @@ -1,20 +1,14 @@ --- layout: docs title: Progress -description: Documentation and examples for using Bootstrap progress bars. +description: Documentation and examples for using Bootstrap custom progress bars featuring support for stacked bars, animated backgrounds, and text labels. group: components +toc: true --- -Use our custom progress component for displaying simple or complex progress bars. We don't use [the HTML5 `` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress), ensuring you can stack progress bars, animate them, and place text labels over them. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - ## How it works -Progress components are built with two HTML elements, some CSS to set the width, and a few attributes. +Progress components are built with two HTML elements, some CSS to set the width, and a few attributes. We don't use [the HTML5 `` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress), ensuring you can stack progress bars, animate them, and place text labels over them. - We use the `.progress` as a wrapper to indicate the max value of the progress bar. - We use the inner `.progress-bar` to indicate the progress so far. @@ -49,11 +43,7 @@ Bootstrap provides a handful of [utilities for setting width]({{ site.baseurl }}

{% endexample %} -## Customizing - -Customize the appearance of your progress bars with custom CSS, background utilities, stripes, and more. - -### Labels +## Labels Add labels to your progress bars by placing text within the `.progress-bar`. @@ -63,7 +53,7 @@ Add labels to your progress bars by placing text within the `.progress-bar`.

{% endexample %} -### Height +## Height We only set a `height` value on the `.progress-bar`, so if you change that value the outer `.progress` will automatically resize accordingly. @@ -76,7 +66,7 @@ We only set a `height` value on the `.progress-bar`, so if you change that value

{% endexample %} -### Backgrounds +## Backgrounds Use background utility classes to change the appearance of individual progress bars. @@ -95,7 +85,7 @@ Use background utility classes to change the appearance of individual progress b

{% endexample %} -### Multiple bars +## Multiple bars Include multiple progress bars in a progress component if you need. @@ -107,7 +97,7 @@ Include multiple progress bars in a progress component if you need.

{% endexample %} -### Striped +## Striped Add `.progress-bar-striped` to any `.progress-bar` to apply a stripe via CSS gradient over the progress bar's background color. @@ -129,7 +119,7 @@ Add `.progress-bar-striped` to any `.progress-bar` to apply a stripe via CSS gra

{% endexample %} -### Animated stripes +## Animated stripes The striped gradient can also be animated. Add `.progress-bar-animated` to `.progress-bar` to animate the stripes right to left via CSS3 animations. diff --git a/docs/components/scrollspy.md b/docs/components/scrollspy.md index 80c057161..a2829d3e5 100644 --- a/docs/components/scrollspy.md +++ b/docs/components/scrollspy.md @@ -1,17 +1,11 @@ --- layout: docs title: Scrollspy -description: Documentation and examples for the scrollspy plugin with Bootstrap's navigation components. +description: Automatically update Bootstrap navigation or list group components based on scroll position to indicate which link is currently active in the viewport. group: components +toc: true --- -Automatically update Bootstrap navigation or list group components based on scroll position to indicate which link is currently active in the viewport. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - ## How it works Scrollspy has a few requirements to function properly: diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md index 2e630e93e..baee52451 100644 --- a/docs/components/tooltips.md +++ b/docs/components/tooltips.md @@ -1,17 +1,11 @@ --- layout: docs title: Tooltips -description: Documentation and examples for adding custom Bootstrap tooltips with CSS and JavaScript. +description: Documentation and examples for adding custom Bootstrap tooltips with CSS and JavaScript using CSS3 for animations and data-attributes for local title storage. group: components +toc: true --- -Inspired by the excellent Tipsy jQuery plugin written by Jason Frame. Tooltips are an updated version, which don't rely on images, use CSS3 for animations, and data-attributes for local title storage. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - ## Overview Things to know when using the tooltip plugin: -- cgit v1.2.3 From 69b5178c0acb52d1159dbbe5fdfefd535571dde1 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 28 May 2017 19:48:44 -0700 Subject: shorter title --- docs/components/forms.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/components') diff --git a/docs/components/forms.md b/docs/components/forms.md index b2546a72b..366f8f625 100644 --- a/docs/components/forms.md +++ b/docs/components/forms.md @@ -630,7 +630,7 @@ Add the `disabled` attribute to a `

` to disable all the controls withi {% endexample %} {% callout warning %} -#### Caveat about link functionality of `` +#### Caveat with anchors By default, browsers will treat all native form controls (``, ` -

- - -{% endexample %} - -## Sizing - -Instead of applying button sizing classes to every button in a group, just add `.btn-group-*` to each `.btn-group`, including each one when nesting multiple groups. - -

- -{% highlight html %} -

...

-{% endhighlight %} - -## Nesting - -Place a `.btn-group` within another `.btn-group` when you want dropdown menus mixed with a series of buttons. - -{% example html %} -

- - - -

- - -

-{% endexample %} - -## Vertical variation - -Make a set of buttons appear vertically stacked rather than horizontally. **Split button dropdowns are not supported here.** - -

- - - - - - -

- - -

- -{% highlight html %} -

- ... -

-{% endhighlight %} - -## Tooltips and popovers - -Due to the specific implementation (and some other components), a bit of special casing is required for tooltips and popovers within button groups. **You'll have to specify the option `container: 'body'`** to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the tooltip or popover is triggered). diff --git a/docs/components/buttons.md b/docs/components/buttons.md deleted file mode 100644 index cfd243dad..000000000 --- a/docs/components/buttons.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -layout: docs -title: Buttons -description: Use Bootstrap's custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more. -group: components -redirect_from: "/components/" -toc: true ---- - -## Examples - -Bootstrap includes six predefined button styles, each serving its own semantic purpose. - -{% example html %} - - - - - - - - - - - - - - - - - - - - -{% endexample %} - -{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %} -{{ callout-include | markdownify }} - -## Button tags - -The `.btn` classes are designed to be used with the ` - - - -{% endexample %} - -## Outline buttons - -In need of a button, but not the hefty background colors they bring? Replace the default modifier classes with the `.btn-outline-*` ones to remove all background images and colors on any button. - -{% example html %} - - - - - - -{% endexample %} - - -## Sizes - -Fancy larger or smaller buttons? Add `.btn-lg` or `.btn-sm` for additional sizes. - -{% example html %} - - -{% endexample %} - -{% example html %} - - -{% endexample %} - -Create block level buttons—those that span the full width of a parent—by adding `.btn-block`. - -{% example html %} - - -{% endexample %} - -## Active state - -Buttons will appear pressed (with a darker background, darker border, and inset shadow) when active. **There's no need to add a class to ` - -{% endexample %} - -Disabled buttons using the `` element behave a bit different: - -- ``s don't support the `disabled` attribute, so you must add the `.disabled` class to make it visually appear disabled. -- Some future-friendly styles are included to disable all `pointer-events` on anchor buttons. In browsers which support that property, you won't see the disabled cursor at all. -- Disabled buttons should include the `aria-disabled="true"` attribute to indicate the state of the element to assistive technologies. - -{% example html %} -Primary link -Link -{% endexample %} - -{% callout warning %} -#### Link functionality caveat - -The `.disabled` class uses `pointer-events: none` to try to disable the link functionality of ``s, but that CSS property is not yet standardized. In addition, even in browsers that do support `pointer-events: none`, keyboard navigation remains unaffected, meaning that sighted keyboard users and users of assistive technologies will still be able to activate these links. So to be safe, add a `tabindex="-1"` attribute on these links (to prevent them from receiving keyboard focus) and use custom JavaScript to disable their functionality. -{% endcallout %} - -## Button plugin - -Do more with buttons. Control button states or create groups of buttons for more components like toolbars. - -### Toggle states - -Add `data-toggle="button"` to toggle a button's `active` state. If you're pre-toggling a button, you must manually add the `.active` class **and** `aria-pressed="true"` to the ` -{% endexample %} - -### Checkbox and radio buttons - -Bootstrap's `.button` styles can be applied to other elements, such as ``s, to provide checkbox or radio style button toggling. Add `data-toggle="buttons"` to a `.btn-group` containing those modified buttons to enable toggling in their respective styles. - -The checked state for these buttons is **only updated via `click` event** on the button. If you use another method to update the input—e.g., with `` or by manually applying the input's `checked` property—you'll need to toggle `.active` on the `` manually. - -Note that pre-checked buttons require you to manually add the `.active` class to the input's ``. - -{% example html %} -

- - Checkbox 1 (pre-checked) - - - Checkbox 2 - - - Checkbox 3 - -

-{% endexample %} - -{% example html %} -

- - Radio 1 (preselected) - - - Radio 2 - - - Radio 3 - -

-{% endexample %} - -### Methods - -| Method | Description | -| --- | --- | -| `$().button('toggle')` |Toggles push state. Gives the button the appearance that it has been activated. | diff --git a/docs/components/card.md b/docs/components/card.md deleted file mode 100644 index ff3096ec2..000000000 --- a/docs/components/card.md +++ /dev/null @@ -1,720 +0,0 @@ ---- -layout: docs -title: Cards -description: Bootstrap's cards provide a flexible and extensible content container with multiple variants and options. -group: components -toc: true ---- - -## About - -A **card** is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options. - -If you're familiar with Bootstrap 3, cards replace our old panels, wells, and thumbnails. Similar functionality to those components is available as modifier classes for cards. - -## Example - -Cards are built with as little markup and styles as possible, but still manage to deliver a ton of control and customization. Built with flexbox, they offer easy alignment and mix well with other Bootstrap components. - -Below is an example of a basic card with mixed content and a fixed width. Cards have no fixed width to start, so they'll naturally fill the full width of its parent element. This is easily customized with our various [sizing options](#sizing). - -{% example html %} -

Card title

Some quick example text to build on the card title and make up the bulk of the card's content.

- Go somewhere -

-{% endexample %} - -## Content types - -Cards support a wide variety of content, including images, text, list groups, links, and more. Below are examples of what's supported. - -### Blocks - -The building block of a card is the `.card-block`. Use it whenever you need a padded section within a card. - -{% example html %} -

- This is some text within a card block. -

-{% endexample %} - -### Titles, text, and links - -Card titles are used by adding `.card-title` to a `` tag. In the same way, links are added and placed next to each other by adding `.card-link` to a `` tag. - -Subtitles are used by adding a `.card-subtitle` to a `` tag. If the `.card-title` and the `.card-subtitle` items are placed in a `.card-block` item, the card title and subtitle are aligned nicely. - -{% example html %} -

Card title

Card subtitle

Some quick example text to build on the card title and make up the bulk of the card's content.

- Card link - Another link -

-{% endexample %} - -### Images - -`.card-img-top` places an image to the top of the card. With `.card-text`, text can be added to the card. Text within `.card-text` can also be styled with the standard HTML tags. - -{% example html %} -

Some quick example text to build on the card title and make up the bulk of the card's content.

-{% endexample %} - -### List groups - -Create lists of content in a card with a flush list group. - -{% example html %} -

Cras justo odio
Dapibus ac facilisis in
Vestibulum at eros

-{% endexample %} - -### Kitchen sink - -Mix and match multiple content types to create the card you need, or throw everything in there. Shown below are image styles, blocks, text styles, and a list group—all wrapped in a fixed-width card. - -{% example html %} -

Card title

Some quick example text to build on the card title and make up the bulk of the card's content.

Cras justo odio
Dapibus ac facilisis in
Vestibulum at eros

- Card link - Another link -

-{% endexample %} - -### Header and footer - -Add an optional header and/or footer within a card. - -{% example html %} -

- Featured -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

-{% endexample %} - -Card headers can be styled by adding `.card-header` to `` elements. - -{% example html %} -

Featured

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

-{% endexample %} - -{% example html %} -

- Quote -

-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
-
Someone famous in Source Title
-

-{% endexample %} - -{% example html %} -

- Featured -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

- 2 days ago -

-{% endexample %} - -## Sizing - -Cards assume no specific `width` to start, so they'll be 100% wide unless otherwise stated. You can change this as needed with custom CSS, grid classes, grid Sass mixins, or utilities. - -### Using grid markup - -Using the grid, wrap cards in columns and rows as needed. - -{% example html %} -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

-{% endexample %} - -### Using utilities - -Use our handful of [available sizing utilities]({{ site.baseurl }}/utilities/sizing/) to quickly set a card's width. - -{% example html %} -

Card title

With supporting text below as a natural lead-in to additional content.

- Button -

- -

Card title

With supporting text below as a natural lead-in to additional content.

- Button -

-{% endexample %} - -### Using custom CSS - -Use custom CSS in your stylesheets or as inline styles to set a width. - -{% example html %} -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

-{% endexample %} - -## Text alignment - -You can quickly change the text alignment of any card—in its entirety or specific parts—with our [text align classes]({{ site.baseurl }}/utilities/typography/#text-alignment). - -{% example html %} -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

- -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

- -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

-{% endexample %} - -## Navigation - -Add some navigation to a card's header (or block) with Bootstrap's [nav components]({{ site.baseurl }}/components/navs/). - -{% example html %} -

- Active -
- Link -
- Disabled -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

-{% endexample %} - -{% example html %} -

- Active -
- Link -
- Disabled -

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

-{% endexample %} - -## Images - -Cards include a few options for working with images. Choose from appending "image caps" at either end of a card, overlaying images with card content, or simply embedding the image in a card. - -### Image caps - -Similar to headers and footers, cards can include top and bottom "image caps"—images at the top or bottom of a card. - -{% example html %} -

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

Last updated 3 mins ago

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

Last updated 3 mins ago

-{% endexample %} - -### Image overlays - -Turn an image into a card background and overlay your card's text. Depending on the image, you may or may not need `.card-inverse` (see below). - -{% example html %} -

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

Last updated 3 mins ago

-{% endexample %} - -## Card styles - -Cards include various options for customizing their backgrounds, borders, and color. - -### Inverted text - -By default, cards use dark text and assume a light background. You can reverse that by toggling the `color` of text within, as well as that of the card's subcomponents, with `.card-inverse`. Then, specify a dark `background-color` and `border-color` to go with it. - -You can also use `.card-inverse` with the [contextual backgrounds variants](#background-variants). - -{% example html %} -

Header

Special title treatment

With supporting text below as a natural lead-in to additional content.

- Go somewhere -

Footer

-{% endexample %} - -### Background variants - -Cards include their own variant classes for quickly changing the `background-color` and `border-color` of a card. **Darker colors require the use of `.card-inverse`.** - -{% example html %} -

-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
-
Someone famous in Source Title
-

-{% endexample %} - -{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %} -{{ callout-include | markdownify }} - -### Outline cards - -In need of a colored card, but not the hefty background colors they bring? Replace the default modifier classes with the `.card-outline-*` ones to style just the `border-color` of a card. - -{% example html %} -

-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
-
Someone famous in Source Title
-

-{% endexample %} - -## Card layout - -In addition to styling the content within cards, Bootstrap includes a few options for laying out series of cards. For the time being, **these layout options are not yet responsive**. - -### Card groups - -Use card groups to render cards as a single, attached element with equal width and height columns. Card groups use `display: flex;` to achieve their uniform sizing. - -{% example html %} -

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

Last updated 3 mins ago

Card title

This card has supporting text below as a natural lead-in to additional content.

Last updated 3 mins ago

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.

Last updated 3 mins ago

-{% endexample %} - -When using card groups with footers, their content will automatically line up. - -{% example html %} -

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

- Last updated 3 mins ago -

Card title

This card has supporting text below as a natural lead-in to additional content.

- Last updated 3 mins ago -

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.

- Last updated 3 mins ago -

-{% endexample %} - -### Card decks - -Need a set of equal width and height cards that aren't attached to one another? Use card decks. - -{% example html %} -

Card title

This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

Last updated 3 mins ago

Card title

This card has supporting text below as a natural lead-in to additional content.

Last updated 3 mins ago

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.

Last updated 3 mins ago

-{% endexample %} - -Just like with card groups, card footers in decks will automatically line up. - -{% example html %} -

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

- Last updated 3 mins ago -

Card title

This card has supporting text below as a natural lead-in to additional content.

- Last updated 3 mins ago -

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.

- Last updated 3 mins ago -

-{% endexample %} - -### Card columns - -Cards can be organized into [Masonry](http://masonry.desandro.com)-like columns with just CSS by wrapping them in `.card-columns`. Cards are built with CSS `column` properties instead of flexbox for easier alignment. Cards are ordered from top to bottom and left to right. - -**Heads up!** Your mileage with card columns may vary. To prevent cards breaking across columns, we must set them to `display: inline-block` as `column-break-inside: avoid` isn't a bulletproof solution yet. - -{% example html %} -

Card title that wraps to a new line

This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
-
- - Someone famous in Source Title - -
-

Card title

This card has supporting text below as a natural lead-in to additional content.

Last updated 3 mins ago

-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat.
-
- - Someone famous in Source Title - -
-

Card title

This card has supporting text below as a natural lead-in to additional content.

Last updated 3 mins ago

-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
-
- - Someone famous in Source Title - -
-

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.

Last updated 3 mins ago

-{% endexample %} - -Card columns can also be extended and customized with some additional code. Shown below is an extension of the `.card-columns` class using the same CSS we use—CSS columns— to generate a set of responsive tiers for changing the number of columns. - -{% highlight scss %} -.card-columns { - @include media-breakpoint-only(lg) { - column-count: 4; - } - @include media-breakpoint-only(xl) { - column-count: 5; - } -} -{% endhighlight %} diff --git a/docs/components/carousel.md b/docs/components/carousel.md deleted file mode 100644 index ae82eb08f..000000000 --- a/docs/components/carousel.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -layout: docs -title: Carousel -description: A slideshow component for cycling through elements—images or slides of text—like a carousel. -group: components -toc: true ---- - -## How it works - -The carousel is a slideshow for cycling through a series of content, built with CSS 3D transforms and a bit of JavaScript. It works with a series of images, text, or custom markup. It also includes support for previous/next controls and indicators. - -In browsers where the [Page Visibility API](https://www.w3.org/TR/page-visibility/) is supported, the carousel will avoid sliding when the webpage is not visible to the user (such as when the browser tab is inactive, the browser window is minimized, etc.). - -Please be aware that nested carousels are not supported, and carousels are generally not compliant with accessibility standards. - -## Example - -Carousels don't automatically normalize slide dimensions. As such, you may need to use additional utilities or custom styles to appropriately size content. While carousels support previous/next controls and indicators, they're not explicitly required. Add and customize as you see fit. - -Be sure to set a unique id on the `.carousel` for optional controls, especially if you're using multiple carousels on a single page. - -### Slides only - -Here's a carousel with slides only. Note the presence of the `.d-block` and `.img-fluid` on carousel images to prevent browser default image alignment. - -{% example html %} -

-{% endexample %} - -### With controls - -Adding in the previous and next controls: - -{% example html %} -

- - - - - - - - -

-{% endexample %} - -### With indicators - -You can also add the indicators to the carousel, alongside the controls, too. - -{% example html %} -

- - - - - - - - -

-{% endexample %} - -{% callout warning %} -#### Initial active element required - -The `.active` class needs to be added to one of the slides. Otherwise, the carousel will not be visible. -{% endcallout %} - -### With captions - -Add captions to your slides easily with the `.carousel-caption` element within any `.carousel-item`. They can be easily hidden on smaller viewports, as shown below, with optional [display utilities]({{ site.baseurl }}/utilities/display-property/). We hide them initially with `.d-none` and bring them back on medium-sized devices with `.d-md-block`. - -

First slide label

Nulla vitae elit libero, a pharetra augue mollis interdum.

Second slide label

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Third slide label

Praesent commodo cursus magna, vel scelerisque nisl consectetur.

- - - - - - - - -

- -{% highlight html %} -

...

-{% endhighlight %} - -## Usage - -### Via data attributes - -Use data attributes to easily control the position of the carousel. `data-slide` accepts the keywords `prev` or `next`, which alters the slide position relative to its current position. Alternatively, use `data-slide-to` to pass a raw slide index to the carousel `data-slide-to="2"`, which shifts the slide position to a particular index beginning with `0`. - -The `data-ride="carousel"` attribute is used to mark a carousel as animating starting at page load. **It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.** - -### Via JavaScript - -Call carousel manually with: - -{% highlight js %} -$('.carousel').carousel() -{% endhighlight %} - -### Options - -Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-interval=""`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
interval	number	5000	The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
keyboard	boolean	true	Whether the carousel should react to keyboard events.
pause	string \| boolean	"hover"	If set to `"hover"`, pauses the cycling of the carousel on `mouseenter` and resumes the cycling of the carousel on `mouseleave`. If set to `false`, hovering over the carousel won't pause it. - On touch-enabled devices, when set to `"hover"`, cycling will pause on `touchend` (once the user finished interacting with the carousel) for two intervals, before automatically resuming. Note that this is in addition to the above mouse behavior.
ride	string	false	Autoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load.
wrap	boolean	true	Whether the carousel should cycle continuously or have hard stops.

- -### Methods - -{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} -{{ callout-include | markdownify }} - -#### `.carousel(options)` - -Initializes the carousel with an optional options `object` and starts cycling through items. - -{% highlight js %} -$('.carousel').carousel({ - interval: 2000 -}) -{% endhighlight %} - -#### `.carousel('cycle')` - -Cycles through the carousel items from left to right. - -#### `.carousel('pause')` - -Stops the carousel from cycling through items. - -#### `.carousel(number)` - -Cycles the carousel to a particular frame (0 based, similar to an array). **Returns to the caller before the target item has been shown** (i.e. before the `slid.bs.carousel` event occurs). - -#### `.carousel('prev')` - -Cycles to the previous item. **Returns to the caller before the previous item has been shown** (i.e. before the `slid.bs.carousel` event occurs). - -#### `.carousel('next')` - -Cycles to the next item. **Returns to the caller before the next item has been shown** (i.e. before the `slid.bs.carousel` event occurs). - -### Events - -Bootstrap's carousel class exposes two events for hooking into carousel functionality. Both events have the following additional properties: - -- `direction`: The direction in which the carousel is sliding (either `"left"` or `"right"`). -- `relatedTarget`: The DOM element that is being slid into place as the active item. -- `from`: The index of the current item -- `to`: The index of the next item - -All carousel events are fired at the carousel itself (i.e. at the `

`). - - - - - - - - - - - - - - - - - - -

Event Type	Description
slide.bs.carousel	This event fires immediately when the `slide` instance method is invoked.
slid.bs.carousel	This event is fired when the carousel has completed its slide transition.

- -{% highlight js %} -$('#myCarousel').on('slide.bs.carousel', function () { - // do something… -}) -{% endhighlight %} diff --git a/docs/components/collapse.md b/docs/components/collapse.md deleted file mode 100644 index 84262487b..000000000 --- a/docs/components/collapse.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -layout: docs -title: Collapse -description: Toggle the visibility of content across your project with a few classes and our JavaScript plugins. -group: components -toc: true ---- - -## Example - -Click the buttons below to show and hide another element via class changes: - -- `.collapse` hides content -- `.collapsing` is applied during transitions -- `.collapse.show` shows content - -You can use a link with the `href` attribute, or a button with the `data-target` attribute. In both cases, the `data-toggle="collapse"` is required. - -{% example html %} -

- - Link with href - - -

- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. -

-{% endexample %} - -## Accordion example - -Using the [card]({{ site.baseurl }}/components/card/) component, you can extend the default collapse behavior to create an accordion. - -{% example html %} -

- - Collapsible Group Item #1 - -

- -

- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS. -

- - Collapsible Group Item #2 - -

- - Collapsible Group Item #3 - -

-{% endexample %} - -You can also create accordions with custom markup. Add the `data-children` attribute and specify a set of sibling elements to toggle (e.g., `.item`). Then, use the same attributes and classes as shown above for connectinh toggles to their associated content. - -{% example html %} -

- - Toggle item - -

- Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed pretium lorem non vestibulum scelerisque. Proin a vestibulum sem, eget tristique massa. Aliquam lacinia rhoncus nibh quis ornare. -

- - Toggle item 2 - -

- Donec at ipsum dignissim, rutrum turpis scelerisque, tristique lectus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vivamus nec dui turpis. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. -

-{% endexample %} - -## Accessibility - -Be sure to add `aria-expanded` to the control element. This attribute explicitly conveys the current state of the collapsible element tied to the control to screen readers and similar assistive technologies. If the collapsible element is closed by default, the attribute on the control element should have a value of `aria-expanded="false"`. If you've set the collapsible element to be open by default using the `show` class, set `aria-expanded="true"` on the control instead. The plugin will automatically toggle this attribute on the control based on whether or not the collapsible element has been opened or closed (via JavaScript, or because the user triggered another control element also tied to the same collapsbile element). - -Additionally, if your control element is targeting a single collapsible element – i.e. the `data-target` attribute is pointing to an `id` selector – you may add an additional `aria-controls` attribute to the control element, containing the `id` of the collapsible element. Modern screen readers and similar assistive technologies make use of this attribute to provide users with additional shortcuts to navigate directly to the collapsible element itself. - -## Usage - -The collapse plugin utilizes a few classes to handle the heavy lifting: - -- `.collapse` hides the content -- `.collapse.show` shows the content -- `.collapsing` is added when the transition starts, and removed when it finishes - -These classes can be found in `_transitions.scss`. - -### Via data attributes - -Just add `data-toggle="collapse"` and a `data-target` to the element to automatically assign control of a collapsible element. The `data-target` attribute accepts a CSS selector to apply the collapse to. Be sure to add the class `collapse` to the collapsible element. If you'd like it to default open, add the additional class `show`. - -To add accordion-like group management to a collapsible area, add the data attribute `data-parent="#selector"`. Refer to the demo to see this in action. - -### Via JavaScript - -Enable manually with: - -{% highlight js %} -$('.collapse').collapse() -{% endhighlight %} - -### Options - -Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-parent=""`. - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
parent	selector	false	If a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the `card` class). The attribute has to be set on the target collapsible area.
toggle	boolean	true	Toggles the collapsible element on invocation

- -### Methods - -{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} -{{ callout-include | markdownify }} - -#### `.collapse(options)` - -Activates your content as a collapsible element. Accepts an optional options `object`. - -{% highlight js %} -$('#myCollapsible').collapse({ - toggle: false -}) -{% endhighlight %} - -#### `.collapse('toggle')` - -Toggles a collapsible element to shown or hidden. **Returns to the caller before the collapsible element has actually been shown or hidden (i.e. before the `shown.bs.collapse` or `hidden.bs.collapse` event occurs). - -#### `.collapse('show')` - -Shows a collapsible element. **Returns to the caller before the collapsible element has actually been shown** (i.e. before the `shown.bs.collapse` event occurs). - -#### `.collapse('hide')` - -Hides a collapsible element. **Returns to the caller before the collapsible element has actually been hidden** (i.e. before the `hidden.bs.collapse` event occurs). - -### Events - -Bootstrap's collapse class exposes a few events for hooking into collapse functionality. - - - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.collapse	This event fires immediately when the `show` instance method is called.
shown.bs.collapse	This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.collapse	This event is fired immediately when the `hide` method has been called.
hidden.bs.collapse	This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).

- -{% highlight js %} -$('#myCollapsible').on('hidden.bs.collapse', function () { - // do something… -}) -{% endhighlight %} diff --git a/docs/components/dropdowns.md b/docs/components/dropdowns.md deleted file mode 100644 index 306fb7f2b..000000000 --- a/docs/components/dropdowns.md +++ /dev/null @@ -1,590 +0,0 @@ ---- -layout: docs -title: Dropdowns -description: Toggle contextual overlays for displaying lists of links and more with the Bootstrap dropdown plugin. -group: components -toc: true ---- - -## Overview - -Dropdowns are toggleable, contextual overlays for displaying lists of links and more. They're made interactive with the included Bootstrap dropdown JavaScript plugin. They're toggled by clicking, not by hovering; this is [an intentional design decision.](http://markdotto.com/2012/02/27/bootstrap-explained-dropdowns/) - -Things to know when using the dropdown plugin: - -- Dropdown rely on the 3rd party library [Popper.js](https://popper.js.org) for positioning. You must include [popper.min.js](https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.9.9/umd/popper.min.js) before bootstrap.js in order for dropdowns to work! -- Popper.js handle natively the flip of Dropdown when it's outside the viewport, if you want to disable that's behavior use `flip` attribute - -## Examples - -Wrap the dropdown's toggle (your button or link) and the dropdown menu within `.dropdown`, or another element that declares `position: relative;`. Dropdowns can be triggered from `` or ` - -

-{% endexample %} - -And with `` elements: - -{% example html %} - -{% endexample %} - -The best part is you can do this with any button variant, too: - -

- - -

- -{% highlight html %} - -

- - -

-{% endhighlight %} - -### Split button dropdowns - -Similarly, create split button dropdowns with virtually the same markup as single button dropdowns, but with the addition of `.dropdown-toggle-split` for proper spacing around the dropdown caret. - -We use this extra class to reduce the horizontal `padding` on either side of the caret by 25% and remove the `margin-left` that's added for regular button dropdowns. Those extra changes keep the caret centered in the split button and provide a more appropriately sized hit area next to the main button. - -

- - - -

- -{% highlight html %} - -

- - - -

-{% endhighlight %} - -## Sizing - -Button dropdowns work with buttons of all sizes, including default and split dropdown buttons. - -

- - -

- -{% highlight html %} - -

- - -

- - - -

- - -

- - - -

-{% endhighlight %} - -## Dropup variation - -Trigger dropdown menus above elements by adding `.dropup` to the parent element. - -

- - -

- -

- - - -

- -{% highlight html %} - -

- - - -

- - -

- - - -

-{% endhighlight %} - -## Menu items - -Historically dropdown menu contents *had* to be links, but that's no longer the case with v4. Now you can optionally use ` - -

-{% endexample %} - -## Menu 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. - -{% callout info %} -**Heads up!** Dropdowns are positioned only with CSS and may need some additional styles for exact alignment. -{% endcallout %} - -{% example html %} -

- - -

-{% endexample %} - -## Menu headers - -Add a header to label sections of actions in any dropdown menu. - -{% example html %} - -{% endexample %} - -## Menu dividers - -Separate groups of related menu items with a divider. - -{% example html %} - -{% endexample %} - -## Disabled menu items - -Add `.disabled` to items in the dropdown to **style them as disabled**. - -{% example html %} - -{% endexample %} - -## Usage - -Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the `.show` class on the parent list item. - -{% callout info %} -On touch-enabled devices, opening a dropdown adds empty (`$.noop`) `mouseover` handlers to the immediate children of the `` element. This admittedly ugly hack is necessary to work around a [quirk in iOS' event delegation](https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html), which would otherwise prevent a tap anywhere outside of the dropdown from triggering the code that closes the dropdown. Once the dropdown is closed, these additional empty `mouseover` handlers are removed. -{% endcallout %} - -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 %} - -{% endhighlight %} - -### Via JavaScript - -Call the dropdowns via JavaScript: - -{% highlight js %} -$('.dropdown-toggle').dropdown() -{% endhighlight %} - -{% callout info %} -##### `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. -{% endcallout %} - -### Options - -Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-placement=""`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
placement	string	'bottom'	- How to position the popover - top \| bottom. -
offset	number \| string	0	Offset of the dropdown relative to its target. For more information refer to Popper.js's offset docs.
flip	boolean	true	Allow Dropdown to flip in case of an overlapping on the reference element. For more information refer to Popper.js's flip docs.

- -### Methods - -| Method | Description | -| --- | --- | -| `$().dropdown('toggle')` | Toggles the dropdown menu of a given navbar or tabbed navigation. | -| `$().dropdown('update')` | Updates the position of an element's dropdown. | - -### 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. - -| Event | Description | -| --- | --- | -| `show.bs.dropdown` | This event fires immediately when the show instance method is called. | -| `shown.bs.dropdown` | This event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete). | -| `hide.bs.dropdown` | This event is fired immediately when the hide instance method has been called. | -| `hidden.bs.dropdown`| This event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete). | - -{% highlight js %} -$('#myDropdown').on('show.bs.dropdown', function () { - // do something… -}) -{% endhighlight %} diff --git a/docs/components/forms.md b/docs/components/forms.md deleted file mode 100644 index 366f8f625..000000000 --- a/docs/components/forms.md +++ /dev/null @@ -1,1018 +0,0 @@ ---- -layout: docs -title: Forms -description: Examples and usage guidelines for form control styles, layout options, and custom components for creating a wide variety of forms. -group: components -toc: true ---- - -## Form controls - -Bootstrap's form controls expand on [our Rebooted form styles]({{ site.baseurl }}/content/reboot/#forms) with classes. Use these classes to opt into their customized displays for a more consistent rendering across browsers and devices. The example form below demonstrates common HTML form elements that receive updated styles from Bootstrap with additional classes. - -Remember, since Bootstrap utilizes the HTML5 doctype, **all inputs must have a `type` attribute**. - -{% example html %} - -

- Email address - - We'll never share your email with anyone else. -

- Password - -

- Example select - -

- Example multiple select - -

- Example textarea - -

- File input - - This is some placeholder block-level help text for the above input. It's a bit lighter and easily wraps to a new line. -

- Radio buttons -

- - - Option one is this and that—be sure to include why it's great - -

- - - Option two can be something else and selecting it will deselect option one - -

- - - Option three is disabled - -

- - - Check me out - -

- - -{% endexample %} - -Below is a complete list of the specific form controls supported by Bootstrap and the classes that customize them. Additional documentation is available for each group. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Classes	Used for	Supported variations
- {% markdown %}`.form-group`{% endmarkdown %} -	- Any group of form controls -	- {% markdown %}Use with any block-level element like ` ` or ` `{% endmarkdown %} -
- {% markdown %}`.form-control`{% endmarkdown %} -	- Textual inputs -	- {% markdown %}`text`, `password`, `datetime-local`, `date`, `month`, `time`, `week`, `number`, `email`, `url`, `search`, `tel`, `color`{% endmarkdown %} -
	- Select menus -	- {% markdown %}`multiple`, `size`{% endmarkdown %} -
	- Textareas -	- N/A -
- {% markdown %}`.form-control-file`{% endmarkdown %} -	- File inputs -	- {% markdown %}`file`{% endmarkdown %} -
-{% markdown %} -`.form-check` -{% endmarkdown %} -	- Checkboxes and radios -	- N/A -

- -### Textual inputs - -Here are examples of `.form-control` applied to each textual HTML5 `` `type`. - -{% example html %} -

- Text -

- -

- Search -

- -

- Email -

- -

- URL -

- -

- Telephone -

- -

- Password -

- -

- Number -

- -

- Date and time -

- -

- Date -

- -

- Month -

- -

- Week -

- -

- Time -

- -

- Color -

- -

-{% endexample %} - -## Form layouts - -Since Bootstrap applies `display: block` and `width: 100%` to almost all our form controls, forms will by default stack vertically. Additional classes can be used to vary this layout on a per-form basis. - -### Form groups - -The `.form-group` class is the easiest way to add some structure to forms. Its only purpose is to provide `margin-bottom` around a label and control pairing. As a bonus, since it's a class you can use it with `

`s, `

`s, or nearly any other element. - -{% example html %} - -{% endexample %} - -### Inline forms - -Use the `.form-inline` class to display a series of labels, form controls, and buttons on a single horizontal row. Form controls within inline forms vary slightly from their default states. - -- Controls are `display: flex`, collapsing any HTML white space and allowing you to provide alignment control with [spacing]({{ site.baseurl }}/utilities/spacing/) and [flexbox]({{ site.baseurl }}/utilities/flexbox/) utilities. -- Controls and input groups receive `width: auto` to override the Bootstrap default `width: 100%`. -- Controls **only appear inline in viewports that are at least 576px wide** to account for narrow viewports on mobile devices. - -You may need to manually address the width and alignment of individual form controls with [spacing utilities]({{ site.baseurl }}/utilities/spacing/) (as shown below). Lastly, be sure to always include a `` with each form control, even if you need to hide it from non-screenreader visitors with `.sr-only`. - -{% example html %} - -{% endexample %} - -Custom form controls and selects are also supported. - -{% example html %} - -{% endexample %} - -{% callout warning %} -#### Alternatives to hidden labels -Assistive technologies such as screen readers will have trouble with your forms if you don't include a label for every input. For these inline forms, you can hide the labels using the `.sr-only` class. There are further alternative methods of providing a label for assistive technologies, such as the `aria-label`, `aria-labelledby` or `title` attribute. If none of these are present, assistive technologies may resort to using the `placeholder` attribute, if present, but note that use of `placeholder` as a replacement for other labelling methods is not advised. -{% endcallout %} - -### Using the Grid - -For more structured form layouts that are also responsive, you can utilize Bootstrap's [predefined grid classes]({{ site.baseurl }}/layout/grid/) or [mixins]({{ site.baseurl }}/layout/grid/#sass-mixins) to create horizontal forms. Add the `.row` class to form groups and use the `.col-*-*` classes to specify the width of your labels and controls. - -Be sure to add `.col-form-label` to your ``s as well so they're vertically centered with their associated form controls. For `` elements, you can use `.col-form-legend` to make them appear similar to regular `` elements. - -{% example html %} -

- -

-{% endexample %} - -More complex layouts can also be created with the grid system. - -{% example html %} -

- -

-{% endexample %} - -Grid-based form layouts also support large and small inputs. - -{% example html %} -

- -

-{% endexample %} - -## Checkboxes and radios - -Default checkboxes and radios are improved upon with the help of `.form-check`, **a single class for both input types that improves the layout and behavior of their HTML elements**. Checkboxes are for selecting one or several options in a list, while radios are for selecting one option from many. - -Disabled checkboxes and radios are supported, but to provide a `not-allowed` cursor on hover of the parent ``, you'll need to add the `.disabled` class to the parent `.form-check`. The disabled class will also lighten the text color to help indicate the input's state. - -### Default (stacked) - -By default, any number of checkboxes and radios that are immediate sibling will be vertically stacked and appropriately spaced with `.form-check`. - -{% example html %} -

- - - Option one is this and that—be sure to include why it's great - -

- - - Option two is disabled - -

-{% endexample %} - -{% example html %} -

- - - Option one is this and that—be sure to include why it's great - -

- - - Option two can be something else and selecting it will deselect option one - -

- - - Option three is disabled - -

-{% endexample %} - -### Inline - -Group checkboxes or radios on the same horizontal row by adding `.form-check-inline` to any `.form-check`. - -{% example html %} -

- - 1 - -

- - 2 - -

- - 3 - -

-{% endexample %} - -{% example html %} -

- - 1 - -

- - 2 - -

- - 3 - -

-{% endexample %} - -### Without labels - -Should you have no text within the ``, the input is positioned as you'd expect. **Currently only works on non-inline checkboxes and radios.** Remember to still provide some form of label for assistive technologies (for instance, using `aria-label`). - -{% example html %} -

- - - -

-{% endexample %} - -## Static controls - -If you want to have read-only fields in your form styled as plain text, use the `.form-control-static` class to remove the default form field styling and preserve the correct margin and padding. - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} - -## Disabled states - -Add the `disabled` boolean attribute on an input to prevent user interactions and make it appear lighter. - -{% highlight html %} - -{% endhighlight %} - -Add the `disabled` attribute to a `

` to disable all the controls within. - -{% example html %} - -{% endexample %} - -{% callout warning %} -#### Caveat with anchors - -By default, browsers will treat all native form controls (``, ` -{% endexample %} - -## Control sizing - -Set heights using classes like `.form-control-lg`, and set widths using grid column classes like `.col-lg-*`. - -{% example html %} - - - -{% endexample %} - -{% example html %} - - - -{% endexample %} - -## Column sizing - -Wrap inputs in grid columns, or any custom parent element, to easily enforce desired widths. - -{% example html %} -

- -

-{% endexample %} - -## Help text - -Block-level help text in forms can be created using `.form-text` (previously known as `.help-block` in v3). Inline help text can be flexibly implemented using any inline HTML element and utility classes like `.text-muted`. - -{% callout warning %} -#### Associating help text with form controls - -Help text should be explicitly associated with the form control it relates to using the `aria-describedby` attribute. This will ensure that assistive technologies – such as screen readers – will announce this help text when the user focuses or enters the control. -{% endcallout %} - -### Block level - -Block help text—for below inputs or for longer lines of help text—can be easily achieved with `.form-text`. This class includes `display: block` and adds some top margin for easy spacing from the inputs above. - -{% example html %} -Password - -

- Your password must be 8-20 characters long, contain letters and numbers, and must not contain spaces, special characters, or emoji. -

-{% endexample %} - -### Inline - -Inline text can use any typical inline HTML element (be it a ``, ``, or something else). - -{% example html %} - -{% endexample %} - -## Validation - -Bootstrap includes validation styles for danger, warning, and success states on most form controls. - -### How it works - -Here's a rundown of how they work: - -- To use, add `.has-warning`, `.has-danger`, or `.has-success` to the parent element. Any `.col-form-label`, `.form-control`, or custom form element will receive the validation styles. -- Contextual validation text, in addition to your usual form field help text, can be added with the use of `.form-control-feedback`. This text will adapt to the parent `.has-*` class. By default it only includes a bit of `margin` for spacing and a modified `color` for each state. -- Validation icons are `url()`s configured via Sass variables that are applied to `background-image` declarations for each state. -- You may use your own base64 PNGs or SVGs by updating the Sass variables and recompiling. -- Icons can also be disabled entirely by setting the variables to `none` or commenting out the source Sass. - -### Defining states - -Generally speaking, you'll want to use a particular state for specific types of feedback: - -- **Danger** is great for when there's a blocking or required field. A user *must* fill in this field properly to submit the form. -- **Warning** works well for input values that are in progress, like password strength, or soft validation before a user attempts to submit a form. -- And lastly, **success** is ideal for situations when you have per-field validation throughout a form and want to encourage a user through the rest of the fields. - -{% comment %} -{% callout warning %} -#### Conveying validation state to assistive technologies and colorblind users - -Using these validation styles to denote the state of a form control only provides a visual, color-based indication, which will not be conveyed to users of assistive technologies - such as screen readers - or to colorblind users. - -Ensure that an alternative indication of state is also provided. For instance, you can include a hint about state in the form control's `` text itself (as is the case in the following code example), include a [Glyphicon]({{ site.baseurl }}/components/#glyphicons) (with appropriate alternative text using the `.sr-only` class - see the [Glyphicon examples]({{ site.baseurl }}/components/#glyphicons-examples)), or by providing an additional [help text](#forms-help-text) block. Specifically for assistive technologies, invalid form controls can also be assigned an `aria-invalid="true"` attribute. -{% endcallout %} -{% endcomment %} - -### Examples - -Here are some examples of the aforementioned classes in action. First up is your standard left-aligned fields with labels, help text, and validation messaging. - -{% example html %} -

- Input with success - -

Success! You've done it.

- Example help text that remains unchanged. -

- Input with warning - -

Shucks, check the formatting of that and try again.

- Example help text that remains unchanged. -

- Input with danger - -

Sorry, that username's taken. Try another?

- Example help text that remains unchanged. -

-{% endexample %} - -Those same states can also be used with horizontal forms. - -{% example html %} -

- -

-{% endexample %} - -Checkboxes and radios are also supported. - -{% example html %} -

- - - Checkbox with success - -

- - - Checkbox with warning - -

- - - Checkbox with danger - -

-{% endexample %} - -## Custom forms - -For even more customization and cross browser consistency, use our completely custom form elements to replace the browser defaults. They're built on top of semantic and accessible markup, so they're solid replacements for any default form control. - -### Checkboxes and radios - -Each checkbox and radio is wrapped in a `` for three reasons: - -- It provides a larger hit areas for checking the control. -- It provides a helpful and semantic wrapper to help us replace the default ``s. -- It triggers the state of the `` automatically, meaning no JavaScript is required. - -We hide the default `` with `opacity` and use the `.custom-control-indicator` to build a new custom form indicator in its place. Unfortunately we can't build a custom one from just the `` because CSS's `content` doesn't work on that element. - -We use the sibling selector (`~`) for all our `` states—like `:checked`—to properly style our custom form indicator. When combined with the `.custom-control-description` class, we can also style the text for each item based on the ``'s state. - -In the checked states, we use **base64 embedded SVG icons** from [Open Iconic](https://useiconic.com/open). This provides us the best control for styling and positioning across browsers and devices. - -#### Checkboxes - -{% example html %} - - - - Check this custom checkbox - -{% endexample %} - -Custom checkboxes can also utilize the `:indeterminate` pseudo class when manually set via JavaScript (there is no available HTML attribute for specifying it). - -

- - - - Check this custom checkbox - -

- -If you're using jQuery, something like this should suffice: - -{% highlight js %} -$('.your-checkbox').prop('indeterminate', true) -{% endhighlight %} - -#### Radios - -{% example html %} - - - - Toggle this custom radio - - - - - Or toggle this other custom radio - -{% endexample %} - -#### Disabled - -Custom checkboxes and radios can also be disabled. Add the `disabled` boolean attribute to the `` and the custom indicator and label description will be automatically styled. - -{% example html %} - - - - Check this custom checkbox - - - - - - Toggle this custom radio - -{% endexample %} - -#### Validation states - -Add other states to your custom forms with our validation classes. - -{% example html %} -

- - - - Check this custom checkbox - -

-{% endexample %} - -#### Stacked - -Custom checkboxes and radios are inline to start. Add a parent with class `.custom-controls-stacked` to ensure each form control is on separate lines. - -{% example html %} -

- - - - Toggle this custom radio - - - - - Or toggle this other custom radio - -

-{% endexample %} - -### Select menu - -Custom ` - - - - - -{% endexample %} - -### File browser - -The file input is the most gnarly of the bunch and require additional JavaScript if you'd like to hook them up with functional *Choose file...* and selected file name text. - -{% example html %} - - - - -{% endexample %} - -Here's how it works: - -- We wrap the `` in a `` so the custom control properly triggers the file browser. -- We hide the default file `` via `opacity`. -- We use `:after` to generate a custom background and directive (*Choose file...*). -- We use `:before` to generate and position the *Browse* button. -- We declare a `height` on the `` for proper spacing for surrounding content. - -In other words, it's an entirely custom element, all generated via CSS. - -#### Translating or customizing the strings - -The [`:lang()` pseudo-class](https://developer.mozilla.org/en-US/docs/Web/CSS/:lang) is used to allow for easy translation of the "Browse" and "Choose file..." text into other languages. Simply override or add entries to the `$custom-file-text` SCSS variable with the relevant [language tag](https://en.wikipedia.org/wiki/IETF_language_tag) and localized strings. The English strings can be customized the same way. For example, here's how one might add a Spanish translation (Spanish's language code is `es`): - -{% highlight scss %} -$custom-file-text: ( - placeholder: ( - en: "Choose file...", - es: "Seleccionar archivo..." - ), - button-label: ( - en: "Browse", - es: "Navegar" - ) -); -{% endhighlight %} - -You'll need to set the language of your document (or subtree thereof) correctly in order for the correct text to be shown. This can be done using [the `lang` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) or the [`Content-Language` HTTP header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.12), among other methods. diff --git a/docs/components/input-group.md b/docs/components/input-group.md deleted file mode 100644 index 144d6f628..000000000 --- a/docs/components/input-group.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -layout: docs -title: Input group -description: Easily extend form controls by adding text, buttons, or button groups on either side of textual inputs. -group: components -toc: true ---- - -## Basic example - -Place one add-on or button on either side of an input. You may also place one on both sides of an input. **We do not support multiple form-controls in a single input group.** - -{% example html %} -

- @ - -

-
-

- - @example.com -

-
-Your vanity URL -

- https://example.com/users/ - -

-
-

- $ - - .00 -

-
-

- $ - 0.00 - -

-{% endexample %} - -## Sizing - -Add the relative form sizing classes to the `.input-group` itself and contents within will automatically resize—no need for repeating the form control size classes on each element. - -{% example html %} -

- @ - -

-
-

- @ - -

-{% endexample %} - -## Checkboxes and radio addons - -Place any checkbox or radio option within an input group's addon instead of text. - -{% example html %} -

- - - - -

-{% endexample %} - -## Multiple addons - -Multiple add-ons are supported and can be mixed with checkbox and radio input versions. - -{% example html %} -

- - - - $ - -

- $ - 0.00 - -

-{% endexample %} - - -## Button addons - -Buttons in input groups must wrapped in a `.input-group-btn` for proper alignment and sizing. This is required due to default browser styles that cannot be overridden. - -{% example html %} -

- - - - -

- - - -

-
-

- - - - - - - -

-{% endexample %} - -## Buttons with dropdowns - -{% example html %} -

- - -

- -

- - -

-{% endexample %} - -## Segmented buttons - -{% example html %} -

- - - -

- -

- - - -

-{% endexample %} - -## Accessibility - -Screen readers will have trouble with your forms if you don't include a label for every input. For these input groups, ensure that any additional label or functionality is conveyed to assistive technologies. - -The exact technique to be used (`` elements hidden using the `.sr-only` class, or use of the `aria-label` and `aria-labelledby` attributes, possibly in combination with `aria-describedby`) and what additional information will need to be conveyed will vary depending on the exact type of interface widget you're implementing. The examples in this section provide a few suggested, case-specific approaches. diff --git a/docs/components/jumbotron.md b/docs/components/jumbotron.md deleted file mode 100644 index 2d5278412..000000000 --- a/docs/components/jumbotron.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: docs -title: Jumbotron -description: Lightweight, flexible component for showcasing hero unit style content. -group: components ---- - -A lightweight, flexible component that can optionally extend the entire viewport to showcase key marketing messages on your site. - -{% example html %} -

Hello, world!

This is a simple hero unit, a simple jumbotron-style component for calling extra attention to featured content or information.

It uses utility classes for typography and spacing to space content out within the larger container.

- Learn more -

-{% endexample %} - -To make the jumbotron full width, and without rounded corners, add the `.jumbotron-fluid` modifier class and add a `.container` or `.container-fluid` within. - -{% example html %} -

Fluid jumbotron

This is a modified jumbotron that occupies the entire horizontal space of its parent.

-{% endexample %} diff --git a/docs/components/list-group.md b/docs/components/list-group.md deleted file mode 100644 index f67f3c86e..000000000 --- a/docs/components/list-group.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -layout: docs -title: List group -description: List groups are a flexible and powerful component for displaying a series of content. Modify and extend them to support just about any content within. -group: components -toc: true ---- - -## Basic example - -The most basic list group is an unordered list with list items and the proper classes. Build upon it with the options that follow, or with your own CSS as needed. - -{% example html %} -

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus
Porta ac consectetur ac
Vestibulum at eros

-{% endexample %} - -## Active items - -Add `.active` to a `.list-group-item` to indicate the current active selection. - -{% example html %} -

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus
Porta ac consectetur ac
Vestibulum at eros

-{% endexample %} - -## Disabled items - -Add `.disabled` to a `.list-group-item` to make it _appear_ disabled. Note that some elements with `.disabled` will also require custom JavaScript to fully disable their click events (e.g., links). - -{% example html %} -

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus
Porta ac consectetur ac
Vestibulum at eros

-{% endexample %} - -## Links and buttons - -Use ``s or ` - - - - -

-{% endexample %} - -## Contextual classes - -Use contextual classes to style list items with a stateful background and color. - -{% example html %} -

Dapibus ac facilisis in
Dapibus ac facilisis in
Cras sit amet nibh libero
Porta ac consectetur ac
Vestibulum at eros

-{% endexample %} - -Contextual classes also work with `.list-group-item-action`. Note the addition of the hover styles here not present in the previous example. Also supported is the `.active` state; apply it to indicate an active selection on a contextual list group item. - -{% example html %} -

- Dapibus ac facilisis in - Dapibus ac facilisis in - Cras sit amet nibh libero - Porta ac consectetur ac - Vestibulum at eros -

-{% endexample %} - -{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %} -{{ callout-include | markdownify }} - -## With badges - -Add badges to any list group item to show unread counts, activity, and more with the help of some [utilities]({{ site.baseurl }}/utilities/flexbox/). - -{% example html %} -

- Cras justo odio - 14 -
- Dapibus ac facilisis in - 2 -
- Morbi leo risus - 1 -

-{% endexample %} - -## Custom content - -Add nearly any HTML within, even for linked list groups like the one below, with the help of [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). - -{% example html %} -

- -

List group item heading

- 3 days ago -

Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.

- Donec id elit non mi porta. - - -

List group item heading

- 3 days ago -

Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.

- Donec id elit non mi porta. - - -

List group item heading

- 3 days ago -

Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.

- Donec id elit non mi porta. - -

-{% endexample %} - -## JavaScript behavior - -Use the tab JavaScript plugin—include it individually or through the compiled `bootstrap.js` file—to extend our list group to create tabbable panes of local content. - -

- Home - Profile - Messages - Settings -

- -{% highlight html %} -

- Home - Profile - Messages - Settings -

...

-{% endhighlight %} - -### Using data attributes - -You can activate a list group navigation without writing any JavaScript by simply specifying `data-toggle="list"` or on an element. Use these data attributes on `.list-group-item`. - -

-{% highlight html %} - -

- Home - Profile - Messages - Settings -

- - -

...

-{% endhighlight %} -

- -### Via JavaScript - -Enable tabbable list item via JavaScript (each list item needs to be activated individually): - -{% highlight js %} -$('#myList a').click(function (e) { - e.preventDefault() - $(this).tab('show') -}) -{% endhighlight %} - -You can activate individual list item in several ways: - -{% highlight js %} -$('#myList a[href="#profile"]').tab('show') // Select tab by name -$('#myList a:first').tab('show') // Select first tab -$('#myList a:last').tab('show') // Select last tab -$('#myList li:eq(2) a').tab('show') // Select third tab (0-indexed) -{% endhighlight %} - -### Fade effect - -To make tabs panel fade in, add `.fade` to each `.tab-pane`. The first tab pane must also have `.show` to make the initial content visible. - -{% highlight html %} -

...

-{% endhighlight %} - -### Methods - -#### $().tab - -Activates a list item element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the DOM. - -{% highlight html %} -

- Home - Profile - Messages - Settings -

- -

...

- - -{% endhighlight %} - -#### .tab('show') - -Selects the given list item and shows its associated pane. Any other list item that was previously selected becomes unselected and its associated pane is hidden. **Returns to the caller before the tab pane has actually been shown** (for example, before the `shown.bs.tab` event occurs). - -{% highlight js %} -$('#someListItem').tab('show') -{% endhighlight %} - -### Events - -When showing a new tab, the events fire in the following order: - -1. `hide.bs.tab` (on the current active tab) -2. `show.bs.tab` (on the to-be-shown tab) -3. `hidden.bs.tab` (on the previous active tab, the same one as for the `hide.bs.tab` event) -4. `shown.bs.tab` (on the newly-active just-shown tab, the same one as for the `show.bs.tab` event) - -If no tab was already active, the `hide.bs.tab` and `hidden.bs.tab` events will not be fired. - - - - - - - - - - - - - - - - - - - - - - - - - - -

Event type	Description
show.bs.tab	This event fires on tab show, but before the new tab has been shown. Use `event.target` and `event.relatedTarget` to target the active tab and the previous active tab (if available) respectively.
shown.bs.tab	This event fires on tab show after a tab has been shown. Use `event.target` and `event.relatedTarget` to target the active tab and the previous active tab (if available) respectively.
hide.bs.tab	This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use `event.target` and `event.relatedTarget` to target the current active tab and the new soon-to-be-active tab, respectively.
hidden.bs.tab	This event fires after a new tab is shown (and thus the previous active tab is hidden). Use `event.target` and `event.relatedTarget` to target the previous active tab and the new active tab, respectively.

- -{% highlight js %} -$('a[data-toggle="list"]').on('shown.bs.tab', function (e) { - e.target // newly activated tab - e.relatedTarget // previous active tab -}) -{% endhighlight %} diff --git a/docs/components/modal.md b/docs/components/modal.md deleted file mode 100644 index 8abb6a9c2..000000000 --- a/docs/components/modal.md +++ /dev/null @@ -1,616 +0,0 @@ ---- -layout: docs -title: Modal -description: Use Bootstrap's JavaScript modal plugin to add dialogs to your site for lightboxes, user notifications, or completely custom content. -group: components -toc: true ---- - -## How it works - -Before getting started with Bootstrap's modal component, be sure to read the following as our menu options have recently changed. - -- Modals are built with HTML, CSS, and JavaScript. They're positioned over everything else in the document and remove scroll from the `` so that modal content scrolls instead. -- Clicking on the modal "backdrop" will automatically close the modal. -- Bootstrap only supports one modal window at a time. Nested modals aren't supported as we believe them to be poor user experiences. -- Modals use `position: fixed`, which can sometimes be a bit particular about its rendering. Whenever possible, place your modal HTML in a top-level position to avoid potential interference from other elements. You'll likely run into issues when nesting a `.modal` within another fixed element. -- Once again, due to `position: fixed`, there are some caveats with using modals on mobile devices. [See our browser support docs]({{ site.baseurl }}/getting-started/browsers-devices/#modals-and-dropdowns-on-mobile) for details. -- Lastly, the `autofocus` HTML attribute has no effect in modals. Here's how you can achieve the same effect with custom JavaScript. - -Keep reading for demos and usage guidelines. - - -- Due to how HTML5 defines its semantics, [the `autofocus` HTML attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-autofocus) has no effect in Bootstrap modals. To achieve the same effect, use some custom JavaScript: - -{% highlight js %} -$('#myModal').on('shown.bs.modal', function () { - $('#myInput').focus() -}) -{% endhighlight %} - -## Examples - -### Modal components - -Below is a _static_ modal example (meaning its `position` and `display` have been overridden). Included are the modal header, modal body (required for `padding`), and modal footer (optional). We ask that you include modal headers with dismiss actions whenever possible, or provide another explicit dismiss action. - - - -{% highlight html %} - -{% endhighlight %} - -### Live demo - -Toggle a working modal demo by clicking the button below. It will slide down and fade in from the top of the page. - - - -

- -

- -{% highlight html %} - - - - - -{% endhighlight %} - -### Scrolling long content - -When modals become too long for the user's viewport or device, they scroll independent of the page itself. Try the demo below to see what we mean. - - - -

- -

- -{% highlight html %} - - - - - -{% endhighlight %} - -### Tooltips and popovers - -[Tooltips]({{ site.baseurl }}/components/tooltips/) and [popovers]({{ site.baseurl }}/components/popovers/) can be placed within modals as needed. When modals are closed, any tooltips and popovers within are also automatically dismissed. - - - -

- -

- -{% highlight html %} - -{% endhighlight %} - -### Using the grid - -Utilize the Bootstrap grid system within a modal by nesting `.container-fluid` within the `.modal-body`. Then, use the normal grid system classes as you would anywhere else. - - - -

- -

- -{% highlight html %} - -{% endhighlight %} - -### Varying modal content - -Have a bunch of buttons that all trigger the same modal with slightly different contents? Use `event.relatedTarget` and [HTML `data-*` attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes) (possibly [via jQuery](https://api.jquery.com/data/)) to vary the contents of the modal depending on which button was clicked. - -Below is a live demo followed by example HTML and JavaScript. For more information, [read the modal events docs](#events) for details on `relatedTarget`. - -{% example html %} - - - - - -{% endexample %} - -{% highlight js %} -$('#exampleModal').on('show.bs.modal', function (event) { - var button = $(event.relatedTarget) // Button that triggered the modal - var recipient = button.data('whatever') // Extract info from data-* attributes - // If necessary, you could initiate an AJAX request here (and then do the updating in a callback). - // Update the modal's content. We'll use jQuery here, but you could use a data binding library or other methods instead. - var modal = $(this) - modal.find('.modal-title').text('New message to ' + recipient) - modal.find('.modal-body input').val(recipient) -}) -{% endhighlight %} - -### Remove animation - -For modals that simply appear rather than fade in to view, remove the `.fade` class from your modal markup. - -{% highlight html %} - -{% endhighlight %} - -### Dynamic heights - -If the height of a modal changes while it is open, you should call `$('#myModal').data('bs.modal').handleUpdate()` or `$('#myModal').modal('handleUpdate')` to readjust the modal's position in case a scrollbar appears. - -### Accessibility - -Be sure to add `role="dialog"` and `aria-labelledby="..."`, referencing the modal title, to `.modal`, and `role="document"` to the `.modal-dialog` itself. Additionally, you may give a description of your modal dialog with `aria-describedby` on `.modal`. - -### Embedding YouTube videos - -Embedding YouTube videos in modals requires additional JavaScript not in Bootstrap to automatically stop playback and more. [See this helpful Stack Overflow post](https://stackoverflow.com/questions/18622508/bootstrap-3-and-youtube-in-modal) for more information. - -## Optional sizes - -Modals have two optional sizes, available via modifier classes to be placed on a `.modal-dialog`. These sizes kick in at certain breakpoints to avoid horizontal scrollbars on narrower viewports. - -

- - -

- -{% highlight html %} - - - - - - - - - -{% endhighlight %} - - - - - -## Usage - -The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds `.modal-open` to the `` to override default scrolling behavior and generates a `.modal-backdrop` to provide a click area for dismissing shown modals when clicking outside the modal. - -### Via data attributes - -Activate a modal without writing JavaScript. Set `data-toggle="modal"` on a controller element, like a button, along with a `data-target="#foo"` or `href="#foo"` to target a specific modal to toggle. - -{% highlight html %} - -{% endhighlight %} - -### Via JavaScript - -Call a modal with id `myModal` with a single line of JavaScript: - -{% highlight js %}$('#myModal').modal(options){% endhighlight %} - -### Options - -Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-backdrop=""`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
backdrop	boolean or the string `'static'`	true	Includes a modal-backdrop element. Alternatively, specify `static` for a backdrop which doesn't close the modal on click.
keyboard	boolean	true	Closes the modal when escape key is pressed
focus	boolean	true	Puts the focus on the modal when initialized.
show	boolean	true	Shows the modal when initialized.

- -### Methods - -{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} -{{ callout-include | markdownify }} - -#### `.modal(options)` - -Activates your content as a modal. Accepts an optional options `object`. - -{% highlight js %} -$('#myModal').modal({ - keyboard: false -}) -{% endhighlight %} - -#### `.modal('toggle')` - -Manually toggles a modal. **Returns to the caller before the modal has actually been shown or hidden** (i.e. before the `shown.bs.modal` or `hidden.bs.modal` event occurs). - -{% highlight js %}$('#myModal').modal('toggle'){% endhighlight %} - -#### `.modal('show')` - -Manually opens a modal. **Returns to the caller before the modal has actually been shown** (i.e. before the `shown.bs.modal` event occurs). - -{% highlight js %}$('#myModal').modal('show'){% endhighlight %} - -#### `.modal('hide')` - -Manually hides a modal. **Returns to the caller before the modal has actually been hidden** (i.e. before the `hidden.bs.modal` event occurs). - -{% highlight js %}$('#myModal').modal('hide'){% endhighlight %} - -#### `.modal('handleUpdate')` - -Manually readjust the modal's position if the height of a modal changes while it is open (i.e. in case a scrollbar appears). - -{% highlight js %}$('#myModal').modal('handleUpdate'){% endhighlight %} - -### Events - -Bootstrap's modal class exposes a few events for hooking into modal functionality. All modal events are fired at the modal itself (i.e. at the `

`). - - - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.modal	This event fires immediately when the `show` instance method is called. If caused by a click, the clicked element is available as the `relatedTarget` property of the event.
shown.bs.modal	This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the `relatedTarget` property of the event.
hide.bs.modal	This event is fired immediately when the `hide` instance method has been called.
hidden.bs.modal	This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).

- -{% highlight js %} -$('#myModal').on('hidden.bs.modal', function (e) { - // do something... -}) -{% endhighlight %} diff --git a/docs/components/navbar.md b/docs/components/navbar.md deleted file mode 100644 index 07c86c938..000000000 --- a/docs/components/navbar.md +++ /dev/null @@ -1,538 +0,0 @@ ---- -layout: docs -title: Navbar -description: Documentation and examples for Bootstrap's powerful, responsive navigation header, the navbar. Includes support for branding, navigation, and more, including support for our collapse plugin. -group: components -toc: true ---- - -## How it works - -Here's what you need to know before getting started with the navbar: - -- Navbars require a wrapping `.navbar` with `.navbar-expand{-sm|-md|-lg|-xl}` for responsive collapsing and [color scheme](#color-schemes) classes. -- Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width. -- Navbars and their contents are built with flexbox, providing easy alignment options via utility classes. -- Navbars are responsive by default, but you can easily modify them to change that. Responsive behavior depends on our Collapse JavaScript plugin. -- Ensure accessibility by using a `

` element or, if using a more generic element such as a `

`, add a `role="navigation"` to every navbar to explicitly identify it as a landmark region for users of assistive technologies. - -Read on for an example and list of supported sub-components. - -## Supported content - -Navbars come with built-in support for a handful of sub-components. Choose from the following as needed: - -- `.navbar-brand` for your company, product, or project name. -- `.navbar-nav` for a full-height and lightweight navigation (including support for dropdowns). -- `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#responsive-behaviors) behaviors. -- `.form-inline` for any form controls and actions. -- `.navbar-text` for adding vertically centered strings of text. -- `.collapse.navbar-collapse` for grouping and hiding navbar contents by a parent breakpoint. - -Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `lg` (large) breakpoint. - -{% example html %} - -{% endexample %} - -### Brand - -The `.navbar-brand` can be applied to most elements, but an anchor works best as some elements might require utility classes or custom styles. - -{% example html %} - - - - - -{% endexample %} - -Adding images to the `.navbar-brand` will likely always require custom styles or utilities to properly size. Here are some examples to demonstrate. - -{% example html %} - - -{% endexample %} - -{% example html %} - - -{% endexample %} - -### Nav - -Navbar navigation links build on our `.nav` options with their own modifier class and require the use of [toggler classes](#toggler) for proper responsive styling. **Navigation in navbars will also grow to occupy as much horizontal space as possible** to keep your navbar contents securely aligned. - -Active states—with `.active`—to indicate the current page can be applied directly to `.nav-link`s or their immediate parent `.nav-item`s. - -{% example html %} - -{% endexample %} - -And because we use classes for our navs, you can avoid the list-based approach entirely if you like. - -{% example html %} - -{% endexample %} - -You may also utilize dropdowns in your navbar nav. Dropdown menus require a wrapping element for positioning, so be sure to use separate and nested elements for `.nav-item` and `.nav-link` as shown below. - -{% example html %} - -{% endexample %} - -### Forms - -Place various form controls and components within a navbar with `.form-inline`. - -{% example html %} - -{% endexample %} - -Align the contents of your inline forms with utilities as needed. - -{% example html %} - -{% endexample %} - -Input groups work, too: - -{% example html %} - -{% endexample %} - -Various buttons are supported as part of these navbar forms, too. This is also a great reminder that vertical alignment utilities can be used to align different sized elements. - -{% example html %} - -{% endexample %} - -### Text - -Navbars may contain bits of text with the help of `.navbar-text`. This class adjusts vertical alignment and horizontal spacing for strings of text. - -{% example html %} - -{% endexample %} - -Mix and match with other components and utilities as needed. - -{% example html %} - -{% endexample %} - -## Color schemes - -Theming the navbar has never been easier thanks to the combination of theming classes and `background-color` utilities. Choose from `.navbar-light` for use with light background colors, or `.navbar-inverse` for dark background colors. Then, customize with `.bg-*` utilities. - -

- - - - - -

- -{% highlight html %} - - - - - -{% endhighlight %} - -## Containers - -Although it's not required, you can wrap a navbar in a `.container` to center it on a page or add one within to only center the contents of a [fixed or static top navbar](#placement). - -{% example html %} -

- -

-{% endexample %} - -When the container is within your navbar, its horizontal padding is removed at breakpoints lower than your specified `.navbar-expand{-sm|-md|-lg|-xl}` class. This ensures we're not doubling up on padding unnecessarily on lower viewports when your navbar is collapsed. - -{% example html %} - -{% endexample %} - -## Placement - -Use our position utilities to place navbars in non-static positions. Choose from fixed to the top, fixed to the bottom, or stickied to the top. **Note that `position: sticky`, used for `.sticky-top`, [isn't fully supported in every browser](http://caniuse.com/#feat=css-sticky).** - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} - -## Responsive behaviors - -Navbars can utilize `.navbar-toggler`, `.navbar-collapse`, and `.navbar-expand{-sm|-md|-lg|-xl}` classes to change when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements. - -For navbars that never collapse, add the `.navbar-expand` class on the navbar. For navbars that always collapse, don't add any `.navbar-expand` class. - -### Toggler - -Navbar togglers are left-aligned by default, but should they follow a sibling element like a `.navbar-brand`, they'll automatically be aligned to the far right. Reversing your markup will reverse the placement of the toggler. Below are examples of different toggle styles. - -With no `.navbar-brand` shown in lowest breakpoint: - -{% example html %} - -{% endexample %} - -With a brand name shown on the left and toggler on the right: - -{% example html %} - -{% endexample %} - -With a toggler on the left and brand name on the right: - -{% example html %} - -{% endexample %} - -### External content - -Sometimes you want to use the collapse plugin to trigger hidden content elsewhere on the page. Because our plugin works on the `id` and `data-target` matching, that's easily done! - -{% example html %} -

Collapsed content

- Toggleable via the navbar brand. -

- -

-{% endexample %} diff --git a/docs/components/navs.md b/docs/components/navs.md deleted file mode 100644 index 2e340287d..000000000 --- a/docs/components/navs.md +++ /dev/null @@ -1,673 +0,0 @@ ---- -layout: docs -title: Navs -description: Documentation and examples for how to use Bootstrap's included navigation components. -group: components -toc: true ---- - -## Base nav - -Navigation available in Bootstrap share general markup and styles, from the base `.nav` class to the active and disabled states. Swap modifier classes to switch between each style. - -The base `.nav` component is built with flexbox and provide a strong foundation for building all types of navigation components. It includes some style overrides (for working with lists), some link padding for larger hit areas, and basic disabled styling. - -{% callout info %} -The base `.nav` component does not include any `.active` state. The following examples include the class, mainly to demonstrate that this particular class does not trigger any special styling. -{% endcallout %} - -{% example html %} -

- Active -
- Link -
- Link -
- Disabled -

-{% endexample %} - -Classes are used throughout, so your markup can be super flexible. Use `

` element. Because the `.nav` uses `display: flex`, the nav links behave the same as nav items would, but without the extra markup. - -{% example html %} - -{% endexample %} - -## Available styles - -Change the style of `.nav`s component with modifiers and utilities. Mix and match as needed, or build your own. - -### Horizontal alignment - -Change the horizontal alignment of your nav with [flexbox utilities]({{ site.baseurl }}/layout/grid/#horizontal-alignment). By default, navs are left-aligned, but you can easily change them to center or right aligned. - -Centered with `.justify-content-center`: - -{% example html %} -

- Active -
- Link -
- Link -
- Disabled -

-{% endexample %} - -Right-aligned with `.justify-content-end`: - -{% example html %} -

- Active -
- Link -
- Link -
- Disabled -

-{% endexample %} - -### Vertical - -Stack your navigation by changing the flex item direction with the `.flex-column` utility. Need to stack them on some viewports but not others? Use the responsive versions (e.g., `.flex-sm-column`). - -{% example html %} -

- Active -
- Link -
- Link -
- Disabled -

-{% endexample %} - -As always, vertical navigation is possible without `

- Active -
- Link -
- Link -
- Disabled -

- Active -
- Link -
- Link -
- Disabled -

- Active -
- Longer nav link -
- Link -
- Disabled -

`-based navigation, be sure to include `.nav-item` on the anchors. - -{% example html %} - -{% endexample %} - -For equal-width elements, use `.nav-justified`. All horizontal space will be occupied by nav links, but unlike the `.nav-fill` above, every nav item will be the same width. - -{% example html %} - -{% endexample %} - -Similar to the `.nav-fill` example using a `

`-based navigation, be sure to include `.nav-item` on the anchors. - -{% example html %} - - -{% endexample %} -## Working with flex utilities - -If you need responsive nav variations, consider using a series of [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). While more verbose, these utilities offer greater customization across responsive breakpoints. In the example below, our nav will be stacked on the lowest breakpoint, then adapt to a horizontal layout that fills the available width starting from the small breakpoint. - -{% example html %} - -{% endexample %} - -## Regarding accessibility - -If you're using navs to provide a navigation bar, be sure to add a `role="navigation"` to the most logical parent container of the `

` element around the whole navigation. Do not add the role to the `

WAI

ARIA

WAI

ARIA

- Home -
- Profile -
- - Dropdown - -
- @fat - @mdo -
-

- Home -
- Profile -
- - Dropdown - -
- @fat - @mdo -
-

...

`-based markup shown below. - -

- -

- -{% highlight html %} - -

...

-{% endhighlight %} - -The tabs plugin also works with pills. - -

- Home -
- Profile -
- Dropdown -
- @fat - @mdo -
-

- -{% highlight html %} -

- Home -
- Profile -
- Dropdown -
- @fat - @mdo -
-

...

-{% endhighlight %} - -And with vertical pills. - -

- Home - Profile - Messages - Settings -

- -{% highlight html %} -

- Home - Profile - Messages - Settings -

...

-{% endhighlight %} - -### Using data attributes - -You can activate a tab or pill navigation without writing any JavaScript by simply specifying `data-toggle="tab"` or `data-toggle="pill"` on an element. Use these data attributes on `.nav-tabs` or `.nav-pills`. - -{% highlight html %} - -

- Home -
- Profile -
- Messages -
- Settings -

- - -

...

-{% endhighlight %} - -### Via JavaScript - -Enable tabbable tabs via JavaScript (each tab needs to be activated individually): - -{% highlight js %} -$('#myTab a').click(function (e) { - e.preventDefault() - $(this).tab('show') -}) -{% endhighlight %} - -You can activate individual tabs in several ways: - -{% highlight js %} -$('#myTab a[href="#profile"]').tab('show') // Select tab by name -$('#myTab a:first').tab('show') // Select first tab -$('#myTab a:last').tab('show') // Select last tab -$('#myTab li:eq(2) a').tab('show') // Select third tab (0-indexed) -{% endhighlight %} - -### Fade effect - -To make tabs fade in, add `.fade` to each `.tab-pane`. The first tab pane must also have `.show` to make the initial content visible. - -{% highlight html %} -

...

-{% endhighlight %} - -### Methods - -{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} -{{ callout-include | markdownify }} - -#### $().tab - -Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the DOM. - -{% highlight html %} -

- Home -
- Profile -
- Messages -
- Settings -

- -

...

- - -{% endhighlight %} - -#### .tab('show') - -Selects the given tab and shows its associated pane. Any other tab that was previously selected becomes unselected and its associated pane is hidden. **Returns to the caller before the tab pane has actually been shown** (i.e. before the `shown.bs.tab` event occurs). - -{% highlight js %} -$('#someTab').tab('show') -{% endhighlight %} - -### Events - -When showing a new tab, the events fire in the following order: - -1. `hide.bs.tab` (on the current active tab) -2. `show.bs.tab` (on the to-be-shown tab) -3. `hidden.bs.tab` (on the previous active tab, the same one as for the `hide.bs.tab` event) -4. `shown.bs.tab` (on the newly-active just-shown tab, the same one as for the `show.bs.tab` event) - -If no tab was already active, then the `hide.bs.tab` and `hidden.bs.tab` events will not be fired. - - - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.tab	This event fires on tab show, but before the new tab has been shown. Use `event.target` and `event.relatedTarget` to target the active tab and the previous active tab (if available) respectively.
shown.bs.tab	This event fires on tab show after a tab has been shown. Use `event.target` and `event.relatedTarget` to target the active tab and the previous active tab (if available) respectively.
hide.bs.tab	This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use `event.target` and `event.relatedTarget` to target the current active tab and the new soon-to-be-active tab, respectively.
hidden.bs.tab	This event fires after a new tab is shown (and thus the previous active tab is hidden). Use `event.target` and `event.relatedTarget` to target the previous active tab and the new active tab, respectively.

- -{% highlight js %} -$('a[data-toggle="tab"]').on('shown.bs.tab', function (e) { - e.target // newly activated tab - e.relatedTarget // previous active tab -}) -{% endhighlight %} diff --git a/docs/components/pagination.md b/docs/components/pagination.md deleted file mode 100644 index 0ea749e30..000000000 --- a/docs/components/pagination.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -layout: docs -title: Pagination -description: Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages. -group: components -toc: true ---- - -## Overview - -We use a large block of connected links for our pagination, making links hard to miss and easily scalable—all while providing large hit areas. Pagination is built with list HTML elements so screen readers can announce the number of available links. Use a wrapping `

` element to identify it as a navigation section to screen readers and other assistive technologies. - -In addition, as pages likely have more than one such navigation section, it's advisable to provide a descriptive `aria-label` for the `

` to reflect its purpose. For example, if the pagination component is used to navigate between a set of search results, an appropriate label could be `aria-label="Search results pages"`. - -{% example html %} - -{% endexample %} - -## Working with icons - -Looking to use an icon or symbol in place of text for some pagination links? Be sure to provide proper screen reader support with `aria` attributes and the `.sr-only` utility. - -{% example html %} - -{% endexample %} - -## Disabled and active states - -Pagination links are customizable for different circumstances. Use `.disabled` for links that appear un-clickable and `.active` to indicate the current page. - -While the `.disabled` class uses `pointer-events: none` to _try_ to disable the link functionality of ``s, that CSS property is not yet standardized and doesn't account for keyboard navigation. As such, you should always add `tabindex="-1"` on disabled links and use custom JavaScript to fully disable their functionality. - -{% example html %} - -{% endexample %} - -You can optionally swap out active or disabled anchors for ``, or omit the anchor in the case of the prev/next arrows, to remove click functionality and prevent keyboard focus while retaining intended styles. - -{% example html %} - -{% endexample %} - -## Sizing - -Fancy larger or smaller pagination? Add `.pagination-lg` or `.pagination-sm` for additional sizes. - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} - -## Alignment - -Change the alignment of pagination components with [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} diff --git a/docs/components/popovers.md b/docs/components/popovers.md deleted file mode 100644 index a7750d635..000000000 --- a/docs/components/popovers.md +++ /dev/null @@ -1,372 +0,0 @@ ---- -layout: docs -title: Popovers -description: Documentation and examples for adding Bootstrap popovers, like those found in iOS, to any element on your site. -group: components -toc: true ---- - -## Overview - -Things to know when using the popover plugin: - - -- Popovers rely on the 3rd party library [Popper.js](https://popper.js.org) for positioning. You must include [popper.min.js](https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.9.9/umd/popper.min.js) before bootstrap.js in order for popovers to work! -- Popovers require the [tooltip plugin]({{ site.baseurl }}/components/tooltips/) as a dependency. -- Popovers are opt-in for performance reasons, so **you must initialize them yourself**. -- Zero-length `title` and `content` values will never show a popover. -- Specify `container: 'body'` to avoid rendering problems in more complex components (like our input groups, button groups, etc). -- Triggering popovers on hidden elements will not work. -- Popovers for `.disabled` or `disabled` elements must be triggered on a wrapper element. -- When triggered from hyperlinks that span multiple lines, popovers will be centered. Use `white-space: nowrap;` on your ``s to avoid this behavior. -- Popovers must be hidden before their corresponding elements have been removed from the DOM. - -Got all that? Great, let's see how they work with some examples. - -## Example: Enable popovers everywhere - -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 %} - -## Example: Using the `container` option - -When you have some styles on a parent element that interfere with a popover, you'll want to specify a custom `container` so that the popover's HTML appears within that element instead. - -{% highlight js %} -$(function () { - $('.example-popover').popover({ - container: 'body' - }) -}) -{% endhighlight %} - -## Static popover - -Four options are available: top, right, bottom, and left aligned. - - - -## 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. - -{% callout danger %} -#### Specific markup required for dismiss-on-next-click - -For proper cross-browser and cross-platform behavior, you must use the `` tag, _not_ the ` -

- -{% highlight html %} -

-{% endhighlight %} diff --git a/docs/components/scrollspy.md b/docs/components/scrollspy.md deleted file mode 100644 index a2829d3e5..000000000 --- a/docs/components/scrollspy.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: docs -title: Scrollspy -description: Automatically update Bootstrap navigation or list group components based on scroll position to indicate which link is currently active in the viewport. -group: components -toc: true ---- - -## How it works - -Scrollspy has a few requirements to function properly: - -- It must to be used on a Bootstrap [nav component]({{ site.baseurl }}/components/navs/) or [list group]({{ site.baseurl }}/components/list-group/). -- Scrollspy requires `position: relative;` on the element you're spying on, usually the ``. -- When spying on elements other than the ``, be sure to have a `height` set and `overflow-y: scroll;` applied. -- Anchors (``) are required and must point to an element with that `id`. - -When successfully implemented, your nav or list group will update accordingly, moving the `.active` class from one item to the next based on their associated targets. - -## Example in navbar - -Scroll the area below the navbar and watch the active class change. The dropdown items will be highlighted as well. - -

- -

@fat

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.

@mdo

Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn adipisicing craft beer vice keytar deserunt.

one

Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi, velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in, sustainable delectus consectetur fanny pack iphone.

two

In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko, cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack, tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt.

three

Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats. -

- -{% highlight html %} - -

@fat

...

@mdo

...

one

...

two

...

three

...

-{% endhighlight %} - -## Example with nested nav - -Scrollspy also works with nested `.nav`s. If a nested `.nav` is `.active`, its parents will also be `.active`. Scroll the area next to the navbar and watch the active class change. - -

- -

Item 1

Item 1-1

Item 2-2

Item 2

Item 3

Item 3-1

Item 3-2

- -{% highlight html %} - - -

Item 1

...

Item 1-1

...

Item 2-2

...

Item 2

...

Item 3

...

Item 3-1

...

Item 3-2

...

-{% endhighlight %} - -## Example with list-group - -Scrollspy also works with `.list-group`s. Scroll the area next to the list group and watch the active class change. - -

- Item 1 - Item2 - Item 3 - Item 4 -

Item 1

Item 2

Item 3

Item 4

- -{% highlight html %} -

- Item 1 - Item2 - Item 3 - Item 4 -

Item 1

...

Item 2

...

Item 3

...

Item 4

...

-{% endhighlight %} - - -## Usage - -### Via data attributes - -To easily add scrollspy behavior to your topbar navigation, add `data-spy="scroll"` to the element you want to spy on (most typically this would be the ``). Then add the `data-target` attribute with the ID or class of the parent element of any Bootstrap `.nav` component. - -{% highlight css %} -body { - position: relative; -} -{% endhighlight %} - -{% highlight html %} - - ... - - ... - -{% endhighlight %} - -### Via JavaScript - -After adding `position: relative;` in your CSS, call the scrollspy via JavaScript: - -{% highlight js %} -$('body').scrollspy({ target: '#navbar-example' }) -{% endhighlight %} - -{% callout danger %} -#### Resolvable ID targets required - -Navbar links must have resolvable id targets. For example, a `home` must correspond to something in the DOM like `

`. -{% endcallout %} - -{% callout info %} -#### Non-`:visible` target elements ignored - -Target elements that are not [`:visible` according to jQuery](https://api.jquery.com/visible-selector/) will be ignored and their corresponding nav items will never be highlighted. -{% endcallout %} - -### Methods - -#### `.scrollspy('refresh')` - -When using scrollspy in conjunction with adding or removing of elements from the DOM, you'll need to call the refresh method like so: - -{% highlight js %} -$('[data-spy="scroll"]').each(function () { - var $spy = $(this).scrollspy('refresh') -}) -{% endhighlight %} - - -### Options - -Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-offset=""`. - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
offset	number	10	Pixels to offset from top when calculating position of scroll.

- -### Events - - - - - - - - - - - - - - -

Event Type	Description
activate.bs.scrollspy	This event fires whenever a new item becomes activated by the scrollspy.

- -{% highlight js %} -$('#myScrollspy').on('activate.bs.scrollspy', function () { - // do something… -}) -{% endhighlight %} diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md deleted file mode 100644 index baee52451..000000000 --- a/docs/components/tooltips.md +++ /dev/null @@ -1,349 +0,0 @@ ---- -layout: docs -title: Tooltips -description: Documentation and examples for adding custom Bootstrap tooltips with CSS and JavaScript using CSS3 for animations and data-attributes for local title storage. -group: components -toc: true ---- - -## Overview - -Things to know when using the tooltip plugin: - -- Tooltips rely on the 3rd party library [Popper.js](https://popper.js.org) for positioning. You must include [popper.min.js](https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.9.9/umd/popper.min.js) before bootstrap.js in order for tooltips to work! -- Tooltips are opt-in for performance reasons, so **you must initialize them yourself**. -- Tooltips with zero-length titles are never displayed. -- Specify `container: 'body'` to avoid rendering problems in more complex components (like our input groups, button groups, etc). -- Triggering tooltips on hidden elements will not work. -- Tooltips for `.disabled` or `disabled` elements must be triggered on a wrapper element. -- When triggered from hyperlinks that span multiple lines, tooltips will be centered. Use `white-space: nowrap;` on your ``s to avoid this behavior. -- Tooltips must be hidden before their corresponding elements have been removed from the DOM. - -Got all that? Great, let's see how they work with some examples. - -## Example: Enable tooltips everywhere - -One way to initialize all tooltips on a page would be to select them by their `data-toggle` attribute: - -{% highlight js %} -$(function () { - $('[data-toggle="tooltip"]').tooltip() -}) -{% endhighlight %} - -## Examples - -Hover over the links below to see tooltips: - - - -### Static demo - -Four options are available: top, right, bottom, and left aligned. - - - -### Interactive demo - -Hover over the buttons below to see their tooltips. - - - -{% highlight html %} - - - - -{% endhighlight %} - -And with custom HTML added: - -{% highlight html %} - -{% endhighlight %} - -## Usage - -The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element. - -Trigger the tooltip via JavaScript: - -{% highlight js %} -$('#example').tooltip(options) -{% endhighlight %} - -### Markup - -The required markup for a tooltip is only a `data` attribute and `title` on the HTML element you wish to have a tooltip. The generated markup of a tooltip is rather simple, though it does require a position (by default, set to `top` by the plugin). - -{% callout warning %} -#### Making tooltips work for keyboard and assistive technology users - -You should only add tooltips to HTML elements that are traditionally keyboard-focusable and interactive (such as links or form controls). Although arbitrary HTML elements (such as ``s) can be made focusable by adding the `tabindex="0"` attribute, this will add potentially annoying and confusing tab stops on non-interactive elements for keyboard users. In addition, most assistive technologies currently do not announce the tooltip in this situation. -{% endcallout %} - -{% highlight html %} - -Hover over me - - - -{% endhighlight %} - -### Options - -Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-animation=""`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
animation	boolean	true	Apply a CSS fade transition to the tooltip
container	string \| element \| false	false	- 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. -
delay	number \| object	0	- 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 }` -
html	boolean	false	- 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. -
placement	string \| function	'top'	- How to position the tooltip - auto \| top \| bottom \| left \| right. When `auto` is specified, it will dynamically reorient the tooltip. - 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. -
selector	string	false	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	string	`'<div class="tooltip" role="tooltip"><div class="arrow" x-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`. - `.arrow` will become the tooltip's arrow. - The outermost wrapper element should have the `.tooltip` class. -
title	string \| 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. -
trigger	string	'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.
offset	number \| string	0	Offset of the tooltip relative to its target. For more information refer to Popper.js's offset docs.
fallbackPlacement	string \| array	'flip'	Allow to specify which position Popper will use on fallback. For more information refer to - Popper.js's behavior docs

- -{% callout info %} -#### Data attributes for individual tooltips - -Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above. -{% endcallout %} - -### Methods - -{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} -{{ callout-include | markdownify }} - -#### `$().tooltip(options)` - -Attaches a tooltip handler to an element collection. - -#### `.tooltip('show')` - -Reveals an element's tooltip. **Returns to the caller before the tooltip has actually been shown** (i.e. before the `shown.bs.tooltip` event occurs). This is considered a "manual" triggering of the tooltip. Tooltips with zero-length titles are never displayed. - -{% highlight js %}$('#element').tooltip('show'){% endhighlight %} - -#### `.tooltip('hide')` - -Hides an element's tooltip. **Returns to the caller before the tooltip has actually been hidden** (i.e. before the `hidden.bs.tooltip` event occurs). This is considered a "manual" triggering of the tooltip. - -{% highlight js %}$('#element').tooltip('hide'){% endhighlight %} - -#### `.tooltip('toggle')` - -Toggles an element's tooltip. **Returns to the caller before the tooltip has actually been shown or hidden** (i.e. before the `shown.bs.tooltip` or `hidden.bs.tooltip` event occurs). This is considered a "manual" triggering of the tooltip. - -{% highlight js %}$('#element').tooltip('toggle'){% endhighlight %} - -#### `.tooltip('dispose')` - -Hides and destroys an element's tooltip. Tooltips that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements. - -{% 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 %} - -#### `.tooltip('update')` - -Updates the position of an element's tooltip. - -{% highlight js %}$('#element').tooltip('update'){% endhighlight %} - -### Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.tooltip	This event fires immediately when the `show` instance method is called.
shown.bs.tooltip	This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.tooltip	This event is fired immediately when the `hide` instance method has been called.
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.tooltip	This event is fired after the `show.bs.tooltip` event when the tooltip template has been added to the DOM.

- -{% highlight js %} -$('#myTooltip').on('hidden.bs.tooltip', function () { - // do something… -}) -{% endhighlight %} -- cgit v1.2.3

First slide label

Second slide label

Third slide label

...

Card title

Card title

Card title

Card title

Card title

Card title

Card title

Support card subtitle

Card subtitle

Special title treatment

Special title treatment

Special title treatment

Special title treatment

Special title treatment

Special title treatment

Card title

Special title treatment

Special title treatment

Card title

Card title

Special title treatment

Special title treatment

Special title treatment

Special title treatment

Card title

Card title

Card title

Card title

Card title

Card title

Card title

Card title

Card title

Card title

Card title

Modal title

Modal title

Modal title

Modal title

Modal title

Modal title

Modal title

Modal title

Modal title

Modal title

Popover in a modal

Grids in modals

New message

New message

Large modal

Large modal

List group item heading

List group item heading

List group item heading

List group item heading

List group item heading

List group item heading

Special title treatment

- + Collapsible Group Item #2

- + Collapsible Group Item #3

Card title

Card title that wraps to a new line

Card title

First slide label

Second slide label

Third slide label

Popover top

Popover right