GPUI Deck

レシピのコピー

23 のカタログレシピは、再利用可能なアプリケーションソースで、ネイティブの two-style サンプルとカタログサンプルで使用されています。

23 のカタログレシピは、再利用可能なアプリケーションソースで、ネイティブの two-style サンプルと カタログサンプルで使用されています。Button と Chart にも公開コントロール用の表示レシピがあります。これらは GPUI の レイアウトを既存のコントロールと合成し、色、余白、サイズは コンシューマーの Palette またはアプリケーションが渡す Styled の値に置いています。

アプリケーションへのコピー

ソース CLI は、レシピを、推移的なレシピの依存関係、ライト/ダークの トークンソース、モジュール宣言、ライセンス、必要なアセットとともにコピーします。

cargo run -p gpui-deck-cli --locked -- list
cargo run -p gpui-deck-cli --locked -- add data-table avatar --to ../my-app/src/ui

コンシューマーで mod ui; を宣言し、ui::recipes::{DataTable, Avatar} と ui::Appearance::Settings.palette() または ui::Appearance::Compact.palette() を使用してください。 インストールガイドに記載されている Cargo の依存関係を使用します。CLI は コンシューマーのマニフェストを変更しません。ビルド時にリポジトリの現在のレシピソースを埋め込みます。 リモートレジストリや更新サービスはありません。

アプリケーションのマニフェストに次の feature 宣言を残してください。

[features]
test-support = ["gpui-deck/test-support"]

コピーされたレシピのテストは、このコンシューマーの feature で制御されています。これを宣言すると、 その cfg の値も Rust に認識されます。既存の GPUI テストを実行するには、有効にしてください。

さらに名前を指定して add を再度実行すると、同じディレクトリを拡張できます。既存のレシピと パレットへの編集は保持されます。生成された mod.rs の宣言と recipes/.gpui-deck は、インストール済みのセットを記録しています。それらのスキャフォールドが編集されている場合は、 CLI は書き込む前に停止し、宣言を手動で追加する方法を説明します。 衝突する新しいファイルも拒否されます。コピーされたソースは アプリケーションのものです。

チェックアウトを更新したら、diff でインストール済みのファイルと現在の CLI に含まれるソースを比較できます。 PATH に Git が必要です。インストール済みレシピのマニフェストを読み、管理対象ファイルの変更と欠落を表示します。 パッチの - はアプリの行、+ は CLI に含まれる行です。アプリのファイルは変更されません。

cargo run -p gpui-deck-cli --locked -- diff --to ../my-app/src/ui

手動でコピーするには、次のようにします。

  1. 必要なファイルを crates/base/examples/recipes から アプリケーションのモジュールにコピーします。リポジトリのライセンス条件は保持してください。

  2. 小さな mod.rs に倣って、コピーしたモジュールを宣言し、型を再エクスポートします。アプリケーションが必要とするモジュールだけを コピーし、それらのモジュールだけを列挙してください。

  3. presentation.rs を、 アプリケーションの recipes ディレクトリの隣にコピーします。これには、テスト済みのサンプルで使われている実際の Palette と両方の 外観が含まれており、Demo やその動作は含まれません。 これを宣言し、レシピの親モジュールでそのトークンを公開します。

    mod presentation;
    pub(crate) use presentation::{Appearance, Palette};
    mod recipes;

    アプリケーションのビューで Appearance::Settings.palette() か Appearance::Compact.palette() を 選んでください。use super::super::Palette のようなレシピのインポートは そのまま動作します。コピーしたトークンの値をアプリケーションに合わせて変更するか、Palette を 既存のトークン型に置き換えてください。AspectRatio はパレットを取りません。その視覚スタイルは コンシューマーが用意します。Bubble と Chart は、現時点ではそれぞれ独自のコピー可能なスタイリングを持っています。

  4. そのアプリケーションのモジュールから型をインポートします。それらは pub(crate) の可視性を持ち、 gpui_deck からはエクスポートされません。追加の依存関係は不要です。

パレットモジュールとレシピはアプリケーションのソースであり、ライブラリの エクスポートの外にあります。CLI はローカルでのソース配布を提供しますが、これらの視覚トークンは グローバルなテーマプロバイダーをインストールするものではありません。インタラクティブな動作は、引き続きライブラリが担います。

一部のレシピは、他のレシピモジュールを合成しています。目的のレシピと一緒に、それらのモジュールと再エクスポートも コピーしてください。

レシピ必要な他のレシピモジュール
DataTableInputGroup、EmptyState、Pagination
MessageTypography (Paragraph)
SidebarSheet
TraceTypography (Paragraph)

検証の範囲

