Close
Angular React Web Components Blazor Angular

Sass によるパレット

Ignite UI for Angular の Sass パレットは、palette() 関数がシード カラーから生成し、palette() ミックスインが CSS 変数として出力するカラー シェードのマップです。

概要

Ignite UI for Angular のパレットは、カラー ファミリ (primary、secondary、gray、surface、info、success、warn、error) をキーとする Sass マップです。各ファミリはそのシェードのマップであり、すべてのコンポーネント テーマは、--ig-* CSS 変数を通じてこれらのシェードからカラーを読み取ります。

palette() 関数は、シード カラーからマップ全体を作成します。デフォルトの fitted ジェネレーターでは、各ファミリに次のバリアントが含まれます。

ファミリ バリアント
primary、secondary、info、success、warn、error 50–900、A100、A200、A400、A700、seed
gray 50–900、seed
surface base、sunken、raised、overlay、container、seed

すべてのバリアントには、500-contrast のような対応する -contrast バリアントがあります。その値は黒か白のどちらかで、そのシェードの上で読みやすいほうをブラウザーが選びます。primary カラーは通常ブランド カラーで、igx-navbar などの目立つ静的要素のスタイルを設定します。secondary はボタン、スイッチ、スライダーなどの操作可能な要素のスタイルを設定します。surface はカード、メニュー、ピッカーなどのコンポーネントの背景です。

シェードの配置方法と、surface ファミリが数値ではなくロールを持つ理由については、パレット生成を参照してください。

パレットの生成

必須の 3 つのシード ($primary、$secondary、$surface) を指定して palette() を呼び出し、その結果を palette() ミックスインに渡して CSS 変数として出力します。

@use "igniteui-angular/theming" as *;

$brand-palette: palette(
  $primary: #0099ff,
  $secondary: #df1b74,
  $surface: #ffffff
);

:root {
  @include palette($brand-palette);
}

