Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【CSS Modules】base-paletteアットルール記述子の使い方

base-paletteアットルール記述子の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

base-palette定数は、CSS Modules環境において、アプリケーションの基本となるカラーパレットを表す定数です。これは、主要なブランドカラーやアクセントカラーなど、アプリケーション全体で一貫して使用される色の集合を定義するために用いられます。

CSS Modulesは、各コンポーネントのスタイルが独立して管理されるように設計されており、これによりスタイルの衝突を防ぎ、メンテナンス性を向上させます。base-palette定数を用いることで、このようなモジュール化された環境の中でも、アプリケーション全体で共通のデザインガイドラインに基づいた色の使用を容易に実現できます。

例えば、ボタン、テキスト、背景などの要素が、特定のテーマカラーセットに基づいて統一された外観を持つことを保証するために、この定数が活用されます。開発者は、色の具体的なHEX値やRGB値ではなく、base-paletteによって定義された意味のある名前(例: primary-colorsecondary-color)を用いてスタイルを記述できるようになります。これにより、デザインシステムの整合性が保たれ、後から色の変更が必要になった場合でも、一箇所を修正するだけでアプリケーション全体に反映させることが可能となり、効率的な開発と高い保守性を実現します。システムエンジニアを目指す方にとって、大規模なアプリケーション開発において一貫したUI/UXを保つ上で非常に重要な概念となるでしょう。

公式リファレンス: base-palette

構文(syntax)

1base-palette: primary {
2  --color-brand: #007bff;
3  --color-text: #333;
4  --color-background: #f0f0f0;
5}

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

CSS ベースパレットで色を管理する

1/*
2 * システムのベースとなるカラーパレットを定義します。
3 * これらのCSSカスタムプロパティ(CSS変数)は、ウェブサイト全体で一貫した色使いを保証し、
4 * 色の変更が必要になった際に一箇所で管理できるようにします。
5 */
6:root {
7  /* 主要なUI要素やブランドカラーに使う色 */
8  --color-primary: #007bff;
9  /* 補助的なUI要素やニュートラルな要素に使う色 */
10  --color-secondary: #6c757d;
11  /* 成功や肯定的なフィードバックを示す色 */
12  --color-success: #28a745;
13  /* 危険やエラーを示す色 */
14  --color-danger: #dc3545;
15  /* 警告や注意を示す色 */
16  --color-warning: #ffc107;
17  /* 情報提供や中立的な情報を示す色 */
18  --color-info: #17a2b8;
19
20  /* 明るい背景色やテキスト色 */
21  --color-light: #f8f9fa;
22  /* 暗い背景色やテキスト色 */
23  --color-dark: #343a40;
24
25  /* 本文テキストのデフォルト色 */
26  --color-text-body: #212529;
27  /* 明るい背景上のテキスト色(例: ダークカラーボタン上のテキスト) */
28  --color-text-on-dark: #ffffff;
29}
30
31/*
32 * 定義されたベースパレットを実際に使用する例。
33 * これにより、サイト全体のデザインの一貫性を保ちつつ、
34 * 容易にテーマカラーを変更できるようになります。
35 */
36body {
37  /* ボディの背景色とテキスト色をベースパレットから設定 */
38  background-color: var(--color-light);
39  color: var(--color-text-body);
40  font-family: sans-serif;
41  margin: 0;
42  padding: 20px;
43}
44
45.button-primary {
46  /* 主要ボタンの背景色とテキスト色を設定 */
47  background-color: var(--color-primary);
48  color: var(--color-text-on-dark);
49  padding: 10px 20px;
50  border: none;
51  border-radius: 5px;
52  cursor: pointer;
53  font-size: 16px;
54}
55
56.alert-danger {
57  /* エラーメッセージ用の背景色とテキスト色を設定 */
58  background-color: var(--color-danger);
59  color: var(--color-text-on-dark);
60  padding: 15px;
61  border-radius: 5px;
62  margin-top: 10px;
63}

このサンプルコードは、ウェブサイトのデザイン全体で利用する基本的な色(カラーパレット)を定義し、管理する方法を示しています。これは、リファレンス情報にある「base-palette」という概念を、CSSの標準機能であるカスタムプロパティ(CSS変数)を使って実現したものです。特定のCSS at-ruleや関数ではないため、引数や戻り値は存在しません。

コードの冒頭では、:rootセレクタ内に様々な色のカスタムプロパティを定義しています。例えば、--color-primaryは主要な要素に使う色、--color-successは成功を示す色といった具合に、意味のある名前を付けて色コード(例: #007bff)を割り当てています。これにより、サイト全体で同じ色が異なる場所で使われる際に、毎回色コードを記述する手間を省き、デザインの一貫性を保ちやすくなります。また、将来的にブランドカラーを変更する際も、この:rootブロック内の一箇所を修正するだけで、サイト全体の色を更新できるため、メンテナンス性が大幅に向上します。

コードの後半では、定義したカラーパレットを実際にHTML要素に適用する例を示しています。bodyの背景色やテキスト色、.button-primaryクラスを持つボタン、.alert-dangerクラスを持つ警告メッセージなどに、var(--カスタムプロパティ名)という形式で色を適用しています。このvar()関数を使うことで、先ほど定義したカスタムプロパティの値を参照し、簡単に利用できます。このように、カラーパレットを一元的に定義し、それを再利用することで、システムエンジニアがWebアプリケーションのUIを開発する際に、デザインの統一性を保ちつつ、効率的にスタイルを管理できるようになります。

このコードは、CSSカスタムプロパティ(CSS変数)を使って、ウェブサイト全体のカラーパレットを:root要素に定義しています。これにより、サイト全体の色使いの一貫性を保ち、デザイン変更時の管理を一元化できます。

注意点として、カスタムプロパティは--で始まる命名規則を持ち、参照時にはvar()関数で指定します。未定義のカスタムプロパティを参照した場合、スタイルが適用されないため、定義漏れに注意が必要です。

補足として、カスタムプロパティの名前は、色そのものではなく、その用途や役割に基づいて命名すると、コードの可読性と保守性が向上します。また、アクセシビリティの観点から、背景色とテキスト色のコントラスト比が十分であるかを確認することも重要です。これらの点に留意することで、デザインの一貫性を保ちつつ、安全で効果的なCSS管理が可能です。

関連コンテンツ

関連IT用語

関連プログラミング言語