컴포저블 미리보기로 UI 미리보기

컴포저블은 함수로 정의되고 @Composable로 주석이 지정됩니다.

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

'Hello World'라는 단어가 포함된 간단한 텍스트 요소

이 컴포저블의 미리보기를 사용 설정하려면 @Composable 및 @Preview 주석이 달린 다른 컴포저블을 만듭니다. 주석이 달린 이 새로운 컴포저블에는 이제 처음에 만든 컴포저블인 SimpleComposable가 포함됩니다.

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

@Preview 주석은 이 컴포저블이 이 파일의 디자인 뷰에 표시되어야 한다고 Android 스튜디오에 알립니다. 수정할 때 컴포저블 미리보기의 실시간 업데이트를 확인할 수 있습니다.

Compose 미리보기를 사용한 실시간 업데이트를 보여주는 gif

코드에 매개변수를 수동으로 추가하여 Android 스튜디오의 @Preview 렌더링 방식을 맞춤설정할 수 있습니다. @Preview 주석을 동일한 함수에 여러 번 추가하여 속성이 다른 컴포저블을 미리 볼 수도 있습니다.

@Preview 컴포저블을 사용하는 주요 이점 중 하나는 Android 스튜디오에서 에뮬레이터에 의존하지 않아도 된다는 것입니다. 메모리 사용량이 많은 에뮬레이터 시작을 절약하여 최종 디자인과 분위기를 변경할 수 있으며, 작은 코드 변경을 쉽게 실행하고 테스트할 수 있는 @Preview의 기능을 사용할 수 있습니다.

@Preview 주석을 가장 효과적으로 활용하려면 입력으로 수신하는 상태와 출력되는 이벤트 측면에서 화면을 정의해야 합니다.

@Preview 정의

Android 스튜디오는 컴포저블 미리보기를 확장할 수 있는 기능을 제공합니다. 컨테이너 디자인을 변경하거나 미리보기와 상호작용하거나 에뮬레이터 또는 기기에 미리보기를 직접 배포할 수 있습니다.

크기

기본적으로 콘텐츠를 래핑하기 위해 @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 스튜디오 Flamingo에서 미리보기 주석의 device 매개변수를 수정하여 다양한 기기에서 컴포저블의 구성을 정의할 수 있습니다.

구성 가능한 함수 샘플

기기 매개변수에 빈 문자열 (@Preview(device = ""))이 있으면 Ctrl + Space를 눌러 자동 완성을 호출할 수 있습니다. 그런 다음 각 매개변수의 값을 설정할 수 있습니다.

샘플 함수 수정

자동 완성의 목록에서 기기 옵션(예: @Preview(device = "id:pixel_4"))을 선택할 수 있습니다. 또는 spec:width=px,height=px,dpi=int…를 선택하여 각 매개변수의 개별 값을 설정하여 맞춤 기기를 입력할 수 있습니다.

사양 목록

적용하려면 Enter 키를 누르거나 Esc 키를 사용하여 취소하세요.

잘못된 값을 설정하면 선언에 빨간색 밑줄이 표시되고 수정사항을 사용할 수 있습니다 (macOS의 경우 Alt + Enter (⌥ + 비용) > Replace with ...). 검사에서는 입력과 가장 유사한 수정사항을 제공하려고 시도합니다.

잘못된 값의 예

언어

다양한 사용자 언어를 테스트하려면 locale 매개변수를 추가합니다.

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

프랑스 국기와 함께 'Bonjour'라는 단어가 포함된 간단한 텍스트 요소

배경 색상 설정

기본적으로 컴포저블은 투명한 배경에 표시됩니다. 배경을 추가하려면 showBackground 및 backgroundColor 매개변수를 추가합니다. backgroundColor는 Color 값이 아닌 ARGB Long입니다.

@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 스튜디오에서는 정의된 미리보기와 상호작용할 수 있는 기능을 제공합니다. 이 상호작용을 통해 미리보기의 런타임 동작을 이해하고 미리보기를 통해 UI를 더 효과적으로 탐색할 수 있습니다.

대화형 모드

대화형 모드를 사용하면 프로그램을 실행하는 기기(예: 휴대전화나 태블릿)에서와 비슷한 방식으로 미리보기와 상호작용할 수 있습니다. 대화형 모드는 샌드박스 환경에서 격리됩니다 (즉, 다른 미리보기와 격리됨). 이 환경에서는 요소를 클릭하고 미리보기에 사용자 입력을 입력할 수 있습니다. 이렇게 하면 컴포저블의 다양한 상태와 동작, 애니메이션까지 빠르게 테스트할 수 있습니다.

미리보기의 '대화형' 버튼을 클릭하는 사용자

미리보기와 상호작용하는 사용자의 동영상

코드 탐색 및 컴포저블 개요

미리보기 위로 마우스를 가져가면 미리보기 내에 포함된 컴포저블의 개요가 표시됩니다. 컴포저블 개요를 클릭하면 편집기 뷰가 컴포저블 정의로 이동합니다.

