android

android/compose-samples

Official Jetpack Compose samples.

View on GitHub Website / Demo Back to listing

23.5kstars 5.5kforks 100+contributors Kotlin

README.md

# Jetpack Compose Samples
<img src="readme/samples_montage.gif" alt="Jetpack Compose Samples" width="824" />

This repository contains a set of individual Android Studio projects to help you learn about
Compose in Android. Each sample demonstrates different use cases, complexity levels and APIs.

For more information, please [read the documentation](https://developer.android.com/jetpack/compose).

💻 Requirements
------------
To try out these sample apps, you need to use [Android Studio](https://developer.android.com/studio).
You can clone this repository or import the
project from Android Studio following the steps
[here](https://developer.android.com/jetpack/compose/setup#sample).

🧬 Samples
------------

| Project | |
|:-----|---------|
| <img src="readme/jetnews.png" alt="JetNews" width="240"></img> A sample blog post viewer that demonstrates the use of Compose with a typical Material app and real-world architecture. • Medium complexity • Varied UI • Light & dark themes • Resource loading • UI Testing **[> Browse](JetNews/)** | <img src="readme/screenshots/JetNews.png" width="320" alt="Jetnews sample demo"> |
| | |
| <img src="readme/jetchat.png" alt="Jetchat" width="240"></img> A sample chat app that focuses on UI state patterns and text input. • Low complexity • Material Design 3 theme and Material You dynamic color • Resource loading • Back button handling • Integration with Architecture Components: Navigation, Fragments, LiveData, ViewModel • Animation • UI Testing **[> Browse](Jetchat/)** | <img src="readme/screenshots/Jetchat.png" width="320" alt="Jetchat sample demo">|
| | |
| <img src="readme/jetsnack.png" alt="Jetsnack" width="240"></img> Jetsnack is a sample snack ordering app built with Compose. • Medium complexity • Custom design system • Custom layouts • Animation **[> Browse](Jetsnack/)** | <img src="readme/screenshots/Jetsnack.png" width="320" alt="Jetsnack sample demo">|
| | |
| <img src="readme/jetcaster.png" alt="Jetcaster" width="240"></img> A sample podcast app that features a full-featured, Redux-style architecture and showcases dynamic themes. • Advanced sample • Dynamic theming using podcast artwork • Image fetching • [`WindowInsets`](https://developer.android.com/reference/kotlin/android/view/WindowInsets) support • Coroutines • Local storage with Room **[> Browse](Jetcaster/)** | <img src="readme/screenshots/Jetcaster.png" width="320" alt="Jetcaster sample demo">|
| | |
| <img src="readme/reply.png" alt="Reply" width="240"></img> A compose implementation of the Reply material study, an email client app that focuses on adaptive design for mobile, tablets and foldables. It also showcases brand new Material design 3 theming, dynamic colors and navigation components. • Medium complexity • Adaptive UI for phones, tablet and desktops • Foldable support • Material 3 theming & Components • Dynamic colors and Light/Dark theme support **[> Browse](Reply/)** | <img src="readme/screenshots/Reply.png" width="320" alt="Reply sample demo">|
| | |
| <img src="readme/jetlagged_heading.png" alt="JetLagged" width="240"></img> A sample sleep tracker app, showcasing how to create custom layouts and graphics in Compose • Custom Layouts • Graphs with Paths **[> Browse](JetLagged/)** | <img src="JetLagged/screenshots/JetLagged_Full.png" width="320" alt="JetLagged sample demo">|

🧬 Additional samples
------------

| Project | |
|:-----|---------|
| <img src="readme/nia.png" alt="Now in Android" width="240"></img> An app for keeping up to date with the latest news and developments in Android. • [Jetpack Compose](https://developer.android.com/jetpack/compose) first app. • Implements the recommended Android [Architecture Guidelines](https://developer.android.com/topic/architecture) • Integrates [Jetpack Libraries](https://developer.android.com/jetpack) holistically in the context of a real world app <a href="https://play.google.com/store/apps/details?id=com.google.samples.apps.nowinandroid"><img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" height="70"></a> **[> Browse](https://github.com/android/nowinandroid)** | <img src="readme/screenshots/NiA.png" width="320" alt="Now In Android Github Repository">|
| | |
| <img src="readme/material_catalog.png" alt="Material Catalog" width="240"></img> A catalog of Material Design components and features available in Jetpack Compose. See how to implement them and how they look and behave on real devices. • Lives in AOSP—always up to date • Uses the same samples as API reference docs • Theme picker to change Material Theming values at runtime • Links to guidelines, docs, source code, and issue tracker <a href="https://play.google.com/store/apps/details?id=androidx.compose.material.catalog"><img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" height="70"></a> **[> Browse on AOSP](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:compose/integration-tests/material-catalog)** | <img src="readme/screenshots/Material_Catalog.png" width="320" alt="Material Catalog sample demo">|

## High level features

Looking for a sample that has the following features?

### Custom Layouts
* [Jetnews: Interests Screen](https://github.com/android/compose-samples/blob/ee198110d8a7575da281de9bd0f84e91970468ca/JetNews/app/src/main/java/com/example/jetnews/ui/interests/InterestsScreen.kt#L428)
* [Jetchat: AnimatedFabContent](https://github.com/android/compose-samples/blob/ee198110d8a7575da281de9bd0f84e91970468ca/Jetchat/app/src/main/java/com/example/compose/jetchat/components/AnimatingFabContent.kt#L101)
* [Jetsnack: Grid](https://github.com/android/compose-samples/blob/73d7f25815e6936e0e815ce975905a6f10744c36/Jetsnack/app/src/main/java/com/example/jetsnack/ui/components/Grid.kt#L27)
* [Jetsnack: CollapsingImageLayout](https://github.com/android/compose-samples/blob/main/Jetsnack/app/src/main/java/com/example/jetsnack/ui/snackdetail/SnackDetail.kt)

### Theming
* [Jetchat: Material3](https://github.com/android/compose-samples/blob/main/Jetchat/app/src/main/java/com/example/compose/jetchat/theme/Themes.kt#L91)
* [Jetcaster: Custom theme based on cover art](https://github.com/android/compose-samples/blob/main/Jetcaster/app/src/main/java/com/example/jetcaster/util/DynamicTheming.kt)
* [Jetsnack: Custom Design System](https://github.com/android/compose-samples/blob/main/Jetsnack/app/src/main/java/com/example/jetsnack/ui/theme/Theme.kt)

### Animations
* [Jetsurvey: AnimatedContent](https://github.com/android/compose-samples/pull/842)
* [Jetcaster: Animated theme colors](https://github.com/android/compose-samples/blob/69e9d862b5ffb321064364d7883e859db6daeccd/Jetcaster/app/src/main/java/com/example/jetcaster/util/DynamicTheming.kt)
* [Jetsnack: Animating Bottom Barl](https://github.com/android/compose-samples/blob/main/Jetsnack/app/src/main/java/com/example/jetsnack/ui/home/Home.kt)

### Text
* [Jetchat: Downloadable Fonts](https://github.com/android/compose-samples/pull/787)

### Large Screens
* [Jetcaster - Supporting Pane](https://github.com/android/compose-samples/blob/3dbbf0912b57dacefcfb79191a2d7d6b053dadb8/Jetcaster/app/src/main/java/com/example/jetcaster/ui/home/Home.kt#L282)
* [Jetnews - Window Size Classes](https://github.com/android/compose-samples/blob/69e9d862b5ffb321064364d7883e859db6daeccd/JetNews/app/src/main/java/com/example/jetnews/ui/MainActivity.kt#L36)

### TV
* [Jetcaster - TV](https://github.com/android/compose-samples/tree/3dbbf0912b57dacefcfb79191a2d7d6b053dadb8/Jetcaster/tv-app)

### Wear
* [Jetcaster - Wear](https://github.com/android/compose-samples/tree/3dbbf0912b57dacefcfb79191a2d7d6b053dadb8/Jetcaster/wear)

## Formatting

To automatically format all samples: Run `./scripts/format.sh`
To check one sample for errors: Navigate to the sample folder and run `./gradlew spotlessCheck`
To format one sample: Navigate to the sample folder and run `./gradlew spotlessApply`

## Updates

To update dependencies to their new stable versions, run:

```
./scripts/updateDeps.sh
```

Any other version updates need to be made individually.

## Obsolete Sample Projects

Over time some of our samples become a little stale and are removed to keep the
repository easy to navigate. If you are curious you can still find them in the 
history, however if you are new you might be better served sticking to
the most up to date resources.

| Project                                          | Removed    | Commit                                                              |
| ------------------------------------------------ | -----------|-------------------------------------------------------------------- |
| [Crane](../../tree/v2024.05.00/Crane)         | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) |
| [Owl](../../tree/v2024.05.00/Owl)             | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) |
| [Jetsurvey](../../tree/v2024.05.00/Jetsurvey) | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) |
| [Rally](../../tree/v2024.05.00/Rally)         | 2024-08-02 | [ee8e272](../../commit/ee8e27289f4bc36304ee9f04397f49c35f402a65) |

## License
```
Copyright 2024 The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

Repository info

Default branch: main
Latest version: v2026.08.00
Created: 2019-09-27
Last activity: 2026-10-09
License: Apache-2.0
Open issues: 9
Watchers: 431

Topics

android jetpack-compose sample

Contributors

riggaroo

440 contributions

JoseAlcerreca

321 contributions

JolandaVerhoef

298 contributions

nickbutcher

253 contributions

arriolac

232 contributions