Sass

利用我们的源 Sass 文件来利用变量、映射、mixins 和函数来帮助您更快地构建和自定义项目。

当前页

利用我们的源 Sass 文件来利用变量、映射、混合等。

文件结构

尽可能避免修改 Bootstrap 的核心文件。对于 Sass 来说，这意味着创建自己的样式表来导入 Bootstrap，以便您可以修改和扩展它。假设你使用的是像 npm 这样的包管理器，你将有一个如下所示的文件结构：

your-project/
├── scss
│   └── custom.scss
└── node_modules/
    └── bootstrap
        ├── js
        └── scss

如果您已经下载了我们的源文件并且没有使用包管理器，则需要手动创建类似于该结构的内容，将 Bootstrap 的源文件与您自己的文件分开。

your-project/
├── scss
│   └── custom.scss
└── bootstrap/
    ├── js
    └── scss

Importing

在custom.scss中，您将导入 Bootstrap 的源 Sass 文件。您有两个选择：包括所有 Bootstrap，或选择您需要的部分。我们鼓励后者，但请注意，我们的组件之间存在一些要求和依赖关系。您还需要为我们的插件包含一些JavaScript。

// Custom.scss
// Option A: Include all of Bootstrap

// Include any default variable overrides here (though functions won't be available)

@import "../node_modules/bootstrap/scss/bootstrap";

// Then add additional custom code here

// Custom.scss
// Option B: Include parts of Bootstrap

// 1. Include functions first (so you can manipulate colors, SVGs, calc, etc)
@import "../node_modules/bootstrap/scss/functions";

// 2. Include any default variable overrides here

// 3. Include remainder of required Bootstrap stylesheets (including any separate color mode stylesheets)
@import "../node_modules/bootstrap/scss/variables";
@import "../node_modules/bootstrap/scss/variables-dark";

// 4. Include any default map overrides here

// 5. Include remainder of required parts
@import "../node_modules/bootstrap/scss/maps";
@import "../node_modules/bootstrap/scss/mixins";
@import "../node_modules/bootstrap/scss/root";

// 6. Optionally include any other parts as needed
@import "../node_modules/bootstrap/scss/utilities";
@import "../node_modules/bootstrap/scss/reboot";
@import "../node_modules/bootstrap/scss/type";
@import "../node_modules/bootstrap/scss/images";
@import "../node_modules/bootstrap/scss/containers";
@import "../node_modules/bootstrap/scss/grid";
@import "../node_modules/bootstrap/scss/helpers";

// 7. Optionally include utilities API last to generate classes based on the Sass map in `_utilities.scss`
@import "../node_modules/bootstrap/scss/utilities/api";

// 8. Add additional custom code here

完成该设置后，您可以开始修改 custom.scss中的任何 Sass 变量和映射。您还可以根据需要在// Optional部分下开始添加 Bootstrap 的各个部分。我们建议使用bootstrap.scss文件中的完整导入堆栈作为起点。

变量默认值

Bootstrap 中的每个 Sass 变量都包含 !default 标志，允许您在自己的 Sass 中覆盖变量的默认值，而无需修改 Bootstrap 的源代码。根据需要复制和粘贴变量，修改其值，并删除!default标志。如果已分配变量，则不会通过 Bootstrap 中的默认值重新分配该变量。

您可以在scss/_variables.scss中找到Bootstrap变量的完整列表。某些变量设置为null，除非在配置中覆盖这些变量，否则这些变量不会输出属性。

变量覆盖必须在导入函数之后，但在其余导入之前。

下面是一个通过 npm 导入和编译 Bootstrap 时更改<body>的background-color 和color的示例：

// Required
@import "../node_modules/bootstrap/scss/functions";

// Default variable overrides
$body-bg: #000;
$body-color: #111;

// Required
@import "../node_modules/bootstrap/scss/variables";
@import "../node_modules/bootstrap/scss/variables-dark";
@import "../node_modules/bootstrap/scss/maps";
@import "../node_modules/bootstrap/scss/mixins";
@import "../node_modules/bootstrap/scss/root";

// Optional Bootstrap components here
@import "../node_modules/bootstrap/scss/reboot";
@import "../node_modules/bootstrap/scss/type";
// etc

根据需要对Bootstrap中的任何变量重复此操作，包括下面的全局选项。

通过 npm 通过我们的入门项目开始使用 Bootstrap！ 前往 Sass & JS example模板存储库，了解如何在您自己的 npm 项目中构建和自定义 Bootstrap。包括 Sass 编译器、Autoprefixer、Stylelint、PurgeCSS 和 Bootstrap 图标。

映射和循环

Bootstrap 包括一些 Sass 映射，这些键值对可以更轻松地生成相关 CSS 族。我们将 Sass 映射用于颜色、网格断点等。就像 Sass 变量一样，所有 Sass 映射都包含 !default标志，并且可以被覆盖和扩展。

默认情况下，我们的一些 Sass 映射会合并到空映射中。这样做是为了允许轻松扩展给定的 Sass 映射，但代价是从映射中删除项目稍微困难一些。

修改映射

$theme-colors映射中的所有变量都定义为独立变量。要修改$theme-colors映射中的现有颜色，请将以下内容添加到自定义 Sass 文件中：

$primary: #0074d9;
$danger: #ff4136;

稍后，这些变量将在 Bootstrap 的$theme-colors映射中设置：

$theme-colors: (
  "primary": $primary,
  "danger": $danger
);

添加到映射

