Skip to content

lit-ui-router-effect / RefControllerOptions

Interface: RefControllerOptions<T> ​

Defined in: lit-ui-router-effect/src/ref-controller.ts:39

Options for RefController.

Extended by ​

Type Parameters ​

Type Parameter
T

Properties ​

PropertyTypeDescriptionDefined in
equals?(a, b) => booleanComparer deciding whether the selected value changed. Defaults to Object.is; pass Equal.equals for structural comparison (plain objects on effect 4, Data values on either major).lit-ui-router-effect/src/ref-controller.ts:61
initialValue?TValue exposed on .value before the first read of a ref that is only resolved on hostConnected (see RefSource) — that is, before the host connects, and on any host that renders while disconnected (SSR). Refs given directly are read at construction instead, so they never need it.lit-ui-router-effect/src/ref-controller.ts:54
onChange?(value) => voidInvoked (before host.requestUpdate()) whenever the selected value changes — and once on every host (re)connect. Use for effects such as resetting component state from route params.lit-ui-router-effect/src/ref-controller.ts:45
runtime?RefRuntimeThe runtime the subscription fiber is forked on, and refs are read with. Defaults to Effect's default runtime; pass the app's ManagedRuntime to keep the fibers on one. The selector gets no services from it.lit-ui-router-effect/src/ref-controller.ts:68