既存の構成スイートは、ネイティブのサンプルと同じレシピモジュールを実行します。そのコマンド検索のフローは、 空状態からの回復をカバーし、日付ピッカーの フローは、グループ化された月ボタンの移動と起動をカバーします。静的な形状と パレットの値には、別個のテストスイートはありません。既存のフィールド/プリセットのフローは、 名前がない場合の回復、読み取り専用の入力に対する無効なアドオン、緊急の インラインのセマンティクス、Item の保持されるプレビュー/編集の動作をカバーします。日付ピッカーの フローは、通常の Schedule の通知が Note のままであることも確認します。既存の 3 プラットフォームの CI は、実際のコンシューマーの構成とネイティブの コンパイルを引き続きチェックします。Linux ではさらに、独立したレシピのテストを実行します。Windows と macOS は、 同じ構成ターゲットから two_styles::recipes:: のテストを除外し、 実際のアプリケーションのフローを残しつつ、レシピのみのチェックの繰り返しを避けます。さらに 1 つの 構成フローが、プリセットテーブルのソート、フィルター/空状態からの回復、 ページの境界、安定した ID によるアクション、保持される選択をカバーします。別個のデータ テストフレームワークや、プラットフォームごとに重複するフローはありません。これらの結果では、 ネイティブのスクリーンリーダー、IME、視覚、パフォーマンスの検証は確認できません。

既存のプレビューのフローは、名前付きの Spinner の描画、装飾的で フォーカス不可の Skeleton、GPUI の reduced-motion での描画、リセットのキャンセル、 パーセンテージの塗りの復元、および開閉コンテンツが閉じたときのインジケーターの削除もカバーしています。読み込み系のレシピには、 テスト関数や CI ジョブは追加されません。アニメーションのスケジューリングは、 ここに 2 つ目のテストコントローラーを置くのではなく、GPUI の責務のままです。

既存の Help フローは、合成された Breadcrumb の祖先のアクションとあわせて、Kbd の読み上げ可能な記号のキー名と、 新しいフォーカスストップがないことを確認します。 コンテキストメニューのフローは、そのキーキャップで表示される既存のショートカットを実行します。 これらの静的なキーのヒントには、別個のキーバインドのテストコントローラー、 パレットのスイート、CI ジョブはありません。ネイティブのスクリーンリーダーの音声と デスクトップでの視覚的な描画は、別の検証作業として残ります。

メディア系のレシピは、同じ構成ターゲット内に 2 つの重点的な回帰テストを追加します。 Avatar は、画像ソースがない、保留中、失敗、読み込み済み、クリア済みの各状態を実行しながら、 そのネイティブな名前、フォーカスへの中立性、固定のジオメトリを確認します。読み込み済みのパスでは、 同梱の SVG をデコードします。AspectRatio は、2 つのコンテナー幅、はみ出す コンテンツ、フレーム外でのポインターのクリップを実行します。既存のプリセットのフローは、 保持されている選択が、プレビューのアートワーク、フレームの比率、セッション名を決めることと、 既存のトリガーと解除の動作が維持されることを確認します。これらのチェックでは、 リモート画像のトランスポート、ネイティブのスクリーンリーダーの音声、デスクトップでの 視覚的な描画、パフォーマンスの測定は確認できません。

Sheet のカバレッジは、辺の配置、通常幅と狭いビューポート幅、 固定のヘッダー/フッターのジオメトリ、本体のスクロール、子孫へのフォーカスの表示、 保持されるフォーム状態での閉じと再オープンを実行します。また、 共有の Dialog の背景でのホイール処理により、下のコンテンツがスクロールしないことを確認し、 狭いウィンドウで Select を開いて、子ポップアップの水平方向の境界を確認します。 ネストされたモーダルのチェックは、最上位のダイアログでのフォーカスの封じ込めとホイールの遮断、 Sheet を開いたままそのダイアログを閉じること、 および Sheet を経由して元のトリガーに戻ることをカバーします。これらは既存の GPUI テストコンテキストでの レイアウトとインタラクションのチェックであり、その範囲では、ネイティブのスクリーンリーダー、プラットフォームの IME、 デスクトップでの視覚的な検証は確認できません。

Typography のチェックは、視覚的なサイズとは独立したネイティブの見出しレベル、 完全なアクセシブルな名前、Paragraph と Code のロール、テキストにフォーカスストップがないことを カバーします。レイアウトのカバレッジは、長いテキストとコードを使い、両方の外観を 通常幅と狭い幅で確認します。Help のコンシューマーは、既存の階層、 祖先のアクション、キーボードによる移動を維持します。構成ターゲットは、サンプルの描画スタックの回帰を確認するために、 1.5 MiB のテストスレッドスタックでも実行されます。 これらはネイティブのメタデータ、レイアウト、シミュレートされた入力のチェックです。スクリーンリーダーの 音声、プラットフォームの IME の動作、デスクトップでの視覚的な結果には、別の 検証が必要です。

