使用可組合項預覽預覽 UI

組件由函式定義，並加上 @Composable 註解：

@Composable
fun SimpleComposable() {
    Text("Hello World")
}
AndroidStudioComposeSnippets.kt

包含「Hello World」字詞的簡單文字元素

如要啟用此可組合函式的預覽功能，請建立另一個可組合函式，並附加 @Composable 和 @Preview 註解。這個新的註解可組合項現在包含您最初建立的可組合函式 SimpleComposable：

@Preview
@Composable
fun SimpleComposablePreview() {
    SimpleComposable()
}
AndroidStudioComposeSnippets.kt

@Preview 註解會告知 Android Studio，這個可組合項應顯示在這個檔案的設計檢視畫面中。您可以即時查看編輯內容後，組合式元件預覽畫面的更新內容。

使用 Compose 預覽畫面顯示即時更新項目的 GIF 圖片

您可以在程式碼中手動新增參數，以自訂 Android Studio 轉譯 @Preview 的方式。您甚至可以多次將 @Preview 註解新增至相同函式，以預覽具有不同屬性的可組合項。

使用 @Preview 可組合項的主要優點之一，就是避免在 Android Studio 中依賴模擬器。您可以儲存需要大量記憶體的模擬器啟動作業，以便進行更多最終外觀和操作介面變更，並讓 @Preview 輕鬆進行及測試小型程式碼變更。

如要盡可能有效地運用 @Preview 註解，請務必根據螢幕接收的狀態和輸出的事件，定義螢幕。

定義 @Preview

Android Studio 提供了幾項可擴展組件預覽畫面的功能。您可以變更預覽畫面的容器設計、與它們互動，或是直接將預覽畫面部署到模擬器或裝置中。

尺寸

根據預設，系統會自動選擇可包覆內容的 @Preview 尺寸。如要手動設定尺寸，請新增 heightDp 和 widthDp 參數。系統已將這些值解譯為 dp，因此您不需要再將 .dp 加進這些值：

@Preview(widthDp = 50, heightDp = 50)
@Composable
fun SquareComposablePreview() {
    Box(Modifier.background(Color.Yellow)) {
        Text("Hello World")
    }
}
AndroidStudioComposeSnippets.kt

搭配黃色正方形顯示「Hello World」字詞

動態色彩預覽

如果已在應用程式中啟用動態色彩，請使用 wallpaper 屬性切換桌布，查看 UI 如何因應不同使用者所選的桌布做出調整。從 Wallpaper 類別提供的不同桌布主題中選取。這項功能需要 Compose 1.4.0 以上版本。

在不同裝置上使用

在 Android Studio Flamingo 中，您可以編輯 Preview 註解的 device 參數，定義可組合函式在不同裝置的設定。

可組合函式範例

如果裝置參數包含空字串 (@Preview(device = ""))，您可以按下 Ctrl + Space 來叫用自動完成功能。接著，您可以設定每個參數的值。

編輯範例函式

您可以從自動完成功能的清單中選取任何裝置選項，例如 @Preview(device = "id:pixel_4")。您也可以選擇輸入自訂裝置，方法是選擇 spec:width=px,height=px,dpi=int… 來設定各個參數的個別值。

規格清單

如要套用，請按下 Enter，或按 Esc 取消。

如果您設定無效的值，系統會以紅色底線標示宣告，並提供可能的修正方式 (Alt + Enter (macOS 為 ⌥ + ⏎) >「Replace with …」)。檢查工具會嘗試提供最接近您輸入內容的修正方式。

無效值示例

語言代碼

如要測試不同的使用者語言代碼，請新增 locale 參數：

@Preview(locale = "fr-rFR")
@Composable
fun DifferentLocaleComposablePreview() {
    Text(text = stringResource(R.string.greeting))
}
AndroidStudioComposeSnippets.kt

包含「Bonjour」字詞且帶有法國國旗的簡單文字元素

設定背景顏色

根據預設，組件會配合透明背景顯示。如要新增背景，請新增 showBackground 和 backgroundColor 參數。請注意，backgroundColor 是 ARGB Long，而不是 Color 值：

@Preview(showBackground = true, backgroundColor = 0xFF00FF00)
@Composable
fun WithGreenBackground() {
    Text("Hello World")
}
AndroidStudioComposeSnippets.kt

搭配綠色矩形顯示「Hello World」字詞

系統 UI

如果您需要在預覽畫面中顯示狀態和動作列，請新增 showSystemUi 參數：

@Preview(showSystemUi = true)
@Composable
fun DecoratedComposablePreview() {
    Text("Hello World")
}
AndroidStudioComposeSnippets.kt

正在顯示附有狀態和動作列的一項活動的預覽視窗。

UI 模式

