sass:map

Dart Sass: 自 1.23.0 起
LibSass: ✗
Ruby Sass: ✗

目前只有 Dart Sass 支持使用 @use 加载内置模块。其他实现的使用者必须使用其全局名称调用函数。

💡 趣事

Sass 库和设计系统倾向于共享和覆盖以嵌套映射 (包含包含映射的映射) 表示的配置。

为了帮助您处理嵌套映射，一些映射函数支持深度操作。例如，如果您将多个键传递给 map.get()，它将按照这些键找到所需的嵌套映射。

SCSS

Sass

     游乐场SCSS 语法@use "sass:map";

$config: (a: (b: (c: d)));
@debug map.get($config, a, b, c); // d

     游乐场Sass 语法@use "sass:map"

$config: (a: (b: (c: d)))
@debug map.get($config, a, b, c) // d

map.deep-merge($map1, $map2) //=> map

Dart Sass: 自 1.27.0 起
LibSass: ✗
Ruby Sass: ✗

与 map.merge() 相同，不同之处在于嵌套映射值也递归地合并。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$helvetica-light: (
  "weights": (
    "lightest": 100,
    "light": 300
  )
);
$helvetica-heavy: (
  "weights": (
    "medium": 500,
    "bold": 700
  )
);

@debug map.deep-merge($helvetica-light, $helvetica-heavy);
// (
//   "weights": (
//     "lightest": 100,
//     "light": 300,
//     "medium": 500,
//     "bold": 700
//   )
// )
@debug map.merge($helvetica-light, $helvetica-heavy);
// (
//   "weights": (
//     "medium: 500,
//     "bold": 700
//   )
// )

       游乐场Sass 语法@use "sass:map"

$helvetica-light: ("weights": ("lightest": 100, "light": 300))
$helvetica-heavy: ("weights": ("medium": 500, "bold": 700))

@debug map.deep-merge($helvetica-light, $helvetica-heavy)
// (
//   "weights": (
//     "lightest": 100,
//     "light": 300,
//     "medium": 500,
//     "bold": 700
//   )
// )
@debug map.merge($helvetica-light, $helvetica-heavy);
// (
//   "weights": (
//     "medium: 500,
//     "bold": 700
//   )
// )

map.deep-remove($map, $key, $keys...) //=> map

Dart Sass: 自 1.27.0 起
LibSass: ✗
Ruby Sass: ✗

如果 $keys 为空，则返回 $map 的副本，但没有与 $key 关联的值。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$font-weights: ("regular": 400, "medium": 500, "bold": 700);

@debug map.deep-remove($font-weights, "regular");
// ("medium": 500, "bold": 700)

       游乐场Sass 语法@use "sass:map"

$font-weights: ("regular": 400, "medium": 500, "bold": 700)

@debug map.deep-remove($font-weights, "regular")
// ("medium": 500, "bold": 700)

如果 $keys 不为空，则从左到右遵循包括 $key 但不包括 $keys 中最后一个键的键集，以找到目标更新的嵌套映射。

返回 $map 的副本，其中目标映射没有与 $keys 中最后一个键关联的值。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$fonts: (
  "Helvetica": (
    "weights": (
      "regular": 400,
      "medium": 500,
      "bold": 700
    )
  )
);

@debug map.deep-remove($fonts, "Helvetica", "weights", "regular");
// (
//   "Helvetica": (
//     "weights: (
//       "medium": 500,
//       "bold": 700
//     )
//   )
// )

       游乐场Sass 语法@use "sass:map"

$fonts: ("Helvetica": ("weights": ("regular": 400, "medium": 500, "bold": 700)))

@debug map.deep-remove($fonts, "Helvetica", "weights", "regular")
// (
//   "Helvetica": (
//     "weights: (
//       "medium": 500,
//       "bold": 700
//     )
//   )
// )

map.get($map, $key, $keys...)
map-get($map, $key, $keys...)

如果 $keys 为空，则返回 $map 中与 $key 关联的值。

如果 $map 没有与 $key 关联的值，则返回 null。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";
$font-weights: ("regular": 400, "medium": 500, "bold": 700);

@debug map.get($font-weights, "medium"); // 500
@debug map.get($font-weights, "extra-bold"); // null

       游乐场Sass 语法@use "sass:map"
$font-weights: ("regular": 400, "medium": 500, "bold": 700)

@debug map.get($font-weights, "medium")  // 500
@debug map.get($font-weights, "extra-bold")  // null

Dart Sass: 自 1.27.0 起
LibSass: ✗
Ruby Sass: ✗

只有 Dart Sass 支持使用超过两个参数调用 map.get()。

