[Insets] Setup migration for accompanist/insets #1034
Conversation
alexvanyo
force-pushed
the
av/deprecated-insets
branch
2 times, most recently
from
fe591f4
to
4ef088e
Compare
...src/main/java/com/google/accompanist/sample/swiperefresh/SwipeRefreshContentPaddingSample.kt
Show resolved
Hide resolved
| @@ -28,6 +30,7 @@ import androidx.compose.runtime.setValue | |||
| * offsets which describe changes to the four edges of a rectangle. | |||
| */ | |||
| @Stable | |||
| @Deprecated("accompanist/insets is deprecated") | |||
There was a problem hiding this comment.
Would it be better in cases without a replaceWith to mention something like "it has been superseded by ..." so the user at least knows where to go and look?
There was a problem hiding this comment.
Done, I updated the deprecated descriptions to briefly explain the equivalents of methods and classes that don't have exact equivalents, and also linked to the migration doc.
| @@ -14,6 +14,8 @@ | |||
| * limitations under the License. | |||
| */ | |||
|
|
|||
| @file:Suppress("DEPRECATION") | |||
There was a problem hiding this comment.
Please leave a comment on the sample uses of this with something like "to be replaced in a later PR to test the migration"
There was a problem hiding this comment.
I wasn't planning to publish those in-place to the repo, although I have a branch with those changes here working off of the migrations:
https://github.com/google/accompanist/tree/av/deprecated-insets-replace-samples
...src/main/java/com/google/accompanist/sample/swiperefresh/SwipeRefreshContentPaddingSample.kt
Show resolved
Hide resolved
alexvanyo
force-pushed
the
av/deprecated-insets
branch
from
9ab97c7
to
4424a71
Compare
alexvanyo
requested review from
simona-anomis
and removed request for
simona-anomis
|
@bentrengrove and @simona-anomis this is ready for another look! |
| """ | ||
| accompanist/insets is deprecated. | ||
| The androidx.compose equivalent of LocalWindowInsets is the extensions on WindowInsets. | ||
| For more migration information, please visit https://google.github.io/accompanist/insets/#migration |
There was a problem hiding this comment.
Do we need to publish those docs first before merging this?
There was a problem hiding this comment.
I'm not entirely sure what the doc publishing process is, will those go out immediately after publishing?
If so, the updated docs/insets.md in this PR should make this link real after the merge.
There was a problem hiding this comment.
Oh sorry! I completely missed that you had changed it because GitHub had collapsed it
|
Thanks @bentrengrove and @simona-anomis ! |
An initial PR beginning the process of deprecating accompanist/insets in favor of built-in
androidx.compose.foundationsupport.Most of the accompanist/insets APIs have been deprecated, with
ReplaceWiths where possible. There are cases whereReplaceWithdoesn't exactly match the new behavior and where complete auto-migration isn't possible (parameters became specific types), so this was a best-effort to help along the way.The insets doc has been updated with a migration guide, along with a more complete table of migrations and an explanation of behavior differences.
There are some things that are not yet supported in
androidx:androidx.compose.foundationinsets, and I am tracking upstreaming those if possible.TODO: