hooks/xyz.junerver.compose.hooks.useredux

Package-level declarations

Types

DispatchAsync

typealias DispatchAsync<A> = (block: suspend CoroutineScope.(Dispatch<A>) -> A) -> Unit

Store

data class Store(val middlewares: Array<Middleware<Any, Any>>, val records: List<StoreRecord>)

StoreScope

class StoreScope

Properties

ReduxContext

val ReduxContext: ReactContext<Tuple3<Map<KClass<*>, Any>, Map<KClass<*>, Dispatch<Any>>, Map<String, Tuple2<Any, Dispatch<Any>>>>>

Redux context

Functions

createStore

fun createStore(middlewares: Array<Middleware<Any, Any>> = emptyArray(), fn: StoreScope.() -> Unit): Store

Create store

plus

operator fun Store.plus(other: Store): Store

ReduxProvider

@Composable

fun ReduxProvider(store: Store, content: @Composable () -> Unit)

Redux provider, you should provide a state store to this Provider by use createStore

registerErr

fun registerErr(target: String): Nothing

useDispatch

@Composable

inline fun <A> useDispatch(alias: String? = null): Dispatch<A>

Use dispatch, Through this hook, you can easily obtain the global dispatch function

useDispatchAsync

@Composable

inline fun <A> useDispatchAsync(alias: String? = null, noinline onBefore: DispatchCallback<A>? = null, noinline onFinally: DispatchCallback<A>? = null): DispatchAsync<A>

Get a dispatch function that supports asynchronous execution. This function receives a suspend function whose return value is Action as a parameter.

useSelector

@Composable

inline fun <T> useSelector(alias: String? = null): T

Use selector

@Composable

inline fun <T, R> useSelector(alias: String? = null, block: T.() -> R): R

Use selector, by pass block, you can also select part of state class,to use in your component