@k8ordo/ui

テーマ

@k8ordo/uiの色、余白、文字を決めるデザイントークンの一覧です。トークンはCSS変数なので、定義し直せばアプリの色に合わせられます。

このページの内容

用途別の色

文字と背景と線のように、用途で名前を付けた色です。ライトとダークで別の値を持ち、darkクラスで切り替わります。

文字の色

color-fg-base

Light gray-900 · Dark gray-50

本文の文字

color-fg-subtle

Light gray-600 · Dark gray-400

プレースホルダーなど、最も薄い文字

color-fg-mute

Light gray-700 · Dark gray-300

説明やキャプションなど、補足の文字

color-fg-inverse

Light gray-50 · Dark gray-900

bg-inverseの上に置く文字

color-fg-info

Light blue-800 · Dark blue-200

情報メッセージの文字

color-fg-success

Light green-800 · Dark green-200

成功メッセージの文字

color-fg-warning

Light yellow-800 · Dark yellow-200

警告メッセージの文字

color-fg-error

Light red-800 · Dark red-200

エラーメッセージの文字

背景の色

color-bg-base

Light white · Dark gray-800

カードの背景

color-bg-raised

Light white · Dark gray-800

モーダルやメニューなど、重ねて開く要素の背景

color-bg-surface

Light gray-50 · Dark gray-950

最も外側の背景。ライトではbg-subtleより明るく、ダークでは暗い

color-bg-subtle

Light gray-100 · Dark gray-900

ページの背景

color-bg-mute

Light gray-200 · Dark gray-700

ホバー状態の背景

color-bg-emphasize

Light gray-300 · Dark gray-600

アクティブ状態の背景

color-bg-inverse

Light gray-900 · Dark white

反転した背景。fg-inverseと組み合わせる

color-bg-info

Light blue-100 · Dark blue-900

情報メッセージの背景

color-bg-success

Light green-100 · Dark green-900

成功メッセージの背景

color-bg-warning

Light yellow-100 · Dark yellow-900

警告メッセージの背景

color-bg-error

Light red-100 · Dark red-900

エラーメッセージの背景

線の色

color-border-base

Light gray-400 · Dark gray-600

入力欄など、標準の線

color-border-subtle

Light gray-100 · Dark gray-700

最も薄い線

color-border-mute

Light gray-200 · Dark gray-600

区切りなど、控えめな線

color-border-emphasize

Light gray-500 · Dark gray-500

ホバー時など、強調する線

color-border-inverse

Light gray-700 · Dark gray-300

bg-inverseの上に引く線

color-border-info

Light blue-500 · Dark blue-400

情報の線。フォーカスリングにも使う

color-border-success

Light green-500 · Dark green-400

成功状態の線

color-border-warning

Light yellow-500 · Dark yellow-400

警告状態の線

color-border-error

Light red-500 · Dark red-400

エラー状態の線

ブランドの色

primaryはティール、secondaryはシアンです。groupの4色は、グラフの系列のように複数のデータを描き分けるときに使います。

primary

color-primary-fg

Light teal-800 · Dark teal-300

primaryの文字とアイコン

color-primary-bg

Light teal-200 · Dark teal-900

primaryの塗り。solidのボタンなど

color-primary-bg-subtle

Light teal-50 · Dark teal-950

最も薄いprimaryの背景。選択状態など

color-primary-bg-mute

Light teal-100 · Dark teal-900

控えめなprimaryの背景

color-primary-bg-emphasize

Light teal-300 · Dark teal-800

ホバー時など、強いprimaryの背景

color-primary-border

Light teal-500 · Dark teal-500

primaryの線

secondary

color-secondary-fg

Light cyan-800 · Dark cyan-300

secondaryの文字とアイコン

color-secondary-bg

Light cyan-200 · Dark cyan-900

secondaryの塗り

color-secondary-bg-subtle

Light cyan-50 · Dark cyan-950

最も薄いsecondaryの背景

color-secondary-bg-mute

Light cyan-100 · Dark cyan-900

控えめなsecondaryの背景

color-secondary-bg-emphasize

Light cyan-300 · Dark cyan-800

ホバー時など、強いsecondaryの背景

color-secondary-border

Light cyan-500 · Dark cyan-500

