compose-samples README

The project's README from github.com/android/compose-samples. As one markdown file: README.md.

Jetpack Compose Samples

Jetpack Compose Samples

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.

💻 Requirements

To try out these sample apps, you need to use Android Studio. You can clone this repository or import the project from Android Studio following the steps here.

🧬 Samples

Project

JetNews

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 sample demo

Jetchat

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 sample demo

Jetsnack

Jetsnack is a sample snack ordering app built with Compose.

• Medium complexity
• Custom design system
• Custom layouts
• Animation

> Browse

Jetsnack sample demo

Jetcaster

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 support
• Coroutines
• Local storage with Room

> Browse

Jetcaster sample demo

Reply

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 sample demo

JetLagged

A sample sleep tracker app, showcasing how to create custom layouts and graphics in Compose

• Custom Layouts
• Graphs with Paths

> Browse

JetLagged sample demo

🧬 Additional samples

Project

Now in Android

An app for keeping up to date with the latest news and developments in Android.

• Jetpack Compose first app.
• Implements the recommended Android Architecture Guidelines
• Integrates Jetpack Libraries holistically in the context of a real world app


> Browse

Now In Android Github Repository

Material Catalog

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


> Browse on AOSP

Material Catalog sample demo

High level features

Looking for a sample that has the following features?

Custom Layouts

Theming

Animations

Text

Large Screens

TV

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 2024-08-02 ee8e272
Owl 2024-08-02 ee8e272
Jetsurvey 2024-08-02 ee8e272
Rally 2024-08-02 ee8e272

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.

compose-samples (android/compose-samples)

Searching Database…

Что это такое?Официальная подборка примеров приложений от Google для изучения Jetpack Compose — современного инструментария для создания интерфейсов Android. Каждый пример — отдельный проект для Android Studio, показывающий разные сценарии использования, уровни сложности и API.
Это одно приложение или много отдельных проектов?Много отдельных проектов: каждый пример — самостоятельное приложение, которое открывается и запускается отдельно, — от простого просмотрщика блог-постов до полноценного подкаст-клиента.
Как запустить какой-нибудь из этих примеров?Установите Android Studio, затем либо склонируйте этот репозиторий, либо импортируйте проект прямо из Android Studio и запустите пример на эмуляторе или устройстве.
Нужно ли что-то ещё, кроме Android Studio?Нет — в README единственным требованием названа Android Studio. Каждый пример — обычный Gradle-проект, поэтому всё остальное подтянется автоматически при открытии и сборке.
Всё ли в репозитории ещё актуально?Нет — устаревшие примеры удаляют, чтобы репозиторий оставался удобным для навигации: Crane, Owl, Jetsurvey и Rally были удалены в августе 2024 года и теперь существуют только в истории git.
Примеры подойдут новичкам или рассчитаны на опытных разработчиков?И тем, и другим: Jetchat помечен как простой, Jetsnack и Reply — среднего уровня, а подкаст-приложение Jetcaster — продвинутый: архитектура в стиле Redux, корутины и Room для локального хранения данных.
Это только для Android или можно запустить и на компьютере?Они нацелены на Android — телефоны, планшеты и складные устройства: почтовый клиент Reply создан специально для адаптивного дизайна на таких экранах, а у Jetcaster есть ещё версии для TV и Wear.
Какие приложения туда входят?Шесть основных примеров: JetNews (просмотрщик блог-постов), Jetchat (чат), Jetsnack (заказ снеков с собственным дизайн-системом), Jetcaster (подкаст-плеер), Reply (адаптивный почтовый клиент) и трекер сна с кастомными макетами и графиками, а ещё новостное приложение и каталог компонентов Material.
Какие приёмы Compose они демонстрируют?Кастомные макеты и графику (сетка в Jetsnack, графики на Path в трекере сна), темизацию (Material 3, собственные дизайн-системы, динамический цвет из обложек подкастов), анимации, загружаемые шрифты и поддержку больших экранов через window size classes.
Есть ли пример, где все компоненты Material собраны в одном месте?Да — каталог компонентов Material Design, который живёт в AOSP, поэтому он всегда актуален и использует те же примеры, что и справочная документация по API. Там же есть переключатель тем, чтобы менять значения Material Theming на ходу.
Как поддерживать форматирование кода, если я что-то поменяю в примере?Запустите ./scripts/format.sh, чтобы отформатировать все примеры разом, или внутри папки примера используйте ./gradlew spotlessCheck, чтобы найти проблемы, и ./gradlew spotlessApply, чтобы их исправить.
Creator
android
Size
206.7 MB
Stars
23.5K
Age
7y
Commits · 90 Days