如果 $keys 不为空，则从左到右遵循包括 $key 但不包括 $keys 中最后一个键的键集，以找到目标搜索的嵌套映射。

返回目标映射中与 $keys 中最后一个键关联的值。

如果映射没有与键关联的值，或者 $keys 中的任何键在映射中缺失或引用不是映射的值，则返回 null。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$fonts: (
  "Helvetica": (
    "weights": (
      "regular": 400,
      "medium": 500,
      "bold": 700
    )
  )
);

@debug map.get($fonts, "Helvetica", "weights", "regular"); // 400
@debug map.get($fonts, "Helvetica", "colors"); // null

       游乐场Sass 语法@use "sass:map"

$fonts: ("Helvetica": ("weights": ("regular": 400, "medium": 500, "bold": 700)))

@debug map.get($fonts, "Helvetica", "weights", "regular") // 400
@debug map.get($fonts, "Helvetica", "colors") // null

map.has-key($map, $key, $keys...)
map-has-key($map, $key, $keys...) //=> boolean

如果 $keys 为空，则返回 $map 是否包含与 $key 关联的值。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$font-weights: ("regular": 400, "medium": 500, "bold": 700);

@debug map.has-key($font-weights, "regular"); // true
@debug map.has-key($font-weights, "bolder"); // false

       游乐场Sass 语法@use "sass:map"

$font-weights: ("regular": 400, "medium": 500, "bold": 700)

@debug map.has-key($font-weights, "regular") // true
@debug map.has-key($font-weights, "bolder") // false

Dart Sass: 自 1.27.0 起
LibSass: ✗
Ruby Sass: ✗

只有 Dart Sass 支持使用超过两个参数调用 map.has-key()。

如果 $keys 不为空，则从左到右遵循包括 $key 但不包括 $keys 中最后一个键的键集，以找到目标搜索的嵌套映射。

如果目标映射包含与 $keys 中最后一个键关联的值，则返回 true。

如果它不包含，或者 $keys 中的任何键在映射中缺失或引用不是映射的值，则返回 false。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$fonts: (
  "Helvetica": (
    "weights": (
      "regular": 400,
      "medium": 500,
      "bold": 700
    )
  )
);

@debug map.has-key($fonts, "Helvetica", "weights", "regular"); // true
@debug map.has-key($fonts, "Helvetica", "colors"); // false

       游乐场Sass 语法@use "sass:map"

$fonts: ("Helvetica": ("weights": ("regular": 400, "medium": 500, "bold": 700)))

@debug map.has-key($fonts, "Helvetica", "weights", "regular") // true
@debug map.has-key($fonts, "Helvetica", "colors") // false

map.keys($map)
map-keys($map) //=> list

返回 $map 中所有键的逗号分隔列表。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$font-weights: ("regular": 400, "medium": 500, "bold": 700);

@debug map.keys($font-weights); // "regular", "medium", "bold"

       游乐场Sass 语法@use "sass:map"

$font-weights: ("regular": 400, "medium": 500, "bold": 700)

@debug map.keys($font-weights)  // "regular", "medium", "bold"

map.merge($map1, $map2)
map-merge($map1, $map2)
map.merge($map1, $keys..., $map2)
map-merge($map1, $keys..., $map2) //=> map

⚠️ 注意！

实际上，传递给 map.merge($map1, $keys..., $map2) 的实际参数被传递为 map.merge($map1, $args...)。它们在此处被描述为 $map1, $keys..., $map2，仅用于解释目的。

如果没有传递 $keys，则返回一个新映射，其中包含来自 $map1 和 $map2 的所有键和值。

如果 $map1 和 $map2 都具有相同的键，则 $map2 的值优先。

返回的映射中所有也出现在 $map1 中的键的顺序与 $map1 中的顺序相同。来自 $map2 的新键出现在映射的末尾。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$light-weights: ("lightest": 100, "light": 300);
$heavy-weights: ("medium": 500, "bold": 700);

@debug map.merge($light-weights, $heavy-weights);
// ("lightest": 100, "light": 300, "medium": 500, "bold": 700)

       游乐场Sass 语法@use "sass:map"

$light-weights: ("lightest": 100, "light": 300)
$heavy-weights: ("medium": 500, "bold": 700)

@debug map.merge($light-weights, $heavy-weights)
// ("lightest": 100, "light": 300, "medium": 500, "bold": 700)

Dart Sass: 自 1.27.0 起
LibSass: ✗
Ruby Sass: ✗

只有 Dart Sass 支持使用超过两个参数调用 map.merge()。

如果 $keys 不为空，则遵循 $keys 以找到目标合并的嵌套映射。如果 $keys 中的任何键在映射中缺失或引用不是映射的值，则将该键的值设置为一个空映射。