uiMode 參數可以採用任何 Configuration.UI_* 常數，並允許您據此變更預覽行為。舉例來說，您可以將預覽畫面設為夜間模式，看看主題的回應方式。

Compose 預覽 UI

LocalInspectionMode

您可以透過 LocalInspectionMode CompositionLocal 讀取資料，查看系統是否在預覽畫面 (位於可檢視的元件內) 中算繪組合函式。如果系統在預覽畫面中算繪組合，LocalInspectionMode.current 的評估值會是 true。您可以利用這項資訊自訂預覽畫面，例如在預覽視窗中顯示預留位置圖片，而非顯示實際資料。

這樣一來，您也可以解決限制。例如顯示範例資料，而非呼叫網路要求。

@Composable
fun GreetingScreen(name: String) {
    if (LocalInspectionMode.current) {
        // Show this text in a preview window:
        Text("Hello preview user!")
    } else {
        // Show this text in the app:
        Text("Hello $name!")
    }
}
AndroidStudioComposeSnippets.kt

與 @Preview 互動

Android Studio 提供的功能可讓您與已定義的預覽畫面互動。這項互動可協助您瞭解預覽畫面的執行階段行為，並透過預覽畫面更有效地瀏覽 UI。

互動模式

在互動模式下，您可以透過類似在裝置上執行程式 (例如手機或平板電腦) 的方式與預覽畫面互動。互動模式存在於沙箱環境中，但與其他預覽隔畫面離開來，您可在預覽畫面中點選元素，並輸入使用者輸入內容。您可以透過這種模式快速測試可組合項的不同狀態、手勢，甚至是動畫。

使用者點選預覽畫面的「interactive」(互動) 按鈕

使用者與預覽畫面互動的影片

程式碼導覽與組件概述

將滑鼠游標懸停在預覽畫面上，即可查看其中所含可組合項的概述。按一下組件概述，會觸發編輯器檢視畫面，供您查看定義。

使用者將滑鼠游標懸停在預覽畫面上，促使 Studio 顯示其中所含組件的概述

執行預覽

您可以在模擬器或實體裝置上執行特定 @Preview。預覽是以新 Activity 的形式部署在同一專案應用程式中，因此共用相同的結構定義和權限。如果權限已授予，您就不需要編寫要求權限的程式碼範本。

在 @Preview 註解旁邊或預覽畫面頂端按一下「Run Preview」圖示 「執行預覽」圖示，Android Studio 就會將該 @Preview 部署至已連結的裝置或模擬器。

使用者點選預覽畫面的「run preview」(執行預覽) 按鈕

使用者將預覽部署到裝置的影片

複製 @Preview 算繪

在任何算繪出的預覽畫面上按一下滑鼠右鍵，即可複製為圖片。

使用者在預覽畫面上按滑鼠右鍵，將其複製為圖片。

相同 @Preview 註解的多個預覽畫面

您可以展示相同 @Preview 可組合項的多個版本，這些版本具有不同的規格，或傳遞至可組合項的不同參數。這樣一來，您就能減少原本需要編寫的樣板程式碼。

多格預覽範本

androidx.compose.ui:ui-tooling-preview 1.6.0-alpha01+ 導入了 Multipreview API 範本：@PreviewScreenSizes、@PreviewFontScales、@PreviewLightDark 和 @PreviewDynamicColors，因此您只要使用單一註解，即可在常見情境中預覽 Compose UI。

使用範本預覽不同的字型和螢幕大小

建立自訂多重預覽註解

使用多重預覽時，您可以定義註解類別，且其本身具有多個使用不同設定的 @Preview 註解。將此註解新增至可組合函式，即可自動轉譯所有不同的預覽畫面。舉例來說，您可以使用此註解同時預覽多種裝置、字型大小或主題，不需要針對每一個組件重複執行這些定義。

首先，請建立您的自訂註解類別：

@Preview(
    name = "small font",
    group = "font scales",
    fontScale = 0.5f
)
@Preview(
    name = "large font",
    group = "font scales",
    fontScale = 1.5f
)
annotation class FontScalePreviews
AndroidStudioComposeSnippets.kt

您可以針對預覽組件使用此自訂註解：

@FontScalePreviews
@Composable
fun HelloWorldPreview() {
    Text("Hello World")
}
AndroidStudioComposeSnippets.kt

顯示小字體與大字型的 Android Studio 設計分頁

您可以合併多重預覽註解和一般預覽註解，以建立更完整的預覽組合。合併多重預覽註解並不代表會顯示其他不同的組合。因此，每個多重預覽註解都會分開運作，並且只會顯示各自的變化版本。

@Preview(
    name = "Spanish",
    group = "locale",
    locale = "es"
)
@FontScalePreviews
annotation class CombinedPreviews

