components/dev.fritz2.components/MultiSelectionStore

MultiSelectionStore

open class MultiSelectionStore<T> : RootStore<List<T>>

This store can be used for components with an internal store that has to deal with a List of some type T.

Use the toggle method to add or remove an selected item from the current selection:

val selection = MultiSelectionStore<String>()
lineUp {
    items {
        listOf("One", "Two", "Three", "Four", "Five").forEach { value ->
            box({
                background { color { info } }
            }) {
                +value
                clicks.events.map { value } handledBy selection.toggle
                //                  ^^^^^                       ^^^^^^
                //                  pass current value to the ``toggle`` handler!
            }
        }
    }
}
div {
    +"Selection:"
    ul {
        selection.data.renderEach { value ->
            li { +value }
        }
    }
}

RFC: Never ever expose the internal store directly to the client side! Only accept values or Flows and return those in order to exchange data with the client!

Constructors

MultiSelectionStore

fun MultiSelectionStore()

Functions

enqueue

open suspend override fun enqueue(update: QueuedUpdate<List<T>>)

equals

open operator fun equals(other: Any?): Boolean

errorHandler

open fun errorHandler(exception: Throwable, oldValue: List<T>): List<T>

handle

open fun handle(errorHandler: ErrorHandler<List<T>>, execute: suspend (List<T>) -> List<T>): SimpleHandler<Unit>

open fun <A> handle(errorHandler: ErrorHandler<List<T>>, execute: suspend (List<T>, A) -> List<T>): SimpleHandler<A>

handleAndEmit

open fun <E> handleAndEmit(errorHandler: ErrorHandler<List<T>>, execute: suspend FlowCollector<E>.(List<T>) -> List<T>): EmittingHandler<Unit, E>

open fun <A, E> handleAndEmit(errorHandler: ErrorHandler<List<T>>, execute: suspend FlowCollector<E>.(List<T>, A) -> List<T>): EmittingHandler<A, E>

handledBy

open infix fun <A> Flow<A>.handledBy(handler: Handler<A>)

hashCode

open fun hashCode(): Int

sub

fun <X> sub(lens: Lens<List<T>, X>): SubStore<List<T>, List<T>, X>

syncBy

open fun syncBy(handler: Handler<Unit>)

open fun syncBy(handler: Handler<List<T>>)

syncWith

open fun <I> syncWith(socket: Socket, resource: Resource<List<T>, I>)

toString

open fun toString(): String

Properties

current

open override val current: List<T>

data

open override val data: StateFlow<List<T>>

open override val id: String

job

open override val job: Job

toggle

val toggle: EmittingHandler<T, List<T>>

update

open override val update: SimpleHandler<List<T>>