Make default values in ChildPanelsAnimators null

[arkivanov]

Summary by CodeRabbit

• Documentation

  • Updated parameter descriptions for single, dual, and triple in the ChildPanelsAnimators class to clarify their optional status.

• New Features

  • Adjusted default values for parameters in the ChildPanelsAnimators class to enhance flexibility and consistency.

[coderabbitai]

Walkthrough

The changes made in the ChildPanelsAnimators class involve updates to the documentation and modifications of default parameter values. The parameters single, dual, and triple now have clearer descriptions indicating that StackAnimator instances are optional. The default values have been adjusted: single is now null, dual is set to a pair of single, and triple is defined using the updated dual values.

Changes

File	Change Summary
extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/panels/ChildPanelsAnimators.kt	Updated documentation for single, dual, and triple parameters to clarify their optional nature. Changed default value of single to null, dual to Pair(single, single), and aligned triple with the new dual.

Poem

In the land of code where bunnies play,
Parameters shifted in a clearer way.
Optional whispers in the air,
Default values now show they care.
With each little change, we hop with glee,
A brighter future for you and me! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5d7421d and 96b5803.

📒 Files selected for processing (1)

• extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/panels/ChildPanelsAnimators.kt (1 hunks)

🔇 Additional comments (3)

extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/panels/ChildPanelsAnimators.kt (3)

9-11: Documentation updates accurately reflect the optional nature of parameters.

The changes in the documentation for single, dual, and triple parameters clearly indicate that the StackAnimator instances are now optional. This aligns well with the PR objective of making default values in ChildPanelsAnimators null.

Also applies to: 15-19

---

Line range hint 1-26: Summary: Changes successfully implement PR objective

The modifications to ChildPanelsAnimators class effectively make the default values null as intended. The documentation has been updated to reflect these changes, and the constructor parameters have been modified accordingly. These changes enhance the flexibility of the class by making the StackAnimator instances optional.

Overall, the implementation aligns well with the PR objective and maintains consistency throughout the class.

---

23-24: Constructor parameter changes align with PR objective.

The changes to the default values of the constructor parameters successfully implement the PR objective:

1. The single parameter now defaults to null instead of fade().
2. The dual parameter's default value has been updated to maintain consistency with the single parameter change.
3. The triple parameter's default value remains unchanged but stays consistent by referencing dual.

These changes effectively make the default values in ChildPanelsAnimators null as intended.

To ensure these changes don't unexpectedly affect existing code, please run the following verification:

This will help identify any code that might be affected by the changed default values.

✅ Verification successful

No impact from constructor parameter default changes detected.

All existing usages of ChildPanelsAnimators explicitly specify parameters, ensuring that the changes to default values do not affect existing code.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for usages of ChildPanelsAnimators to identify potential impacts.

# Test: Search for ChildPanelsAnimators usage
rg --type kotlin "ChildPanelsAnimators\(" -A 5

Length of output: 6322

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.