通过创建自定义值的新 Sass 映射并将其与原始映射合并，将新颜色添加到$theme-colors或任何其他映射。在本例中，我们将创建一个新的$custom-colors映射，并将其与$theme-colors合并。

// Create your own map
$custom-colors: (
  "custom-color": #900
);

// Merge the maps
$theme-colors: map-merge($theme-colors, $custom-colors);

从映射中删除

要从$theme-colors或任何其他映射中删除颜色，请使用 map-remove。请注意，您必须在我们的要求之间插入$theme-colors，就在它在variables 中的定义之后和在“映射”中使用之前：

// Required
@import "../node_modules/bootstrap/scss/functions";
@import "../node_modules/bootstrap/scss/variables";
@import "../node_modules/bootstrap/scss/variables-dark";

$theme-colors: map-remove($theme-colors, "info", "light", "dark");

@import "../node_modules/bootstrap/scss/maps";
@import "../node_modules/bootstrap/scss/mixins";
@import "../node_modules/bootstrap/scss/root";

// Optional
@import "../node_modules/bootstrap/scss/reboot";
@import "../node_modules/bootstrap/scss/type";
// etc

必需的键

Bootstrap 假设 Sass 映射中存在一些特定的键，因为我们使用了这些键，并自己扩展了这些键。自定义包含的映射时，在使用特定 Sass 映射的密钥时可能会遇到错误。

例如，我们使用$theme-colors中的primary、success和danger键来表示链接、按钮和表单状态。替换这些键的值应该不会出现问题，但删除它们可能会导致 Sass 编译问题。在这些情况下，需要修改使用这些值的 Sass 代码。

函数

颜色

在我们拥有的 Sass maps 旁边，主题颜色也可以用作独立变量，例如$primary。

.custom-element {
  color: $gray-100;
  background-color: $dark;
}

您可以使用 Bootstrap 的tint-color()和 shade-color()函数使颜色变亮或变暗。这些函数会将颜色与黑色或白色混合，这与 Sass 的原生lighten()和 darken()函数不同，后者会以固定的量改变亮度，这通常不会产生所需的效果。

scss/_functions.scss

// Tint a color: mix a color with white
@function tint-color($color, $weight) {
  @return mix(white, $color, $weight);
}

// Shade a color: mix a color with black
@function shade-color($color, $weight) {
  @return mix(black, $color, $weight);
}

// Shade the color if the weight is positive, else tint it
@function shift-color($color, $weight) {
  @return if($weight > 0, shade-color($color, $weight), tint-color($color, -$weight));
}

实际上，您将调用该函数并传入颜色和粗细参数。

.custom-element {
  color: tint-color($primary, 10%);
}

.custom-element-2 {
  color: shade-color($danger, 30%);
}

颜色对比度

为了满足 Web 内容可访问性指南（WCAG）对比度要求，作者必须提供最低文本颜色对比度为 4.5：1和最低非文本颜色对比度为 3：1，只有极少数例外。

为了帮助解决这个问题，我们在 Bootstrap 中包含了 color-contrast功能。它使用 WCAG 对比度算法根据sRGB色彩空间中的相对亮度计算对比度阈值，以根据指定的基色自动返回浅色（#fff）、暗色（#212529）或黑色（#000）对比度。此函数对于生成多个类的混合或循环特别有用。

例如，要从我们的 $theme-colors映射生成色板：

For example, to generate color swatches from our $theme-colors map:

@each $color, $value in $theme-colors {
  .swatch-#{$color} {
    color: color-contrast($value);
  }
}

它还可用于一次性对比度需求：

.custom-element {
  color: color-contrast(#000); // returns `color: #fff`
}

您还可以使用我们的色彩映射表函数指定基色：

.custom-element {
  color: color-contrast($dark); // returns `color: #fff`
}

转义 SVG

我们使用escape-svg函数来转义SVG背景图像的<，>和#字符。使用escape-svg函数时，数据 URI 必须用引号括起来。

加减函数

我们使用 add和subtract函数来包装CSScalc函数。这些函数的主要目的是避免将“无单位”0值传递到calc表达式时出错。像calc(10px - 0)这样的表达式将在所有浏览器中返回错误，尽管在数学上是正确的。

计算有效的示例：

$border-radius: .25rem;
$border-width: 1px;

.element {
  // Output calc(.25rem - 1px) is valid
  border-radius: calc($border-radius - $border-width);
}

.element {
  // Output the same calc(.25rem - 1px) as above
  border-radius: subtract($border-radius, $border-width);
}

计算无效的示例：

$border-radius: .25rem;
$border-width: 0;

.element {
  // Output calc(.25rem - 0) is invalid
  border-radius: calc($border-radius - $border-width);
}

.element {
  // Output .25rem
  border-radius: subtract($border-radius, $border-width);
}

Mixins

我们的scss/mixins/ 目录有大量的mixin，它们为Bootstrap的各个部分提供支持，也可以在您自己的项目中使用。

配色方案

prefers-color-scheme媒体查询的速记混合支持light、dark和自定义配色方案。有关我们的颜色模式混合的信息，请参阅颜色模式文档。

scss/mixins/_color-scheme.scss

@mixin color-scheme($name) {
  @media (prefers-color-scheme: #{$name}) {
    @content;
  }
}

.custom-element {
  @include color-scheme(dark) {
    // Insert dark mode styles here
  }

  @include color-scheme(custom-named-scheme) {
    // Insert custom color scheme styles here
  }
}