Android Sunflower with Compose

A gardening app illustrating Android development best practices with migrating a View-based app to Jetpack Compose.

To learn about how Sunflower was migrated to Compose, see the migration journey document.

This sample showcases:

• Compose working in an existing app: including integration with strings, resources, and themes and styles.
• Integration with an existing architecture based on Jetpack libraries.
• CollapsingToolbarLayout behavior implemented manually with Compose.
• Showing Snackbars with Compose.
• Using Compose within a RecyclerView (#766)

Note: To see the original View implementation of Sunflower, checkout the views branch.

Screenshots

Features

Sunflower's plant details screen is built with Compose as well as the plant list item view within a RecyclerView.

All Compose code can be found in the compose folder.

Note: As Compose cannot render HTML code in Text yet. The AndroidViewBinding API is used to embed a TextView in Compose. See the PlantDescription composable in the PlantDetailView file.

Requirements

Unsplash API key

Sunflower uses the Unsplash API to load pictures on the gallery screen. To use the API, you will need to obtain a free developer API key. See the Unsplash API Documentation for instructions.

Once you have the key, add this line to the gradle.properties file, either in your user home directory (usually ~/.gradle/gradle.properties on Linux and Mac) or in the project's root folder:

unsplash_access_key=<your Unsplash access key>

The app is still usable without an API key, though you won't be able to navigate to the gallery screen.

Android Studio IDE setup

For development, the latest version of Android Studio is required. The latest version can be downloaded from here.

Sunflower uses ktlint to enforce Kotlin coding styles. Here's how to configure it for use with Android Studio (instructions adapted from the ktlint README):

• Close Android Studio if it's open

• Download ktlint using these installation instructions

• Apply ktlint settings to Android Studio using these instructions

• Start Android Studio

Additional resources

Check out these Wiki pages to learn more about Android Sunflower:

• Notable Community Contributions

• Publications

Non-Goals

Previously, this sample app was focused on demonstrating best practices for multiple Jetpack libraries. However, this is no longer the case and development will instead be focused on how to adopt Compose in an existing View-based app. So, there are no plans to implement features outside of this scope. Keep this in mind when making contributions to this library.

Support

• Stack Overflow:
  • https://stackoverflow.com/questions/tagged/android-jetpack-compose

If you've found an error in this sample, please file an issue: https://github.com/android/sunflower/issues

Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub.

Third Party Content

Select text used for describing the plants (in plants.json) are used from Wikipedia via CC BY-SA 3.0 US (license in ASSETS_LICENSE).

"seed" by Aisyah is licensed under CC BY 3.0

License

Copyright 2018 Google, Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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.