commit | 2ae4491c96160cde4b70863202542499c68da4b7 | [log] [tgz] |
---|---|---|
author | Louis Pullen-Freilich <lpf@google.com> | Sat Feb 06 21:48:44 2021 +0000 |
committer | Louis Pullen-Freilich <lpf@google.com> | Thu Feb 11 00:42:02 2021 +0000 |
tree | 0fdd576e191b0dc8de2d40812a5ad008433fb442 | |
parent | b692bb59ad908111c9be01849ddae15d989ce02c [diff] |
InteractionState -> [Mutable]InteractionSource rework This CL replaces InteractionState with [Mutable]InteractionSource - interfaces responsible for emitting / observing Interaction events. InteractionSource exposes interactions: Flow<Interaction>, which allows consumers to observe the ordered stream of Interactions and change how components appear accordingly. This resolves a few issues with the existing InteractionState implementation: - No handling for multiple sources of the same Interaction For example, a compound component with two `clickable`s - if one `clickable` is pressed, then the other, then the first `clickable` is released, this would appear as though the entire InteractionState was not pressed. - Lossy compression of events into state InteractionState turns a stream events into a snapshot state at a given point in time. Complex components / indications such as Ripple care about the ordering of events, and trying to reconstruct ordering from a snapshot state is a bit messy and can lose information. - Batched state writes State<> is not a great fit for representing events as the name suggests - one of the reasons for this is that state writes are batched, so multiple changes (such as multiple fast presses) will be batched into one write. This means that we might skip showing ripples for presses if events happen too closely together. - Lack of detailed information for events For simple components, just knowing if the component is pressed or not can be enough to change how it appears, but for complicated components it can be important to know if a press was stopped / cancelled - this sort of information did not exist in InteractionState. Additionally metadata such as press position can be important, but there was no scalable way to support this. Now Interactions can just be unique instances with metadata, so Pressed() can contain a press position just as a property for consumers that need to know this information. As well as the `interactions` Flow, simple extension functions on InteractionSource (collectIsDraggedAsState, collectIsFocusedAsState, collectIsPressedAsState) have been added for cases when components only care about the binary state of a particular interaction, and not the entire stream of events. MutableInteractionSource exposes `emit()` and `tryEmit()` methods that allow emitting Interactions to the `interactions` Flow. This CL also changes the existing Interactions to be classes, and adds further classes representing stop / cancel events for the initial events. Bug: b/152525426 Fixes: b/171913923 Fixes: b/171710801 Fixes: b/174852378 Test: InteractionSourceTest Test: updateApi Relnote: "InteractionState has been replaced with [Mutable]InteractionSource - interfaces responsible for emitting / collecting Interaction events. Instead of passing `interactionState = remember { InteractionState() }` to components such as Button and Modifier.clickable(), use `interactionSource = remember { MutableInteractionSource() }`. Instead of: `Interaction.Pressed in interactionState` you should instead use the extension functions on InteractionSource, such as InteractionSource.collectIsPressedAsState(). For complex use cases you can use InteractionSource.interactions to observe the stream of Interactions. See the InteractionSource documentation and samples for more information." Change-Id: I85965d0dba39d1740c097915d1d1a367eea2a78c
Jetpack is a suite of libraries, tools, and guidance to help developers write high-quality apps easier. These components help you follow best practices, free you from writing boilerplate code, and simplify complex tasks, so you can focus on the code you care about.
Jetpack comprises the androidx.*
package libraries, unbundled from the platform APIs. This means that it offers backward compatibility and is updated more frequently than the Android platform, making sure you always have access to the latest and greatest versions of the Jetpack components.
Our official AARs and JARs binaries are distributed through Google Maven.
You can learn more about using it from Android Jetpack landing page.
For contributions via GitHub, see the GitHub Contribution Guide.
Note: The contributions workflow via GitHub is currently experimental - only contributions to the following projects are being accepted at this time:
When contributing to Jetpack, follow the code review etiquette.
We are not currently accepting new modules.
NOTE: You will need to use Linux or Mac OS. Building under Windows is not currently supported.
repo
(Repo is a tool that makes it easier to work with Git in the context of Android. For more information about Repo, see the Repo Command Reference)mkdir ~/bin PATH=~/bin:$PATH curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo chmod a+x ~/bin/repo
git config --global user.name "Your Name" git config --global user.email "you@example.com"
mkdir androidx-main cd androidx-main
repo
command to initialize the repository.repo init -u https://android.googlesource.com/platform/manifest -b androidx-main --partial-clone --clone-filter=blob:limit=10M
repo sync -j8 -c
You will use this command to sync your checkout in the future - it’s similar to git fetch
To open the project with the specific version of Android Studio recommended for developing:
cd path/to/checkout/frameworks/support/ ANDROIDX_PROJECTS=MAIN ./gradlew studio
and accept the license agreement when prompted. Now you're ready to edit, run, and test!
You can also the following sets of projects: ALL
, MAIN
, COMPOSE
, or FLAN
If you get “Unregistered VCS root detected” click “Add root” to enable git integration for Android Studio.
If you see any warnings (red underlines) run Build > Clean Project
.
You can do most of your work from Android Studio, however you can also build the full AndroidX library from command line:
cd path/to/checkout/frameworks/support/ ./gradlew createArchive
You can build maven artifacts locally, and test them directly in your app:
./gradlew createArchive
And put the following at the top of your ‘repositories’ property in your project build.gradle
file:
maven { url '/path/to/checkout/out/androidx/build/support_repo/' }
Our continuous integration system builds all in progress (and potentially unstable) libraries as new changes are merged. You can manually download these AARs and JARs for your experimentation.
Run FooBarTest
Run androidx.foobar
The AndroidX repository has a set of Android applications that exercise AndroidX code. These applications can be useful when you want to debug a real running application, or reproduce a problem interactively, before writing test code.
These applications are named either <libraryname>-integration-tests-testapp
, or support-\*-demos
(e.g. support-v4-demos
or support-leanback-demos
). You can run them by clicking Run > Run ...
and choosing the desired application.
Before uploading your first contribution, you will need setup a password and agree to the contribution agreement:
Generate a HTTPS password: https://android-review.googlesource.com/new-password
Agree to the Google Contributor Licenses Agreement: https://android-review.googlesource.com/settings/new-agreement
cd path/to/checkout/frameworks/support/ repo start my_branch_name . # make needed modifications... git commit -a repo upload --current-branch .
If you see the following prompt, choose always
:
Run hook scripts from https://android.googlesource.com/platform/manifest (yes/always/NO)?
If the upload succeeds, you'll see output like:
remote: remote: New Changes: remote: https://android-review.googlesource.com/c/platform/frameworks/support/+/720062 Further README updates remote:
To edit your change, use git commit --amend
, and re-upload.
AndroidX uses git to store all the binary Gradle dependencies. They are stored in prebuilts/androidx/internal
and prebuilts/androidx/external
directories in your checkout. All the dependencies in these directories are also available from google()
, jcenter()
, or mavenCentral()
. We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.