mirror/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-08-21 21:35:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

tocss: Add vars option

Browse Source 
This commit adds a new `vars` option to both the Sass transpilers (Dart Sass and Libsass).

This means that you can pass a map with key/value pairs to the transpiler:

```handlebars
{{ $vars := dict "$color1" "blue" "$color2" "green" "$font_size" "24px" }}
{{ $cssOpts := (dict "transpiler" "dartsass" "outputStyle" "compressed" "vars" $vars ) }}
{{ $r := resources.Get "scss/main.scss" |  toCSS $cssOpts }}
```

And the the variables will be available in the `hugo:vars` namespace. Example usage for Dart Sass:

```scss
@use "hugo:vars" as v;

p {
    color: v.$color1;
    font-size: v.$font_size;
}
```

Note that Libsass does not support the `use` keyword, so you need to `import` them as global variables:

```scss
@import "hugo:vars";

p {
    color: $color1;
    font-size: $font_size;
}
```

Hugo will:

* Add a missing leading `$` for the variable names if needed.
* Wrap the values in `unquote('VALUE')` (Sass built-in) to get proper handling of identifiers vs other strings.

This means that you can pull variables directly from e.g. the site config:

```toml
[params]
[params.sassvars]
color1 = "blue"
color2 = "green"
font_size = "24px"
image = "images/hero.jpg"
```

```handlebars
{{ $vars := site.Params.sassvars}}
{{ $cssOpts := (dict "transpiler" "dartsass" "outputStyle" "compressed" "vars" $vars ) }}
{{ $r := resources.Get "scss/main.scss" |  toCSS $cssOpts }}
```

Fixes #10555
This commit is contained in:
Bjørn Erik Pedersen
2022-12-19 18:49:02 +01:00
parent 9a215d6950
commit 41a080b268
7 changed files with 218 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
resources/resource_transformers/tocss/scss/integration_test.go
View File

@@ -25,6 +25,7 @@ import (
)
func TestTransformIncludePaths(t *testing.T) {
t.Parallel()
if !scss.Supports() {
t.Skip()
}
@@ -57,6 +58,7 @@ T1: {{ $r.Content }}
}
func TestTransformImportRegularCSS(t *testing.T) {
t.Parallel()
if !scss.Supports() {
t.Skip()
}
@@ -113,6 +115,7 @@ moo {
}
func TestTransformThemeOverrides(t *testing.T) {
t.Parallel()
if !scss.Supports() {
t.Skip()
}
@@ -175,6 +178,7 @@ zoo {
}
func TestTransformErrors(t *testing.T) {
t.Parallel()
if !scss.Supports() {
t.Skip()
}
@@ -245,3 +249,45 @@ T1: {{ $r.Content }}
})
}
func TestOptionVars(t *testing.T) {
t.Parallel()
if !scss.Supports() {
t.Skip()
}
files := `
-- assets/scss/main.scss --
@import "hugo:vars";
body {
body {
background: url($image) no-repeat center/cover;
}
}
p {
color: $color1;
font-size: var$font_size;
}
b {
color: $color2;
}
-- layouts/index.html --
{{ $image := "images/hero.jpg" }}
{{ $vars := dict "$color1" "blue" "$color2" "green" "font_size" "24px" "image" $image }}
{{ $cssOpts := (dict "transpiler" "libsass" "outputStyle" "compressed" "vars" $vars ) }}
{{ $r := resources.Get "scss/main.scss" | toCSS $cssOpts }}
T1: {{ $r.Content }}
`
b := hugolib.NewIntegrationTestBuilder(
hugolib.IntegrationTestConfig{
T: t,
TxtarString: files,
NeedsOsFS: true,
}).Build()
b.AssertFileContent("public/index.html", `T1: body body{background:url(images/hero.jpg) no-repeat center/cover}p{color:blue;font-size:var 24px}b{color:green}`)
}