デザインシステムライブラリへのバインド
プロダクト画面は、ローカルレイヤーだけでなく、プロジェクトのデザインシステムを使用しなければなりません。
プリセットの選択
各デザインシステムには、presets/ に1つのプリセットがあります。ユーザーにどのプリセットを使用するか尋ねるか、プロジェクトの依存関係を確認してください(例:プロジェクトがデザイントークンパッケージに依存している場合は、対応するプリセットを使用します)。フォーマットは presets/README.md を参照してください。プリセットがない場合は、以下の「自動バインドの仕組み」に従って一度だけ検索し、結果を新しいプリセットとして保存します。プロジェクトにライブラリがない場合は、「None」と書き、レポートにその旨を記載します。
開始する前に、get_libraries を使用して、すべてのライブラリが libraries_added_to_file に含まれていることを確認してください。不足しているものがある場合は、ユーザーに Figma の Assets › Libraries から追加するよう依頼し、追加されるまで続行しないでください。
バインドルール
画面を変更するよりも、何かをバインドしないままにしておく方が良いです。ツールは以下のことだけを行い、それ以外はローカルのままにしてレポートします。
| タイプ | ルール | やってはいけないこと |
|---|---|---|
| カラー | 不透明度も含めて完全一致の場合のみバインドします。半透明の色は、その透明度を持つトークンが必要です。Figma はバインド時に不透明度を1にリセットするためです | 最も近い色にスナップしない |
| 角丸、ストローク、スペーシング、タイプサイズ | 値が完全に等しい場合のみバインドします | 3px を 2px や 4px に変更しない |
| エイリアストークン | 別のトークンを指すトークン(プリミティブ上のセマンティックトークン)は、チェーンの最後の値としてカウントされます。値に両方がある場合、自身の値を持つトークンが優先されます。エイリアスは、他のトークンが持っていない値にのみ使用されます | 同じ値を持つ2つのセマンティックトークンを推測で選択せず、報告する |
| テキストスタイル | フォント、サイズ、行の高さがすべて等しい場合のみバインドします | フォントが異なる場合、サイズのみバインドする |
| アイコン | ライブラリに同じ名前のコンポーネントがある場合のみ置き換えます。同じ目的を持つことが確認されたマッピングについてのみ、古い名前を受け入れます | 意味は似ているが外観が異なるアイコンを使用しない |
| コンポーネント | ライブラリのコンポーネントがプロダクトのものと同じに見える場合のみ置き換えます。プロダクトのサイズは維持します | 見た目が異なる場合は、ローカルコンポーネントを維持し、プロダクト画面を変更しない |
なぜ最も近い値にスナップしないのか:一致する値は一致する意味を意味するわけではなく、ステートボードとコードが一致しなくなります。一致するトークンがない値はデザインシステムのギャップです。ツールに選ばせるのではなく、設計者が決定できるようにリストアップします。
自動バインドの仕組み
プリセットを使用する場合、al-capture.cjs の設定で preset を設定し、al-pack.py の4番目の引数としてプリセット名を渡します。画面はビルド時に自動的にバインドされます。プリセットがない場合のみ、以下のプロセスに従い、結果を presets/<name>.json として保存します。libs はバインド設定、extract は抽出中に使用されるスプライトマッピングです。
- レイアウトツリーを抽出した後、JSON 内のすべての
lib(アイコン名)をリストアップします - 各名前について、
search_design_systemでアイコンシステムを検索します。system:crossはicon / system / crossにマッピングされます。完全な名前の一致のみを受け入れます search_design_systemを使用してコンポーネントセットを見つけ、いくつかのインスタンスを配置し、スクリーンショットを撮り、プロダクトの見た目と比較してbuttons.rulesを決定しますopts.libsを組み立てます。最初に3~4個のカードをビルドし、log.driftとスクリーンショットを確認します。正しく見える場合のみバッチ処理します
const libs = {
tokens: ['My DS - Foundation'], // これらのライブラリから変数を読み取る
icons: { 'system:cross': '<componentKey>' },
buttons: {
set: '<componentSetKey>',
rules: { FFE13A: { Type: 'primary', Size: 'medium', Compact: 'false', Status: 'default' } }, // キーはボタンの背景色
},
words: { value: 'Price' }, // テキストプロパティをチームの用語に合わせて名前変更する
};
al-capture.cjs の出力には unmappedIcons が含まれ、今回使用されたがプリセットがまだマッピングしていないアイコンがリストされます。search_design_system でそれらを検索し、完全な名前の一致をプリセットに追加します。次回は自動的にバインドされるため、プリセットは使用とともにより完全になります。
__alBuild が返す stat にはバインド結果が含まれます:boundColors、boundLayout、libIcons、dsButtons、unboundColors、localIcons。
既存画面のバインド
al-bind.js は単独で使用できます。トークンのみをバインドし、アイコンやコンポーネントは置き換えません。スクリプト全体を use_figma に貼り付けるか(eval で読み込む)、次のように呼び出します:
return await __alBind(['<frame id>'], { tokens: ['<library name>'] });
これは boundColors、boundLayout、unboundColors(トークンのない色)を返します。skippedText は、フォントを読み込めなかったテキストの数をカウントするため、そのサイズはバインドされないままになります。
__alBuild で画面がビルドされると、トークンテーブルは _registry にキャッシュされるため、以降の画面で毎回変数をインポートする必要はありません。プリセットが異なるトークンライブラリをリストしている場合、再構築されます。ライブラリが新しいトークンや変更されたトークンを公開した後は、次の __alBuild 呼び出しに refreshTokens: true を渡します。
コンポーネント
- Auto Layout で中央揃え:パディングやテキストボックスの幅ではなく、テキストを変更しても位置がずれないようにする
- コンテナはコンポーネントではない:既にコンポーネントを含む繰り返し構造は、単なるコンテナです
- ステートはバリアント:選択済みと無効は、インスタンスの色を上書きするのではなく、プロパティで切り替え可能でなければなりません
- 小さなコンポーネントをプロパティに分割:2つのバリアントプロパティ
TypeとState。テキストはコンポーネントプロパティにします - メインコンポーネントは完全である必要がある:ビューポートで切り取られた要素をコンポーネントにしない
レポート
常に以下をリストアップします:
- バインド比率:色、レイアウト値
- ライブラリバージョンに置き換えられたアイコンとコンポーネントの数
- トークンのない色(上位いくつか)、設計者が決定できるようにするため
- ローカルのままにされたアイコンとコンポーネント、およびその理由