arkivanov / Decompose

Kotlin Multiplatform lifecycle-aware business logic components (aka BLoCs) with routing (navigation) and pluggable UI (Jetpack Compose, SwiftUI, JS React, etc.)
https://arkivanov.github.io/Decompose
Apache License 2.0
2.25k stars 85 forks source link

Sample Shared Transitions example without predictive back support #751

Closed arkivanov closed 3 months ago

arkivanov commented 3 months ago

As part of #690.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes enhance the application's image handling and navigation capabilities. By shifting from an ImageType enumeration to a more flexible ImageResourceId approach, the codebase improves its modularity and clarity. New components for shared transitions and galleries have been introduced, streamlining interactive features. These adjustments not only optimize resource management but also enrich user experience through better-defined navigation paths.

Changes

File Path Change Summary
KittenView.swift Modified image handling logic to use imageResourceId. Removed PreviewKittenComponent for cleaner code.
PainterResource.kt Introduced painterResource function to retrieve images as Painter objects in a type-safe manner.
KittenContent.kt Refactored image handling to use painterResource directly. Added KittenContentPreview for enhanced previews.
MenuContent.kt Added a new button for "Shared Transitions" to enhance interactivity.
PagesContent.kt Changed visibility of PagesContent to internal. Refactored close button implementation for clarity.
RootContent.kt Introduced SharedTransitionsChild for handling shared transitions in navigation.
ImageResourceId.kt Defined ImageResourceId enum for better image resource management with serialization support.
DefaultCustomNavigationComponent.kt Replaced ImageType with ImageResourceId for configuration flexibility.
DefaultKittenComponent.kt Updated parameter from imageType to imageResourceId for clarity.
KittenComponent.kt Replaced imageType with imageResourceId. Removed ImageType enum.
PreviewKittenComponent.kt Introduced a new class for previews, implementing KittenComponent.
DefaultMenuComponent.kt New parameter for handling shared transitions in menu interactions.
MenuComponent.kt Added onSharedTransitionsItemSelected callback to enhance menu functionality.
DefaultPagesComponent.kt Updated navigation logic to use ImageResourceId.
DefaultRootComponent.kt Added navigation item for shared transitions and updated methods for new configurations.
RootComponent.kt Introduced SharedTransitionsChild for managing shared transitions.
DefaultSharedTransitionsComponent.kt Created a component for managing navigation between gallery and photo views.
SharedTransitionsComponent.kt Defined interface for managing shared transitions with a stack of components.
DefaultGalleryComponent.kt Implemented gallery management functionality with dynamic image creation.
GalleryComponent.kt Introduced an interface for gallery functionality.
DefaultPhotoComponent.kt Created a component for managing photo display with close functionality.
Image.kt Defined Image data class with serialization support for handling image data.
PhotoComponent.kt Introduced interface for photo-related functionality.
PreviewPhotoComponent.kt Added a preview component for photo display with basic functionality.
DefaultTabsComponent.kt Added new parameter for handling shared transitions in tabs.
TabsComponentIntegrationTest.kt Introduced test for verifying shared transitions functionality in tabs.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MenuComponent
    participant SharedTransitionsComponent
    participant GalleryComponent
    participant PhotoComponent

    User->>MenuComponent: Selects Shared Transitions
    MenuComponent->>SharedTransitionsComponent: Trigger Transition
    SharedTransitionsComponent->>GalleryComponent: Navigate to Gallery
    GalleryComponent->>User: Display Images
    User->>GalleryComponent: Select Image
    GalleryComponent->>SharedTransitionsComponent: Transition to Photo
    SharedTransitionsComponent->>PhotoComponent: Display Photo
    User->>PhotoComponent: Close Photo
    PhotoComponent->>SharedTransitionsComponent: Notify Closed

🐰 In a world of images and dreams so bright,
A rabbit hops through code, full of delight.
With transitions shared and resources anew,
We dance in the gallery, just me and you.
So let’s celebrate changes, both big and small,
For every new feature brings joy to us all! πŸ₯•βœ¨


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.