ターゲットをビルドし、その Jetpack Compose @Preview 関数を PNG 画像とオプションのコンポーネント ツリー JSON ファイルにレンダリングします。
使用方法
android preview render [-h] [--component-tree] [--daemon] [--format=PARAM] [--fqn=PARAM] [--no-image] [--output=PARAM] [<reference>] [-- <build_args>]
オプション
--component-tree- コンポーネント ツリー(境界、コンポーネント名、ソースの場所、セマンティクス、パラメータ、修飾子)をコンパニオン JSON ファイルに保存します。--daemon- プレビュー レンダラを永続的なバックグラウンド デーモンとして実行します(10 分間操作がないとシャットダウンします)。-f,--format=PARAM- 出力形式(「text」または「json」。デフォルトは「text」)。--fqn=PARAM- レンダリングするプレビューの完全修飾名。複数回指定できます。-h,--help- 指定したコマンドのヘルプ メッセージを表示します。--no-image- プレビュー画像のレンダリングをスキップします(--component-tree が必要)。-o,--output=PARAM- レンダリングされたプレビュー出力を書き込むディレクトリまたはパス(デフォルトは一時ディレクトリ)。
android のオプション:
--sdk=PARAM- Android SDK へのパス。-v,--verbose- トラブルシューティング用の詳細出力を有効にします。-V,--version- バージョン情報を出力して終了します。
位置引数
<reference>- ビルド リファレンス([system://][path]?[target])。-- <build_args>- ビルドシステムにそのまま渡される引数。他の引数と区別するには、-- を使用します。
説明
android preview render は、ターゲットをコンパイルし、Jetpack Compose の @Preview 関数をオフスクリーン(デフォルトでは一時ディレクトリ、または --output で指定されたパス)にレンダリングします。生成された PNG 画像とオプションのコンポーネント ツリー JSON ファイルの絶対パスを標準出力に出力します。
ビルド参照([system://][path]?[target])を渡して、ビルドするワークスペースとターゲットを選択します。<reference> を省略すると、現在のワークスペースのデフォルト ターゲットが使用されます。
プレビュー出力をフィルタして構成する
--fqn: レンダリングする@Preview関数の完全修飾名を指定します(例:com.example.app.HomeScreenKt.HomeScreenPreview)。少なくとも 1 つの--fqnが必要です。1 回のビルドで複数のプレビューをレンダリングするには、--fqnを繰り返します。または、android preview listを実行して、利用可能なプレビューを検出します。-o, --output: レンダリングされたプレビュー出力が書き込まれるディレクトリまたはパス(.pngまたは.json)(デフォルトは一時ディレクトリ)。--daemon: プレビュー レンダラをバックグラウンド デーモンとして実行し続けます。このデーモンは、10 分間操作がないとシャットダウンします。これにより、後続のレンダリングが高速化されます。--component-tree: レンダリングされたコンポーネントの階層、境界、ソースの場所、セマンティクス、パラメータ、修飾子を含むコンパニオン JSON ファイルを書き込みます。--no-image:--component-treeJSON 出力のみが必要な場合に、PNG 画像の生成をスキップします。-f, --format:text(デフォルト)または構造化json出力を選択します。
例
現在の Gradle ワークスペースの :app で特定の @Preview 関数をレンダリングします。
android preview render :app --fqn=com.example.app.HomeScreenKt.HomeScreenPreview
バックグラウンド デーモンを使用して複数の @Preview 関数をレンダリングし、そのコンポーネント ツリーをエクスポートします。
android preview render :app \
--daemon \
--component-tree \
--fqn=com.example.app.HomeScreenKt.HomeScreenPreview \
--fqn=com.example.app.SettingsScreenKt.SettingsPreview