Table of Contents
Accompanist is a group of libraries that goal to health supplement Jetpack Compose with functions that are commonly essential by developers but not still formally supported in Jetpack Compose AndroidX libraries.
Accompanist is a labs-like environment for new Compose APIs. We use it to enable fill acknowledged gaps in the Compose toolkit, experiment with new APIs and to get insight into the advancement practical experience of acquiring a Compose library. The purpose of Accompanist is to not exist. We want to upstream the libraries into the official toolkit, at which point they will be deprecated and taken out from Accompanist.
Currently in Accompanist you can obtain libraries for Circulation Layouts, Pager, Navigation Transitions, Swipe Refresh and extra.
We usually get asked a lot of concerns about this library and so imagined we could publish a article to reply some of the most requested Accompanist queries.
A big motive for Accompanist’s existence is the fact that AndroidX does not let experimental API use across distinct modules. There were being characteristics we understood we could establish that would not be allowed in AndroidX. For instance, navigation transitions involve some experimental animation APIs so are not able to be crafted in navigation-compose but can be crafted in Accompanist.
For standalone characteristics, you may possibly consider, why not just mark the APIs as Experimental in AndroidX? When we insert an experimental API to AndroidX, we are confident that the aspect will exist in some sort but probably the API will modify form. We also try out to have them out of Experimental as rapidly as probable, we know this does not constantly happen but that is the goal. When we will need them to be for a longer period long lasting in experimental or are not guaranteed the element can make feeling, Accompanist is in which they dwell.
This desk summarizes the different principles that apply to various API spots. These guidelines are more specific later on in the article as well.
The aim of Accompanist is to sooner or later not exist, that as the AndroidX Compose libraries experienced & stabilize, all features is upstreamed.
An additional important section of the reason Accompanist exists is background. Accompanist was initially produced by Chris Banes and the Compose crew for the duration of the early days of Compose. The Compose staff have been establishing the Compose samples and as Compose was still in incredibly early enhancement, there were a good deal of gaps in the feature set they expected. Both from Compose itself but also from a absence of guidance by other libraries. The workforce wrote a large amount of code to make the applications do the job. Accompanist was created as a put to release this code for many others to use. The first ever Accompanist library was a Coil wrapper for loading illustrations or photos asynchronously. Window insets handling was added next, followed by AppCompat theme adapter and then in .7. a additional 4 libraries had been additional. Pager, Pager Indicators, Program UI Controller and Stream Layouts. This was also when the library was moved from Chris’s personalized account to an official Google library and the package deal title was adjusted from dev.chrisbanes.accompanist to com.google.accompanist appropriately. By this issue, many users of the Compose crew and the group ended up operating on and contributing to the library and it grew from there.
At present we have 12 lively libraries and 1 deprecated library (Insets as it has been upstreamed) in Accompanist. Our goal is to choose the most employed features from Accompanist and upstream them into the key Compose libraries. This was at first efficiently done with the initially Accompanist library, Coil and then was subsequently carried out with Insets to Compose Foundation. We will be ramping up our upstreaming initiatives around the following handful of Compose releases, APIs may well alter through upstreaming but we are dedicated to providing an uncomplicated migration path for all users of Accompanist. With the updating of the Compose Roadmap you can see, the next API that is being upstreamed is Movement Layout.
The major Compose libraries are designed in AndroidX, our open supply repository of Android libraries. This group of libraries is recognised as Jetpack. Accompanist nevertheless is formulated individually from the main Compose libraries. When we converse about “upstreaming”, we necessarily mean to shift the advancement from Accompanist to the principal Compose libraries as an formal aspect.
Accompanist is formulated on GitHub, in the open. The primary rationale for this is just heritage, as mentioned previously mentioned. What started as a library made by 1 author, grew and turned into a assortment of libraries created by a number of authors. There are some vital benefits and motives it continues to be on GitHub nonetheless.
AndroidX Experimental APIs
As comprehensive earlier mentioned, AndroidX does not allow cross module experimental APIs. This signifies, Compose Navigation wouldn’t be able to use the experimental Compose Animation APIs that make navigation transitions feasible. Base Sheet Navigator would not be ready to use the experimental Materials APIs, and so on. As these are functions we know the neighborhood needs, producing them in Accompanist is great. It permits us to get the function out to developers without having getting to hold out for the future main edition of Compose to take out the experimental annotation.
Binary Compatibility
AndroidX also has rigorous binary compatibility guidelines that make changing APIs tough without having bumping big variation numbers. These guidelines exist for a very good rationale, as APIs modifying all the time would make acquiring with them a load. Accompanist tries to not improve the API composition greatly in between releases but does not assure it. When we launch an API in AndroidX, we may possibly transform it but our hope is we never have to. In scenarios where by we are not positive about an API, we mark it as experimental. In Accompanist we are no cost to experiment even much more which is good for when we are not confident about anything without the need of local community feedback.
Group Contributions
AndroidX has really a steep onboarding path in advance of your initial contribution, it is also hard to build and run domestically. GitHub makes it possible for for a great deal less complicated neighborhood contributions, which we really encourage. Since we create in a process previously familiar to builders, we get a good deal additional contributions than we would normally, for illustration Navigation Material was produced by Jossi Wolf right before he joined Google!
Perception into the Compose encounter
Producing on GitHub offers us beneficial insight into what difficulties external builders confront. By just being in AndroidX, we frequently pass up concerns that seem evident to external developers. By producing in GitHub exactly where most other exterior libraries are made, we place difficulties significantly earlier.
We imagine it is! Accompanist is applied by just underneath 30% of applications that use Compose on the Enjoy Retail outlet and is still rising. It is also made use of by the Engage in Keep app alone, and several other 1st celebration Google applications. Accompanist is no unique to any other library you could import into your application. We make each individual hard work to manage it, deal with bugs and continue to be on best of issues. You ought to always assessment the resource code your self to see if you are content with it right before introducing it to your app, the exact same as any other library you use.
Our objective is to upstream the most utilised features into the principal Compose library the moment we can, and we are going to be carrying out that with a lot more libraries before long. We will not just right away get rid of them from Accompanist although. Any time a library is upstreamed, we maintain a deprecated variation of it in Accompanist for at minimum a person steady launch of Compose. We will also present a migration guidebook or @ReplaceWith annotations to make transferring from the Accompanist model, to the official edition easy.
Without having a Google operator functioning with you, no, we do not any longer. Now that Compose is out and steady, we want the library ecosystem to increase! We really don’t want each individual library ending up in Accompanist as a substitute, this is just puzzling for builders. We would really like for you to launch your aspect as a library of its own. If you do imagine your library would make feeling in Accompanist, remember to open up an concern first to focus on with us and we may well be ready to discover an owner to operate with you.
We unquestionably take and really encourage bug fixes and improvements to the existing libraries. If you have a huge contribution, like any open resource repository, it is usually most effective to attain out to us through GitHub issues, to check out if we can assist its inclusion.
There was 1 just introduced to assist with adaptive layouts, but that is the only new library planned at the minute. Separately to Accompanist, we have also posted and are establishing Horologist to assist in a comparable way with Compose for Use.
We know obtaining a different library outside the house of AndroidX is perplexing for developers and results in added perform through a migration nevertheless so we only want to increase new libraries to Accompanist where there is a apparent path to upstreaming and the experimentation in Accompanist is clearly expected.
