WIP: Add dependencies to our Sass files

This commit is contained in:
Mark Otto 2020-09-29 21:42:22 -07:00
parent f927a95b6c
commit 614593c379
37 changed files with 350 additions and 32 deletions

View file

@ -1,3 +1,12 @@
// Dependencies
//
// _variables.scss
// _reboot.scss
// mixins/_alert.scss
// mixins/_border-radius.scss
// mixins/_gradient.scss
//
// Base styles
//

View file

@ -1,3 +1,14 @@
// Dependencies
//
// _variables.scss
// _reboot.scss
// mixins/_badge.scss
// mixins/_border-radius.scss
// mixins/_hover.scss
// mixins/_transition.scss
// vendor/_rfs.scss
// Base class
//
// Requires one of the contextual, color modifier classes for `color` and

View file

@ -1,3 +1,12 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// vendor/_rfs.scss
.breadcrumb {
display: flex;
flex-wrap: wrap;

View file

@ -1,3 +1,15 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _buttons.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// mixins/_hover.scss
// vendor/_rfs.scss
// stylelint-disable selector-no-qualifying-type
// Make the div behave like a button

View file

@ -1,3 +1,18 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _buttons.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// mixins/_buttons.scss
// mixins/_gradients.scss
// mixins/_hover.scss
// mixins/_transition.scss
// vendor/_rfs.scss
// stylelint-disable selector-no-qualifying-type
//

View file

@ -1,3 +1,13 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_breakpoints.scss
// mixins/_hover.scss
//
// Base styles
//

View file

@ -1,3 +1,13 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_clearfix.scss
// mixins/_hover.scss
// mixins/_transition.scss
// Notes on the classes:
//
// 1. .carousel.pointer-event should ideally be pan-y (to allow for users to scroll vertically)

View file

@ -1,3 +1,12 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_hover.scss
// vendor/_rfs.scss
.close {
float: right;
@include font-size($close-font-size);

View file

@ -1,3 +1,12 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_box-shadow.scss
// vendor/_rfs.scss
// Inline code
code {
@include font-size($code-font-size);

View file

@ -1,3 +1,16 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// mixins/_gradients.scss
// mixins/_hover.scss
// mixins/_transition.scss
// vendor/_rfs.scss
// Embedded icons from Open Iconic.
// Released under MIT and copyright 2014 Waybury.
// https://useiconic.com/open

View file

@ -1,3 +1,17 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// mixins/_breakpoints.scss
// mixins/_caret.scss
// mixins/_gradient.scss
// mixins/_nav-divider.scss
// vendor/_rfs.scss
// The dropdown wrapper (`<div>`)
.dropup,
.dropright,

View file

@ -1,3 +1,16 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// mixins/_breakpoints.scss
// mixins/_forms.scss
// mixins/_transition.scss
// vendor/_rfs.scss
// stylelint-disable selector-no-qualifying-type
//

View file

@ -2,6 +2,10 @@
//
// Utility mixins and functions for evaluating source code across our variables, maps, and mixins.
// Dependencies
//
// _variables.scss
// Ascending
// Used to evaluate Sass maps like our grid breakpoints.
@mixin _assert-ascending($map, $map-name) {

View file

@ -1,3 +1,13 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_breakpoints.scss
// mixins/_grid.scss
// mixins/_grid-framework.scss
// Container widths
//
// Set the container width, and override it for fixed navbars in media queries.

View file

@ -1,3 +1,14 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// mixins/_image.scss
// vendor/_rfs.scss
// Responsive images (ensure images don't scale beyond their parents)
//
// This is purposefully opt-in via an explicit class rather than being the default for all `<img>`s.

View file

@ -1,3 +1,16 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// _buttons.scss
// _forms.scss
// _custom-forms.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// vendor/_rfs.scss
// stylelint-disable selector-no-qualifying-type
//

View file

@ -1,3 +1,12 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_breakpoints.scss
// mixins/_border-radius.scss
.jumbotron {
padding: $jumbotron-padding ($jumbotron-padding / 2);
margin-bottom: $jumbotron-padding;

View file

@ -1,3 +1,14 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_breakpoints.scss
// mixins/_border-radius.scss
// mixins/_hover.scss
// mixins/_list-group.scss
// Base class
//
// Easily usable on <ul>, <ol>, or <div>.

View file

@ -1,3 +1,10 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
.media {
display: flex;
align-items: flex-start;

View file

@ -1,3 +1,15 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// _close.scss
// mixins/_breakpoints.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// mixins/_transition.scss
// .modal-open - body class for killing the scroll
// .modal - container to scroll within
// .modal-dialog - positioning shell for the actual modal

View file

@ -1,3 +1,12 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_hover.scss
// Base class
//
// Kickstart any navigation component with a set of style resets. Works with

View file

@ -1,3 +1,16 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// _nav.scss
// _grid.scss
// mixins/_border-radius.scss
// mixins/_breakpoints.scss
// mixins/_hover.scss
// vendor/_rfs.scss
// Contents
//
// Navbar

View file

@ -1,3 +1,15 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_breakpoints.scss
// mixins/_lists.scss
// mixins/_pagination.scss
// vendor/_rfs.scss
.pagination {
display: flex;
@include list-unstyled();

View file

@ -1,3 +1,14 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// mixins/_reset-text.scss
// vendor/_rfs.scss
.popover {
position: absolute;
top: 0;

View file

@ -1,3 +1,8 @@
// Dependencies
//
// _variables.scss
// stylelint-disable declaration-no-important, selector-no-qualifying-type
// Source: https://github.com/h5bp/main.css/blob/master/src/_print.css

View file

@ -1,3 +1,14 @@
// Dependencies
//
// _variables.scss
// mixins/_border-radius.scss
// mixins/_box-shadow.scss
// mixins/_gradients.scss
// mixins/_hover.scss
// mixins/_transition.scss
// vendor/_rfs.scss
// Disable animation if transitions are disabled
@if $enable-transitions {
@keyframes progress-bar-stripes {

View file

@ -1,3 +1,10 @@
// Dependencies
//
// _variables.scss
// mixins/_hover.scss
// vendor/_rfs.scss
// stylelint-disable at-rule-no-vendor-prefix, declaration-no-important, selector-no-qualifying-type, property-no-vendor-prefix
// Reboot

View file

@ -1,3 +1,8 @@
// Dependencies
//
// _variables.scss
// Do not forget to update getting-started/theming.md!
:root {
// Custom variable values only support SassScript inside `#{}`.

View file

@ -1,3 +1,10 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
//
// Rotating border
//

View file

@ -1,3 +1,14 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// mixins/_breakpoints.scss
// mixins/_table-row.scss
// vendor/_rfs.scss
//
// Basic Bootstrap table
//

View file

@ -1,3 +1,12 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_border-radius.scss
// vendor/_rfs.scss
.toast {
// Prevents from shrinking in IE11, when in a flex container
// See https://github.com/twbs/bootstrap/issues/28341

View file

@ -1,4 +1,17 @@
// Dependencies
//
// _variables.scss
// _functions.scss
// _reboot.scss
// mixins/_reset-text.scss
// mixins/_border-radius.scss
// vendor/_rfs.scss
//
// Base class
//
.tooltip {
position: absolute;
z-index: $zindex-tooltip;

View file

@ -1,3 +1,9 @@
// Dependencies
//
// _variables.scss
// mixins/_transition.scss
.fade {
@include transition($transition-fade);

View file

@ -1,3 +1,10 @@
// Dependencies
//
// _variables.scss
// mixins/_lists.scss
// vendor/_rfs.scss
// stylelint-disable declaration-no-important, selector-list-comma-newline-after
//

View file

@ -40,15 +40,14 @@ Skip the download with [BootstrapCDN](https://www.bootstrapcdn.com/) to deliver
{% highlight html %}
<link rel="stylesheet" href="{{ site.cdn.css }}" integrity="{{ site.cdn.css_hash }}" crossorigin="anonymous">
<script src="{{ site.cdn.js_bundle }}" integrity="{{ site.cdn.js_bundle_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.js }}" integrity="{{ site.cdn.js_hash }}" crossorigin="anonymous"></script>
{% endhighlight %}
If you're using our compiled JavaScript and prefer to include Popper.js separately, add Popper.js before our JS, via a CDN preferably.
If you're using our compiled JavaScript, don't forget to include jQuery and Popper.js, via a CDN preferably, before our JS.
{% highlight html %}
<script src="{{ site.cdn.jquery }}" integrity="{{ site.cdn.jquery_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.popper }}" integrity="{{ site.cdn.popper_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.js }}" integrity="{{ site.cdn.js_hash }}" crossorigin="anonymous"></script>
{% endhighlight %}
## Package managers

View file

@ -26,22 +26,9 @@ Copy-paste the stylesheet `<link>` into your `<head>` before all other styleshee
### JS
Many of our components require the use of JavaScript to function. Specifically, they require [jQuery](https://jquery.com/), [Popper.js](https://popper.js.org/), and our own JavaScript plugins. We use [jQuery's slim build](https://blog.jquery.com/2016/06/09/jquery-3-0-final-released/), but the full version is also supported.
Many of our components require the use of JavaScript to function. Specifically, they require [jQuery](https://jquery.com/), [Popper.js](https://popper.js.org/), and our own JavaScript plugins. Place the following `<script>`s near the end of your pages, right before the closing `</body>` tag, to enable them. jQuery must come first, then Popper.js, and then our JavaScript plugins.
Place **one of the following `<script>`s** near the end of your pages, right before the closing `</body>` tag, to enable them. jQuery must come first, then Popper.js, and then our JavaScript plugins.
#### Bundle
Include everything you need in one script with our bundle. Our `bootstrap.bundle.js` and `bootstrap.bundle.min.js` include [Popper](https://popper.js.org/), but not [jQuery](https://jquery.com/). For more information about what's included in Bootstrap, please see our [contents]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/contents/#precompiled-bootstrap) section.
{% highlight html %}
<script src="{{ site.cdn.jquery }}" integrity="{{ site.cdn.jquery_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.js_bundle }}" integrity="{{ site.cdn.js_bundle_hash }}" crossorigin="anonymous"></script>
{% endhighlight %}
#### Separate
If you decide to go with the separate scripts solution, Popper.js must come first, and then our JavaScript plugins.
We use [jQuery's slim build](https://blog.jquery.com/2016/06/09/jquery-3-0-final-released/), but the full version is also supported.
{% highlight html %}
<script src="{{ site.cdn.jquery }}" integrity="{{ site.cdn.jquery_hash }}" crossorigin="anonymous"></script>
@ -49,9 +36,9 @@ If you decide to go with the separate scripts solution, Popper.js must come firs
<script src="{{ site.cdn.js }}" integrity="{{ site.cdn.js_hash }}" crossorigin="anonymous"></script>
{% endhighlight %}
#### Components
Curious which components explicitly require jQuery, our JS, and Popper.js? Click the show components link below. If you're at all unsure about the general page structure, keep reading for an example page template.
Curious which components explicitly require jQuery, our JS, and Popper.js? Click the show components link below. If you're unsure about the page structure, keep reading for an example page template.
Our `bootstrap.bundle.js` and `bootstrap.bundle.min.js` include [Popper](https://popper.js.org/), but not [jQuery](https://jquery.com/). For more information about what's included in Bootstrap, please see our [contents]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/contents/#precompiled-bootstrap) section.
<details>
<summary class="text-primary mb-3">Show components requiring JavaScript</summary>
@ -90,17 +77,11 @@ Be sure to have your pages set up with the latest design and development standar
<body>
<h1>Hello, world!</h1>
<!-- Optional JavaScript; choose one of the two! -->
<!-- Option 1: jQuery and Bootstrap Bundle (includes Popper) -->
<script src="{{ site.cdn.jquery }}" integrity="{{ site.cdn.jquery_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.js_bundle }}" integrity="{{ site.cdn.js_bundle_hash }}" crossorigin="anonymous"></script>
<!-- Option 2: jQuery, Popper.js, and Bootstrap JS
<!-- Optional JavaScript -->
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script src="{{ site.cdn.jquery }}" integrity="{{ site.cdn.jquery_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.popper }}" integrity="{{ site.cdn.popper_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.js }}" integrity="{{ site.cdn.js_hash }}" crossorigin="anonymous"></script>
-->
</body>
</html>
{% endhighlight %}

View file

@ -61,18 +61,19 @@ gem install bootstrap -v {{ site.current_ruby_version }}
When you only need to include Bootstraps compiled CSS or JS, you can use <a href="https://www.bootstrapcdn.com/">BootstrapCDN</a>.
</p>
<p>
See it in action with our simple <a href="{{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/introduction/#starter-template">starter template</a>, or <a href="{{ site.baseurl }}/docs/{{ site.docs_version }}/examples/">browse the examples</a> to jumpstart your next project. You can also choose to include Popper.js and our JS <a href="{{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/introduction/#separate">separately</a>.
See it in action with our simple <a href="{{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/introduction/#starter-template">starter template</a>, or <a href="{{ site.baseurl }}/docs/{{ site.docs_version }}/examples/">browse the examples</a> to jumpstart your next project.
</p>
<a class="btn btn-lg btn-outline-primary mb-3" href="{{ site.baseurl }}/docs/{{ site.docs_version }}/layout/overview/">Explore the docs</a>
</div>
<div class="col-md-7 pl-md-5">
{% highlight html %}
<!-- CSS -->
<!-- CSS only -->
<link rel="stylesheet" href="{{ site.cdn.css }}" integrity="{{ site.cdn.css_hash }}" crossorigin="anonymous">
<!-- jQuery and JS bundle w/ Popper.js -->
<!-- JS, Popper.js, and jQuery -->
<script src="{{ site.cdn.jquery }}" integrity="{{ site.cdn.jquery_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.js_bundle }}" integrity="{{ site.cdn.js_bundle_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.popper }}" integrity="{{ site.cdn.popper_hash }}" crossorigin="anonymous"></script>
<script src="{{ site.cdn.js }}" integrity="{{ site.cdn.js_hash }}" crossorigin="anonymous"></script>
{% endhighlight %}
</div>
</div>