Skip to content

lit-ui-router / SrefStatusControllerOptions

Interface: SrefStatusControllerOptions

Defined in: packages/lit-ui-router/src/sref-status-controller.ts:30

Options for SrefStatusController: which state to watch, plus the router to watch it in.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
options?TransitionOptionsTransition options; relative defaults to the enclosing view's stateSrefTargetParams.optionspackages/lit-ui-router/src/sref-active.ts:43
params?RawParamsState parameters to matchSrefTargetParams.paramspackages/lit-ui-router/src/sref-active.ts:41
router?UIRouterThe UIRouter instance to observe. When omitted, the controller discovers the router from an ancestor <ui-router> (or <ui-view>) via the ui-router-context event when the host connects. Passing it explicitly also moves the first status computation into the constructor, so the status is there for the very first render and needs no DOM — the hand-off an element-less environment has no other way to make.-packages/lit-ui-router/src/sref-status-controller.ts:43
state?stringThe state name to check for active statusSrefTargetParams.statepackages/lit-ui-router/src/sref-active.ts:39