Maintenance notice

This repository is not maintained. Arkadii Ivanov continued to work on the fork arkivanov/Decompose.

Decompose

Please see the project website for documentation and APIs.

Decompose is a Kotlin Multiplatform library for breaking down your code into lifecycle-aware business logic components (aka BLoC), with routing functionality and pluggable UI (Jetpack Compose, Android Views, SwiftUI, JS React, etc.). This project is inspired by Badoos RIBs fork of the Uber RIBs framework.

Setup

Please check the Installation section of the documentation.

Overview

Here are some key concepts of the library, more details can be found in the documentation.

• Component - every component represents a piece of logic with its own lifecycle, the UI is optional an is plugged externally
• ComponentContext - every component has its own [ComponentContext], which makes components lifecycle-aware and allows state preservation, instances retaining (aka AndroidX ViewModel) and back button handling
• Router - enables navigation between child components, nested navigation is also supported
• Lifecycle - provides a way to listen for lifecycle events in components
• StateKeeper - makes it possible to preserve state or data in a component when it gets destroyed
• InstanceKeeper - retains instances in your components (similar to AndroidX ViewModel)
• BackPressedHandler - provides a way to handle and intercept back button presses

Component hierarchy

<img src="docs/media/ComponentHierarchy.png" width="512">

Pluggable UI hierarchy

<img src="docs/media/PluggableUiHierarchy.png" width="512">

Typical component structure

<img src="docs/media/ComponentStructure.png" width="512">

Samples

Check out the project website for a full description of each sample.

Articles

• Decompose — experiments with Kotlin Multiplatform lifecycle-aware components and navigation
• Fully cross-platform Kotlin applications (almost)

Author

Twitter: @arkann1985

If you like this project you can always <a href="https://www.buymeacoffee.com/arkivanov" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy Me A Coffee" height=32></a> ;-)