tree: 25b6aaec5229fa894b2c2391d709bec6a2988c7b [path history] [tgz]
  1. OWNERS
  2. README.md
  3. animation/
  4. benchmark-utils/
  5. compiler/
  6. desktop/
  7. docs/
  8. foundation/
  9. integration-tests/
  10. lint/
  11. material/
  12. material3/
  13. runtime/
  14. test-utils/
  15. ui/
compose/README.md

Jetpack Compose

Intro

Jetpack Compose is a suite of libraries within the AndroidX ecosystem. For more information, see our project page

Syntax

Jetpack Compose uses composable functions instead of XML layouts to define UI components. You can see this in action in the demos, like androidx.compose.material.demos.ButtonDemo.kt. More information can be found in the compiler README.

Compiler

Composable functions are built using a custom Kotlin compiler plugin. More information about the compiler plugin is available in this README.

Getting started

To try out Jetpack Compose you need to set up the toolchain for AndroidX development. Follow the process here to check out the code.

To start the required version of Android Studio, you need to run the ANDROIDX_PROJECTS=COMPOSE ./gradlew studio

cd path/to/checkout/frameworks/support/
ANDROIDX_PROJECTS=COMPOSE ./gradlew studio

Also if you would like to build from the command line, all gradle commands need to be run from the frameworks/support folder. E.g. to build the demo app, run:

cd path/to/checkout/frameworks/support/
./gradlew :compose:integration-tests:demos:installDebug

Structure

Library code for Jetpack Compose lives under the frameworks/support/compose directory. Additionally, sample code can be found within each module in the integration-tests subdirectories. Run the demos app to see examples of components and behavior.

Guidance and documentation

Get started with Jetpack Compose

Samples

Pathway course

Feedback

To provide feedback or report bugs, please refer to the main AndroidX contribution guide and report your bugs here

Release notes

Browse source

Existing open bugs

File a new bug

Slack