Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/arkivanov/Decompose

Kotlin Multiplatform lifecycle-aware business logic components (aka BLoCs) with routing (navigation) and pluggable UI (Jetpack Compose, SwiftUI, JS React, etc.)
https://github.com/arkivanov/Decompose

android kotlin kotlin-multiplatform multiplatform navigation

Last synced: 14 days ago
JSON representation

Kotlin Multiplatform lifecycle-aware business logic components (aka BLoCs) with routing (navigation) and pluggable UI (Jetpack Compose, SwiftUI, JS React, etc.)

Lists

README 

        

  

  

  










[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

[![Twitter URL](https://img.shields.io/badge/[email protected]?style=social&logo=twitter)](https://twitter.com/arkann1985)



---



Decompose is a Kotlin Multiplatform library for breaking down your code into tree-structured lifecycle-aware business logic components (aka BLoC), with routing functionality and pluggable UI (Jetpack/Multiplatform Compose, Android Views, SwiftUI, Kotlin/React, etc.).



Please see the [project website](https://arkivanov.github.io/Decompose/) for documentation and APIs. 



Should you have any questions or ideas - there is [Discussions](https://github.com/arkivanov/Decompose/discussions) section. Also welcome to the Kotlin Slack channel - [#decompose](https://kotlinlang.slack.com/archives/C03H3N51SKT)!



## ⚡⚡⚡ Where are all the stars, issues, discussions, pull requests, etc?



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](https://github.com/badoo).



Now I **continue my work** on this project **as a copy**.



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](https://github.com/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

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



- [A thread on Hacker News](https://news.ycombinator.com/item?id=29447854)



## Why Decompose?



* Decompose breaks the code down into small and independent components and organizes them into trees. Each parent component is only aware of its immediate children.

* 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, Kotlin/React, etc.)

  * Business logic code is testable with pure multiplatform unit tests

* Navigation state is fully exposed - plug any UI you want, animate as you like using your favourite UI framework's API or use predefined API.

* Navigation is a pure function from the old state to a new one - navigate without limits.

* Proper dependency injection (DI) and inversion of control (IoC) via constructor, including but not limited to type-safe arguments.

* Shared navigation logic

* Lifecycle-aware components

* Components in the back stack are not destroyed, they continue working in background without UI

* State preservation (automatically on Android, manually on all other targets via `kotlinx-serialization`)

* Instances retaining (aka ViewModels) over configuration changes (mostly useful in Android)



## Setup



Please check the [Installation](https://arkivanov.github.io/Decompose/getting-started/installation/) section of the documentation.



### Supported platforms



In general, Decompose supports the following targets: `android`, `jvm`, `ios`, `watchos`, `tvos`, `macos`, `wasmJs`, `js`. However, some modules do not support all targets or the support depends on the Decompose version. Please see the Installation docs for details.



## Overview



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



* [Component](https://arkivanov.github.io/Decompose/component/overview/) - every component represents a piece of logic with its own lifecycle, the UI is optional and is plugged externally

* [ComponentContext](https://arkivanov.github.io/Decompose/component/overview/#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

* [Child Stack](https://arkivanov.github.io/Decompose/navigation/stack/overview/) - enables navigation between child components, nested navigation is also supported

* [Child Slot](https://arkivanov.github.io/Decompose/navigation/slot/overview/) - allows only one child component at a time, or none

* [Child Pages](https://arkivanov.github.io/Decompose/navigation/pages/overview/) - a list of child components with one selected component (e.g. pager-like navigation)

* [Generic Navigation](https://arkivanov.github.io/Decompose/navigation/children/overview/) - provides a way to create your own custom navigation model, when none of the predefined models fit your needs

* [Lifecycle](https://arkivanov.github.io/Decompose/component/lifecycle/) - provides a way to listen for lifecycle events in components

* [StateKeeper](https://arkivanov.github.io/Decompose/component/state-preservation/) - makes it possible to preserve state or data in a component when it gets destroyed

* [InstanceKeeper](https://arkivanov.github.io/Decompose/component/instance-retaining/) - retains instances in your components (similar to AndroidX `ViewModel`)

* [BackPressedHandler](https://arkivanov.github.io/Decompose/component/back-button/) - provides a way to handle and intercept back button presses



### Component hierarchy






### Pluggable UI hierarchy






### Typical component structure






## Quick start



Please refer to the [Quick start](https://arkivanov.github.io/Decompose/getting-started/quick-start/) section of the docs.



## Samples



Check out the [Samples](https://arkivanov.github.io/Decompose/samples/) section of the docs for a full description of each sample.



## Template



Check out the [template repository](https://github.com/arkivanov/decompose-multiplatform-template) which may be used to kick-start a project for you.



## Articles



- [Decompose — experiments with Kotlin Multiplatform lifecycle-aware components and navigation](https://proandroiddev.com/decompose-experiments-with-kotlin-multiplatform-lifecycle-aware-components-and-navigation-a04ef3c7f6a3?source=friends_link&sk=f7d289cc329b6c8a765fc049e36c313f)

- [Fully cross-platform Kotlin applications (almost)](https://proandroiddev.com/fully-cross-platform-kotlin-applications-almost-29c7054f8f28?source=friends_link&sk=4619fdcb17912fde589bc4fca83efbbd)

- [A comprehensive thirty-line navigation for Jetpack/Multiplatform Compose](https://medium.com/p/5b723c4f256e) - if you find Decompose verbose and would prefer something built on top of Compose.



- "Component-based Approach" series by [Artur Artikov](https://twitter.com/artik_artikov)

  - Part 1: [Fighting Complexity in Android Applications](https://medium.com/@a.artikov/component-based-approach-fighting-complexity-in-android-applications-2eaf5e8c5fad)

  - Part 2: [Implementing Screens with the Decompose Library](https://medium.com/@a.artikov/component-based-approach-implementing-screens-with-the-decompose-library-19c41d8ed087)



## Author



Twitter: [@arkann1985](https://twitter.com/arkann1985)



If you like this project you can always Buy Me A Coffee ;-)