Updated docs with the new animation API #757
Conversation
WalkthroughThe recent updates to the Compose extension of the Decompose library introduce significant enhancements, including function renaming and an experimental animation API. Key changes involve replacing Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant App
participant Navigation
participant Animation
User->>App: Trigger Navigation
App->>Navigation: Request ChildStack
Navigation->>Animation: Start Transition
Animation-->>Navigation: Finish Animation
Navigation-->>App: Return to User
App-->>User: Display Updated Screen
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (4)
docs/extensions/compose.md (4)
276-276: Clarify the API version.Specify the exact version number for clarity.
- Since version `3.2.0-alpha04` Decompose also provides additional module with experimental animation API. + Since version `3.2.0-alpha04`, Decompose provides an additional module with an experimental animation API.
444-444: Remove unnecessary comma.The sentence structure does not require a comma before "when."
- Previous examples demonstrate simple cases, when all children have the same animation. + Previous examples demonstrate simple cases when all children have the same animation.Tools
LanguageTool
[typographical] ~444-~444: Usually, there’s no comma before “when”.
Context: ...evious examples demonstrate simple cases, when all children have the same animation. B...(IF_NO_COMMA)
523-523: Remove unnecessary comma.The sentence structure does not require a comma before "so that."
- The default stack animation is configurable, so that it's possible to avoid specifying the same animation multiple times. + The default stack animation is configurable so that it's possible to avoid specifying the same animation multiple times.Tools
LanguageTool
[typographical] ~523-~523: The conjunction “so that” does not have a comma in front.
Context: ... default stack animation is configurable, so that it's possible to avoid specifying the s...(SO_THAT_UNNECESSARY_COMMA)
772-772: Add missing article.Add "the" before "same slide animation" for grammatical correctness.
- then same slide animation will be playing for predictive back gesture. + then the same slide animation will be playing for predictive back gesture.Tools
LanguageTool
[uncategorized] ~772-~772: Possible missing article found.
Context: ...de())specified forChildStack`, then same slide animation will be playing for pre...(AI_HYDRA_LEO_MISSING_THE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/extensions/compose.md (7 hunks)
- extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackParams.kt (1 hunks)
Files skipped from review due to trivial changes (1)
- extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackParams.kt
Additional context used
LanguageTool
docs/extensions/compose.md
[typographical] ~444-~444: Usually, there’s no comma before “when”.
Context: ...evious examples demonstrate simple cases, when all children have the same animation. B...(IF_NO_COMMA)
[style] ~479-~479: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...f" width="512"> It is also possible to take into account the other child and the animation direc...(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
[typographical] ~523-~523: The conjunction “so that” does not have a comma in front.
Context: ... default stack animation is configurable, so that it's possible to avoid specifying the s...(SO_THAT_UNNECESSARY_COMMA)
[uncategorized] ~772-~772: Possible missing article found.
Context: ...de())specified forChildStack`, then same slide animation will be playing for pre...(AI_HYDRA_LEO_MISSING_THE)
Markdownlint
docs/extensions/compose.md
350-350: null
Images should have alternate text (alt text)(MD045, no-alt-text)
392-392: null
Images should have alternate text (alt text)(MD045, no-alt-text)
440-440: null
Images should have alternate text (alt text)(MD045, no-alt-text)
477-477: null
Images should have alternate text (alt text)(MD045, no-alt-text)
224-224: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
248-248: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
282-282: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
287-287: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
314-314: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
333-333: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
356-356: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
375-375: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
400-400: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
421-421: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
448-448: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
475-475: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
483-483: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
503-503: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
527-527: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
553-553: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
587-587: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
615-615: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
646-646: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
677-677: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
706-706: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
737-737: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
807-807: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
833-833: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
863-863: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
867-867: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
905-905: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
933-933: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1013-1013: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1040-1040: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1069-1069: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1089-1089: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1115-1115: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1181-1181: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (10)
docs/extensions/compose.md (10)
272-272: Add alt text to images.Images should have alternate text for accessibility.
- <img src="https://raw.githubusercontent.com/arkivanov/Decompose/master/docs/media/ComposeAnimationFade.gif" width="512"> + <img src="https://raw.githubusercontent.com/arkivanov/Decompose/master/docs/media/ComposeAnimationFade.gif" width="512" alt="Fade animation example">
310-310: Add alt text to images.Images should have alternate text for accessibility.
- <img src="https://raw.githubusercontent.com/arkivanov/Decompose/master/docs/media/ComposeAnimationSlide.gif" width="512"> + <img src="https://raw.githubusercontent.com/arkivanov/Decompose/master/docs/media/ComposeAnimationSlide.gif" width="512" alt="Slide animation example">
350-350: Add alt text to images.Images should have alternate text for accessibility.
- <img src="https://raw.githubusercontent.com/arkivanov/Decompose/master/docs/media/ComposeAnimationFadeScale.gif" width="512"> + <img src="https://raw.githubusercontent.com/arkivanov/Decompose/master/docs/media/ComposeAnimationFadeScale.gif" width="512" alt="Fade and scale animation example">Tools
Markdownlint
350-350: null
Images should have alternate text (alt text)(MD045, no-alt-text)
392-392: Add alt text to images.Images should have alternate text for accessibility.
- <img src="https://raw.githubusercontent.com/arkivanov/Decompose/master/docs/media/ComposeAnimationSeparate.gif" width="512"> + <img src="https://raw.githubusercontent.com/arkivanov/Decompose/master/docs/media/ComposeAnimationSeparate.gif" width="512" alt="Separate animations for children example">Tools
Markdownlint
392-392: null
Images should have alternate text (alt text)(MD045, no-alt-text)
222-224: Use fenced code blocks.Convert indented code blocks to fenced code blocks for consistency.
- ```kotlin title="Example" + ```kotlinTools
Markdownlint
224-224: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
248-248: Use fenced code blocks.Convert indented code blocks to fenced code blocks for consistency.
- ```kotlin title="Example" + ```kotlinTools
Markdownlint
248-248: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
527-527: Use fenced code blocks.Convert indented code blocks to fenced code blocks for consistency.
- ```kotlin + ```kotlinTools
Markdownlint
527-527: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
553-553: Use fenced code blocks.Convert indented code blocks to fenced code blocks for consistency.
- ```kotlin + ```kotlinTools
Markdownlint
553-553: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1013-1013: Use fenced code blocks.Convert indented code blocks to fenced code blocks for consistency.
- ```kotlin title="In commonMain source set" + ```kotlinTools
Markdownlint
1013-1013: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1040-1040: Use fenced code blocks.Convert indented code blocks to fenced code blocks for consistency.
- ```kotlin title="In commonMain source set" + ```kotlinTools
Markdownlint
1040-1040: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/extensions/compose.md (7 hunks)
- extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackParams.kt (1 hunks)
Files skipped from review due to trivial changes (1)
- extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackParams.kt
Additional context used
LanguageTool
docs/extensions/compose.md
[style] ~479-~479: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...f" width="512"> It is also possible to take into account the other child and the animation direc...(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
Markdownlint
docs/extensions/compose.md
350-350: null
Images should have alternate text (alt text)(MD045, no-alt-text)
392-392: null
Images should have alternate text (alt text)(MD045, no-alt-text)
440-440: null
Images should have alternate text (alt text)(MD045, no-alt-text)
477-477: null
Images should have alternate text (alt text)(MD045, no-alt-text)
224-224: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
248-248: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
282-282: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
287-287: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
314-314: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
333-333: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
356-356: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
375-375: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
400-400: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
421-421: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
448-448: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
475-475: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
483-483: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
503-503: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
527-527: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
553-553: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
587-587: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
615-615: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
646-646: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
677-677: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
706-706: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
737-737: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
807-807: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
833-833: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
863-863: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
867-867: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
905-905: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
933-933: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1013-1013: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1040-1040: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1069-1069: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1089-1089: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1115-1115: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1181-1181: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
Additional comments not posted (2)
docs/extensions/compose.md (2)
103-103: Update to reflect new API name.The documentation should reflect the new
ChildStackAPI name instead ofChildren.
217-217: Update to reflect new API name.The documentation should reflect the new
ChildPagesAPI name instead ofPages.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (4)
docs/extensions/compose.md (4)
224-224: Use fenced code block style.Switch from indented to fenced code block style for consistency and readability.
- ```kotlin title="Example" + ```kotlinTools
Markdownlint
224-224: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
248-248: Use fenced code block style.Switch from indented to fenced code block style for consistency and readability.
- ```kotlin title="Example" + ```kotlinTools
Markdownlint
248-248: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
350-350: Add alt text to images.Images should have alternate text for better accessibility.
Tools
Markdownlint
350-350: null
Images should have alternate text (alt text)(MD045, no-alt-text)
392-392: Add alt text to images.Images should have alternate text for better accessibility.
Tools
Markdownlint
392-392: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/extensions/compose.md (6 hunks)
- extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackParams.kt (1 hunks)
Files skipped from review due to trivial changes (1)
- extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackParams.kt
Additional context used
LanguageTool
docs/extensions/compose.md
[style] ~479-~479: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...f" width="512"> It is also possible to take into account the other child and the animation direc...(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
Markdownlint
docs/extensions/compose.md
350-350: null
Images should have alternate text (alt text)(MD045, no-alt-text)
392-392: null
Images should have alternate text (alt text)(MD045, no-alt-text)
440-440: null
Images should have alternate text (alt text)(MD045, no-alt-text)
477-477: null
Images should have alternate text (alt text)(MD045, no-alt-text)
224-224: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
248-248: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
282-282: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
287-287: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
314-314: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
333-333: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
356-356: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
375-375: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
400-400: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
421-421: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
448-448: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
475-475: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
483-483: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
503-503: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
527-527: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
553-553: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
587-587: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
615-615: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
646-646: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
677-677: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
706-706: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
737-737: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
813-813: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
839-839: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
869-869: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
873-873: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
911-911: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
939-939: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1019-1019: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1046-1046: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1075-1075: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1095-1095: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1121-1121: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
1187-1187: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
Additional comments not posted (2)
docs/extensions/compose.md (2)
103-103: Update to reflect new API name.The documentation should reflect the new
ChildStackAPI name instead ofChildren.- The Compose extension module provides the [Children(...)] + The Compose extension module provides the [ChildStack(...)]
217-217: Update to reflect new API name.The documentation should reflect the new
ChildPagesAPI name instead ofPages.- The Compose extension module provides the [Pages(...)] + The Compose extension module provides the [ChildPages(...)]
Summary by CodeRabbit
New Features
Documentation