任意のシードは、$gray、$info (#1377d5)、$success (#4eb862)、$warn (#faa419)、$error (#ff134a) です。theme() ミックスインは内部で palette() ミックスインを含めています。そのため、palette() ミックスインを直接含めるのは、パレットだけを出力する場合 (たとえば、2 つ目のパレットを特定のクラスに限定して適用する場合) に限られます。

palette() に渡すシードは、Sass のカラーである必要があります。パレットはビルド時に計算されるため、CSS 変数を引数として渡すことはできません。

palette() ミックスインは、-contrast カラーが選択される WCAG レベルも設定します。$contrast-level に 'a'、'aa' (デフォルト)、または 'aaa' を渡します。

:root {
  @include palette($brand-palette, $contrast-level: 'aaa');
}

fitted ジェネレーターでは、すべてのシェードが固定の色として出力されます。

:root {
  --ig-primary-100: rgb(172, 207, 251);
  --ig-primary-500: rgb(9, 109, 183);
  --ig-primary-600: rgb(6, 89, 150);
  --ig-primary-seed: #0099ff;
  --ig-surface-base: rgb(255, 255, 255);
  --ig-surface-sunken: rgb(247, 247, 247);
  /* ... */
}

シェードは固定されているため、CSS でこれらの変数のいずれかを上書きしても、そのシェードのみが変更されます。ファミリを変更するには、そのシードを変更して再ビルドします。

スケール

スケールは、ファミリのシェードが及ぶ範囲と間隔を設定します。デフォルトを置き換えるには、palette() に $scales を渡します。デフォルトは、gray 以外のすべてのファミリが even、gray が material です。

1 つのファミリにプリセットを指定するか、すべてのファミリに 1 つのプリセットを渡します。

// The grays follow IBM Carbon's rhythm; every other family keeps its default
$brand-palette: palette(#0099ff, #df1b74, #ffffff, $scales: ('gray': 'carbon'));

// Every family uses the tailwind preset
$brand-palette: palette(#0099ff, #df1b74, #ffffff, $scales: 'tailwind');

プリセットは even、material、tailwind、carbon です。パレット生成でこれらを比較しています。

次のキーを使用して、スケールをインラインで記述します。

キー 値 効果
range 1.1 14 のような 2 つのコントラスト比 シェード 50 とシェード 900 のコントラストです。デフォルトは even の範囲 1.182 18.232 です。
curve 0.5 0 0.8 0.8 のような 4 つの数値 CSS の cubic-bezier() のように読み取られ、範囲に沿ってシェードを再配分します。均等な間隔にする場合は省略します。
anchor 'surface' または 'white' gray の範囲を何に対して測定するかを指定します。デフォルトは 'surface' です。他のファミリは常に白に対して測定されます。
$brand-palette: palette(
  #0099ff,
  #df1b74,
  #121212,
  $scales: (
    'primary': (range: 1.1 14, curve: 0.5 0 0.8 0.8),
    'gray': (range: 1.1 14, anchor: 'white')
  )
);

4 つの数値だけのリストは、even の範囲に適用するカーブとして扱われます。範囲やカーブを独自に指定するとシェード間のコントラストが変わるため、変更後は、使用している色の組み合わせのコントラストを確認してください。

ジェネレーター

palette() 関数には 2 つのジェネレーターがあります。デフォルトの fitted は、コントラスト ターゲットに合わせて各シェードを算出します。legacy は、シードを 500 に配置し、固定の HSL 乗数で他のシェードを導出して、500 の CSS 相対カラーとして出力します。

:root {
  --ig-primary-500: #0099ff;
  --ig-primary-600: hsl(from var(--ig-primary-500) h calc(s * 1.26) calc(l * 0.89));
}

特定のパレットだけで legacy ジェネレーターを使い続けるには、$generator を指定します。ビルド内のすべての palette() 呼び出しで使い続けるには、ライブラリがほかのモジュールから読み込まれる前に $shade-generator を設定します。

// One palette
$brand-palette: palette(#0099ff, #df1b74, #ffffff, $generator: 'legacy');
// Every palette() call in the build
@use "igniteui-theming" with ($shade-generator: 'legacy');
@use "igniteui-angular/theming" as *;

legacy パレットは $scales 引数を無視します。

事前定義されたパレット

Ignite UI for Angular は、対応するスキーマと組み合わせて使用できる、事前定義されたライト パレットとダーク パレットを提供します。

  • ライト パレット
    • $light-material-palette
    • $light-fluent-excel-palette
    • $light-fluent-word-palette
    • $light-fluent-palette
    • $light-bootstrap-palette
    • $light-indigo-palette
  • ダーク パレット
    • $dark-material-palette
    • $dark-fluent-excel-palette
    • $dark-fluent-word-palette
    • $dark-fluent-palette
    • $dark-bootstrap-palette
    • $dark-indigo-palette

どのライト パレットもライト スキーマと、どのダーク パレットもダーク スキーマと組み合わせられます。事前定義されたパレットは legacy ジェネレーターで作成されています。そのため、これらをもとにしたテーマではシェードが相対カラーのまま出力され、実行時に 500 バリアントを上書きすると、ほかのシェードにも反映されます。

グレースケール カラー

gray ファミリは、ほとんどのテキスト、ボーダー、無効状態のカラーを提供し、そのシェードはサーフェスに対して設定されます。グレーの作成元のカラーを選択するには、$gray を渡します。

$brand-palette: palette(
  $primary: #2ab759,
  $secondary: #f96a88,
  $surface: #222222,
  $gray: #ffffff
);

$gray を省略すると、グレーのシードは、ライト サーフェスでは黒、ダーク サーフェスでは白になります。デフォルトの material スケールでは、シェード 50 は白またはほぼ黒のサーフェスに最も近いグレー、900 はサーフェスから最も遠いグレーです。グレー スケールのアンカーがダーク テーマにどのように影響するかについては、グレーとページを参照してください。

カラー バリアント

color() 関数は、パレットのシェードを返します。最大 4 つの引数 ($palette、$color、$variant、$opacity) を受け取ります。

// A reference to the CSS variable: var(--ig-primary-500)
$primary-500: color();

// var(--ig-primary-600)
$primary-600: color($variant: 600);

// The primary 600 shade at 50% opacity, as a CSS relative color
$primary-600-translucent: color($variant: 600, $opacity: 0.5);

// The surface's raised role: var(--ig-surface-raised)
$raised: color($color: 'surface', $variant: 'raised');

// The resolved color of the secondary A700 shade in $brand-palette
$secondary-a700: color($brand-palette, 'secondary', 'A700');

.panel {
  background: $raised;
  border-color: $primary-600;
}

$palette を指定しない場合、color() は CSS 変数への参照を返すため、値は実行時に出力されるパレットに従います。$palette を指定すると、そのマップから解決されたカラーを返します。$color のデフォルトは primary、$variant のデフォルトは 500 です ($color が surface の場合は base)。

コントラスト テキスト カラー

contrast-color() 関数は、シェードのコントラスト カラーを返し、color() と同じ引数を受け取ります。

.callout {
  background: color($color: 'primary', $variant: 600);
  color: contrast-color($color: 'primary', $variant: 600);
}

戻り値は CSS の相対カラーで、palette() ミックスインで指定したコントラスト レベルに従って、ブラウザーが黒か白に決定します。

カラー クラス

color-classes() ミックスインは、パレット内のシェードごとに、そのカラーを指定の CSS プロパティに設定する CSS クラスを生成します。

  • $prop - カラーを割り当てる CSS プロパティ。
  • $prefix - 生成されるクラス名のプレフィックス。デフォルトは 'igx' です。
  • $suffix - 生成されるクラス名のサフィックス。
  • $palette - 使用するパレット。
@include color-classes(
  $prop: 'background-color',
  $prefix: 'bg'
);

primary の 500 シェードは、クラス .bg-primary-500 になります。

<div class="bg-primary-500">...</div>

カスタム パレット マップ

コンポーネント テーマが参照するのはパレット マップの構造だけです。そのため、テーマが参照するキーがそろっていれば、手動で作成したマップも使用できます。数値のバリアントも含めてすべてのキーを引用符で囲み、surface にはサーフェス ロールを指定します。

$handmade-palette: (
  'primary': (
    '50': #e6eff8,
    '50-contrast': black,
    // ... '100' through '900', then 'A100', 'A200', 'A400', 'A700', each with a '-contrast' entry
    '500': #6797de,
    '500-contrast': white,
  ),
  // 'secondary', 'gray', 'info', 'success', 'warn', and 'error' follow the same pattern
  'surface': (
    'base': #ffffff,
    'base-contrast': black,
    'sunken': #f7f7f7,
    'sunken-contrast': black,
    'raised': #ffffff,
    'raised-contrast': black,
    'overlay': #ffffff,
    'overlay-contrast': black,
    'container': rgba(0, 0, 0, 0.03),
    'container-contrast': black,
  ),
);

Ignite UI for Angular 22.3.0 のコンポーネント テーマは、カラー ファミリと gray の番号付きシェード、primary と secondary のアクセント シェード、および base サーフェス ロールを読み取ります。その他のサーフェス ロールは、独自のスタイルで使用するためのものです。それ以外のバリアントを参照するスタイルでも値が解決されるように、概要に記載されているすべてのバリアントを含めてください。

トラブルシューティング

--ig-primary-500 を上書きしても、他のプライマリ シェードが更新されないのはなぜですか? fitted ジェネレーターで生成されたパレットは、固定の色を出力します。palette() に渡すシードを変更して再ビルドしてください。実行時に 500 からほかのシェードを導出させたい場合は、$generator: 'legacy' を指定してパレットを生成します。

--ig-surface-500 または color($color: 'surface', $variant: 500) への参照を移行するにはどうすればよいですか? 番号付きのサーフェス シェードは非推奨になり、ロールに置き換えられました。すべてのパレットが引き続きそれらを出力するため、移行中も参照は動作し続けます。ページまたはコンポーネントの背景には base、その上のレイヤーには raised または overlay、その中に埋め込まれるレイヤーには sunken、半透明の塗りつぶしには container を使用します。color($color: 'surface') は、すでに base を返します。

ビルドで Shade "gray-900" wanted 18.232:1 but its hue only reaches … と出力されるのはなぜですか? カラーとアンカーの組み合わせで実現できる以上のコントラストを、スケールが求めているためです。典型的な例は、ダーク サーフェスで、サーフェスにアンカーしたグレー スケールを使用する場合です。この場合、ジェネレーターは到達できる範囲で最も近いシェードを使用します。range の上限を下げるか、anchor: 'white' を設定してください。

API リファレンス

その他のリソース