headless/dev.fritz2.headless.foundation/BooleanAttributeHook

BooleanAttributeHook

class BooleanAttributeHook<C : Tag<*>>(valueSetter: C.(Boolean, String) -> Unit, flowOfValueSetter: C.(Flow<Boolean>, String) -> Unit, trueValue: String = "") : Hook<C, Unit, Unit>

This Hook encapsulates the effect of setting a boolean attribute to a Tag.

The boolean attribute itself has to be defined by the owner of the hook as constructor parameter, the specific value however can be provided by the user.

If the user does not provide any value, no attribute will be attached to the Tag!

Constructors

BooleanAttributeHook

constructor(valueSetter: C.(Boolean, String) -> Unit, flowOfValueSetter: C.(Flow<Boolean>, String) -> Unit, trueValue: String = "")

Properties

alsoExpr

var alsoExpr: Unit.() -> Unit?

This field encapsulates some behaviour, which should be applied to the result R of the Hook's Effect.

isSet

val isSet: Boolean

value

open var value: Effect<C, Unit, Unit>?

Functions

also

fun also(expr: Unit.() -> Unit)

This method offers the created result as receiver within a context expression in order to expose some additional configuration entry point for a client.

invoke

operator fun invoke(value: Boolean?)

operator fun invoke(value: Flow<Boolean>)

use

fun use(item: Effect<C, Unit, Unit>)