Google Git
Sign in
android / platform / frameworks / support / c3c96aef1d6c366ee1658cd8dfa27588231740c2
commitc3c96aef1d6c366ee1658cd8dfa27588231740c2[log] [tgz]
authorLouis Pullen-Freilich <lpf@google.com>Thu Sep 28 16:59:45 2023 +0100
committerLouis Pullen-Freilich <lpf@google.com>Fri Nov 24 12:52:28 2023 +0000
tree7140016ffa4f985f5d027716088de541ab7fe470
parent42669acf5918c0d34c648465a64a23282dd3a5f5 [diff]
Deprecates rememberRipple and RippleTheme, adds createRippleNode API

This CL adds a new ripple implementation (createRippleNode) built using Modifier.Node APIs, so it can be used inside IndicationNodeFactory.
This leads to large performance improvements and greatly reduced allocations.

IndicationNodeFactory does not support calling Composable functions, so RippleTheme cannot be used to theme ripples built using the new node
APIs. In addition, having one singular library as the source of truth for ripple theme leads to tension and problems between design systems:
for example the default RippleTheme functions are actually the material spec, not material3, so they should have been versioned with the
material library instead. Similarly, if you are wrapping material / material3 with your own theme, both themes will end up 'fighting' over the
RippleTheme - the theme configuration is a property of the design system, not a generic system.

As a result, this CL deprecates rememberRipple and RippleTheme - the intention moving forward is for design system libraries to provide their
own theming APIs for ripples (if desired), and their own ripple Indication implementations that consume their own theme values. This allows us
to simplify the layering and API shape, and allows for more flexibility between custom design systems. createRippleNode encapsulates all of
the ripple logic so design system implementations can just delegate to createRippleNode after querying their theme values in a separate node.

Bug: b/298048146
Test: RememberRippleTest, RippleModifierNodeTest, RippleBenchmark
Relnote: "Deprecates rememberRipple, RippleTheme and LocalRippleTheme, adds createRippleNode. Instead of using these APIs, use the new ripple Indication and theming APIs in design system libraries such as material / material3. See developer.android.com for migration / backwards compatibility information and more background information behind this change."
Change-Id: I23f260b2f070e3f0f5b145b87eb1c6a06f3fd861
14 files changed
tree: 7140016ffa4f985f5d027716088de541ab7fe470
  1. .github/
  2. .idea/
  3. activity/
  4. annotation/
  5. appactions/
  6. appcompat/
  7. appintegration/
  8. appsearch/
  9. arch/
  10. asynclayoutinflater/
  11. autofill/
  12. benchmark/
  13. biometric/
  14. bluetooth/
  15. browser/
  16. buildSrc/
  17. buildSrc-tests/
  18. busytown/
  19. camera/
  20. car/
  21. cardview/
  22. collection/
  23. compose/
  24. concurrent/
  25. constraintlayout/
  26. contentpager/
  27. coordinatorlayout/
  28. core/
  29. credentials/
  30. cursoradapter/
  31. customview/
  32. datastore/
  33. development/
  34. docs/
  35. docs-public/
  36. docs-tip-of-tree/
  37. documentfile/
  38. draganddrop/
  39. drawerlayout/
  40. dynamicanimation/
  41. emoji/
  42. emoji2/
  43. enterprise/
  44. exifinterface/
  45. external/
  46. fragment/
  47. glance/
  48. gradle/
  49. graphics/
  50. gridlayout/
  51. health/
  52. heifwriter/
  53. hilt/
  54. input/
  55. inspection/
  56. interpolator/
  57. javascriptengine/
  58. kruth/
  59. leanback/
  60. lifecycle/
  61. lint-checks/
  62. loader/
  63. media/
  64. media2/
  65. mediarouter/
  66. metrics/
  67. navigation/
  68. paging/
  69. palette/
  70. percentlayout/
  71. placeholder/
  72. placeholder-tests/
  73. playground-common/
  74. playground-projects/
  75. preference/
  76. print/
  77. privacysandbox/
  78. profileinstaller/
  79. recommendation/
  80. recyclerview/
  81. remotecallback/
  82. resourceinspection/
  83. room/
  84. safeparcel/
  85. samples/
  86. savedstate/
  87. security/
  88. sharetarget/
  89. slice/
  90. slidingpanelayout/
  91. sqlite/
  92. sqliteMultiplatform/
  93. stableaidl/
  94. startup/
  95. swiperefreshlayout/
  96. test/
  97. testutils/
  98. text/
  99. tracing/
  100. transition/
  101. tv/
  102. tvprovider/
  103. vectordrawable/
  104. versionedparcelable/
  105. viewpager/
  106. viewpager2/
  107. wear/
  108. webkit/
  109. window/
  110. work/
  111. .gitignore
  112. .mailmap
  113. build.gradle
  114. cleanBuild.sh
  115. code-review.md
  116. CONTRIBUTING.md
  117. gradle.properties
  118. gradlew
  119. libraryversions.toml
  120. LICENSE.txt
  121. OWNERS
  122. PREUPLOAD.cfg
  123. README.md
  124. settings.gradle
  125. studiow
  126. TEXT_OWNERS
README.md

Android Jetpack

Revved up by Develocity

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.

Contribution Guide

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:

Code Review Etiquette

When contributing to Jetpack, follow the code review etiquette.

Accepted Types of Contributions

  • Bug fixes - needs a corresponding bug report in the Android Issue Tracker
  • Each bug fix is expected to come with tests
  • Fixing spelling errors
  • Updating documentation
  • Adding new tests to the area that is not currently covered by tests
  • New features to existing libraries if the feature request bug has been approved by an AndroidX team member.

We are not currently accepting new modules.

Checking Out the Code

Head over to the onboarding docs to learn more about getting set up and the development workflow!

Continuous integration

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.

Password and Contributor Agreement before making a change

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

Getting reviewed

  • After you run repo upload, open r.android.com
  • Sign in into your account (or create one if you do not have one yet)
  • Add an appropriate reviewer (use git log to find who did most modifications on the file you are fixing or check the OWNERS file in the project's directory)

Handling binary dependencies

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(), or mavenCentral(). We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.