SASSのビルトインモジュール

SASSのビルトインモジュール

この記事ではSASSのビルトインモジュールについて説明します。

SASSのビルトインモジュールについて、基礎から応用までをステップバイステップで解説します。

YouTube Video

SASSのビルトインモジュール

SASSにはさまざまなビルトインモジュールが提供されており、これらを使用することで、スタイルシートの作成がさらに効率化されます。

SASSのビルトインモジュールとは?

SASSのビルトインモジュールは、再利用可能な関数やミックスインを提供するモジュールです。これらを利用すると、複雑な計算やカスタムスタイルの作成が簡単になります。

主なビルトインモジュールには次のものがあります。

  • sass:color
  • sass:string
  • sass:math
  • sass:list
  • sass:map
  • sass:selector
  • sass:meta

各モジュールには特定のタスクを効率化するための機能が含まれています。

各モジュールの詳細と使用例

sass:color モジュール

sass:colorモジュールは、色の操作を簡単にするための関数を提供します。

主な関数
  • mix(): 2つの色を混ぜる
  • adjust(): 色相・明度・彩度などをまとめて調整する
使用例
 1@use "sass:color";
 2
 3$primary-color: #3498db;
 4$secondary-color: #e74c3c;
 5
 6// Mix two colors with equal weight
 7$blended-color: color.mix($primary-color, $secondary-color, 50%);
 8
 9// Adjust hue by 45 degrees using color.adjust()
10$adjusted-color: color.adjust($primary-color, $hue: 45deg);
11
12div {
13  background-color: $blended-color; // Result of mixing two colors
14  border-color: $adjusted-color;    // Hue adjusted by 45 degrees
15}
  • このコードでは、2つの色を混ぜた新しい色と、色相を調整した色を生成しています。生成した色は背景色やボーダー色として要素に適用されます。色操作の基礎を理解するのに役立つ例です。

sass:string モジュール

sass:string モジュールは、文字列操作に役立つ関数を提供します。

主な関数
  • quote(), unquote(): 文字列をクォートまたはアンコートする
  • length(): 文字列の長さを取得する
  • to-upper-case(), to-lower-case(): 文字列を大文字または小文字に変換する
使用例
 1@use "sass:string";
 2
 3// base values
 4$base-url: "https://example.com";
 5$path: "/assets/style.css";
 6
 7// 1) Combine strings using interpolation and then quote the result
 8$full-quoted: string.quote("#{$base-url}#{$path}");
 9// Example result: "\"https://example.com/assets/style.css\""
10
11// 2) Remove quotes from a quoted string
12$full-unquoted: string.unquote($full-quoted);
13// Example result: https://example.com/assets/style.css
14
15// 3) Get the length of the unquoted string
16$url-length: string.length($full-unquoted);
17// Example output: number of characters in the URL
18
19// 4) Convert strings to upper/lower case and quote for safe CSS output
20$block-name: "main-header";
21// "MAIN-HEADER"
22$upper-quoted: string.quote(string.to-upper-case($block-name));
23// "main-footer"
24$lower-quoted: string.quote(string.to-lower-case("MAIN-FOOTER"));
25
26a::after {
27  /* Use quoted strings for content to ensure valid CSS */
28  content: $full-quoted; /* "https://example.com/assets/style.css" */
29}
30
31:root {
32  /* Insert numeric values with interpolation when needed */
33  --url-length: #{ $url-length }; /* Example: --url-length: 31; */
34}
35
36.header::before {
37  /* Output uppercase version */
38  content: $upper-quoted; /* "MAIN-HEADER" */
39}
40
41.footer::after {
42  /* Output lowercase version */
43  content: $lower-quoted; /* "main-footer" */
44}
  • string.quote()string.unquote() を使うと、出力CSSの文字列表現を正確にコントロールできます。string.length()は、文字列の長さを取得する関数です。string.to-upper-case() / string.to-lower-case() はクラス名の生成や BEM 名の整形に便利です。

sass:math モジュール

sass:math モジュールは、数学的な計算を行うための関数を提供します。

