Add ScrollState.viewportSize in order to support scrollbars.

For a scrollbar to correctly size its "thumb" it needs to know the ratio between the size of the visible part of the scrolled content (viewport) and the size of the entire content. Additionally, to be able to scroll a "page" (when clicked on the track) it needs the size of the viewport. Unfortunately this information is not currently available in ScrollState.

In our current, incorrect, implementation, the scrollbar assumes that its own size (e.g. height for a vertical scrollbar) is also the size of the viewport. This is correct most of the time, so it has went unnoticed until now.

We considered several options to add this information:
1. Simply add a `viewportSize` property to ScrollState to indicate the visible size of the content. The size of the entire content can be calculated with `maxValue + viewportSize` (the case where the content is smaller than the viewport is irrelevant for a scrollbar).
2. Analogously to LazyListState add a `layoutInfo` property to ScrollState and put `viewportSize` in it. Possibly add `contentSize` there too. The latter would create the implicit dependency that `maxValue == max(0, contentSize - viewportSize)`.

The first option is currently our favorite, due to its simplicity, and because we don't foresee more fields being added into the `ScrollableLayoutInfo` suggested in option 2.

Test: unit tests

Change-Id: I16e79d7b8a286fda98b535efcb457e66ade60751
1 file changed
tree: 7d298f8a9e20f8fc4505a26ea54fe97360fe2045
  1. .github/
  2. .idea/
  3. activity/
  4. ads/
  5. annotation/
  6. appactions/
  7. appcompat/
  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-kmp/
  36. docs-public/
  37. docs-tip-of-tree/
  38. documentfile/
  39. draganddrop/
  40. drawerlayout/
  41. dynamicanimation/
  42. emoji/
  43. emoji2/
  44. enterprise/
  45. exifinterface/
  46. external/
  47. fragment/
  48. frameworks/
  49. glance/
  50. gradle/
  51. graphics/
  52. gridlayout/
  53. health/
  54. heifwriter/
  55. hilt/
  56. input/
  57. inspection/
  58. interpolator/
  59. javascriptengine/
  60. leanback/
  61. lifecycle/
  62. lint-checks/
  63. loader/
  64. media/
  65. media2/
  66. mediarouter/
  67. metrics/
  68. navigation/
  69. paging/
  70. palette/
  71. percentlayout/
  72. placeholder/
  73. placeholder-tests/
  74. playground-common/
  75. preference/
  76. print/
  77. privacysandbox/
  78. profileinstaller/
  79. recommendation/
  80. recyclerview/
  81. remotecallback/
  82. resourceinspection/
  83. room/
  84. samples/
  85. savedstate/
  86. security/
  87. sharetarget/
  88. slice/
  89. slidingpanelayout/
  90. sqlite/
  91. startup/
  92. swiperefreshlayout/
  93. test/
  94. testutils/
  95. text/
  96. tracing/
  97. transition/
  98. tv/
  99. tvprovider/
  100. vectordrawable/
  101. versionedparcelable/
  102. viewpager/
  103. viewpager2/
  104. wear/
  105. webkit/
  106. window/
  107. work/
  108. .gitignore
  109. .mailmap
  110. build.gradle
  111. cleanBuild.sh
  112. code-review.md
  113. CONTRIBUTING.md
  114. gradle.properties
  115. gradlew
  116. libraryversions.toml
  117. LICENSE.txt
  118. OWNERS
  119. PREUPLOAD.cfg
  120. README.md
  121. settings.gradle
  122. studiow
  123. TEXT_OWNERS
README.md

Android Jetpack

Revved up by Gradle Enterprise

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