网站搜索

Jekyll 浅色和深色模式的实用指南


通过确保标记保留在 Sass/CSS 中、重用样式并覆盖一些 Bootstrap 5 默认值,可以实现浅色和深色模式。

<元字符集=“utf-8”>

在我的业余项目 www.fediverse.to 中添加明暗模式是一次有趣的旅程。我特别喜欢整个过程的直观性。 prefers-color-scheme CSS 属性包含用户的配色方案——浅色或深色。然后,我为两种模式定义 SASS 或 CSS 样式,浏览器将应用用户想要的样式。就是这样!从操作系统到浏览器再到网站的无缝流程对于用户和开发人员来说是一个巨大的胜利。

在修改了 www.fediverse.to 之后,我决定也向该网站添加浅色和深色模式。我开始在网上研究如何最好地解决这个问题。此 GitHub 线程显示了该功能的当前进度。这个深入的 POC 展示了这个过程的挑战性。

挑战

最大的挑战是有时 SASS 和 CSS 不能很好地配合。

让我解释。

从我之前关于浅色和深色主题的文章来看,要创建这两种样式,我需要像这样定义 CSS:

/* Light mode */
:root {
   --body-bg: #FFFFFF;
   --body-color: #000000;
}

/* Dark mode */
@media (prefers-color-scheme: dark) {
   :root {
       --body-bg: #000000;
       --body-color: #FFFFFF;
   }
}

这很简单。定义样式后,我在 CSS 中使用 var(--body-bg) 和 var(--body-color)。根据prefers-color-scheme的值切换的颜色。

Bootstrap 5 使用 Sass 来定义颜色值。我的网站在 _variables.scss 中的配色方案如下所示:

// User-defined colors
$my-link-color: #FFCCBB !default;
$my-text-color: #E2E8E4 !default;
$my-bg-color: #303C6C;

现在解决方案似乎很明显了,对吧?我可以将 prefers-color-scheme 与上面的变量结合起来,然后繁荣!

// User-defined colors
:root {
 --my-link-color: #FFCCBB;
 --my-text-color: #E2E8E4;
 --my-bg-color: #303C6C;
}

/* Dark mode */
@media (prefers-color-scheme: dark) {
 :root {
 --my-link-color: #FF0000;
 --my-text-color: #FFFFFF;
 --my-bg-color: #000000;
  }
}

此外,我需要将 $ 值替换为 _variables.scss 中的 -- 变体。进行更改并运行 jekyll build 后,我得到以下信息:

Conversion error: Jekyll::Converters::Scss encountered an error while converting 'css/main.scss':
                    Error: argument `$color2` of `mix($color1, $color2, $weight: 50%)` must be a color on line 161:11 of _sass/_functions.scss, in function `mix` from line 161:11 of _sass/_functions.scss, in function `shade-color` from line 166:27 of _sass/_functions.scss, in function `if` from line 166:11 of _sass/_functions.scss, in function `shift-color` from line 309:43 of _sass/_variables.scss from line 11:9 of _sass/bootstrap.scss from line 1:9 of stdin >> @return mix(black, $color, $weight); ----------^ 
             Error: Error: argument `$color2` of `mix($color1, $color2, $weight: 50%)` must be a color on line 161:11 of _sass/_functions.scss, in function `mix` from line 161:11 of _sass/_functions.scss, in function `shade-color` from line 166:27 of _sass/_functions.scss, in function `if` from line 166:11 of _sass/_functions.scss, in function `shift-color` from line 309:43 of _sass/_variables.scss from line 11:9 of _sass/bootstrap.scss from line 1:9 of stdin >> @return mix(black, $color, $weight); ----------^ 
             Error: Run jekyll build --trace for more information.

该错误意味着 Bootstrap mixin 期望颜色值是颜色值,而不是 CSS 变量。从这里开始,深入研究 Bootstrap 代码来重写 mixin。但我必须重写大部分 Bootstrap 才能使其正常工作。本页描述了此时可用的大多数选项。但我能够用更简单的方法凑合。

由于我没有使用整个 Bootstrap 功能套件,因此我能够通过组合 prefers-color-scheme、一些 CSS 覆盖和一些代码重复来添加浅色和深色模式。

第 1 步:将演示与结构分开

在应用新样式来处理浅色和深色模式之前,我对 HTML 和 CSS 进行了一些清理。

第一步是确保所有表示层内容都在 CSS 中而不是 HTML 中。表示标记 (CSS) 应始终与页面结构 (HTML) 分开。但随着时间的推移,网站的源代码可能会变得混乱。如果您的颜色类已经分离到 CSS 中,您可以跳过此步骤。

我发现我的 HTML 代码中充满了 Bootstrap 颜色类。某些 div 和 footer 标记使用了 text-light、text-dark、bg-light HTML 中的strong> 和bg-dark。由于处理浅色和深色主题依赖于 CSS,因此必须取消颜色类。因此,我将它们全部从 HTML 移至我的自定义 SASS 文件中。

