lit-ui-router / UiSrefDirective

Class: UiSrefDirective

Defined in: packages/lit-ui-router/src/ui-sref.ts:144

Directive class that creates state-based navigation links.

This directive is used internally by the uiSref directive function. It transforms elements (typically <a> tags) into UI-Router navigation links by setting the href attribute and handling click events.

See

• uiSref for the public API
• AsyncDirective
• StateService.go

Extends

• AsyncDirective

Properties

Property	Type	Default value	Description	Defined in
href	string | null	null	the href computed for the target, or null when there is none	packages/lit-ui-router/src/ui-sref.ts:164
options	TransitionOptions	{}	the transition options from the last render	packages/lit-ui-router/src/ui-sref.ts:150
params	RawParams	{}	the target state params from the last render	packages/lit-ui-router/src/ui-sref.ts:148
state	string | null	null	the target state name from the last render	packages/lit-ui-router/src/ui-sref.ts:146
targetState	| TargetState | null	null	the resolved target, or null until the router is found	packages/lit-ui-router/src/ui-sref.ts:166
uiSrefOptions	UiSrefOptions	{}	this directive's own options, stripped from the transition options	packages/lit-ui-router/src/ui-sref.ts:161

Methods

getOptions()

getOptions(opts?): TransitionOptions;

Defined in: packages/lit-ui-router/src/ui-sref.ts:203

the transition options with relative defaulted to the enclosing view

Parameters

Parameter	Type
opts?	TransitionOptions

Returns

TransitionOptions