Overview

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. This version is meant to port some of the Accompanist libraries to Compose Multiplatform, so it can be used on the Jvm, Android, and Apple platforms.

Current Library Compose Multiplatform Version: 1.4.0

Current Library Jetpack Compose Version: 1.4.0

Currently, Accompanist contains:

⏳ Placeholder ¶

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

🌊 Flow Layouts (Soon to be deprecated - Upstreamed in Compose 1.4)¶

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

⬇️ Swipe to Refresh (Deprecated)¶

See our Migration Guide for migrating to PullRefresh in Compose Material.

See our Migration Guide for migrating to Pager in Compose.

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.

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.