我保留了上下文颜色类(bg-primary、bg-warning、text-muted 等)原样。我为浅色和深色主题选择的颜色不会干扰它们。确保您的主题颜色与上下文颜色配合良好。否则,您也应该将它们移至 CSS 中。

到目前为止,我已经在这个网站上写了 100 多篇文章。因此,我必须扫描 _posts/ 目录下的所有帖子,寻找颜色类别。与上面的步骤一样,确保将所有颜色类移至 CSS 中。不要忘记检查 Jekyll 集合和页面。

第 2 步:尽可能整合样式

整合和重用样式元素可确保您减少后顾之忧。主页上的我的项目和特色写作部分显示了类似卡片的布局。它们使用自己的自定义 CSS 样式。我重新设计了它们以匹配文章链接,现在我不用担心了。

还有其他几个元素使用自己的样式。我没有重新设计它们,而是选择删除它们。

例如,页脚使用自己的背景颜色。这需要两种不同的颜色来表示浅色和深色主题。我选择从页脚中删除背景以简化迁移。页脚现在采用背景颜色。

如果您的网站使用了太多样式,则在迁移时删除它们可能是明智的做法。移至浅色/深色主题完成后,您可以将它们添加回来。

目标是保持迁移简单,并在需要时添加新样式。

步骤 3:添加浅色和深色配色方案

清理完成后,我现在可以专注于添加浅色和深色主题的样式元素。我定义了新的颜色样式并将它们应用到 HTML 元素。我选择从以下几方面入手:

  1. --body-bg 用于背景颜色。
  2. --body-color 用于主体/文本颜色。
  3. --body-link-color 用于链接。
  4. --card-bg 用于 Bootstrap Card 背景颜色。
:root {
 --body-bg: #EEE2DC;
 --body-color: #AC3B61;
 --body-link-color: #AC3B61;
 --card-bg: #EDC7B7;
}

/* Dark mode */
@media (prefers-color-scheme: dark) {
 :root {
 --body-bg: #303C6C;
 --body-color: #E2E8E4;
 --body-link-color: #FFCCBB;
 --card-bg: #212529;
  }
}

定义颜色后,我更改了 CSS 以使用新颜色。例如,body 元素现在如下所示:

body {
 background-color: var(--body-bg);
 color: var(--body-color) !important;
}

您可以在 GitLab 上查看其余的 CSS 更改。

如果 Bootstrap 5 是使用您的 Jekyll 源而不是来自 CDN 编译的,您可以覆盖 Bootstrap 5 默认值。这对于简化您需要处理的自定义样式可能有意义。例如,关闭链接装饰让我的生活变得更轻松一些。

$link-hover-decoration: none !default;

第 4 步:导航栏切换器

最后但并非最不重要的一点是:导航栏切换器。在 Bootstrap 5 中,navbar-light 和 navbar-dark 控制切换器的颜色。这些在主要的 nav 元素和 .navbar 中定义。由于我不再在 HTML 中硬编码颜色类,因此我需要复制 CSS。我扩展了默认的 Sass 并添加了我的主题颜色。

.navbar-toggler {
  @extend .navbar-toggler;
  color: var(--text-color);
  border-color: var(--text-color);
}

.navbar-toggler-icon {
  @extend .navbar-toggler-icon;
  background-image: escape-svg(url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 30 30'><path stroke='#000000' stroke-linecap='round' stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/></svg>"));
}

上面的代码是默认的 Bootstrap 5 切换器 CSS 代码,有一些细微的更改。这里需要注意的一件事:对于切换器图标,我硬编码了 lines= #000000 因为黑色适合我的主题颜色。您可能需要更有创意地选择全面有效的配色方案。

(阿尤什·夏尔马,CC BY-SA 4.0)

就是这样!浅色和深色模式现在可以按预期工作!

(阿尤什·夏尔马,CC BY-SA 4.0)

(阿尤什·夏尔马,CC BY-SA 4.0)

(阿尤什·夏尔马,CC BY-SA 4.0)

(阿尤什·夏尔马,CC BY-SA 4.0)

包起来

至少可以说,Bootstrap 5 很复杂。当用自定义样式覆盖它时,需要考虑很多事情。为每个 Bootstrap 5 组件提供浅色和深色变体很困难,但如果您没有太多组件需要处理,这是可能的。

通过确保标记保留在 Sass/CSS 中、重用样式并覆盖一些 Bootstrap 5 默认值,可以实现浅色和深色模式。这不是一个全面的方法,但在 Bootstrap 5 决定提供此功能之前,它是实用且可用的。

我希望这能为您提供有关如何向自己的网站添加浅色和深色主题的更多实用想法。如果您找到更好的方法来使用自己的 CSS 魔法,请不要忘记与社区分享。

快乐编码:)

本文最初出现在作者的博客上,并已获得许可重新发布。

相关文章: