Maven Central License Twitter URL

badge badge badge badge badge badge badge

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.).

⚡⚡⚡ Why is this repository a fork?

Having spent 5 years working on a variety of projects for Badoo/Bumble, I’m now off to another adventure. As part of that transition I was asked to transfer this repository to Badoo GitHub account.

Now I continue my work on this project as a fork.

There should be no breaking changes related to this transfer. Most of the external links should not be broken. The repository link is also the same: arkivanov/Decompose. Please file an issue in this repository, if you think something is broken or does not work properly.

Here is what is mostly affected by the transfer:

  • All the stars were transferred
  • Search in the code will not work as long as this repository has less stars than the parent (your help is needed!)
  • All the Issues and Discussions were transferred as well. I will do all my best to fill the gap here.
  • All pull requests with all the comment history are also gone.

I will continue doing all my best for this project and for the community! Business as usual!

Additional resources:

Why Decompose?

  • Decompose draws clear boundaries between UI and non-UI code, which gives the following benefits:
    • Better separation of concerns
    • Pluggable platform-specific UI (Compose, SwiftUI, React, etc.)
    • Business logic code is testable with pure multiplatform unit tests
  • Proper dependency injection (DI) and inversion of control (IoC) via constructor
  • Shared navigation logic
  • Lifecycle-aware components
  • Components in the back stack are not destroyed, they continue working in background without UI
  • Components and UI state preservation (mostly useful in Android)
  • Instances retaining (aka ViewModels) over configuration changes (mostly useful in Android)

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 and 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

Pluggable UI hierarchy

Typical component structure

Samples

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

Articles

Author

Twitter: @arkann1985

If you like this project you can always Buy Me A Coffee 😉

GitHub

View Github