사용자가 미리보기 위로 마우스를 가져가면 스튜디오에 컴포저블의 윤곽선이 표시됩니다.

미리보기 실행

에뮬레이터나 실제 기기에서 특정 @Preview를 실행할 수 있습니다. 미리보기는 새 Activity와 동일한 프로젝트 앱 내에 배포되므로 동일한 컨텍스트와 권한을 공유합니다. 이미 권한이 부여된 경우 권한을 요청하는 상용구 코드를 작성할 필요가 없습니다.

@Preview 주석 옆이나 미리보기 상단에 있는 Run Preview 아이콘 미리보기 실행 아이콘을 클릭하면 Android 스튜디오에서 @Preview를 연결된 기기나 에뮬레이터에 배포합니다.

미리보기의 '미리보기 실행' 버튼을 클릭하는 사용자

기기에 미리보기를 배포하는 사용자의 동영상

@Preview 렌더링 복사

렌더링된 모든 미리보기는 마우스 오른쪽 버튼으로 클릭하여 이미지로 복사할 수 있습니다.

사용자가 미리보기를 클릭하여 이미지로 복사합니다.

동일한 @Preview 주석의 여러 미리보기

사양이 다르거나 컴포저블에 전달된 서로 다른 매개변수를 사용하여 동일한 @Preview 컴포저블의 여러 버전을 표시할 수 있습니다. 이렇게 하면 달리 작성해야 하는 상용구 코드를 줄일 수 있습니다.

다중 미리보기 템플릿

androidx.compose.ui:ui-tooling-preview 1.6.0-alpha01+에는 다중 미리보기 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 스튜디오 디자인 탭

여러 개의 다중 미리보기 주석과 일반 미리보기 주석을 결합하여 보다 완전한 미리보기 집합을 만들 수 있습니다. 다중 미리보기 주석을 결합한다고 해서 다양한 조합이 모두 표시되는 것은 아닙니다. 대신 각 다중 미리보기 주석이 독립적으로 작동하며 다중 미리보기 주석 고유의 변형만 렌더링합니다.

@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 스튜디오 디자인 탭

다중 미리보기와 일반 미리보기의 혼합 특성 덕분에 대규모 프로젝트의 여러 속성을 더 종합적으로 테스트할 수 있습니다.

@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

이렇게 하면 시퀀스의 데이터 요소당 하나의 미리보기를 렌더링합니다.

엘리스, 프랭크, 줄리아의 컴포저블을 보여주는 미리보기

여러 미리보기에 같은 제공자 클래스를 사용할 수 있습니다. 필요한 경우 제한 매개변수를 설정하여 미리보기 수를 제한합니다.

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

제한사항 및 권장사항

Android 스튜디오는 미리보기 영역에서 직접 미리보기 코드를 실행합니다. 에뮬레이터나 실제 기기를 실행할 필요가 없습니다. Layoutlib라는 Android 프레임워크의 포팅된 부분을 활용하기 때문입니다. Layoutlib은 Android 기기 외부에서 실행되도록 설계된 Android 프레임워크의 맞춤 버전입니다. 라이브러리의 목표는 Android 스튜디오에서 기기에서의 렌더링에 매우 가까운 레이아웃의 미리보기를 제공하는 것입니다.

미리보기 제한사항

미리보기는 Android 스튜디오 내에서 렌더링되는 방식 때문에 가볍고 전체 Android 프레임워크에서 렌더링할 필요가 없습니다. 하지만 여기에는 다음과 같은 제한사항이 있습니다.

  • 네트워크에 액세스할 수 없음
  • 파일에 액세스할 수 없음
  • 일부 Context API를 완전히 사용하지 못할 수도 있음

미리보기 및 ViewModels

컴포저블 내에서 ViewModel를 사용하면 미리보기가 제한됩니다. 미리보기 시스템은 ViewModel에 전달된 모든 매개변수(예: 저장소, 사용 사례, 관리자 등)를 구성할 수 없습니다. 또한 ViewModel가 종속 항목 삽입에 참여하면 (예: Hilt 사용) 미리보기 시스템은 ViewModel를 구성하기 위해 전체 종속 항목 그래프를 빌드할 수 없습니다.

ViewModel를 사용하여 컴포저블을 미리 보려고 하면 Android 스튜디오에서 특정 컴포저블을 렌더링할 때 오류가 표시됩니다.

&#39;ViewModel&#39; 메시지를 인스턴스화할 수 없음이 표시된 Android 스튜디오 문제 창

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

언제든지 Android 스튜디오에서 @Preview 주석을 'Ctrl 또는 ⌘ + 클릭'하면 미리보기를 맞춤설정할 때 조정할 수 있는 매개변수의 전체 목록을 확인할 수 있습니다.

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 스튜디오에서 @Preview의 사용 편의성을 높이는 방법에 관한 자세한 내용과 도구 팁에 관한 자세한 내용은 Compose 도구 블로그를 참고하세요.

다음
애니메이션 미리보기 및 디버그