JavaScript 和 CSS 已经并存了 20 多年。然而,在它们之间共享数据一直非常困难。当然,也有一些大型尝试。但是,我想到了一些简单直观的方法——不需要结构性改变,而是利用 CSS 自定义属性甚至 Sass 变量。
CSS 自定义属性和 JavaScript
在这里,自定义属性不应该让人感到意外。自从浏览器开始支持它们以来,它们一直能够与 JavaScript 协同工作,以 设置和操作值。
具体来说,我们可以通过几种方式在 JavaScript 中使用自定义属性。我们可以使用 setProperty
设置自定义属性的值。
document.documentElement.style.setProperty("--padding", 124 + "px"); // 124px
我们还可以使用 JavaScript 中的 getComputedStyle
检索 CSS 变量。其背后的逻辑相当简单:自定义属性是样式的一部分,因此它们也是计算样式的一部分。
getComputedStyle(document.documentElement).getPropertyValue('--padding') // 124px
getPropertyValue
也是类似的。它让我们可以从 HTML 标记中的内联样式中获取自定义属性值。
document.documentElement.style.getPropertyValue("--padding'"); // 124px
请注意,自定义属性是作用域化的。这意味着我们需要从特定元素获取计算样式。由于我们之前在 :root
中定义了我们的变量,因此我们在 HTML 元素上获取它们。
Sass 变量和 JavaScript
Sass 是一种预处理语言,这意味着它在成为网站的一部分之前会被转换为 CSS。因此,无法像 CSS 自定义属性那样(在 DOM 中作为计算样式访问)从 JavaScript 中访问它们。
我们需要修改构建过程来改变这一点。我怀疑在大多数情况下对此没有很大的需求,因为加载器通常已经是构建过程的一部分。但如果您的项目中并非如此,我们需要三个能够导入和转换 Sass 模块的模块。
以下是在 webpack 配置中的示例。
module.exports = {
// ...
module: {
rules: [
{
test: /\.scss$/,
use: ["style-loader", "css-loader", "sass-loader"]
},
// ...
]
}
};
为了使 Sass(或在这种情况下,具体来说是 SCSS)变量可供 JavaScript 使用,我们需要“导出”它们。
// variables.scss
$primary-color: #fe4e5e;
$background-color: #fefefe;
$padding: 124px;
:export {
primaryColor: $primary-color;
backgroundColor: $background-color;
padding: $padding;
}
:export
块是 webpack 用于导入变量的魔法。这种方法的优点是我们可以使用 camelCase 语法重命名变量并选择要公开的内容。
然后我们将 Sass 文件(variables.scss
)导入到 JavaScript 中,从而可以访问文件中定义的变量。
import variables from './variables.scss';
/*
{
primaryColor: "#fe4e5e"
backgroundColor: "#fefefe"
padding: "124px"
}
*/
document.getElementById("app").style.padding = variables.padding;
:export
语法有一些值得注意的限制。
- 它必须位于顶层,但可以在文件中的任何位置。
- 如果一个文件中有多个
:export
,则键和值会被合并并一起导出。 - 如果某个
exportedKey
重复,则最后一个(按源顺序)优先。 exportedValue
可以包含 CSS 声明值中有效的任何字符(包括空格)。exportedValue
不需要加引号,因为它已经被视为字面字符串。
在 JavaScript 中访问 Sass 变量有很多用途。我倾向于使用这种方法来共享断点。这是我的 breakpoints.scs
文件,稍后我会将其导入到 JavaScript 中,以便可以使用 matchMedia()
方法来保持断点的一致性。
// Sass variables that define breakpoint values
$breakpoints: (
mobile: 375px,
tablet: 768px,
// etc.
);
// Sass variables for writing out media queries
$media: (
mobile: '(max-width: #{map-get($breakpoints, mobile)})',
tablet: '(max-width: #{map-get($breakpoints, tablet)})',
// etc.
);
// The export module that makes Sass variables accessible in JavaScript
:export {
breakpointMobile: unquote(map-get($media, mobile));
breakpointTablet: unquote(map-get($media, tablet));
// etc.
}
动画是另一个用例。动画的持续时间通常存储在 CSS 中,但更复杂的动画需要借助 JavaScript 来完成。
// animation.scss
$global-animation-duration: 300ms;
$global-animation-easing: ease-in-out;
:export {
animationDuration: strip-unit($global-animation-duration);
animationEasing: $global-animation-easing;
}
请注意,我在导出变量时使用了自定义的 strip-unit
函数。这使我能够轻松地在 JavaScript 端解析内容。
// main.js
document.getElementById('image').animate([
{ transform: 'scale(1)', opacity: 1, offset: 0 },
{ transform: 'scale(.6)', opacity: .6, offset: 1 }
], {
duration: Number(variables.animationDuration),
easing: variables.animationEasing,
});
能够如此轻松地在 CSS、Sass 和 JavaScript 之间交换数据让我感到高兴。像这样共享变量使代码变得简单且 DRY。
当然,还有多种方法可以实现相同的效果。Les James 在 2017 年 分享了一种有趣的方法,该方法允许 Sass 和 JavaScript 通过 JSON 进行交互。我可能会有偏见,但我认为我们这里介绍的方法是最简单、最直观的方法。它不需要对您已经使用和编写 CSS 和 JavaScript 的方式进行疯狂的更改。
您可能在其他地方使用了其他方法吗?请在评论中分享——我很想了解您是如何解决这个问题的。
这太棒了。非常感谢。
太棒了!感谢分享。
哇,我以前不知道
:export
。这真的很有用。谢谢非常有用,谢谢
我在我的管道中使用 TailwindCSS,因此访问变量就像从设计系统中使用类或对主题对象的引用一样简单。Tailwind 配置的源是 json 文件,因此无需任何 Sass 复杂操作即可直接将其导入 js 中。
感谢分享。我卡住的地方是反向操作:从 SCSS 中访问 JavaScript 变量。我的客户希望在 JavaScript 中定义主题并在 SCSS 中访问主题值。
我发现关于此的讨论出奇地少。我尝试了 2018 年一篇相关文章中最有希望的基于 Webpack 的技术,但无法使其与最新的库一起使用。
您可以使用 CSS 变量来实现。
Javascript 可以将 CSS 变量分配给任何 DOM 节点。然后您可以在 CSS 中访问它。
我还想补充一点,如果您使用 Gatsby 并希望像上面所示使用
:export
导出 Sass 变量,它将在本地开发模式下工作,但在生产环境中由于 Gatsby 特定的原因而无法工作。简单的解决方法是将文件从variables.scss
重命名为variables.module.scss
。以modules.scss
结尾的文件的处理方式略有不同。一些上下文:https://github.com/gatsbyjs/gatsby/issues/3607#issuecomment-504879759
您好 Marko,感谢您撰写这篇内容丰富的文章!
我正在尝试查找
:export
语法的官方文档,但没有找到。这是 webpack 的功能吗?还是加载器的功能?如果您能指引我到官方文档,我将不胜感激。谢谢!
您好 Maxime,
这是由
css-loader
启用的。但实际上是 CSS 模块 的功能,以下是导出 文档 的确切链接。希望我回答了您的问题。
要将您的脚本添加到网页中,请尝试此 Chrome 扩展程序
https://chrome.google.com/webstore/detail/website-scripting/aggnfbkmhedkekjoplldenefbchaoiln
出于某种原因,如果您编写 Jest 测试并使用
:export
,则 Jest 运行时变量将未定义。这正是我需要的!我尝试了这个,但
variables
对象未定义,并且不包含我在:export
中定义的变量我的 scss 文件。任何帮助将不胜感激,非常感谢!