@CombinedPreviews
@Composable
fun HelloWorldPreview2() {
    MaterialTheme { Surface { Text(stringResource(R.string.hello_world)) } }
}
AndroidStudioComposeSnippets.kt

顯示所有設定中組件的 Android Studio 設計分頁

多重預覽和一般預覽的混合特性可讓您更全面地測試大型專案的許多屬性。

@Preview 和大型資料集

您經常需要將大量資料集傳遞至可組合式預覽畫面。如要這樣做，只要新增含有 @PreviewParameter 註解的參數，即可將範例資料傳送到可組合函式預覽。

@Preview
@Composable
fun UserProfilePreview(
    @PreviewParameter(UserPreviewParameterProvider::class) user: User
) {
    UserProfile(user)
}

AndroidStudioComposeSnippets.kt

如要提供範例資料，請建立可實作 PreviewParameterProvider 並以序列傳回範例資料的類別。

class UserPreviewParameterProvider : PreviewParameterProvider<User> {
    override val values = sequenceOf(
        User("Elise"),
        User("Frank"),
        User("Julia")
    )
}
AndroidStudioComposeSnippets.kt

這會在序列中為每個資料元素算繪一個預覽畫面：

顯示 Elise、Frank 和 Julia 可組合項的預覽畫面

您可以將同一個提供者類別用於多個預覽。如有需要，請設定限制參數來限制預覽數量。

@Preview
@Composable
fun UserProfilePreview2(
    @PreviewParameter(UserPreviewParameterProvider::class, limit = 2) user: User
) {
    UserProfile(user)
}
AndroidStudioComposeSnippets.kt

限制與最佳做法

Android Studio 會直接在預覽區域中執行預覽程式碼。因為它會利用名為 Layoutlib 的 Android 架構移植部分，因此不需要執行模擬器或實體裝置。Layoutlib 是 Android 架構的自訂版本，設計用於在 Android 裝置以外執行。這個程式庫的目標是在 Android Studio 中提供版面配置的預覽畫面，讓您能看到與裝置上顯示的畫面非常相似的畫面。

預覽功能限制

由於預覽畫面是在 Android Studio 中算繪，因此體積輕巧，不需要整個 Android 架構就能算繪。但這項做法有下列限制：

  • 沒有網路存取權
  • 沒有檔案存取權
  • 可能無法完整使用某些 Context API。

預覽畫面和 ViewModels

在可組合函式中使用 ViewModel 時，預覽畫面會受到限制。預覽系統無法建構傳遞至 ViewModel 的所有參數，例如存放區、用途、管理員或類似項目。此外，如果 ViewModel 參與相依性插入作業 (例如使用 Hilt)，預覽系統就無法建構整個相依性圖表來建構 ViewModel。

嘗試使用 ViewModel 預覽可組合項時，Android Studio 在轉譯特定可組合項時會顯示錯誤：

Android Studio 問題窗格，顯示「Failed to instantiate a `ViewModel`」訊息

如果您想預覽使用 ViewModel 的可組合項，請建立另一個可組合項，並將 ViewModel 的參數傳遞為可組合項的引數。這樣一來，您就不需要預覽使用 ViewModel 的可組合函式。

@Composable
fun AuthorColumn(viewModel: AuthorViewModel = viewModel()) {
  AuthorColumn(
    name = viewModel.authorName,
    // ViewModel sends the network requests and makes posts available as a state
    posts = viewModel.posts
  )
}

@Preview
@Composable
fun AuthorScreenPreview(
  // You can use some sample data to preview your composable without the need to construct the ViewModel
  name: String = sampleAuthor.name,
  posts: List<Post> = samplePosts[sampleAuthor]
) {
  AuthorColumn(...) {
    name = NameLabel(name),
    posts = PostsList(posts)
  }
}

註解類別 @Preview

您隨時可以按住 Ctrl 或 ⌘ 鍵並點選 Android Studio 中的 @Preview 註解，取得完整的參數清單，以便在自訂預覽畫面時調整參數。

annotation class Preview(
    val name: String = "",
    val group: String = "",
    @IntRange(from = 1) val apiLevel: Int = -1,
    val widthDp: Int = -1,
    val heightDp: Int = -1,
    val locale: String = "",
    @FloatRange(from = 0.01) val fontScale: Float = 1f,
    val showSystemUi: Boolean = false,
    val showBackground: Boolean = false,
    val backgroundColor: Long = 0,
    @UiMode val uiMode: Int = 0,
    @Device val device: String = Devices.DEFAULT,
    @Wallpaper val wallpaper: Int = Wallpapers.NONE,
)
AndroidStudioComposeSnippets.kt

其他資源

如要進一步瞭解 Android Studio 如何提升 @Preview 的易用性，以及瞭解更多工具提示，請參閱「Compose 工具」網誌。

下一頁
動畫預覽及偵錯