API

css.createTheme

★★★★★ Frozen

ライトやダークなどのテーマを、クラス、属性、メディアクエリで切り替えます。

type CreateTheme = {
  [key: string]: {
    default: string;
    theme: string;
  };
};

export type createTheme = <const T extends CreateTheme>(themeSelector: CreateThemeSelector, rule: T) => CreateThemeReturnType<T>;
export const createTheme: createTheme;

createThemeはカスタムテーマ用のスコープ付きCSS変数を定義します。生成される各変数の名はユニークなハッシュで始まりますので、他のテーマやグローバルなCSS変数と衝突することはできません。

Plumeriaテーマ間の参照はサポートされていません:defaultとthemeは文字列を受け取り、別のテーマメンバーを受け取るものではなく、生成されたCSS変数の名前はコンテンツハッシュであり、テーマが変わると変更される可能性があります。

例

ルート要素にクラスを追加することでテーマを切り替えます。

TypeScript
import * as css from '@plumeria/core';

export const theme = css.createTheme('.dark', {
  text: {
    default: '#333',
    theme: '#eaeaea',
  },
});

使い方

import * as css from '@plumeria/core';
import { theme } from 'lib/theme';

const styles = css.create({
  title: {
    color: theme.text,
  },
});

セレクター

最初の引数には属性セレクターのほか、入れ子にできる条件付きアットルール(@media、@container、@supports など)も使えます。

属性

次回のテーマなどの属性ベースの設定に使用されます。

TypeScript
import * as css from '@plumeria/core';

export const theme = css.createTheme('[data-theme="dark"]', {
  text: {
    default: '#333',
    theme: '#eaeaea',
  },
});

メディアクエリ

JavaScriptなしでシステム設定に従います。

TypeScript
import * as css from '@plumeria/core';

export const theme = css.createTheme('@media (prefers-color-scheme: dark)', {
  text: {
    default: '#333',
    theme: '#eaeaea',
  },
});

補足

他のすべての定義と同様に、テーマは、その変数の一つがスタイルで使用されるまでCSSを送信しません。

Edit on GitHub