主な関数
  • pow(): 累乗
  • sqrt(): 平方根
  • abs(): 絶対値
  • round(), ceil(), floor(): 四捨五入、切り上げ、切り下げ
使用例
 1@use "sass:math";
 2
 3// Using pow() to calculate exponential values
 4$base-size: math.pow(2, 3) * 10px; // 80px
 5
 6// Using sqrt() to compute a square root
 7$root-size: math.sqrt(144) * 1px; // 12px
 8
 9// Using abs() to ensure a positive value
10$offset: math.abs(-15px); // 15px
11
12// Using round(), ceil(), and floor() for different rounding methods
13$rounded: math.round(12.6px); // 13px
14$ceiled: math.ceil(12.1px); // 13px
15$floored: math.floor(12.9px); // 12px
16
17.container {
18  width: $base-size; // 80px
19  height: $root-size; // 12px
20  margin-left: $offset; // 15px
21}
22
23.values {
24  /* Demonstrating different rounding operations */
25  padding: $rounded;  // 13px
26  border-width: $ceiled; // 13px
27  margin-top: $floored; // 12px
28}
  • math.pow()math.sqrt() はサイズ計算に便利で、math.abs() や丸め系関数は補正値の処理に役立ちます。これらを組み合わせることで UI の一貫したスケール計算が容易になります。

sass:list モジュール

sass:list モジュールは、リスト操作に特化した関数を提供します。

主な関数
  • append(): 要素の追加
  • join(): リストの結合
  • nth(): 指定位置の要素を取得
  • length(): リストの長さを取得
使用例
 1@use "sass:list";
 2
 3// Base list
 4$colors: ("red", "blue", "green");
 5
 6// Add an element to the end of the list
 7$colors-appended: list.append($colors, "yellow");
 8// ("red", "blue", "green", "yellow")
 9
10// Add an element to the beginning of the list using join()
11$colors-prepended: list.join(("black",), $colors);
12// ("black", "red", "blue", "green", "yellow")
13
14// Join two lists together
15$extra-colors: ("pink", "cyan");
16$merged-colors: list.join($colors-prepended, $extra-colors);
17// ("black", "red", "blue", "green", "yellow", "pink", "cyan")
18
19// Get list length
20$total-length: list.length($merged-colors);
21
22// Example usage in a loop: assign each color to a list item
23ul {
24  @for $i from 1 through $total-length {
25    li:nth-child(#{$i}) {
26      /* Get the color at index $i */
27      color: list.nth($merged-colors, $i);
28    }
29  }
30}
  • append() でリストの末尾に要素を加え、join() を使えば複数のリストを柔軟に結合できます。また、先頭へ要素を追加したい場合も、単一要素リストを join() で先頭に結合する形で実現できます。length()nth() を組み合わせることで、動的なリスト処理を必要とする UI のスタイル生成が容易になります。

sass:map モジュール

sass:map モジュールは、マップ(連想配列)を操作するための関数を提供します。

主な関数
  • get(): キーに対応する値を取得
  • set(): キーと値のペアを追加または更新
  • keys(): すべてのキーを取得
使用例
 1@use "sass:map";
 2
 3// Base theme map
 4$theme-colors: (
 5  "primary": #3498db,
 6  "secondary": #e74c3c
 7);
 8
 9// Update or add a value using set()
