diff --git a/site/content/docs/5.0/components/card.md b/site/content/docs/5.0/components/card.md index baa645be7..cb25187bd 100644 --- a/site/content/docs/5.0/components/card.md +++ b/site/content/docs/5.0/components/card.md @@ -296,7 +296,7 @@ You can quickly change the text alignment of any card—in its entirety or speci ## Navigation -Add some navigation to a card's header (or block) with Bootstrap's [nav components]({{< docsref "/components/navs" >}}). +Add some navigation to a card's header (or block) with Bootstrap's [nav components]({{< docsref "/components/navs-tabs" >}}). {{< example >}}

diff --git a/site/content/docs/5.0/components/navs-tabs.md b/site/content/docs/5.0/components/navs-tabs.md new file mode 100644 index 000000000..d21837e25 --- /dev/null +++ b/site/content/docs/5.0/components/navs-tabs.md @@ -0,0 +1,665 @@ +--- +layout: docs +title: Navs and tabs +description: Documentation and examples for how to use Bootstrap's included navigation components. +group: components +aliases: "/docs/5.0/components/navs/" +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. + +To convey the active state to assistive technologies, use the `aria-current` attribute — using the `page` value for current page, or `true` for the current item in a set. +{{< /callout >}} + +{{< example >}} +

+{{< /example >}} + +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 >}} + +{{< /example >}} + +## 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]({{< docsref "/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 >}} +

+ Active +
+ Link +
+ Link +
+ Disabled +

+{{< /example >}} + +Right-aligned with `.justify-content-end`: + +{{< example >}} +

+ Active +
+ Link +
+ Link +
+ Disabled +

+{{< /example >}} + +### 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 >}} +

+ Active +
+ Link +
+ Link +
+ Disabled +

+{{< /example >}} + +As always, vertical navigation is possible without `

+ Active +
+ Link +
+ Link +
+ Disabled +

+ Active +
+ Link +
+ Link +
+ Disabled +

+ Active +
+ Much longer nav link +
+ Link +
+ Disabled +

`-based navigation, you can safely omit `.nav-item` as only `.nav-link` is required for styling `` elements. + +{{< example >}} + +{{< /example >}} + +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 >}} +

+ Active +
+ Much longer nav link +
+ Link +
+ Disabled +

+{{< /example >}} + +Similar to the `.nav-fill` example using a `

`-based navigation. + +{{< example >}} + + +{{< /example >}} +## Working with flex utilities + +If you need responsive nav variations, consider using a series of [flexbox utilities]({{< docsref "/utilities/flex" >}}). 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 >}} + +{{< /example >}} + +## 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

not

+ Home +
+ Profile +
+ Contact +

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.

+ Home +
+ Profile +
+ Contact +

...

`, you shouldn't add `role="tablist"` directly to it, as this would override the element's native role as a navigation landmark. Instead, switch to an alternative element (in the example below, a simple `

`) and wrap the `

` around it. + +

+ +

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.

+ +```html + +

...

+``` + +The tabs plugin also works with pills. + +

+ Home +
+ Profile +
+ Contact +

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.

+ +```html +

+ Home +
+ Profile +
+ Contact +

...

+``` + +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.

+ +```html +

+ Home + Profile + Messages + Settings +

...

+``` + +### 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`. + +```html + +

+ Home +
+ Profile +
+ Messages +
+ Settings +

+ + +

...

+``` + +### Via JavaScript + +Enable tabbable tabs via JavaScript (each tab needs to be activated individually): + +```js +var triggerTabList = [].slice.call(document.querySelectorAll('#myTab a')) +triggerTabList.forEach(function (triggerEl) { + var tabTrigger = new bootstrap.Tab(triggerEl) + + triggerEl.addEventListener('click', function (e) { + e.preventDefault() + tabTrigger.show() + }) +}) +``` + +You can activate individual tabs in several ways: + +```js +var triggerEl = document.querySelector('#myTab a[href="#profile"]') +bootstrap.Tab.getInstance(triggerEl).show() // Select tab by name + +var triggerFirstTabEl = document.querySelector('#myTab li:first-child a') +bootstrap.Tab.getInstance(triggerFirstTabEl).show() // Select first tab +``` + +### 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. + +```html +

...

+``` + +### Methods + +{{< callout danger >}} +{{< partial "callout-danger-async-methods.md" >}} +{{< /callout >}} + +#### constructor + +Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the DOM. + +```html +

