diff options
| author | Mark Otto <[email protected]> | 2017-05-28 22:50:57 -0700 |
|---|---|---|
| committer | Mark Otto <[email protected]> | 2017-05-29 23:32:28 -0700 |
| commit | 3e76d6565603fafa2c85ad81d7b6345c4e279c72 (patch) | |
| tree | fad0aa6a4a70cafb4a803bd920d6ae2fa44dc466 /docs/content | |
| parent | 32153eb7cba316b873e82cd7b9362c92ca00eddf (diff) | |
| download | bootstrap-3e76d6565603fafa2c85ad81d7b6345c4e279c72.tar.xz bootstrap-3e76d6565603fafa2c85ad81d7b6345c4e279c72.zip | |
Rearrange all the docs to allow for a docs/major.minor/ setup
Diffstat (limited to 'docs/content')
| -rw-r--r-- | docs/content/code.md | 50 | ||||
| -rw-r--r-- | docs/content/figures.md | 26 | ||||
| -rw-r--r-- | docs/content/images.md | 71 | ||||
| -rw-r--r-- | docs/content/reboot.md | 359 | ||||
| -rw-r--r-- | docs/content/tables.md | 730 | ||||
| -rw-r--r-- | docs/content/typography.md | 311 |
6 files changed, 0 insertions, 1547 deletions
diff --git a/docs/content/code.md b/docs/content/code.md deleted file mode 100644 index ddd7b9031..000000000 --- a/docs/content/code.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: docs -title: Code -description: Documentation and examples for displaying inline and multiline blocks of code with Bootstrap. -group: content -toc: true ---- - -## Inline code - -Wrap inline snippets of code with `<code>`. Be sure to escape HTML angle brackets. - -{% example html %} -For example, <code><section></code> should be wrapped as inline. -{% endexample %} - -## Code blocks - -Use `<pre>`s for multiple lines of code. Once again, be sure to escape any angle brackets in the code for proper rendering. You may optionally add the `.pre-scrollable` class, which will set a max-height of 350px and provide a y-axis scrollbar. - -{% example html %} -<pre><code><p>Sample text here...</p> -<p>And another line of sample text here...</p> -</code></pre> -{% endexample %} - -## Variables - -For indicating variables use the `<var>` tag. - -{% example html %} -<var>y</var> = <var>m</var><var>x</var> + <var>b</var> -{% endexample %} - -## User input - -Use the `<kbd>` to indicate input that is typically entered via keyboard. - -{% example html %} -To switch directories, type <kbd>cd</kbd> followed by the name of the directory.<br> -To edit settings, press <kbd><kbd>ctrl</kbd> + <kbd>,</kbd></kbd> -{% endexample %} - -## Sample output - -For indicating sample output from a program use the `<samp>` tag. - -{% example html %} -<samp>This text is meant to be treated as sample output from a computer program.</samp> -{% endexample %} diff --git a/docs/content/figures.md b/docs/content/figures.md deleted file mode 100644 index 4f90018c9..000000000 --- a/docs/content/figures.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: docs -title: Figures -description: Documentation and examples for displaying related images and text with the figure component in Bootstrap. -group: content ---- - -Anytime you need to display a piece of content—like an image with an optional caption, consider using a `<figure>`. - -Use the included `.figure` , `.figure-img` and `.figure-caption` classes to provide some baseline styles for the HTML5 `<figure>` and `<figcaption>` elements. Images in figures have no explicit size, so be sure to add the `.img-fluid` class to your `<img>` to make it responsive. - -{% example html %} -<figure class="figure"> - <img data-src="holder.js/400x300" class="figure-img img-fluid rounded" alt="A generic square placeholder image with rounded corners in a figure."> - <figcaption class="figure-caption">A caption for the above image.</figcaption> -</figure> -{% endexample %} - -Aligning the figure's caption is easy with our [text utilities]({{ site.baseurl }}/utilities/typography/#text-alignment). - -{% example html %} -<figure class="figure"> - <img data-src="holder.js/400x300" class="figure-img img-fluid rounded" alt="A generic square placeholder image with rounded corners in a figure."> - <figcaption class="figure-caption text-right">A caption for the above image.</figcaption> -</figure> -{% endexample %} diff --git a/docs/content/images.md b/docs/content/images.md deleted file mode 100644 index dc4ce9a9a..000000000 --- a/docs/content/images.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: docs -title: Images -description: Documentation and examples for opting images into responsive behavior (so they never become larger than their parent elements) and add lightweight styles to them—all via classes. -group: content -toc: true ---- - -## Responsive images - -Images in Bootstrap are made responsive with `.img-fluid`. `max-width: 100%;` and `height: auto;` are applied to the image so that it scales with the parent element. - -<div class="bd-example"> - <img data-src="holder.js/100px250" class="img-fluid" alt="Generic responsive image"> -</div> - -{% highlight html %} -<img src="..." class="img-fluid" alt="Responsive image"> -{% endhighlight %} - -{% callout warning %} -#### SVG images and IE 10 - -In Internet Explorer 10, SVG images with `.img-fluid` are disproportionately sized. To fix this, add `width: 100% \9;` where necessary. This fix improperly sizes other image formats, so Bootstrap doesn't apply it automatically. -{% endcallout %} - -## Image thumbnails - -In addition to our [border-radius utilities]({{ site.baseurl }}/utilities/borders/), you can use `.img-thumbnail` to give an image a rounded 1px border appearance. - -<div class="bd-example bd-example-images"> - <img data-src="holder.js/200x200" class="img-thumbnail" alt="A generic square placeholder image with a white border around it, making it resemble a photograph taken with an old instant camera"> -</div> - -{% highlight html %} -<img src="..." alt="..." class="img-thumbnail"> -{% endhighlight %} - -## Aligning images - -Align images with the [helper float classes]({{ site.baseurl }}/utilities/responsive-helpers/#responsive-floats) or [text alignment classes]({{ site.baseurl }}/utilities/typography/#text-alignment). `block`-level images can be centered using [the `.mx-auto` margin utility class]({{ site.baseurl }}/utilities/spacing/#horizontal-centering). - -<div class="bd-example bd-example-images"> - <img data-src="holder.js/200x200" class="rounded float-left" alt="A generic square placeholder image with rounded corners"> - <img data-src="holder.js/200x200" class="rounded float-right" alt="A generic square placeholder image with rounded corners"> -</div> - -{% highlight html %} -<img src="..." class="rounded float-left" alt="..."> -<img src="..." class="rounded float-right" alt="..."> -{% endhighlight %} - -<div class="bd-example bd-example-images"> - <img data-src="holder.js/200x200" class="rounded mx-auto d-block" alt="A generic square placeholder image with rounded corners"> -</div> - -{% highlight html %} -<img src="..." class="rounded mx-auto d-block" alt="..."> -{% endhighlight %} - -<div class="bd-example bd-example-images"> - <div class="text-center"> - <img data-src="holder.js/200x200" class="rounded" alt="A generic square placeholder image with rounded corners"> - </div> -</div> - -{% highlight html %} -<div class="text-center"> - <img src="..." class="rounded" alt="..."> -</div> -{% endhighlight %} diff --git a/docs/content/reboot.md b/docs/content/reboot.md deleted file mode 100644 index a9dd6a6d0..000000000 --- a/docs/content/reboot.md +++ /dev/null @@ -1,359 +0,0 @@ ---- -layout: docs -title: Reboot -description: Reboot, a collection of element-specific CSS changes in a single file, kickstart Bootstrap to provide an elegant, consistent, and simple baseline to build upon. -group: content -redirect_from: "/content/" -toc: true ---- - -## Approach - -Reboot builds upon Normalize, providing many HTML elements with somewhat opinionated styles using only element selectors. Additional styling is done only with classes. For example, we reboot some `<table>` styles for a simpler baseline and later provide `.table`, `.table-bordered`, and more. - -Here are our guidelines and reasons for choosing what to override in Reboot: - -- Update some browser default values to use `rem`s instead of `em`s for scalable component spacing. -- Avoid `margin-top`. Vertical margins can collapse, yielding unexpected results. More importantly though, a single direction of `margin` is a simpler mental model. -- For easier scaling across device sizes, block elements should use `rem`s for `margin`s. -- Keep declarations of `font`-related properties to a minimum, using `inherit` whenever possible. - -## Page defaults - -The `<html>` and `<body>` elements are updated to provide better page-wide defaults. More specifically: - -- The `box-sizing` is globally set on every element—including `*:before` and `*:after`, to `border-box`. This ensures that the declared width of element is never exceeded due to padding or border. - - No base `font-size` is declared on the `<html>`, but `16px` is assumed (the browser default). `font-size: 1rem` is applied on the `<body>` for easy responsive type-scaling via media queries while respecting user preferences and ensuring a more accessible approach. -- The `<body>` also sets a global `font-family` and `line-height`. This is inherited later by some form elements to prevent font inconsistencies. -- For safety, the `<body>` has a declared `background-color`, defaulting to `#fff`. - -## Native font stack - -The default web fonts (Helvetica Neue, Helvetica, and Arial) have been dropped in Bootstrap 4 and replaced with a "native font stack" for optimum text rendering on every device and OS. Read more about [native font stacks in this *Smashing Magazine* article](https://www.smashingmagazine.com/2015/11/using-system-ui-fonts-practical-guide/). - -{% highlight sass %} -$font-family-sans-serif: - // Safari for OS X and iOS (San Francisco) - -apple-system, - // Chrome >= 56 for OS X (San Francisco), Windows, Linux and Android - system-ui, - // Chrome < 56 for OS X (San Francisco) - BlinkMacSystemFont, - // Windows - "Segoe UI", - // Android - "Roboto", - // Basic web fallback - "Helvetica Neue", Arial, sans-serif !default; -{% endhighlight %} - -This `font-family` is applied to the `<body>` and automatically inherited globally throughout Bootstrap. To switch the global `font-family`, update `$font-family-base` and recompile Bootstrap. - -## Headings and paragraphs - -All heading elements—e.g., `<h1>`—and `<p>` are reset to have their `margin-top` removed. Headings have `margin-bottom: .5rem` added and paragraphs `margin-bottom: 1rem` for easy spacing. - -<table> - <thead> - <tr> - <th>Heading</th> - <th>Example</th> - </tr> - </thead> - <tbody> - <tr> - <td> - {% markdown %}`<h1></h1>`{% endmarkdown %} - </td> - <td><span class="h1">h1. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h2></h2>`{% endmarkdown %} - </td> - <td><span class="h2">h2. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h3></h3>`{% endmarkdown %} - </td> - <td><span class="h3">h3. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h4></h4>`{% endmarkdown %} - </td> - <td><span class="h4">h4. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h5></h5>`{% endmarkdown %} - </td> - <td><span class="h5">h5. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h6></h6>`{% endmarkdown %} - </td> - <td><span class="h6">h6. Bootstrap heading</span></td> - </tr> - </tbody> -</table> - -## Lists - -All lists—`<ul>`, `<ol>`, and `<dl>`—have their `margin-top` removed and a `margin-bottom: 1rem`. Nested lists have no `margin-bottom`. - -<div class="bd-example"> -{% markdown %} -* Lorem ipsum dolor sit amet -* Consectetur adipiscing elit -* Integer molestie lorem at massa -* Facilisis in pretium nisl aliquet -* Nulla volutpat aliquam velit - * Phasellus iaculis neque - * Purus sodales ultricies - * Vestibulum laoreet porttitor sem - * Ac tristique libero volutpat at -* Faucibus porta lacus fringilla vel -* Aenean sit amet erat nunc -* Eget porttitor lorem - -1. Lorem ipsum dolor sit amet -2. Consectetur adipiscing elit -3. Integer molestie lorem at massa -4. Facilisis in pretium nisl aliquet -5. Nulla volutpat aliquam velit -6. Faucibus porta lacus fringilla vel -7. Aenean sit amet erat nunc -8. Eget porttitor lorem -{% endmarkdown %} -</div> - -For simpler styling, clear hierarchy, and better spacing, description lists have updated `margin`s. `<dd>`s reset `margin-left` to `0` and add `margin-bottom: .5rem`. `<dt>`s are **bolded**. - -<div class="bd-example"> -{% markdown %} -<dl> - <dt>Description lists</dt> - <dd>A description list is perfect for defining terms.</dd> - <dt>Euismod</dt> - <dd>Vestibulum id ligula porta felis euismod semper eget lacinia odio sem.</dd> - <dd>Donec id elit non mi porta gravida at eget metus.</dd> - <dt>Malesuada porta</dt> - <dd>Etiam porta sem malesuada magna mollis euismod.</dd> -</dl> -{% endmarkdown %} -</div> - -## Preformatted text - -The `<pre>` element is reset to remove its `margin-top` and use `rem` units for its `margin-bottom`. - -<div class="bd-example"> -{% markdown %} -<pre> -.example-element { - margin-bottom: 1rem; -} -</pre> -{% endmarkdown %} -</div> - -## Tables - -Tables are slightly adjusted to style `<caption>`s, collapse borders, and ensure consistent `text-align` throughout. Additional changes for borders, padding, and more come with [the `.table` class]({{ site.baseurl }}/content/tables/). - -<div class="bd-example"> - <table> - <caption> - This is an example table, and this is its caption to describe the contents. - </caption> - <thead> - <tr> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - </tr> - </thead> - <tbody> - <tr> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - </tr> - <tr> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - </tr> - <tr> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - </tr> - </tbody> - </table> -</div> - -## Forms - -Various form elements have been rebooted for simpler base styles. Here are some of the most notable changes: - -- `<fieldset>`s have no borders, padding, or margin so they can be easily used as wrappers for individual inputs or groups of inputs. -- `<legend>`s, like fieldsets, have also been restyled to be displayed as a heading of sorts. -- `<label>`s are set to `display: inline-block` to allow `margin` to be applied. -- `<input>`s, `<select>`s, `<textarea>`s, and `<button>`s are mostly addressed by Normalize, but Reboot removes their `margin` and sets `line-height: inherit`, too. -- `<textarea>`s are modified to only be resizable vertically as horizontal resizing often "breaks" page layout. - -These changes, and more, are demonstrated below. - -<form class="bd-example"> - <fieldset> - <legend>Example legend</legend> - - <p> - <label for="input">Example input</label> - <input type="text" id="input" placeholder="Example input"> - </p> - - <p> - <label for="select">Example select</label> - <select id="select"> - <option value="">Choose...</option> - <optgroup label="Option group 1"> - <option value="">Option 1</option> - <option value="">Option 2</option> - <option value="">Option 3</option> - </optgroup> - <optgroup label="Option group 2"> - <option value="">Option 4</option> - <option value="">Option 5</option> - <option value="">Option 6</option> - </optgroup> - </select> - </p> - - <p> - <label> - <input type="checkbox" value=""> - Check this checkbox - </label> - </p> - - <p> - <label> - <input type="radio" name="optionsRadios" id="optionsRadios1" value="option1" checked> - Option one is this and that - </label> - <label> - <input type="radio" name="optionsRadios" id="optionsRadios2" value="option2"> - Option two is something else that's also super long to demonstrate the wrapping of these fancy form controls. - </label> - <label> - <input type="radio" name="optionsRadios" id="optionsRadios3" value="option3" disabled> - Option three is disabled - </label> - </p> - - <p> - <label for="textarea">Example textarea</label> - <textarea id="textarea" rows="3"></textarea> - </p> - - <p> - <label for="time">Example temporal</label> - <input type="datetime-local" id="time"> - </p> - - <p> - <label for="output">Example output</label> - <output name="result" id="output">100</output> - </p> - - <p> - <button type="submit">Button submit</button> - <input type="submit" value="Input submit button"> - <input type="button" value="Input button"> - </p> - - <p> - <button type="submit" disabled>Button submit</button> - <input type="submit" value="Input submit button" disabled> - <input type="button" value="Input button" disabled> - </p> - </fieldset> -</form> - -## Misc elements - -### Address - -The `<address>` element is updated to reset the browser default `font-style` from `italic` to `normal`. `line-height` is also now inherited, and `margin-bottom: 1rem` has been added. `<address>`s are for presenting contact information for the nearest ancestor (or an entire body of work). Preserve formatting by ending lines with `<br>`. - -<div class="bd-example"> - <address> - <strong>Twitter, Inc.</strong><br> - 1355 Market St, Suite 900<br> - San Francisco, CA 94103<br> - <abbr title="Phone">P:</abbr> (123) 456-7890 - </address> - - <address> - <strong>Full Name</strong><br> - <a href="mailto:#">[email protected]</a> - </address> -</div> - -### Blockquote - -The default `margin` on blockquotes is `1em 40px`, so we reset that to `0 0 1rem` for something more consistent with other elements. - -<div class="bd-example"> - <blockquote class="blockquote"> - <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p> - <footer>Someone famous in <cite title="Source Title">Source Title</cite></footer> - </blockquote> -</div> - -### Inline elements - -The `<abbr>` element receives basic styling to make it stand out amongst paragraph text. - -<div class="bd-example"> - Nulla <abbr title="attribute">attr</abbr> vitae elit libero, a pharetra augue. -</div> - -## HTML5 `[hidden]` attribute - -HTML5 adds [a new global attribute named `[hidden]`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/hidden), which is styled as `display: none` by default. Borrowing an idea from [PureCSS](https://purecss.io), we improve upon this default by making `[hidden] { display: none !important; }` to help prevent its `display` from getting accidentally overridden. While `[hidden]` isn't natively supported by IE10, the explicit declaration in our CSS gets around that problem. - -{% highlight html %} -<input type="text" hidden> -{% endhighlight %} - -{% callout warning %} -#### jQuery incompatibility - -`[hidden]` is not compatible with jQuery's `$(...).hide()` and `$(...).show()` methods. This could potentially change in jQuery 3, but we're not holding our breath. Therefore, we don't currently especially endorse `[hidden]` over other techniques for managing the `display` of elements. -{% endcallout %} - -To merely toggle the visibility of an element, meaning its `display` is not modified and the element can still affect the flow of the document, use [the `.invisible` class]({{ site.baseurl }}/utilities/invisible-content/) instead. - -## Click delay optimization for touch - -Traditionally, browsers on touchscreen devices have a delay of approximately 300ms between the end of a "tap" – the moment when a finger/stylus is lifted from screen – and the [`click` event](https://developer.mozilla.org/en-US/docs/Web/Events/click) being fired. This delay is necessary for these browsers to correctly handle "double-tap to zoom" gestures without prematurely triggering actions or links after the first "tap", but it can make your site feel slightly sluggish and unresponsive. - -Most mobile browsers automatically optimize away this 300ms delay for sites that use the `width=device-width` property as part of their [responsive meta tag]({{ site.baseurl }}/getting-started/introduction/#responsive-meta-tag) (as well as for sites that disable zooming, for instance with `user-scalable=no`, though this practice is strongly discouraged for accessibility and usability reasons). The biggest exceptions here are IE11 on Windows Phone 8.1, and iOS Safari (and any other iOS WebView-based browser) [prior to iOS 9.3](https://webkit.org/blog/5610/more-responsive-tapping-on-ios/). - -On touch-enabled laptop/desktop devices, IE11 and Microsoft Edge are currently the only browsers with "double-tap to zoom" functionality. As the [responsive meta tag]({{ site.baseurl }}/getting-started/introduction/#responsive-meta-tag) is ignored by all desktop browsers, using `width=device-width` will have no effect on the 300ms delay here. - -To address this problem in IE11 and Microsoft Edge on desktop, as well as IE11 on Windows Phone 8.1, Bootstrap explicitly uses the [`touch-action:manipulation` CSS property](https://developer.mozilla.org/en-US/docs/Web/CSS/touch-action) on all interactive elements (such as buttons and links). This property essentially disables double-tap functionality on those elements, eliminating the 300ms delay. - -In the case of old iOS versions (prior to 9.3), the suggested approach is to use additional scripts such as [FastClick](https://github.com/ftlabs/fastclick) to explicitly work around the delay. - -For further details, see the compatibility table for [suppressing 300ms delay for touchscreen interactions](https://patrickhlauke.github.io/touch/tests/results/#suppressing-300ms-delay). diff --git a/docs/content/tables.md b/docs/content/tables.md deleted file mode 100644 index c7523b839..000000000 --- a/docs/content/tables.md +++ /dev/null @@ -1,730 +0,0 @@ ---- -layout: docs -title: Tables -description: Documentation and examples for opt-in styling of tables (given their prevelant use in JavaScript plugins) with Bootstrap. -group: content -toc: true ---- - -## Examples - -Due to the widespread use of tables across third-party widgets like calendars and date pickers, we've designed our tables to be **opt-in**. Just add the base class `.table` to any `<table>`, then extend with custom styles or our various included modifier classes. - -Using the most basic table markup, here's how `.table`-based tables look in Bootstrap. **All table styles are inherited in Bootstrap 4**, meaning any nested tables will be styled in the same manner as the parent. - -{% example html %} -<table class="table"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Larry</td> - <td>the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -You can also invert the colors—with light text on dark backgrounds—with `.table-inverse`. - -{% example html %} -<table class="table table-inverse"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Larry</td> - <td>the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -## Table head options - -Similar to default and inverse tables, use one of two modifier classes to make `<thead>`s appear light or dark gray. - -{% example html %} -<table class="table"> - <thead class="thead-inverse"> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Larry</td> - <td>the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> - -<table class="table"> - <thead class="thead-default"> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Larry</td> - <td>the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -## Striped rows - -Use `.table-striped` to add zebra-striping to any table row within the `<tbody>`. - -{% example html %} -<table class="table table-striped"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Larry</td> - <td>the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -{% example html %} -<table class="table table-striped table-inverse"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Larry</td> - <td>the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -## Bordered table - -Add `.table-bordered` for borders on all sides of the table and cells. - -{% example html %} -<table class="table table-bordered"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Mark</td> - <td>Otto</td> - <td>@TwBootstrap</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">4</th> - <td colspan="2">Larry the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -{% example html %} -<table class="table table-bordered table-inverse"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Mark</td> - <td>Otto</td> - <td>@TwBootstrap</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">4</th> - <td colspan="2">Larry the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -## Hoverable rows - -Add `.table-hover` to enable a hover state on table rows within a `<tbody>`. - -{% example html %} -<table class="table table-hover"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td colspan="2">Larry the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -{% example html %} -<table class="table table-hover table-inverse"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td colspan="2">Larry the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -## Small table - -Add `.table-sm` to make tables more compact by cutting cell padding in half. - -{% example html %} -<table class="table table-sm"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td colspan="2">Larry the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -{% example html %} -<table class="table table-sm table-inverse"> - <thead> - <tr> - <th>#</th> - <th>First Name</th> - <th>Last Name</th> - <th>Username</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Mark</td> - <td>Otto</td> - <td>@mdo</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Jacob</td> - <td>Thornton</td> - <td>@fat</td> - </tr> - <tr> - <th scope="row">3</th> - <td colspan="2">Larry the Bird</td> - <td>@twitter</td> - </tr> - </tbody> -</table> -{% endexample %} - -## Contextual classes - -Use contextual classes to color table rows or individual cells. - -| Class | Description | -| --- | --- | -| `.table-active` | Applies the hover color to a particular row or cell | -| `.table-success` | Indicates a successful or positive action | -| `.table-info` | Indicates a neutral informative change or action | -| `.table-warning` | Indicates a warning that might need attention | -| `.table-danger` | Indicates a dangerous or potentially negative action | - -<div class="bd-example"> - <table class="table"> - <thead> - <tr> - <th>#</th> - <th>Column heading</th> - <th>Column heading</th> - <th>Column heading</th> - </tr> - </thead> - <tbody> - <tr class="table-active"> - <th scope="row">1</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr class="table-success"> - <th scope="row">3</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr> - <th scope="row">4</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr class="table-info"> - <th scope="row">5</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr> - <th scope="row">6</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr class="table-warning"> - <th scope="row">7</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr> - <th scope="row">8</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr class="table-danger"> - <th scope="row">9</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - </tbody> - </table> -</div> - -{% highlight html %} -<!-- On rows --> -<tr class="table-active">...</tr> -<tr class="table-success">...</tr> -<tr class="table-info">...</tr> -<tr class="table-warning">...</tr> -<tr class="table-danger">...</tr> - -<!-- On cells (`td` or `th`) --> -<tr> - <td class="table-active">...</td> - <td class="table-success">...</td> - <td class="table-info">...</td> - <td class="table-warning">...</td> - <td class="table-danger">...</td> -</tr> -{% endhighlight %} - -Regular table background variants are not available with the inverse table, however, you may use [text or background utilities]({{ site.baseurl }}/utilities/colors/) to achieve similar styles. - -<div class="bd-example"> - <table class="table table-inverse"> - <thead> - <tr> - <th>#</th> - <th>Column heading</th> - <th>Column heading</th> - <th>Column heading</th> - </tr> - </thead> - <tbody> - <tr class="bg-primary"> - <th scope="row">1</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr class="bg-success"> - <th scope="row">3</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr> - <th scope="row">4</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr class="bg-info"> - <th scope="row">5</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr> - <th scope="row">6</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr class="bg-warning"> - <th scope="row">7</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr> - <th scope="row">8</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - <tr class="bg-danger"> - <th scope="row">9</th> - <td>Column content</td> - <td>Column content</td> - <td>Column content</td> - </tr> - </tbody> - </table> -</div> - -{% highlight html %} -<!-- On rows --> -<tr class="bg-primary">...</tr> -<tr class="bg-success">...</tr> -<tr class="bg-warning">...</tr> -<tr class="bg-danger">...</tr> -<tr class="bg-info">...</tr> - -<!-- On cells (`td` or `th`) --> -<tr> - <td class="bg-primary">...</td> - <td class="bg-success">...</td> - <td class="bg-warning">...</td> - <td class="bg-danger">...</td> - <td class="bg-info">...</td> -</tr> -{% endhighlight %} - -{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %} -{{ callout-include | markdownify }} - -## Responsive tables - -Create responsive tables by adding `.table-responsive` to any `.table` to make them scroll horizontally on small devices (under 768px). When viewing on anything larger than 768px wide, you will not see any difference in these tables. - -{% callout warning %} -#### Vertical clipping/truncation - -Responsive tables make use of `overflow-y: hidden`, which clips off any content that goes beyond the bottom or top edges of the table. In particular, this can clip off dropdown menus and other third-party widgets. -{% endcallout %} - -<div class="bd-example"> - <table class="table table-responsive"> - <thead> - <tr> - <th>#</th> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - </tr> - </tbody> - </table> - - <table class="table table-bordered table-responsive"> - <thead> - <tr> - <th>#</th> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - <th>Table heading</th> - </tr> - </thead> - <tbody> - <tr> - <th scope="row">1</th> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - </tr> - <tr> - <th scope="row">2</th> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - </tr> - <tr> - <th scope="row">3</th> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - <td>Table cell</td> - </tr> - </tbody> - </table> -</div> - -{% highlight html %} -<table class="table table-responsive"> - ... -</table> -{% endhighlight %} diff --git a/docs/content/typography.md b/docs/content/typography.md deleted file mode 100644 index 754b0ac1b..000000000 --- a/docs/content/typography.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -layout: docs -title: Typography -description: Documentation and examples for Bootstrap typography, including global settings, headings, body text, lists, and more. -group: content -toc: true ---- - -## Global settings - -Bootstrap sets basic global display, typography, and link styles. When more control is needed, check out the [textual utility classes]({{ site.baseurl }}/utilities/typography/). - -- Use a [native font stack]({{ site.baseurl }}/content/reboot/#native-font-stack) that selects the best `font-family` for each OS and device. -- For a more inclusive and accessible type scale, we assume the browser default root `font-size` (typically 16px) so visitors can customize their browser defaults as needed. -- Use the `$font-family-base`, `$font-size-base`, and `$line-height-base` attributes as our typographic base applied to the `<body>`. -- Set the global link color via `$link-color` and apply link underlines only on `:hover`. -- Use `$body-bg` to set a `background-color` on the `<body>` (`#fff` by default). - -These styles can be found within `_reboot.scss`, and the global variables are defined in `_variables.scss`. - -## Headings - -All HTML headings, `<h1>` through `<h6>`, are available. - -<table> - <thead> - <tr> - <th>Heading</th> - <th>Example</th> - </tr> - </thead> - <tbody> - <tr> - <td> - {% markdown %}`<h1></h1>`{% endmarkdown %} - </td> - <td><span class="h1">h1. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h2></h2>`{% endmarkdown %} - </td> - <td><span class="h2">h2. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h3></h3>`{% endmarkdown %} - </td> - <td><span class="h3">h3. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h4></h4>`{% endmarkdown %} - </td> - <td><span class="h4">h4. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h5></h5>`{% endmarkdown %} - </td> - <td><span class="h5">h5. Bootstrap heading</span></td> - </tr> - <tr> - <td> - {% markdown %}`<h6></h6>`{% endmarkdown %} - </td> - <td><span class="h6">h6. Bootstrap heading</span></td> - </tr> - </tbody> -</table> - -{% highlight html %} -<h1>h1. Bootstrap heading</h1> -<h2>h2. Bootstrap heading</h2> -<h3>h3. Bootstrap heading</h3> -<h4>h4. Bootstrap heading</h4> -<h5>h5. Bootstrap heading</h5> -<h6>h6. Bootstrap heading</h6> -{% endhighlight %} - -`.h1` through `.h6` classes are also available, for when you want to match the font styling of a heading but cannot use the associated HTML element. - -{% example html %} -<p class="h1">h1. Bootstrap heading</p> -<p class="h2">h2. Bootstrap heading</p> -<p class="h3">h3. Bootstrap heading</p> -<p class="h4">h4. Bootstrap heading</p> -<p class="h5">h5. Bootstrap heading</p> -<p class="h6">h6. Bootstrap heading</p> -{% endexample %} - -### Customizing headings - -Use the included utility classes to recreate the small secondary heading text from Bootstrap 3. - -<div class="bd-example"> - <span class="h3"> - Fancy display heading - <small class="text-muted">With faded secondary text</small> - </span> -</div> - -{% highlight html %} -<h3> - Fancy display heading - <small class="text-muted">With faded secondary text</small> -</h3> -{% endhighlight %} - -## Display headings - -Traditional heading elements are designed to work best in the meat of your page content. When you need a heading to stand out, consider using a **display heading**—a larger, slightly more opinionated heading style. - -<div class="bd-example bd-example-type"> - <table class="table"> - <tbody> - <tr> - <td><span class="display-1">Display 1</span></td> - </tr> - <tr> - <td><span class="display-2">Display 2</span></td> - </tr> - <tr> - <td><span class="display-3">Display 3</span></td> - </tr> - <tr> - <td><span class="display-4">Display 4</span></td> - </tr> - </tbody> - </table> -</div> - -{% highlight html %} -<h1 class="display-1">Display 1</h1> -<h1 class="display-2">Display 2</h1> -<h1 class="display-3">Display 3</h1> -<h1 class="display-4">Display 4</h1> -{% endhighlight %} - -## Lead - -Make a paragraph stand out by adding `.lead`. - -{% example html %} -<p class="lead"> - Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus. -</p> -{% endexample %} - -## Inline text elements - -Styling for common inline HTML5 elements. - -{% example html %} -<p>You can use the mark tag to <mark>highlight</mark> text.</p> -<p><del>This line of text is meant to be treated as deleted text.</del></p> -<p><s>This line of text is meant to be treated as no longer accurate.</s></p> -<p><ins>This line of text is meant to be treated as an addition to the document.</ins></p> -<p><u>This line of text will render as underlined</u></p> -<p><small>This line of text is meant to be treated as fine print.</small></p> -<p><strong>This line rendered as bold text.</strong></p> -<p><em>This line rendered as italicized text.</em></p> -{% endexample %} - -`.mark` and `.small` classes are also available to apply the same styles as `<mark>` and `<small>` while avoiding any unwanted semantic implications that the tags would bring. - -While not shown above, feel free to use `<b>` and `<i>` in HTML5. `<b>` is meant to highlight words or phrases without conveying additional importance while `<i>` is mostly for voice, technical terms, etc. - -## Text utilities - -Change text alignment, transform, style, weight, and color with our [text utilities]({{ site.baseurl }}/utilities/typography/#text-alignment). - -## Abbreviations - -Stylized implementation of HTML's `<abbr>` element for abbreviations and acronyms to show the expanded version on hover. Abbreviations have a default underline and gain a help cursor to provide additional context on hover and to users of assistive technologies. - -Add `.initialism` to an abbreviation for a slightly smaller font-size. - -{% example html %} -<p><abbr title="attribute">attr</abbr></p> -<p><abbr title="HyperText Markup Language" class="initialism">HTML</abbr></p> -{% endexample %} - -## Blockquotes - -For quoting blocks of content from another source within your document. Wrap `<blockquote class="blockquote">` around any <abbr title="HyperText Markup Language">HTML</abbr> as the quote. - -{% example html %} -<blockquote class="blockquote"> - <p class="mb-0">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p> -</blockquote> -{% endexample %} - -### Naming a source - -Add a `<footer class="blockquote-footer">` for identifying the source. Wrap the name of the source work in `<cite>`. - -{% example html %} -<blockquote class="blockquote"> - <p class="mb-0">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p> - <footer class="blockquote-footer">Someone famous in <cite title="Source Title">Source Title</cite></footer> -</blockquote> -{% endexample %} - -### Reverse layout - -Add `.blockquote-reverse` for a blockquote with right-aligned content. - -{% example html %} -<blockquote class="blockquote blockquote-reverse"> - <p class="mb-0">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p> - <footer class="blockquote-footer">Someone famous in <cite title="Source Title">Source Title</cite></footer> -</blockquote> -{% endexample %} - -## Lists - -### Unstyled - -Remove the default `list-style` and left margin on list items (immediate children only). **This only applies to immediate children list items**, meaning you will need to add the class for any nested lists as well. - -{% example html %} -<ul class="list-unstyled"> - <li>Lorem ipsum dolor sit amet</li> - <li>Consectetur adipiscing elit</li> - <li>Integer molestie lorem at massa</li> - <li>Facilisis in pretium nisl aliquet</li> - <li>Nulla volutpat aliquam velit - <ul> - <li>Phasellus iaculis neque</li> - <li>Purus sodales ultricies</li> - <li>Vestibulum laoreet porttitor sem</li> - <li>Ac tristique libero volutpat at</li> - </ul> - </li> - <li>Faucibus porta lacus fringilla vel</li> - <li>Aenean sit amet erat nunc</li> - <li>Eget porttitor lorem</li> -</ul> -{% endexample %} - -### Inline - -Remove a list's bullets and apply some light `margin` with a combination of two classes, `.list-inline` and `.list-inline-item`. - -{% example html %} -<ul class="list-inline"> - <li class="list-inline-item">Lorem ipsum</li> - <li class="list-inline-item">Phasellus iaculis</li> - <li class="list-inline-item">Nulla volutpat</li> -</ul> -{% endexample %} - -### Description list alignment - -Align terms and descriptions horizontally by using our grid system's predefined classes (or semantic mixins). For longer terms, you can optionally add a `.text-truncate` class to truncate the text with an ellipsis. - -{% example html %} -<dl class="row"> - <dt class="col-sm-3">Description lists</dt> - <dd class="col-sm-9">A description list is perfect for defining terms.</dd> - - <dt class="col-sm-3">Euismod</dt> - <dd class="col-sm-9">Vestibulum id ligula porta felis euismod semper eget lacinia odio sem nec elit.</dd> - <dd class="col-sm-9 offset-sm-3">Donec id elit non mi porta gravida at eget metus.</dd> - - <dt class="col-sm-3">Malesuada porta</dt> - <dd class="col-sm-9">Etiam porta sem malesuada magna mollis euismod.</dd> - - <dt class="col-sm-3 text-truncate">Truncated term is truncated</dt> - <dd class="col-sm-9">Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.</dd> - - <dt class="col-sm-3">Nesting</dt> - <dd class="col-sm-9"> - <dl class="row"> - <dt class="col-sm-4">Nested definition list</dt> - <dd class="col-sm-8">Aenean posuere, tortor sed cursus feugiat, nunc augue blandit nunc.</dd> - </dl> - </dd> -</dl> -{% endexample %} - -## Responsive typography - -*Responsive typography* refers to scaling text and components by simply adjusting the root element's `font-size` within a series of media queries. Bootstrap doesn't do this for you, but it's fairly easy to add if you need it. - -Here's an example of it in practice. Choose whatever `font-size`s and media queries you wish. - -{% highlight scss %} -html { - font-size: 14px; -} - -@include media-breakpoint-up(sm) { - html { - font-size: 16px; - } -} - -@include media-breakpoint-up(md) { - html { - font-size: 20px; - } -} - -@include media-breakpoint-up(lg) { - html { - font-size: 28px; - } -} -{% endhighlight %} |