返回 $map1 的副本，其中目标映射被一个包含目标映射和 $map2 的所有键和值的新的映射替换。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$fonts: (
  "Helvetica": (
    "weights": (
      "lightest": 100,
      "light": 300
    )
  )
);
$heavy-weights: ("medium": 500, "bold": 700);

@debug map.merge($fonts, "Helvetica", "weights", $heavy-weights);
// (
//   "Helvetica": (
//     "weights": (
//       "lightest": 100,
//       "light": 300,
//       "medium": 500,
//       "bold": 700
//     )
//   )
// )

       游乐场Sass 语法@use "sass:map"

$fonts: ("Helvetica": ("weights": ("lightest": 100, "light": 300)))
$heavy-weights: ("medium": 500, "bold": 700)

@debug map.merge($fonts, "Helvetica", "weights", $heavy-weights)
// (
//   "Helvetica": (
//     "weights": (
//       "lightest": 100,
//       "light": 300,
//       "medium": 500,
//       "bold": 700
//     )
//   )
// )

map.remove($map, $keys...)
map-remove($map, $keys...) //=> map

返回 $map 的副本，其中不包含与 $keys 关联的任何值。

如果 $keys 中的键在 $map 中没有关联的值，则忽略它。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$font-weights: ("regular": 400, "medium": 500, "bold": 700);

@debug map.remove($font-weights, "regular"); // ("medium": 500, "bold": 700)
@debug map.remove($font-weights, "regular", "bold"); // ("medium": 500)
@debug map.remove($font-weights, "bolder");
// ("regular": 400, "medium": 500, "bold": 700)

       游乐场Sass 语法@use "sass:map"

$font-weights: ("regular": 400, "medium": 500, "bold": 700)

@debug map.remove($font-weights, "regular")  // ("medium": 500, "bold": 700)
@debug map.remove($font-weights, "regular", "bold")  // ("medium": 500)
@debug map.remove($font-weights, "bolder")
// ("regular": 400, "medium": 500, "bold": 700)

map.set($map, $key, $value)
map.set($map, $keys..., $key, $value) //=> map

⚠️ 注意！

实际上，传递给 map.set($map, $keys..., $key, $value) 的实际参数被传递为 map.set($map, $args...)。它们在此处被描述为 $map, $keys..., $key, $value，仅用于解释目的。

如果未传递 $keys，则返回 $map 的副本，其中 $key 处的 value 设置为 $value。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$font-weights: ("regular": 400, "medium": 500, "bold": 700);

@debug map.set($font-weights, "regular", 300);
// ("regular": 300, "medium": 500, "bold": 700)

       游乐场Sass 语法@use "sass:map"

$font-weights: ("regular": 400, "medium": 500, "bold": 700)

@debug map.set($font-weights, "regular", 300)
// ("regular": 300, "medium": 500, "bold": 700)

Dart Sass: 自 1.27.0 起
LibSass: ✗
Ruby Sass: ✗

只有 Dart Sass 支持使用超过三个参数调用 map.set()。

如果传递了 $keys，则遵循 $keys 以找到目标更新的嵌套映射。如果 $keys 中的任何键在映射中缺失或引用不是映射的值，则将该键的值设置为一个空映射。

返回 $map 的副本，其中目标映射在 $key 处的 value 设置为 $value。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$fonts: (
  "Helvetica": (
    "weights": (
      "regular": 400,
      "medium": 500,
      "bold": 700
    )
  )
);

@debug map.set($fonts, "Helvetica", "weights", "regular", 300);
// (
//   "Helvetica": (
//     "weights": (
//       "regular": 300,
//       "medium": 500,
//       "bold": 700
//     )
//   )
// )

       游乐场Sass 语法@use "sass:map"

$fonts: ("Helvetica": ("weights": ("regular": 400, "medium": 500, "bold": 700)))

@debug map.set($fonts, "Helvetica", "weights", "regular", 300)
// (
//   "Helvetica": (
//     "weights": (
//       "regular": 300,
//       "medium": 500,
//       "bold": 700
//     )
//   )
// )

map.values($map)
map-values($map) //=> list

返回 $map 中所有值的逗号分隔列表。

  SCSS

  Sass

       游乐场SCSS 语法@use "sass:map";

$font-weights: ("regular": 400, "medium": 500, "bold": 700);

@debug map.values($font-weights); // 400, 500, 700

       游乐场Sass 语法@use "sass:map"

$font-weights: ("regular": 400, "medium": 500, "bold": 700)

@debug map.values($font-weights)  // 400, 500, 700