Jetpack Compose API의 스타일 가이드라인

앱용 Compose 코드를 작성하거나 Compose 라이브러리 및 API를 빌드하는 경우 권장사항에 따라 코드를 확장 가능하고 성능이 우수하며 나머지 생태계와 일관되게 만드세요.

다음 문서에서는 Compose를 사용하는 코드를 작성하는 모든 사용자를 위한 가이드라인을 제공합니다.

  • Jetpack Compose용 API 가이드라인: Jetpack Compose 컴파일러 플러그인 및 런타임을 사용하는 모든 시스템의 패턴, 권장 사항, 규범적 스타일 가이드라인을 간략하게 설명합니다. 다음 주제가 포함되어 있습니다.
  • Jetpack Compose의 @Composable 구성요소용 API 가이드라인: 다음 주제를 비롯하여 @Composable UI 구성요소를 만들고 사용하는 데 관한 가이드라인 및 권장사항을 제공합니다.
    • 구성요소 만들기 및 레이어링
    • 새 구성요소 이름 지정
    • 구성요소 종속 항목 표현
    • @Composable 구성요소의 매개변수
    • 구성요소 관련 클래스 및 함수를 만들기 위한 올바른 패턴 따르기
    • @Composable 구성요소 문서화
    • 구성요소의 접근성 개선
    • 하위 호환성을 유지하면서 구성요소 API 업데이트

잠재고객

이 가이드라인은 다음 세 가지 잠재고객을 대상으로 작성되었습니다.

  • Jetpack Compose를 기반으로 앱을 빌드하는 개발자. 앱의 일부에서 Jetpack Compose를 사용하는 경우 이 그룹에 속합니다.
  • Jetpack Compose 프레임워크 개발을 진행하는 개발자. androidx.compose 라이브러리에 기여하는 경우 이 그룹에 속합니다.
  • Jetpack Compose를 기반으로 라이브러리를 만드는 개발자. Compose API 또는 Compose UI 요소 라이브러리를 만드는 경우 이 그룹에 속합니다. 이러한 Compose 구성요소 라이브러리는 공개적으로 제공되거나 회사 또는 팀에 로컬일 수 있습니다.

속한 그룹에 따라 각 스타일 가이드라인의 엄격성 수준이 다릅니다. 예를 들어 Jetpack Compose 프레임워크 개발은 일반적으로 이러한 가이드라인을 가장 엄격하게 준수합니다.

각 개발자 잠재고객의 요구사항에 관한 자세한 내용은 RFC2119를 참고하세요.

프레임워크 및 가이드라인에 기여

androidx 코드베이스의 일부 라이브러리와 스타일 가이드라인 (Compose API 가이드라인 및 @Composable 구성요소 가이드라인) 자체에 기여해 주시면 감사하겠습니다.

기여하려면 androidx 기여 가이드의 안내를 따르세요.