secondaryの線

group

color-group-primary

Light teal-800 · Dark teal-200

1つ目の系列

color-group-secondary

Light cyan-800 · Dark cyan-200

2つ目の系列

color-group-tertiary

Light pink-800 · Dark pink-200

3つ目の系列

color-group-quaternary

Light purple-800 · Dark purple-200

4つ目の系列

基本の色

Gray
50
100
200
300
400
500
600
700
800
900
950
Red
50
100
200
300
400
500
600
700
800
900
950
Pink
50
100
200
300
400
500
600
700
800
900
950
Purple
50
100
200
300
400
500
600
700
800
900
950
Cyan
50
100
200
300
400
500
600
700
800
900
950
Blue
50
100
200
300
400
500
600
700
800
900
950
Teal
50
100
200
300
400
500
600
700
800
900
950
Green
50
100
200
300
400
500
600
700
800
900
950
Yellow
50
100
200
300
400
500
600
700
800
900
950
Orange
50
100
200
300
400
500
600
700
800
900
950

10の色相に、50から950まで11段階の明るさがあります。グレー以外の色相は明るさの段階をそろえているので、段階が同じならコントラストもほぼ同じです。

コンポーネントはこの色を直接使いません。上の用途別の色を通して使います。

トークンの上書き

app.css
:root {
  --color-primary-fg: var(--purple-800);
  --color-primary-bg: var(--purple-200);
  --color-primary-bg-subtle: var(--purple-50);
  --color-primary-bg-mute: var(--purple-100);
  --color-primary-bg-emphasize: var(--purple-300);
  --color-primary-border: var(--purple-500);
}

.dark {
  --color-primary-fg: var(--purple-300);
  --color-primary-bg: var(--purple-800);
  --color-primary-bg-subtle: var(--purple-950);
  --color-primary-bg-mute: var(--purple-900);
  --color-primary-bg-emphasize: var(--purple-700);
  --color-primary-border: var(--purple-500);
}
app.css
:root {
  --color-primary-border: oklch(0.55 0.15 300);
}

トークンは:rootと.darkに、レイヤーの外で定義されています。@k8ordo/uiのスタイルシートより後に読み込むCSSで同じ名前を定義すると、上書きできます。

トークンは、--purple-200のような名前の基本の色を参照しています。参照先を差し替えると、ブランドの色がまとめて変わります。参照の代わりに値をそのまま書いても構いません。

ハイコントラストの値は、@media (prefers-contrast: more)の中の:rootと.darkで定義し直します。

文字

文字の大きさ

xsk8ordo0.75rem / 1.333
smk8ordo0.875rem / 1.429
mdk8ordo1rem / 1.5
lgk8ordo1.125rem / 1.556
xlk8ordo1.25rem / 1.4
2xlk8ordo1.5rem / 1.333
3xlk8ordo1.875rem / 1.2
emphasizek8ordo3rem / 1
highlightk8ordo6rem / 1

文字の太さ

mediumk8ordo450
boldk8ordo700

太さのトークンは--font-weight-mediumと--font-weight-boldの2つです。--font-weight-mediumは450で、一般的な500より細くしています。

字間

nonek8ordo0
normalk8ordo0.025em

行の高さ

none
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.
1
tight
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.
1.25
snug
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.
1.375
normal
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.
1.5
relaxed
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.
1.625
loose
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.
2

角丸

xs0.125rem
sm0.375rem
md0.5rem
lg0.75rem
xl1rem
2xl1.25rem

角丸は要素の役割で変えます。ボタンは--radius-full、入力欄とカードは--radius-xl、チェックボックスは--radius-mdです。

影

2xs0 1px 0 0 rgb(0 0 0 / 0.05)
xs0 1px 2px 0 rgb(0 0 0 / 0.05)
sm0 1px 3px 0 rgb(0 0 0 / 0.1), 0 1px 2px -1px rgb(0 0 0 / 0.1)
md0 4px 6px -1px rgb(0 0 0 / 0.1), 0 2px 4px -2px rgb(0 0 0 / 0.1)
lg0 10px 15px -3px rgb(0 0 0 / 0.1), 0 4px 6px -4px rgb(0 0 0 / 0.1)
xl0 20px 25px -5px rgb(0 0 0 / 0.1), 0 8px 10px -6px rgb(0 0 0 / 0.1)
2xl0 25px 50px -12px rgb(0 0 0 / 0.25)

