lit-ui-router / UiSrefActiveParams
Interface: UiSrefActiveParams
Defined in: packages/lit-ui-router/src/ui-sref-active.ts:147
Parameters for the uiSrefActive directive.
See
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
activeClasses? | string[] | CSS classes to add when the state (or a child state) is active | packages/lit-ui-router/src/ui-sref-active.ts:149 |
ariaCurrentValue? | | false | AriaCurrentValue | AriaCurrentValues | The aria-current value to set when the exact state is active — the same binding Vue Router's ariaCurrentValue uses. Defaults to 'page' on link elements (<a>, <area>, [role="link"]). Pass a value explicitly to apply it to any element; pass false to leave aria-current untouched. Pass an object to also mark ancestors, which is otherwise off: { exact: 'page', active: 'location' }. See AriaCurrentValues — the two do not combine the way activeClasses and exactClasses do. The directive only removes an aria-current it set itself, so a value authored in the template survives until the directive first writes one of its own — after that it owns the attribute and clears it when inactive, warning once. Use false to keep an authored value for good. | packages/lit-ui-router/src/ui-sref-active.ts:169 |
exactClasses? | string[] | CSS classes to add only when the exact state is active | packages/lit-ui-router/src/ui-sref-active.ts:151 |
options? | TransitionOptions | Transition options | packages/lit-ui-router/src/ui-sref-active.ts:175 |
params? | RawParams | State parameters to match | packages/lit-ui-router/src/ui-sref-active.ts:173 |
state? | string | The state name to check for active status | packages/lit-ui-router/src/ui-sref-active.ts:171 |
targetStates? | TargetState[] | The states to watch, built with router.stateService.target(). Lets an element go active for several states, or for links that aren't uiSref directives. Takes precedence: when given, state is ignored and nested uiSref links are not tracked. | packages/lit-ui-router/src/ui-sref-active.ts:182 |