/accompanist

A collection of extension libraries for Jetpack Compose

Primary LanguageKotlinApache License 2.0Apache-2.0

Accompanist logo

Accompanist is a group of libraries that aim to supplement Jetpack Compose with features that are commonly required by developers but not yet available.

Currently, Accompanist contains:

📐 Insets

A library that brings WindowInsets support to Jetpack Compose.

A library that provides easy-to-use utilities for recoloring the Android system bars from Jetpack Compose.

A library that enables the reuse of AppCompat XML themes for theming in Jetpack Compose.

📖 Pager

A library that provides utilities for building paginated layouts in Jetpack Compose, similar to Android's ViewPager.

A library that provides Android runtime permissions support for Jetpack Compose.

A library that provides easy-to-use modifiers for displaying a placeholder UI while content is loading.

A library that adds Flexbox-like layout components to Jetpack Compose.

A library which provides Compose Animation support for Jetpack Navigation Compose.

A library which provides Compose Material support, such as modal bottom sheets, for Jetpack Navigation Compose.

A library which provides a way to use Android Drawables as Jetpack Compose Painters.

A library that provides a layout implementing the swipe-to-refresh UX pattern, similar to Android's SwipeRefreshLayout.


Updates

Jetpack Compose is a fast-moving project and we aim to keep these these libraries up-to-date with the latest tagged release on Compose as quickly as possible. Each release outlines what version of the Compose libraries it depends on.

Future?

Any of the features available in this group of libraries may become obsolete in the future, at which point they will (probably) become deprecated.

We will aim to provide a migration path (where possible), to whatever supersedes the functionality.

Snapshots

Snapshots of the current development version of Accompanist are available, which track the latest commit. See here for more information.


Why the name?

The library is all about adding some utilities around Compose. Music composing is done by a composer, and since this library is about supporting composition, the supporting role of an accompanist felt like a good name.

Contributions

Please contribute! We will gladly review any pull requests. Make sure to read the Contributing page first though.

License

Copyright 2020 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.