カードやポップオーバーに付ける影です。カードは--shadow-sm、モーダルとメニューは--shadow-mdを使います。--shadow-xl以上の強い影は使いません。

余白

0.5
0.125rem (2px)
1
0.25rem (4px)
2
0.5rem (8px)
3
0.75rem (12px)
4
1rem (16px)
5
1.25rem (20px)
6
1.5rem (24px)
8
2rem (32px)
10
2.5rem (40px)
12
3rem (48px)
16
4rem (64px)
20
5rem (80px)
24
6rem (96px)

余白の単位は--spacingの0.25rem(4px)です。calc(var(--spacing) * 4)のように段数を掛けて使います。tailwind.cssではp-4やgap-6のクラスが、数字×0.25remの大きさになります。

ブレイクポイント

sm≥ 640px (40rem)
md≥ 768px (48rem)
lg≥ 1024px (64rem)
xl≥ 1280px (80rem)
2xl≥ 1536px (96rem)

画面の幅でレイアウトを切り替える境目です。メディアクエリは変数を読めないので、@media (width >= 40rem)のように値を書きます。tailwind.cssではsm:のようなバリアントになります。

重なり順

z-raisedAutocomplete, Combobox, RangeSlider10
z-overlayPopover, DropdownMenu, ListBox, Tooltip1000
z-modalModal, Drawer1300
z-toastToast1500

表のoverlayとmodalの行のコンポーネントは、どれもブラウザのtop layerに開きます。top layerの中では開いた順に重なるので、この2つの値は効きません。

toastが決めるのは、ページの中でのトーストの重なり順だけです。

ダークモード

ts
document.documentElement.classList.add('dark');

<html>にdarkクラスを付けると、ページ全体がダークの値に切り替わります。

CSSのcolor-schemeプロパティも.darkの下でdarkになり、スクロールバーやフォームのコントロールも暗く描かれます。tailwind.cssでは、dark:バリアントが.darkの下で効きます。

このクラスは@k8ordo/ui自身は付けません。k8ordoのアプリでは@k8ordo/color-schemeが最初の描画の前に付けます。

印刷

deck.module.css
.deck {
  print-color-adjust: exact;
}
deck.tsx
<div className={clsx(styles.deck, 'print-as-shown')}>{slides}</div>

印刷では、.darkが付いていても、色のトークンとcolor-schemeがライトの値に戻ります。ブラウザは既定で背景を刷らないので、ダークの値のままでは白い紙に明るい文字が出ます。tailwind.cssのdark:とlight:のバリアントも、同じく切り替わります。

背景ごと刷るスライドのように、画面の配色のまま刷りたいときは、print-as-shownクラスを付けた要素を置きます。この要素を含む.darkは、印刷でもダークの値のままです。<html>にdarkが付いていればページ全体がダークのままになるので、刷らない部分は隠します。背景を刷るには、print-color-adjust: exactも指定します。

ハイコントラスト

toggle-button.module.css
.button[aria-pressed='true'] {
  background-color: var(--color-primary-bg-emphasize);

  @media (forced-colors: active) {
    background-color: var(--color-system-highlight);
    color: var(--color-system-highlight-text);
  }
}

自分で作るUIでは、@media (prefers-contrast: more)と@media (forced-colors: active)で書き分けます。強制カラーではシステムカラーだけが残るので、選択状態は--color-system-highlightのようなシステムカラーのトークンで塗ります。tailwind.cssではcontrast-more:とforced-colors:のバリアントです。

コンポーネントのスタイルシートはOSの設定に従います。prefers-contrast: moreでは、文字と線の色の背景とのコントラストが上がります。影だけで区切っていたカードやモーダルには線が付きます。forced-colors: activeでは、境界線とフォーカスリングと選択状態をシステムカラーで描きます。

警告

落とし穴

境界やフォーカスリングをbox-shadowだけで描かないでください。強制カラーでは影が消えます。要素を隠すときはvisibility: hiddenを使い、透明な文字色は使わないでください。強制カラーでは透明の色も塗られて見えます。

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。