Sidebar は、Settings のコンシューマーの既存の構成フローで確認されており、 別個の候補フィクスチャはありません。これらのフローは、明示的な起動、 無効なエントリー、現在のセクションのセマンティクス、保持される値、通常のフォーカスの 移動、積み重ねられた狭いウィンドウのレイアウトをチェックします。Compact の TabList の動作は、 実際のコンシューマーのフローで引き続きカバーされます。Button のネイティブなメタデータの契約が 現在のページのチェックを担い、TabsState のコアの回帰テストが、フォーカスに影響しない プログラムによる選択と変更イベントを担います。

Code Block のカバレッジは、空および複数行のコンテンツ、Unicode、完全なコードの 名前、保持される改行コード、GPUI のテスト用クリップボードを通じた全文の正確なコピーをチェックします。 レイアウトのチェックは、両方の外観、狭い幅、長い行、 長い本体を確認します。コンシューマーのフローは、コピーされた JSON に現在の設定が含まれること、 キーボードでの進入と移動、コードスクロールの端、親の Sheet のスクロール範囲からの分離を検証します。クリップボードのアサーションはテストプラットフォームでのみ実行され、 ユーザーのデスクトップのクリップボードサービスは使いません。構成ターゲットは 1.5 MiB のスタックチェックも維持します。ネイティブのクリップボード連携、スクリーンリーダーの 音声、IME、デスクトップでの視覚的な観察は、別の検証作業として残ります。

Marker のカバレッジは、意味のあるラベルが 1 つであること、装飾的な Separator が出力されないこと、 マーカーを越えた通常のフォーカス移動をチェックします。レイアウトのチェックは、長い韓国語と 英語のラベル、狭い幅、両方の外観を確認します。Schedule のチェックは、 現在選択されている日付と、移動またはキャンセルされたカレンダーのカーソルを区別し、 既存のキーボードフローを維持し、選択が変わったりクリアされたりしたときに境界を更新します。これらはメタデータ、レイアウト、 シミュレートされた入力のチェックです。ネイティブの スクリーンリーダーの音声、IME、DPI、デスクトップでの視覚的な観察は、別の 検証作業として残ります。

Message の重点的なレシピのチェックは、Comment/Label/Paragraph の階層、 渡された各テキストのアクセシブルな名前が 1 回だけ現れること、明示的な改行、長い 韓国語と英語のコンテンツ、両方の外観での狭い幅での折り返しをカバーします。 Button 自体のテストが、起動と無効時の動作をカバーします。Schedule のコンシューマーは、 共有されるメモの値、ローカルの編集メタデータ、空状態の遷移、 Edit note のフォーカス、既存の Sheet のスクロールと解除をチェックします。これらはヘッドレスの メタデータ、レイアウト、入力のチェックです。ネイティブのスクリーンリーダーの音声とデスクトップでの視覚的な検証は 別に残ります。

Attachment の重点的なレシピのチェックは、完全なファイル名による名前と、 子要素のセマンティクスを重複させない結合されたメタデータの説明、長い韓国語と英語のファイル名、 狭い幅での折り返し、両方の外観をカバーします。渡されたアクションは、Button の 個別にテストされた起動と無効時の動作を維持します。Help のコンシューマーは、 バイト数が現在の UTF-8 の JSON に従うこと、Inspect JSON が 既存のコードのフォーカス対象に到達すること、および CodeBlock が完全なコピーとスクロールの動作を維持することをチェックします。クリップボードのアサーションは GPUI のテスト用クリップボードに限られます。ネイティブのファイルアクセス、スクリーンリーダーの音声、 デスクトップでの視覚的な観察は、これらのチェックでは確認できません。

Trace の重点的なレシピのチェックは、要約の名前付け、展開のメタデータ、名前付きの Region と Paragraph の階層、閉じたコンテンツの削除、そして長い要約と 詳細が、両方の外観で狭い幅で折り返されることをカバーします。Collapsible のコアテストが、 起動、無効なトリガーの動作、閉じたときのフォーカスの復帰を担います。渡された アクションは既存の Button の契約を使用します。Help のコンシューマーは、現在のフォームの 値、 開閉状態の保持、Close details アクション、周囲の Sheet のスクロール とフォーカスをチェックします。構成ターゲットは 1.5 MiB のスタックチェックを維持します。これらのテストは ネイティブのメタデータ、レイアウト、シミュレートされた入力を確認するものです。デスクトップでの描画、 スクリーンリーダーの音声、IME、パフォーマンスには、別の検証が必要です。