Breaking Change: @import and global built-in functions
Originally, Sass used @import rules to load other files with a single global namespace, with all built-in functions also available globally. We’re deprecating both Sass @import rules and global built-in functions now that the module system (@use and @forward rules) has been available for several years.
@import causes numerous problems, requiring Sass members to be manually
namespaced to avoid conflicts, slowing down compilation when the same file is
imported more than once, and making it very difficult for both humans and tools
to tell where a given variable, mixin, or function comes from.
The module system fixes these problems and brings Sass’s modularity up to par
with the best practices of other modern languages, but we can’t get the full
benefits of it while @import remains in the language.
@import is now deprecated as of Dart Sass 1.80.0. Additionally, we’re also
deprecating the global versions of Sass built-in functions that are available
in sass: modules.
Transition PeriodTransition Period permalink
- Dart Sass
- since 1.80.0
- LibSass
- ✗
- Ruby Sass
- ✗
Sass @import rules and global built-in function calls now emit deprecation
warnings. While Dart Sass 2.0.0 will be released soon with various smaller
breaking changes, we don’t expect to remove Sass @import rules or global
built-in functions until Dart Sass 3.0.0, which will be released no sooner than
two years after Dart Sass 1.80.0.
Eventually, all @import rules will be treated as plain CSS @imports,
likely after an intermediate period where anything that used to be a Sass
@import throws an error.
Automatic MigrationAutomatic Migration permalink
You can use the Sass migrator to automatically update your stylesheets to use the module system.
$ npm install -g sass-migrator
$ sass-migrator module --migrate-deps your-entrypoint.scss
If you want to migrate away from global built-in functions, but aren’t yet
ready to fully migrate your @import rules, you can pass the --built-in-only
flag to migrate the functions while leaving @import rules as-is.
Migration RecipesMigration Recipes permalink
Nested ImportsNested Imports permalink
While @import can be used within CSS rules, @use has to be written at the
top level of a file (this is because each @used module’s CSS is only included
in the output once, so it wouldn’t make sense to allow it both in a nested
context and the top level). There are two ways to migrate nested @imports to
the module system:
-
The recommended way, which requires a little more up-front effort, is to wrap all the CSS emitted by your nested modules in mixins and
@includethose mixins in the nested context. This matches the way most other programming languages work, where each file defines a function or class that gets called by the files that use it, and it makes it very clear exactly how you expect that file to be used. It also makes it easier to add configuration, since you can just pass parameters or even@contentblocks to the mixin. -
A more direct translation is to use the
meta.load-css()mixin to directly load the module’s CSS where you want to use it. This is appropriate when you don’t have control over the file you’re loading to create a mixin wrapper. Note thatmeta.load-css()fully compiles the CSS before it does any nesting, so any parent selectors won’t "see" the rules outside themeta.load-css()call.
Configured ThemesConfigured Themes permalink
A pattern that people sometimes use with @import is to have a component
library full of partials that all use the same variables without explicitly
loading them, and then having several different "theme" entrypoints that define
different values for those variables to provide different visual themes. They
may either define the variables directly, or override defaults of a base theme
partial. As a simplified example:
SCSS Syntax
// components/_button.scss
button {
color: $text-color;
background-color: $background-color;
}
// _theme.scss
$text-color: black !default;
$background-color: white !default;
// dark.scss
$text-color: white;
$background-color: black;
@import "theme";
@import "components/button";
// More components are usually imported here.
Sass Syntax
// components/_button.scss
button
color: $text-color
background-color: $background-color
// _theme.scss
$text-color: black