lit-ui-router-mobx / RouterReactionControllerOptions
Interface: RouterReactionControllerOptions<T>
Defined in: lit-ui-router-mobx/src/router-reaction-controller.ts:12
Options for RouterReactionController.
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
equals? | IEqualsComparer<T> | Comparer deciding whether the selected value changed (e.g. compareStructural on mobx 7, comparer.structural on mobx 6). Defaults to MobX's identity comparer. | ReactionControllerOptions.equals | lit-ui-router-mobx/src/reaction-controller.ts:26 |
initialValue? | T | Value exposed on .value before the first reaction run — that is, before hostConnected, and on any host that renders while disconnected (SSR). Without it .value is undefined until the host connects, which is safe to render but not to read a property of. | ReactionControllerOptions.initialValue | lit-ui-router-mobx/src/reaction-controller.ts:19 |
onChange? | (value) => void | Invoked (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. | ReactionControllerOptions.onChange | lit-ui-router-mobx/src/reaction-controller.ts:11 |
router? | UIRouter | Explicit router instance. When omitted, the controller asks the nearest router provider on hostConnected: over context-request first (via requestRouter with subscribe: true), then over the ui-router-context event (via UIRouterLitElement.seekRouter) when nobody answers. It rebinds when a subscribed provider hands it the router that replaces its placeholder. | - | lit-ui-router-mobx/src/router-reaction-controller.ts:24 |