Android Studio render-compose-preview

在 Android Studio 中算繪 Compose 預覽畫面。

用量

android studio render-compose-preview [-h] [--output-image-file=PARAM] [--pid=PARAM] [--print-semantics] [--project=PARAM] <path> <composable>

選項

  • -h,--help：顯示指定指令的說明訊息。
  • --output-image-file=PARAM：要寫入結果圖片的檔案名稱。
  • --pid=PARAM：要連線的 Android Studio 執行個體 PID。
  • --print-semantics：如果為 true，則會列印語意樹狀結構。
  • --project=PARAM - 在 Android Studio 中開啟要查詢的專案名稱或路徑。使用 android studio check 取得可用專案的名稱。

android 選項：

  • --sdk=PARAM - Android SDK 的路徑。
  • -v,--verbose - 啟用詳細輸出功能以利疑難排解。
  • -V,--version - 列印版本資訊並結束。

位置引數

  • <path> - 包含 Compose 預覽畫面的檔案路徑，相對於目前目錄或絕對路徑。
  • <composable> - 可組合函式的名稱。

說明

android studio render-compose-preview 會使用 Android Studio 的版面配置算繪引擎算繪 Jetpack Compose @Preview 函式，並視需要列印其無障礙功能語意樹狀結構。

須使用 Android Studio Quail 2 以上版本。

設定預覽輸出內容 (--output-image-file 和 --print-semantics)

  • --output-image-file：將算繪的 PNG 預覽畫面儲存至指定檔案路徑。如果省略，系統會建立暫時的 PNG 檔案。
  • --print-semantics：以 JSON 格式列印 Compose 預覽畫面的無障礙元件資訊樹狀結構，方便 AI 代理檢查互動式節點、文字和邊界，以及算繪的視覺化圖片。

範例

將 HotelDetailScreenPreview 算繪至 preview_hotel.png，並列印其語意樹狀結構：

android studio render-compose-preview \
  --output-image-file=preview_hotel.png \
  --print-semantics \
  app/src/main/java/com/example/myapp/ui/DetailScreen.kt \
  HotelDetailScreenPreview