Kalka
ドキュメント

コンポーネントと変数

バリアントとプロパティを持つ再利用可能なコンポーネント、コレクションとモードを扱う変数ページ、変数が CSS カスタムプロパティとデザイントークンになる仕組み。

docs / components-variables

コンポーネント

コンポーネントは、ボタン、カード、ナビゲーションバーのように繰り返し使うデザインです。そのコピーであるインスタンスはコンポーネントに従います。コンポーネントを変えるとすべてのインスタンスが変わります。ただし、インスタンスで上書きした部分は除きます。

  • コンポーネントを作成: レイヤーを選択して Cmd Alt K(Ctrl Alt K)を押します。
  • インスタンスを作る: アセット パネルからコンポーネントをキャンバスへドラッグするか、そこにある インスタンスを挿入 を使います。
  • メインコンポーネントに移動 で、インスタンスからそのコンポーネントへジャンプします。
  • インスタンスの切り離し(Cmd Alt B、Ctrl Alt B)で、インスタンスを普通のレイヤーに戻します。

アセット パネルには、ドキュメントのコンポーネントがグリッドまたはリストで並び、検索もできます。

バリアント

バリアントは 1 つのコンポーネントのバージョン違いです。たとえばプライマリとセカンダリ、小と大があるボタンです。複数のコンポーネントを選択して コンポーネントセットを作成(Shift Cmd K、Ctrl Shift K)を使い、バリアントプロパティとその値を追加します。各バリアントには、ほかと重ならない値の組み合わせが必要です。インスタンスでは、デザインパネルからバリアントを切り替えます。

コンポーネントプロパティ

コンポーネントはバリアントのほかに、次のものを公開できます。

  • テキスト プロパティ:インスタンスごとにラベルを変える
  • ブール値 プロパティ:一部を表示/非表示にする
  • インスタンスの入れ替え プロパティ:アイコンなど、入れ子のコンポーネントを差し替える
  • スロット:インスタンスごとに独自のレイヤーを入れられる領域。数の上限を設定できる

デザインパネルの プロパティを作成… で作るか、フィールドから コンポーネントプロパティを適用 で作ります。インスタンスでは、これらのプロパティがデザインパネルの最上部に表示されます。

動作

コンポーネントを本物のコントロールのように動かせます。スイッチ、チェックボックス、スライダー、タブ、テキストフィールド、アコーディオン、ホバー、押下、フォーカス、無効の状態を持つボタンなどです。コンポーネントの 動作 セクションで選びます。表示 › プレビュー(Cmd Alt Enter)を使うと、コントロールが実際に動きます。テキストフィールドに入力したり、スライダーをドラッグしたり、アコーディオンを開いたりでき、キーボードでも操作できます。試している間、ドキュメントは何も変わりません。Esc で編集に戻ります。

ライブラリ

ドキュメント間でコンポーネントを共有するには、ライブラリを公開する でドキュメントをライブラリとして公開し、別のドキュメントの ライブラリを管理する で有効にします。ライブラリが変わると、ライブラリの更新を確認する で変更点を並べて、または重ねて確認してから更新できます。

変数

変数は、ブランドカラー、余白、フォントサイズ、ラベルなど、繰り返し使う名前付きの値です。変数を変えると、それを使うすべてのレイヤーが追従します。

変数ページを開く

左側のレールで 変数 をクリックします。デスクトップのエディタでは、変数ページがパネルとキャンバスの上に開きます。もう一度 変数 を押すか、別のパネルを選ぶか、Esc を押すと、キャンバスが元どおりに戻ります。表示 › 変数… や、何も選択していないときのデザインパネルの 変数を開く からも開けます。スマートフォンの画面ではダイアログとして開きます。

Tokens コレクションを開いた変数ページ。カラー、余白、角丸の変数にライトとダークの値、CSS 名があり、下に生成されたスタイルシートがある
変数ページ。各変数の CSS 名とモードごとの値、そして Kalka が書き出すスタイルシート。

種類

種類 用途
カラー 塗り、線、シャドウの色
数値 サイズ、余白、角丸、不透明度、フォントサイズ
テキスト ラベル、文章、フォントファミリー
ブーリアン (真偽値) レイヤーの表示など、true か false

変数は スコープ で使えるフィールドを絞れるので、余白の変数が色のリストに出てくることはありません。CSS 式 を使うと、コード上で clamp(1rem, 4vw, 1.5rem) のような値を持たせられます。

コレクションとモード

変数は Colors や Spacing のような コレクション に属し、グループで整理できます。コレクションには モード を持たせられます。ライトとダーク、コンパクトとゆったり、ブランドごとなどです。各変数はモードごとに値を持ちます。

各モードには、書き出した CSS で適用される条件を指定します。

  • data-theme のような属性で手動で切り替える
  • システムがダークモードまたはライトモードのとき
  • ハイコントラストや視差効果を減らす設定のとき
  • 画面幅、またはコンテナの幅がある値より小さい、または大きいとき
  • 自分で書いた任意の CSS セレクタ、または @media、@supports、@container クエリのもと

変数を使う

フィールドの横で 変数を使用 をクリックし、小さなリストから選びます。カラー変数と数値変数は、ポインタを重ねるとキャンバス上でプレビューできます。変数のリンクを解除 で普通の値に戻ります。すでに設定した値からは、カラー変数を作成 または 数値変数を作成 で一度に変数にできます。

コードの中の変数

変数は CSS カスタムプロパティです。各コレクションのデフォルトモードは :root に書かれ、ほかのモードは異なる値だけをその条件のもとで上書きします。Gray/50 という名前の変数は --color-gray-50 に、Space/small は --spacing-small になります。CSS 名は自分で設定することもできます。

変数ページでは次のことができます。

  • すべての変数を CSS としてコピー、または すべての変数を Tailwind テーマとしてコピー(@theme)
  • デザイントークンとして書き出す: W3C デザイントークンの .zip。コレクションのモードごとに 1 ファイル
  • デザイントークンを読み込む: .json、.tokens、.zip ファイルから。同じ名前の変数は更新され、削除されるものはありません。

Kalka フォルダでは、変数は W3C デザイントークンとして design-system/tokens.json に、CSS として design-system/tokens.css に保存されます。ファイルとバージョンを参照してください。