10$updated-theme: map.set($theme-colors, "warning", #f1c40f);
11// Map now has "warning": #f1c40f added
12
13// Get a value from the map
14$primary-color: map.get($updated-theme, "primary");
15
16// Get all keys from the map
17$all-keys: map.keys($updated-theme);
18// Example: ("primary", "secondary", "warning")
19
20button {
21  /* Apply color retrieved from the theme map */
22  background-color: $primary-color;
23}
24
25.debug {
26  /* Print keys as content for demonstration */
27  content: "#{$all-keys}";
28}
  • map.set() を使うとマップを動的に更新でき、map.get() と組み合わせて柔軟なテーマ構造を作れます。map.keys() を使えば設定情報を一覧として取得できるため、拡張性の高いスタイル設計に役立ちます。

sass:selector モジュール

sass:selector モジュールは、セレクタの操作に役立つ関数を提供します。

主な関数
  • nest(): セレクタをネスト
  • is-superselector(): セレクタの包含関係をチェック
  • replace(): セレクタの置換
使用例
 1@use "sass:selector";
 2
 3// Nest selectors (combine parent and child)
 4$nested-selector: selector.nest(".parent", ".child");
 5// Result: ".parent .child"
 6
 7// Check if one selector is a superselector of another
 8$is-super: selector.is-superselector(".parent", $nested-selector);
 9// true because ".parent" matches all elements that
10// ".parent .child" can match as an ancestor
11
12// Replace part of a selector with another selector
13$replaced-selector: selector.replace(".parent .child", ".child", ".item");
14// Result: ".parent .item"
15
16// Use generated selectors in actual CSS output
17#{$nested-selector} {
18  /* Applies to .parent .child */
19  color: red;
20}
21
22@if $is-super {
23  .info::after {
24    /* Demonstrate boolean result */
25    content: "parent is a superselector";
26  }
27}
28
29#{$replaced-selector} {
30  /* Applies to .parent .item */
31  background: blue;
32}
  • selector.nest() で柔軟にセレクタを合成し、selector.is-superselector() で関係性を検証できます。selector.replace() を組み合わせることで、高度なセレクタ生成ロジックを簡潔に扱えるようになります。

sass:meta モジュール

sass:meta モジュールは、SASSのメタプログラミングに役立つ機能を提供します。

主な関数
  • variable-exists(): 変数が存在するかをチェック
  • global-variable-exists(): グローバル変数が存在するかをチェック
  • inspect(): 値をデバッグ用に表示
使用例
 1@use "sass:meta";
 2
 3// Define a global variable
 4$color: #3498db;
 5
 6// Check if a variable exists in the current scope
 7@if meta.variable-exists("color") {
 8  body {
 9    /* Apply style only if $color exists */
10    background-color: $color;
11  }
12}
13
14// Create a local variable inside a block
15.container {
16  $local-size: 20px;
17
18  @if meta.variable-exists("local-size") {
19    /* Demonstrates detection of local variable */
20    width: $local-size;
21  }
22}
23
24// Check if a global variable exists
25$result: meta.global-variable-exists("color"); // true
26
27.debug {
28  /* Use inspect() to output the inspected value as a string */
29  content: meta.inspect($result); // "true"
30}
  • meta.variable-exists()meta.global-variable-exists() により、スコープごとの変数状態を安全に判定できます。meta.inspect() はデバッグに非常に便利で、値を文字列として可視化できます。

実践的な例

複数のビルトインモジュールを組み合わせることで、Sass の表現力はさらに高まります。以下は、colormathlist モジュールを同時に活用し、色の加工とリスト操作を自動化する例です。

 1@use "sass:color";
 2@use "sass:math";
 3@use "sass:list";
 4
 5// Base color list
 6$base-colors: (#3498db, #e74c3c, #2ecc71);
 7$darkened-colors: (); // Empty list for processed colors
 8
 9// Loop through each base color and darken it by 10%
10@each $color in $base-colors {
11  $darkened-colors: list.append(
12    $darkened-colors,
13    // Darken color by decreasing lightness by 10%
14    color.adjust($color, $lightness: -10%)
15  );
16}
17
18div {
19  // Apply each processed color to a corresponding <div>
20  @for $i from 1 through list.length($darkened-colors) {
21    &:nth-child(#{$i}) {
22      // Set color by index
23      background-color: list.nth($darkened-colors, $i);
24    }
25  }
26}
  • このコードでは、list.append() を使って加工済みの色を順に追加し、color.adjust()$lightness: -10% を用いて色を10%暗くしています。最後に、@forlist.nth() を組み合わせて、それぞれの <div> に対して異なる背景色を適用しています。

まとめ

SASSのビルトインモジュールは、CSSの柔軟性を大幅に高めます。それぞれのモジュールを理解し、適切に使いこなすことで、より効率的で保守性の高いスタイルシートを作成できます。

YouTubeチャンネルでは、Visual Studio Codeを用いて上記の記事を見ながら確認できます。 ぜひYouTubeチャンネルもご覧ください。

YouTube Video