Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mercari/rxreduxk
Micro-framework for Redux implemented in Kotlin
https://github.com/mercari/rxreduxk
action android flux kotlin kotlin-android kotlin-library micro-framework reducer redux rx rxredux state state-management store
Last synced: 5 days ago
JSON representation
Micro-framework for Redux implemented in Kotlin
- Host: GitHub
- URL: https://github.com/mercari/rxreduxk
- Owner: mercari
- License: mit
- Created: 2018-12-10T08:31:59.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-07T13:21:46.000Z (over 1 year ago)
- Last Synced: 2023-08-04T11:09:13.310Z (over 1 year ago)
- Topics: action, android, flux, kotlin, kotlin-android, kotlin-library, micro-framework, reducer, redux, rx, rxredux, state, state-management, store
- Language: Kotlin
- Homepage:
- Size: 160 KB
- Stars: 66
- Watchers: 5
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RxRedux for Kotlin
[](https://bintray.com/mercari-inc/maven/rxreduxk/_latestVersion)
[](https://circleci.com/gh/mercari/RxReduxK)
Micro-framework for Redux implemented in Kotlin
## Installation
```
dependencies {
repositories {
jcenter()
}
}
implementation("com.mercari.rxredux:rxredux:")
```
## Usage
This framework is composed of several types/abstractions inspired by [Redux](https://redux.js.org/) that help to implement the reactive behavior of application components.
It is based on [RxJava](https://github.com/ReactiveX/RxJava) for reactivity and works well with [RemoteDataK](https://github.com/mercari/RemoteDataK).
### State
State represents the model or state of your component or UI.
A State is recommended to be immutable, however it can be allowed to be mutable.
This can typically be implemented by a [data class](https://kotlinlang.org/docs/reference/data-classes.html)
For example:
```kotlin
data class CounterState(
val counter: Int
) : State
```
### Action
An Action represents the desired modifications on a State, for example
```kotlin
class Increment : Action
class Decrement : Action
```
Although not required, it is recommended to model Actions as class hierarchy with a [sealed class](https://kotlinlang.org/docs/reference/sealed-classes.html).
```kotlin
sealed class CounterAction : Action
class Increment : CounterAction()
class Decrement : CounterAction()
```
An Action can contain parameters that make them more useful depending on the desired behaviour.
For example:
```kotlin
class Increment(val by: Int) : CounterAction
```
Actions are to be dispatched through the Store's _dispatch_ method to perform State mutations.
For example:
```kotlin
store.dispatch(Increment(2))
```
### Reducer
A Reducer is where the State is mutated or modified, depending on which Action is applied.
It is basically a map of the desired modifications and their effects.
For example:
```kotlin
class CounterReducer: Reducer {
override fun reduce(currentState: CounterState, action: CounterAction) : CounterState =
when(action) {
is Increment -> CounterState(counter: currenState.counter + action.by)
is Decrement -> CounterState(counter: currenState.counter - action.by)
}
}
```
### Middleware
Middleware allows for a variety of behaviours that are not directly related to the component's State.
This is useful for the implementation of so called cross-cutting concerns such as Logging, by hooking into the sequence of Action events.
Middleware can run before reducing the state or after depending on the need, this can be achieved by overriding the provided methods.
### Store
The Store "stores" the State, and exposes it for observation as an [Observable](http://reactivex.io/documentation/observable.html). It also connects all the other abstractions together.
To create a Store, simply instantiate it with an initial State and its related Reducer:
```kotlin
val counterStore = Store(initialState, reducer)
```
Several middleware can also be added to the Store through the Store's _addMiddleware_ method.
#### Examples
Examples of usage can be seen in the [tests](https://github.com/mercari/RxReduxK/tree/master/rxredux/src/test/java/com/mercari/rxredux)