diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05fac43e..56315fbc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -243,7 +243,7 @@ This performs an initial build and watches both the core and docs sources for ch (assuming the above is done) ```bash - jekyll serve + jekyll serve --baseurl "" ``` ## Releasing diff --git a/Gruntfile.js b/Gruntfile.js index fd2e212f..7ccb871e 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -12,8 +12,8 @@ module.exports = function (grunt) { '$1\n\n' + '[//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs\n\n' + '{% callout info %}\n**Bootstrap Reference Documentation** \n' - + 'This is reference documentation from Bootstrap. \n' - + 'It is being rendered with Material Design for Bootstrap to demonstrate default styling. \n' + + 'This is a part of the reference documentation from Bootstrap. \n' + + 'It is included here to demonstrate rendering with Material Design for Bootstrap default styling. \n' + 'See the Material Design section for more elements and customization options.\n' + '{% endcallout %}' + '\n\n$2' @@ -429,16 +429,16 @@ module.exports = function (grunt) { dest: 'docs/components/' }, 'bs-docs-content': { - //options: { - // // https://regex101.com/r/cZ7aO8/2 - // process: function (content, srcpath) { - // return content - // // insert docs reference - // .replace(/(---[\s\S]+?---)([\s\S]+)/mg, referenceDocNotice) - // // remove sample text 'display' as this is a particular style and is confusing - // .replace(/Fancy display heading/, 'Fancy heading'); - // } - //}, + options: { + // https://regex101.com/r/cZ7aO8/2 + process: function (content, srcpath) { + return content + // insert docs reference + .replace(/(---[\s\S]+?---)([\s\S]+)/mg, referenceDocNotice) + // remove sample text 'display' as this is a particular style and is confusing + .replace(/Fancy display heading/, 'Fancy heading'); + } + }, expand: true, cwd: '../bootstrap/docs/content', src: [ diff --git a/_config.yml b/_config.yml index 472c0274..b77e4424 100644 --- a/_config.yml +++ b/_config.yml @@ -20,8 +20,10 @@ source: docs destination: _gh_pages host: 0.0.0.0 port: 9000 -#baseurl: "/bootstrap-material-design" -#url: "http://fezvrasta.github.io" + + + + encoding: UTF-8 exclude: [assets/scss/] @@ -30,9 +32,11 @@ gems: - jekyll-seo-tag - jekyll-sitemap -# Custom vars -#current_version: 4.0.0-alpha -repo: https://github.com/fezvrasta/bootstrap-material-design +# Site vars +#url: "http://fezvrasta.github.io" +repo: https://github.com/fezvrasta/bootstrap-material-design +baseurl: "/bootstrap-material-design" +url: "http://rosskevin.github.io" # other variables generated in diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml index db825cd2..744e4b25 100644 --- a/docs/_data/nav.yml +++ b/docs/_data/nav.yml @@ -8,21 +8,6 @@ - title: Build tools - title: Best practices -- title: Layout - pages: - - title: Overview - - title: Grid - - title: Media object - - title: Responsive utilities - -- title: Content - pages: - - title: Typography - - title: Code - - title: Images - - title: Tables - - title: Figures - - title: Material Design pages: - title: Test @@ -33,6 +18,31 @@ - title: Labels - title: Selections +- title: About + pages: + - title: History + - title: Team + - title: License + +# change nav-docs.html if you change this name to insert "Bootstrap Reference Documentation" +- title: Migration + +#- title: Layout +# pages: +# - title: Overview +# - title: Grid +# - title: Media object +# - title: Responsive utilities + +- title: Content + pages: + - title: Typography + - title: Code + - title: Images + - title: Tables + - title: Figures + + - title: Components pages: - title: Buttons @@ -64,11 +74,4 @@ # - title: Approach # - title: Icon fonts -- title: About - pages: - - title: History - - title: Team -# - title: Accessibility - - title: License -- title: Migration diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index 466a5338..c3157ea8 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -27,7 +27,6 @@ {% else %} - {% for file in site.data.configBridge.paths.coreJs %} {% endfor %} diff --git a/docs/_includes/header.html b/docs/_includes/header.html index 5de970f3..3a569992 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -17,9 +17,6 @@ - - - {% if site.github %} diff --git a/docs/_includes/nav-docs.html b/docs/_includes/nav-docs.html index 7d74f535..31d8f6dc 100644 --- a/docs/_includes/nav-docs.html +++ b/docs/_includes/nav-docs.html @@ -55,6 +55,13 @@ {% endfor %} + + {% if group.title == "Migration" %} +
+
Bootstrap Reference Documentation
+
+
+ {% endif %} {% endfor %} diff --git a/docs/assets/scss/docs.scss b/docs/assets/scss/docs.scss index 5a0adf9b..b4815eb3 100644 --- a/docs/assets/scss/docs.scss +++ b/docs/assets/scss/docs.scss @@ -91,3 +91,4 @@ $bd-info: $brand-info; // #5bc0de; @import 'mdb/booticon'; @import 'mdb/component-examples'; @import 'mdb/clipboard-js'; +@import 'mdb/sidebar'; diff --git a/docs/assets/scss/mdb/_sidebar.scss b/docs/assets/scss/mdb/_sidebar.scss new file mode 100644 index 00000000..a593fcbf --- /dev/null +++ b/docs/assets/scss/mdb/_sidebar.scss @@ -0,0 +1,8 @@ + +.mdb-toc-item-reference { + margin-top: 1rem; + //margin-bottom: 1rem; + padding: .25rem .75rem; +} + + diff --git a/docs/components/alerts.md b/docs/components/alerts.md index 6538060f..8e45ea89 100644 --- a/docs/components/alerts.md +++ b/docs/components/alerts.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/breadcrumb.md b/docs/components/breadcrumb.md index 5ce76616..60461592 100644 --- a/docs/components/breadcrumb.md +++ b/docs/components/breadcrumb.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/button-dropdown.md b/docs/components/button-dropdown.md index fec7df45..1139d260 100644 --- a/docs/components/button-dropdown.md +++ b/docs/components/button-dropdown.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/button-group.md b/docs/components/button-group.md index b3715fd5..42991787 100644 --- a/docs/components/button-group.md +++ b/docs/components/button-group.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/buttons.md b/docs/components/buttons.md index 484b9c5e..531f7005 100644 --- a/docs/components/buttons.md +++ b/docs/components/buttons.md @@ -9,8 +9,8 @@ redirect_from: "/components/" {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/card.md b/docs/components/card.md index 51263155..43e8a235 100644 --- a/docs/components/card.md +++ b/docs/components/card.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/carousel.md b/docs/components/carousel.md index c2d9949e..ceeb4461 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/collapse.md b/docs/components/collapse.md index 289fda4f..72117570 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/dropdowns.md b/docs/components/dropdowns.md index 80bbba27..345d3846 100644 --- a/docs/components/dropdowns.md +++ b/docs/components/dropdowns.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/forms.md b/docs/components/forms.md index b7832dfc..f7d70eab 100644 --- a/docs/components/forms.md +++ b/docs/components/forms.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/input-group.md b/docs/components/input-group.md index 8235df5d..c7fa19eb 100644 --- a/docs/components/input-group.md +++ b/docs/components/input-group.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/jumbotron.md b/docs/components/jumbotron.md index 795b3298..f1f1d34a 100644 --- a/docs/components/jumbotron.md +++ b/docs/components/jumbotron.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/label.md b/docs/components/label.md index cfee55a2..eeb4aa65 100644 --- a/docs/components/label.md +++ b/docs/components/label.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/list-group.md b/docs/components/list-group.md index aaff7f96..1b906f9d 100644 --- a/docs/components/list-group.md +++ b/docs/components/list-group.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/modal.md b/docs/components/modal.md index fbb07083..639feb36 100644 --- a/docs/components/modal.md +++ b/docs/components/modal.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 946a6ebe..86d7666a 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/navs.md b/docs/components/navs.md index f72badfd..8799157b 100644 --- a/docs/components/navs.md +++ b/docs/components/navs.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/pagination.md b/docs/components/pagination.md index 73fb341b..317bbdf9 100644 --- a/docs/components/pagination.md +++ b/docs/components/pagination.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/popovers.md b/docs/components/popovers.md index d762f80f..fdc0a4cf 100644 --- a/docs/components/popovers.md +++ b/docs/components/popovers.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/progress.md b/docs/components/progress.md index b004d0c6..e780b7e0 100644 --- a/docs/components/progress.md +++ b/docs/components/progress.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/scrollspy.md b/docs/components/scrollspy.md index 73212ac1..401c2b58 100644 --- a/docs/components/scrollspy.md +++ b/docs/components/scrollspy.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md index 6e9f6267..0c0321cc 100644 --- a/docs/components/tooltips.md +++ b/docs/components/tooltips.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/components/utilities.md b/docs/components/utilities.md index 21176d7e..81516f6b 100644 --- a/docs/components/utilities.md +++ b/docs/components/utilities.md @@ -8,8 +8,8 @@ group: components {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} @@ -29,10 +29,12 @@ Assign `margin` or `padding` to an element or a subset of its sides with shortha The classes are named using the format: `{property}-{sides}-{size}` Where *property* is one of: + * `m` - for classes that set `margin` * `p` - for classes that set `padding` Where *sides* is one of: + * `t` - for classes that set `margin-top` or `padding-top` * `b` - for classes that set `margin-bottom` or `padding-bottom` * `l` - for classes that set `margin-left` or `padding-left` @@ -42,6 +44,7 @@ Where *sides* is one of: * `a` - for classes that set a `margin` or `padding` on all 4 sides of the element Where *size* is one of: + * `0` - for classes that eliminate the `margin` or `padding` by setting it to `0` * `1` - (by default) for classes that set the `margin` or `padding` to `$spacer-x` or `$spacer-y` * `2` - (by default) for classes that set the `margin` or `padding` to `$spacer-x * 1.5` or `$spacer-y * 1.5` diff --git a/docs/content/code.md b/docs/content/code.md index 4ce1e7fa..e815e191 100644 --- a/docs/content/code.md +++ b/docs/content/code.md @@ -4,6 +4,17 @@ title: Code group: content --- +[//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs + +{% callout info %} +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +See the Material Design section for more elements and customization options. +{% endcallout %} + + + Styles for inline code snippets and longer, multiline blocks of code. ## Contents diff --git a/docs/content/figures.md b/docs/content/figures.md index d5727051..9611ca8b 100644 --- a/docs/content/figures.md +++ b/docs/content/figures.md @@ -4,6 +4,17 @@ title: Figures group: content --- +[//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs + +{% callout info %} +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +See the Material Design section for more elements and customization options. +{% endcallout %} + + + Anytime you need to display a piece of content—like an image—with an optional caption, consider using a `
`. Use the included `.figure` , `.figure-img` and `.figure-caption` classes to provide some baseline styles for the HTML5 `
` and `
` elements. Images in figures have no explicit size, so be sure to add the `.img-fluid` class to your `` to make it responsive. diff --git a/docs/content/images.md b/docs/content/images.md index e3e616de..41d00157 100644 --- a/docs/content/images.md +++ b/docs/content/images.md @@ -4,6 +4,17 @@ title: Images group: content --- +[//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs + +{% callout info %} +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +See the Material Design section for more elements and customization options. +{% endcallout %} + + + Opt your images into responsive behavior (so they never become larger than their parent elements) and add lightweight styles to them—all via classes. ## Contents diff --git a/docs/content/reboot.md b/docs/content/reboot.md index 9631a86b..8dfdc745 100644 --- a/docs/content/reboot.md +++ b/docs/content/reboot.md @@ -5,6 +5,17 @@ group: content redirect_from: "/content/" --- +[//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs + +{% callout info %} +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +See the Material Design section for more elements and customization options. +{% endcallout %} + + + Part of Bootstrap's job is to provide an elegant, consistent, and simple baseline to build upon. We use Reboot, a collection of element-specific CSS changes in a single file, to kickstart that. 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 `` styles for a simpler baseline and later provide `.table`, `.table-bordered`, and more. diff --git a/docs/content/tables.md b/docs/content/tables.md index 80bbbf85..ee29e862 100644 --- a/docs/content/tables.md +++ b/docs/content/tables.md @@ -4,6 +4,17 @@ title: Tables group: content --- +[//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs + +{% callout info %} +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +See the Material Design section for more elements and customization options. +{% endcallout %} + + + 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 `
`. ## Contents diff --git a/docs/content/typography.md b/docs/content/typography.md index 651e2c49..a7ccbcb3 100644 --- a/docs/content/typography.md +++ b/docs/content/typography.md @@ -4,6 +4,17 @@ title: Typography group: content --- +[//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs + +{% callout info %} +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +See the Material Design section for more elements and customization options. +{% endcallout %} + + + Bootstrap includes simple and easily customized typography for headings, body text, lists, and more. For even more control, check out the [textual utility classes]({{ site.baseurl }}/components/utilities/). ## Contents @@ -72,7 +83,7 @@ Use the included utility classes to recreate the small secondary heading text fr {% example html %}

- Fancy display heading + Fancy heading With faded secondary text

{% endexample %} diff --git a/docs/examples/carousel/carousel.css b/docs/examples/carousel/carousel.css index c6f3facd..4bf83737 100644 --- a/docs/examples/carousel/carousel.css +++ b/docs/examples/carousel/carousel.css @@ -5,8 +5,8 @@ {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/examples/index.md b/docs/examples/index.md index 7d5bfe17..59dd9bd9 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -7,8 +7,8 @@ title: Examples {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/examples/offcanvas/offcanvas.css b/docs/examples/offcanvas/offcanvas.css index 7eca0012..ac647426 100644 --- a/docs/examples/offcanvas/offcanvas.css +++ b/docs/examples/offcanvas/offcanvas.css @@ -6,8 +6,8 @@ {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/examples/screenshots/equal-height-columns.jpg b/docs/examples/screenshots/equal-height-columns.jpg index 574d0f21..81934d2e 100644 Binary files a/docs/examples/screenshots/equal-height-columns.jpg and b/docs/examples/screenshots/equal-height-columns.jpg differ diff --git a/docs/examples/sticky-footer-navbar/sticky-footer-navbar.css b/docs/examples/sticky-footer-navbar/sticky-footer-navbar.css index 908cfffd..e0c6698e 100644 --- a/docs/examples/sticky-footer-navbar/sticky-footer-navbar.css +++ b/docs/examples/sticky-footer-navbar/sticky-footer-navbar.css @@ -5,8 +5,8 @@ {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/examples/sticky-footer/sticky-footer.css b/docs/examples/sticky-footer/sticky-footer.css index a551458c..217082d2 100644 --- a/docs/examples/sticky-footer/sticky-footer.css +++ b/docs/examples/sticky-footer/sticky-footer.css @@ -5,8 +5,8 @@ {% callout info %} **Bootstrap Reference Documentation** -This is reference documentation from Bootstrap. -It is being rendered with Material Design for Bootstrap to demonstrate default styling. +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} diff --git a/docs/layout/grid.md b/docs/layout/grid.md deleted file mode 100644 index 04c3a528..00000000 --- a/docs/layout/grid.md +++ /dev/null @@ -1,432 +0,0 @@ ---- -layout: docs -title: Grid system -group: layout ---- - -Bootstrap includes a powerful mobile-first grid system for building layouts of all shapes and sizes. It's based on a 12 column layout and has multiple tiers, one for each [media query range]({{ site.baseurl }}/layout/overview/#responsive-breakpoints). You can use it with Sass mixins or our predefined classes. - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - -## How it works - -At a high level, here's how the grid system works: - -- There are three major components—containers, rows, and columns. -- Containers—`.container` for fixed width or `.container-fluid` for full width—center your site's contents and help align your grid content. -- Rows are horizontal groups of columns that ensure your columns are lined up properly. -- Content should be placed within columns, and only columns may be immediate children of rows. -- Column classes indicate the number of columns you'd like to use out of the possible 12 per row. So if you want three equal-width columns, you'd use `.col-sm-4`. -- Column `width`s are set in percentages, so they're always fluid and sized relative to their parent element. -- Columns have horizontal `padding` to create the gutters between individual columns. -- There are five grid tiers, one for each [responsive breakpoint]({{ site.baseurl }}/layout/overview/#responsive-breakpoints): extra small, small, medium, large, and extra large. -- Grid tiers are based on minimum widths, meaning they apply to that one tier and all those above it (e.g., `.col-sm-4` applies to small, medium, large, and extra large devices). -- You can use predefined grid classes or Sass mixins for more semantic markup. - -Sounds good? Great, let's move on to seeing all that in an example. - -## Quick start example - -If you're using Bootstrap's compiled CSS, this the example you'll want to start with. - -{% example html %} -
-
-
- One of three columns -
-
- One of three columns -
-
- One of three columns -
-
-
-{% endexample %} - -The above example creates three equal-width columns on small, medium, large, and extra large devices using our [predefined grid classes](#predefined-classes). Those columns are centered in the page with the parent `.container`. - -## Grid options - -While Bootstrap uses `em`s or `rem`s for defining most sizes, `px`s are used for grid breakpoints and container widths. -This is because the viewport width is in pixels and does not change with the [font size](https://drafts.csswg.org/mediaqueries-3/#units). - -See how aspects of the Bootstrap grid system work across multiple devices with a handy table. - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Extra small
- <544px -
- Small
- ≥544px -
- Medium
- ≥768px -
- Large
- ≥992px -
- Extra large
- ≥1200px -
Grid behaviorHorizontal at all timesCollapsed to start, horizontal above breakpoints
Container widthNone (auto)576px720px940px1140px
Class prefix.col-xs-.col-sm-.col-md-.col-lg-.col-xl-
# of columns12
Gutter width1.875rem / 30px (15px on each side of a column)
NestableYes
OffsetsYes
Column orderingYes
- - -## Sass mixins - -When using Bootstrap's source Sass files, you have the option of using Sass variables and mixins to create custom, semantic, and responsive page layouts. Our [predefined grid classes](#predefined-classes) use these same variables and mixins to provide a whole suite of ready-to-use classes for fast responsive layouts. - -### Variables - -Variables determine the number of columns, the gutter width, and the media query point at which to begin floating columns. We use these to generate the predefined grid classes documented above, as well as for the custom mixins listed below. - -{% highlight scss %} -$grid-breakpoints: ( - // Extra small screen / phone - xs: 0, - // Small screen / phone - sm: 544px, - // Medium screen / tablet - md: 768px, - // Large screen / desktop - lg: 992px, - // Extra large screen / wide desktop - xl: 1200px -); - - -$grid-columns: 12; -$grid-gutter-width: 1.875rem; -{% endhighlight %} - -### Mixins - -Mixins are used in conjunction with the grid variables to generate semantic CSS for individual grid columns. - -{% highlight scss %} -// Creates a wrapper for a series of columns -@mixin make-row($gutter: $grid-gutter-width) { - margin-left: ($gutter / -2); - margin-right: ($gutter / -2); - @include clearfix(); -} - -// Make the element grid-ready (applying everything but the width) -@mixin make-col($gutter: $grid-gutter-width) { - position: relative; - float: left; - min-height: 1px; - padding-left: ($gutter / 2); - padding-right: ($gutter / 2); -} - -// Set a width (to be used in or out of media queries) -@mixin make-col-span($columns) { - width: percentage(($columns / $grid-columns)); -} - -// Get fancy by offsetting, or changing the sort order -@mixin make-col-offset($columns) { - margin-left: percentage(($columns / $grid-columns)); -} -@mixin make-col-push($columns) { - left: percentage(($columns / $grid-columns)); -} -@mixin make-col-pull($columns) { - right: percentage(($columns / $grid-columns)); -} -{% endhighlight %} - -### Example usage - -You can modify the variables to your own custom values, or just use the mixins with their default values. Here's an example of using the default settings to create a two-column layout with a gap between. - -See it in action in this rendered example. - -{% highlight scss %} -.container { - max-width: 60em; - @include make-container(); -} -.row { - @include make-row(); -} -.content-main { - @include make-col(); - - @media (max-width: 32em) { - @include make-col-span(6); - } - @media (min-width: 32.1em) { - @include make-col-span(8); - } -} -.content-secondary { - @include make-col(); - - @media (max-width: 32em) { - @include make-col-span(6); - } - @media (min-width: 32.1em) { - @include make-col-span(4); - } -} -{% endhighlight %} - -{% highlight html %} -
-
-
...
-
...
-
-
-{% endhighlight %} - -## Predefined classes - -In addition to our semantic mixins, Bootstrap includes an extensive set of prebuilt classes for quickly creating grid columns. It includes options for device-based column sizing, reordering columns, and more. - -### Example: Stacked-to-horizontal - -Using a single set of `.col-md-*` grid classes, you can create a basic grid system that starts out stacked on mobile devices and tablet devices (the extra small to small range) before becoming horizontal on desktop (medium) devices. Place grid columns in any `.row`. - -
-{% example html %} -
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
.col-md-1
-
-
-
.col-md-8
-
.col-md-4
-
-
-
.col-md-4
-
.col-md-4
-
.col-md-4
-
-
-
.col-md-6
-
.col-md-6
-
-{% endexample %} -
- -### Example: Mobile and desktop - -Don't want your columns to simply stack in smaller devices? Use the extra small and medium device grid classes by adding `.col-xs-*` and `.col-md-*` to your columns. See the example below for a better idea of how it all works. - -
-{% example html %} - -
-
.col-xs-12 .col-md-8
-
.col-xs-6 .col-md-4
-
- - -
-
.col-xs-6 .col-md-4
-
.col-xs-6 .col-md-4
-
.col-xs-6 .col-md-4
-
- - -
-
.col-xs-6
-
.col-xs-6
-
-{% endexample %} -
- -### Example: Mobile, tablet, desktop - -Build on the previous example by creating even more dynamic and powerful layouts with tablet `.col-sm-*` classes. - -
-{% example html %} -
-
.col-xs-12 .col-sm-6 .col-md-8
-
.col-xs-6 .col-md-4
-
-
-
.col-xs-6 .col-sm-4
-
.col-xs-6 .col-sm-4
- -
-
.col-xs-6 .col-sm-4
-
-{% endexample %} -
- -### Example: Column wrapping - -If more than 12 columns are placed within a single row, each group of extra columns will, as one unit, wrap onto a new line. - -
-{% example html %} -
-
.col-xs-9
-
.col-xs-4
Since 9 + 4 = 13 > 12, this 4-column-wide div gets wrapped onto a new line as one contiguous unit.
-
.col-xs-6
Subsequent columns continue along the new line.
-
-{% endexample %} -
- -### Example: Responsive column resets - -With the four tiers of grids available you're bound to run into issues where, at certain breakpoints, your columns don't clear quite right as one is taller than the other. To fix that, use a combination of a `.clearfix` and our [responsive utility classes]({{ site.baseurl }}/layout/responsive-utilities/). - -
-{% example html %} -
-
.col-xs-6 .col-sm-3
-
.col-xs-6 .col-sm-3
- - -
- -
.col-xs-6 .col-sm-3
-
.col-xs-6 .col-sm-3
-
-{% endexample %} -
- -In addition to column clearing at responsive breakpoints, you may need to **reset offsets, pushes, or pulls**. See this in action in [the grid example]({{ site.baseurl }}/examples/grid/). - -
-{% example html %} -
-
.col-sm-5 .col-md-6
-
.col-sm-5 .col-sm-offset-2 .col-md-6 .col-md-offset-0
-
- -
-
.col-sm-6 .col-md-5 .col-lg-6
-
.col-sm-6 .col-md-5 .col-md-offset-2 .col-lg-6 .col-lg-offset-0
-
-{% endexample %} -
- -### Example: Offsetting columns - -Move columns to the right using `.col-md-offset-*` classes. These classes increase the left margin of a column by `*` columns. For example, `.col-md-offset-4` moves `.col-md-4` over four columns. - -
-{% example html %} -
-
.col-md-4
-
.col-md-4 .col-md-offset-4
-
-
-
.col-md-3 .col-md-offset-3
-
.col-md-3 .col-md-offset-3
-
-
-
.col-md-6 .col-md-offset-3
-
-{% endexample %} -
- -### Example: Nesting columns - -To nest your content with the default grid, add a new `.row` and set of `.col-sm-*` columns within an existing `.col-sm-*` column. Nested rows should include a set of columns that add up to 12 or fewer (it is not required that you use all 12 available columns). - -
-{% example html %} -
-
- Level 1: .col-sm-9 -
-
- Level 2: .col-xs-8 .col-sm-6 -
-
- Level 2: .col-xs-4 .col-sm-6 -
-
-
-
-{% endexample %} -
- -### Example: Column ordering - -Easily change the order of our built-in grid columns with `.col-md-push-*` and `.col-md-pull-*` modifier classes. - -
-{% example html %} -
-
.col-md-9 .col-md-push-3
-
.col-md-3 .col-md-pull-9
-
-{% endexample %} -
diff --git a/docs/layout/media-object.md b/docs/layout/media-object.md deleted file mode 100644 index 602bd210..00000000 --- a/docs/layout/media-object.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -layout: docs -title: Media object -group: layout ---- - -The [media object](http://www.stubbornella.org/content/2010/06/25/the-media-object-saves-hundreds-of-lines-of-code/) is an abstract element used as the basis for building more complex and repetitive components (like blog comments, Tweets, etc). Included is support for left and right aligned content, content alignment options, nesting, and more. - -{% callout info %} -**Heads up!** When [flexbox mode]({{ site.baseurl }}/getting-started/flexbox/) is enabled, the media object will use `flex` styles wherever possible. -{% endcallout %} - -## Contents - -* Will be replaced with the ToC, excluding the "Contents" header -{:toc} - -## Default media - -The default media allow to float a media object (images, video, audio) to the left or right of a content block. - -{% example html %} -
- - Generic placeholder image - -
-

Media heading

- Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. -
-
-{% endexample %} - -## Nesting - -Media components can also be nested. - -{% example html %} -
-
- - Generic placeholder image - -
-
-

Media heading

- Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. -
- - Generic placeholder image - -
-

Nested media heading

- Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus. -
-
-
-
-{% endexample %} - -## Alignment - -The images or other media can be aligned top, middle, or bottom. The default is top aligned. - -{% example html %} -
-
- - Generic placeholder image - -
-
-

Top aligned media

-

Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus.

-

Donec sed odio dui. Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.

-
-
-{% endexample %} - -{% example html %} -
-
- - Generic placeholder image - -
-
-

Middle aligned media

-

Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus.

-

Donec sed odio dui. Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.

-
-
-{% endexample %} - -{% example html %} -
-
- - Generic placeholder image - -
-
-

Bottom aligned media

-

Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. Fusce condimentum nunc ac nisi vulputate fringilla. Donec lacinia congue felis in faucibus.

-

Donec sed odio dui. Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.

-
-
-{% endexample %} - -## Media list - -With a bit of extra markup, you can use media inside list (useful for comment threads or articles lists). - -{% example html %} -
    -
  • -
    - - Generic placeholder image - -
    -
    -

    Media heading

    -

    Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis.

    - -
    - - Generic placeholder image - -
    -

    Nested media heading

    - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. - -
    -
    - - Generic placeholder image - -
    -
    -

    Nested media heading

    - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. -
    -
    -
    -
    - -
    -
    - - Generic placeholder image - -
    -
    -

    Nested media heading

    - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. -
    -
    -
    -
  • -
  • -
    -

    Media heading

    - Cras sit amet nibh libero, in gravida nulla. Nulla vel metus scelerisque ante sollicitudin commodo. Cras purus odio, vestibulum in vulputate at, tempus viverra turpis. -
    -
    - - Generic placeholder image - -
    -
  • -
-{% endexample %} diff --git a/docs/layout/overview.md b/docs/layout/overview.md deleted file mode 100644 index 4fa972d2..00000000 --- a/docs/layout/overview.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -layout: docs -title: Overview -group: layout -redirect_from: "/layout/" ---- - -Bootstrap includes several components and options for laying out your project, including wrapping containers, a powerful grid system, a flexible media object, and responsive utility classes. - -## Containers - -Containers are the most basic layout element in Bootstrap and are **required when using our grid system**. Choose from a responsive, fixed-width container (meaning its `max-width` changes at each breakpoint) or fluid-width (meaning it's `100%` wide all the time). - -While containers *can* be nested, most layouts do not require a nested container. - -
-
-
-
-
-
-
- -{% highlight html %} -
- -
-{% endhighlight %} - -Use `.container-fluid` for a full width container, spanning the entire width of the viewport. - -
-
-
-
-
-
-
- -{% highlight html %} -
- ... -
-{% endhighlight %} - - -## Responsive breakpoints - -Since Bootstrap is developed to be mobile first, we use a handful of [media queries](https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Media_queries) to create sensible breakpoints for our layouts and interfaces. These breakpoints are mostly based on minimum viewport widths and allow us to scale up elements as the viewport changes. - -Bootstrap primarily uses the following media query ranges—or breakpoints—in our source Sass files for our layout, grid system, and components. - -{% highlight scss %} -// Extra small devices (portrait phones, less than 34em) -// No media query since this is the default in Bootstrap - -// Small devices (landscape phones, 34em and up) -@media (min-width: 34em) { ... } - -// Medium devices (tablets, 48em and up) -@media (min-width: 48em) { ... } - -// Large devices (desktops, 62em and up) -@media (min-width: 62em) { ... } - -// Extra large devices (large desktops, 75em and up) -@media (min-width: 75em) { ... } -{% endhighlight %} - -Since we write our source CSS in Sass, all our media queries are available via Sass mixins: - -{% highlight scss %} -@include media-breakpoint-up(xs) { ... } -@include media-breakpoint-up(sm) { ... } -@include media-breakpoint-up(md) { ... } -@include media-breakpoint-up(lg) { ... } -@include media-breakpoint-up(xl) { ... } - -// Example usage: -@include media-breakpoint-up(sm) { - .some-class { - display: block; - } -} -{% endhighlight %} - -We occasionally use media queries that go in the other direction (the given screen size *or smaller*): - -{% highlight scss %} -// Extra small devices (portrait phones, less than 34em) -@media (max-width: 33.9em) { ... } - -// Small devices (landscape phones, less than 48em) -@media (max-width: 47.9em) { ... } - -// Medium devices (tablets, less than 62em) -@media (max-width: 61.9em) { ... } - -// Large devices (desktops, less than 75em) -@media (max-width: 74.9em) { ... } - -// Extra large devices (large desktops) -// No media query since the extra-large breakpoint has no upper bound on its width -{% endhighlight %} - -Once again, these media queries are also available via Sass mixins: - -{% highlight scss %} -@include media-breakpoint-down(xs) { ... } -@include media-breakpoint-down(sm) { ... } -@include media-breakpoint-down(md) { ... } -@include media-breakpoint-down(lg) { ... } -@include media-breakpoint-down(xl) { ... } -{% endhighlight %} diff --git a/docs/layout/responsive-utilities.md b/docs/layout/responsive-utilities.md deleted file mode 100644 index f52b52db..00000000 --- a/docs/layout/responsive-utilities.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -layout: docs -title: Responsive utilities -group: layout ---- - -For faster mobile-friendly development, use these utility classes for showing and hiding content by device via media query. Also included are utility classes for toggling content when printed. - -Try to use these on a limited basis and avoid creating entirely different versions of the same site. Instead, use them to complement each device's presentation. - -## Available classes - -* The `.hidden-*-up` classes hide the element when the viewport is at the given breakpoint or wider. For example, `.hidden-md-up` hides an element on medium, large, and extra-large viewports. -* The `.hidden-*-down` classes hide the element when the viewport is at the given breakpoint or smaller. For example, `.hidden-md-down` hides an element on extra-small, small, and medium viewports). -* There are no explicit "visible"/"show" responsive utility classes; you make an element visible by simply not hiding it at that breakpoint size. -* You can combine one `.hidden-*-up` class with one `.hidden-*-down` class to show an element only on a given interval of screen sizes. For example, `.hidden-sm-down.hidden-xl-up` shows the element only on medium and large viewports. Using multiple `.hidden-*-up` classes or multiple `.hidden-*-down` classes is redundant and pointless. -* These classes don't attempt to accommodate less common cases where an element's visibility can't be expressed as a single contiguous range of viewport breakpoint sizes; you will instead need to use custom CSS in such cases. - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Extra small devices - Portrait phones (<34em) - - Small devices - Landscape phones (≥34em) - - Medium devices - Tablets (≥48em) - - Large devices - Desktops (≥62em) - - Extra large devices - Desktops (≥75em) -
.hidden-xs-downVisibleVisibleVisibleVisible
.hidden-sm-downVisibleVisibleVisible
.hidden-md-downVisibleVisible
.hidden-lg-downVisible
.hidden-xl-down
.hidden-xs-up
.hidden-sm-upVisible
.hidden-md-upVisibleVisible
.hidden-lg-upVisibleVisibleVisible
.hidden-xl-upVisibleVisibleVisibleVisible
-
- -

Print classes

-

Similar to the regular responsive classes, use these for toggling content for print.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ClassBrowserPrint
.visible-print-blockVisible
(as display: block)
.visible-print-inlineVisible
(as display: inline)
.visible-print-inline-blockVisible
(as display: inline-block)
.hidden-printVisible
-
- -## Test cases - -Resize your browser or load on different devices to test the responsive utility classes. - -Green checkmarks indicate the element **is visible** in your current viewport. - -
-
- ✔ Visible on extra small - Extra small -
-
- ✔ Visible on small or narrower - Small or narrower -
-
- ✔ Visible on medium or narrower - Medium or narrower -
-
- ✔ Visible on large or narrower - Large or narrower -
-
-
-
- ✔ Visible on small or wider - Small or wider -
-
- ✔ Visible on medium or wider - Medium or wider -
-
- ✔ Visible on large or wider - Large or wider -
-
- ✔ Visible on extra large - Extra large -
-
-
-
- ✔ Your viewport is exactly extra small - Your viewport is NOT exactly extra small -
-
- ✔ Your viewport is exactly small - Your viewport is NOT exactly small -
-
- ✔ Your viewport is exactly medium - Your viewport is NOT exactly medium -
-
- ✔ Your viewport is exactly large - Your viewport is NOT exactly large -
-
- ✔ Your viewport is exactly extra large - Your viewport is NOT exactly extra large -
-
diff --git a/docs/material-design/buttons.md b/docs/material-design/buttons.md index a873bbe3..93cdf0ed 100644 --- a/docs/material-design/buttons.md +++ b/docs/material-design/buttons.md @@ -67,25 +67,25 @@ group: material-design ## Floating Action {% example html %} - - - - - - - {% endexample %} @@ -93,22 +93,22 @@ group: material-design ### Disabled {% example html %}
- - - - - -
@@ -116,22 +116,22 @@ group: material-design ### Sizes -Using `btn-fab-sm` on the button, or using `btn-group-sm` on the enclosing element of a `btn-fab` renders a small variation. +Using `mdb-btn-fab-sm` on the button, or using `btn-group-sm` on the enclosing element of a `mdb-btn-fab` renders a small variation. {% example html %} - - - - diff --git a/docs/material-design/forms.md b/docs/material-design/forms.md index 01556a89..044fc45e 100644 --- a/docs/material-design/forms.md +++ b/docs/material-design/forms.md @@ -95,50 +95,51 @@ Below is a complete list of options supported by Material Design for Bootstrap a - {% markdown %}`.mdb-form-group`{% endmarkdown %} + .mdb-form-group - Any group of form controls + Any group of form controls (e.g. combination of label/input). {% markdown %}This is automatically added by javascript, but if your code is templated, adding `.mdb-form-group` to your form groups or otherwise your groups of controls can reduce rendering churn since the javascript will not - add the class after the initial page rendering.{% endmarkdown %} + add the class after the initial page rendering. This can also demarcate complex label/input combinations inside the + same `.form-group`.{% endmarkdown %} - {% markdown %}`.mdb-label-floating`{% endmarkdown %} + .mdb-form-group-sm + + + {% markdown %}Added to the `.mdb-form-group`, this will render the combination label/input/help in the smaller variation.{% endmarkdown %} - + {% markdown %}{% endmarkdown %} - - {% markdown %}TODO{% endmarkdown %} - - + - {% markdown %}`.mdb-label-static`{% endmarkdown %} + .mdb-form-group-lg + + + {% markdown %}Added to the `.mdb-form-group`, this will render the combination label/input/help in the larger variation.{% endmarkdown %} - + {% markdown %}{% endmarkdown %} - - {% markdown %}TODO{% endmarkdown %} - - + - {% markdown %}`.mdb-label-placeholder`{% endmarkdown %} + .mdb-help + + + Any help text - + {% markdown %}Mark any help text next to an input with `.mdb-help` to gain behaviors such as showing upon focus.{% endmarkdown %} - - {% markdown %}TODO{% endmarkdown %} - - + @@ -146,12 +147,11 @@ Below is a complete list of options supported by Material Design for Bootstrap a ### Form groups The `.mdb-form-group` class is usually added to the `.form-group` element. Whereas the `.form-group` adds structure to forms by providing `margin-bottom` around a label and control pairing, - the only purpose of the `.mdb-form-group` is to demarcate Material Design behaviors. Decorations and size variations are intended to be specified on - this element e.g. `.mdb-label-floating`. Focus/hover styling for the label/input is determined based on the `.mdb-form-group`. + the only purpose of the `.mdb-form-group` is to demarcate Material Design behaviors for a combination of label/input. Focus/hover styling for the label/input is determined based on the `.mdb-form-group`. The `.mdb-form-group` is added automatically by javascript through basic discovery of the outer demarcation of the component defined by the Bootstrap standard markup. If your code is templated, you may want to add `.mdb-form-group` to the markup directly to prevent any rendering churn from the javascript determining -and adding the class to the markup. In custom situations, the javascript may not be able to properly resolve the location for the `.mdb-form-group`, so in rare cases +and adding the class to the markup. In custom situations, the javascript may not be able to properly resolve the location for the `.mdb-form-group`, so in rare or complex cases you may need to wrap your markup in an `.mdb-form-group` to get appropriate focus/hover behavior. {% example html %} diff --git a/docs/material-design/labels.md b/docs/material-design/labels.md index e79d7c08..19eb4c99 100644 --- a/docs/material-design/labels.md +++ b/docs/material-design/labels.md @@ -4,6 +4,56 @@ title: Labels group: material-design --- +Below is a complete list of `