+ Home +
+ Profile +
+ Messages +
+ Settings +

+ +

...

+ + +``` + +#### 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). + +```js + var someTabTriggerEl = document.querySelector('#someTabTrigger') + var tab = new bootstrap.Tab(someTabTriggerEl) + + tab.show() +``` + +#### dispose + +Destroys an element's tab. + +#### getInstance + +*Static* method which allows you to get the tab instance associated with a DOM element + +```js +var triggerEl = document.querySelector('#trigger') +var tab = bootstrap.Tab.getInstance(triggerEl) // Returns a Bootstrap tab instance +``` + +### 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.

+ +```js +var tabEl = document.querySelector('a[data-toggle="tab"]') +tabEl.addEventListener('shown.bs.tab', function (e) { + e.target // newly activated tab + e.relatedTarget // previous active tab +}) +``` diff --git a/site/content/docs/5.0/components/navs.md b/site/content/docs/5.0/components/navs.md deleted file mode 100644 index 0e74443f7..000000000 --- a/site/content/docs/5.0/components/navs.md +++ /dev/null @@ -1,664 +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. - -To convey the active state to assistive technologies, use the `aria-current` attribute — using the `page` value for current page, or `true` for the current item in a set. -{{< /callout >}} - -{{< example >}} -

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

-{{< /example >}} - -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 >}} - -{{< /example >}} - -## 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]({{< docsref "/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 >}} -

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

-{{< /example >}} - -Right-aligned with `.justify-content-end`: - -{{< example >}} -

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

-{{< /example >}} - -### 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 >}} -

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

-{{< /example >}} - -As always, vertical navigation is possible without `

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

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

- Active -
- Much longer nav link -
- Link -
- Disabled -

`-based navigation, you can safely omit `.nav-item` as only `.nav-link` is required for styling `` elements. - -{{< example >}} - -{{< /example >}} - -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 >}} -

- Active -
- Much longer nav link -
- Link -
- Disabled -

-{{< /example >}} - -Similar to the `.nav-fill` example using a `

`-based navigation. - -{{< example >}} - - -{{< /example >}} -## Working with flex utilities - -If you need responsive nav variations, consider using a series of [flexbox utilities]({{< docsref "/utilities/flex" >}}). 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 >}} - -{{< /example >}} - -## 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

not

- Home -
- Profile -
- Contact -

- Home -
- Profile -
- Contact -

...

`) and wrap the `

` around it. - -

- -

- -```html - -

...

-``` - -The tabs plugin also works with pills. - -

- Home -
- Profile -
- Contact -

- -```html -

- Home -
- Profile -
- Contact -

...

-``` - -And with vertical pills. - -

- Home - Profile - Messages - Settings -

- -```html -

- Home - Profile - Messages - Settings -

...

-``` - -### 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`. - -```html - -

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

- - -

...

-``` - -### Via JavaScript - -Enable tabbable tabs via JavaScript (each tab needs to be activated individually): - -```js -var triggerTabList = [].slice.call(document.querySelectorAll('#myTab a')) -triggerTabList.forEach(function (triggerEl) { - var tabTrigger = new bootstrap.Tab(triggerEl) - - triggerEl.addEventListener('click', function (e) { - e.preventDefault() - tabTrigger.show() - }) -}) -``` - -You can activate individual tabs in several ways: - -```js -var triggerEl = document.querySelector('#myTab a[href="#profile"]') -bootstrap.Tab.getInstance(triggerEl).show() // Select tab by name - -var triggerFirstTabEl = document.querySelector('#myTab li:first-child a') -bootstrap.Tab.getInstance(triggerFirstTabEl).show() // Select first tab -``` - -### 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. - -```html -

...

-``` - -### Methods - -{{< callout danger >}} -{{< partial "callout-danger-async-methods.md" >}} -{{< /callout >}} - -#### constructor - -Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the DOM. - -```html -

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

- -

...

- - -``` - -#### 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). - -```js - var someTabTriggerEl = document.querySelector('#someTabTrigger') - var tab = new bootstrap.Tab(someTabTriggerEl) - - tab.show() -``` - -#### dispose - -Destroys an element's tab. - -#### getInstance - -*Static* method which allows you to get the tab instance associated with a DOM element - -```js -var triggerEl = document.querySelector('#trigger') -var tab = bootstrap.Tab.getInstance(triggerEl) // Returns a Bootstrap tab instance -``` - -### 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.