lit-ui-router / UiSrefDirective

Class: UiSrefDirective

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

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
element	UiSrefElement | null	null	-	packages/lit-ui-router/src/ui-sref.ts:185
href	string | null	null	-	packages/lit-ui-router/src/ui-sref.ts:193
options	TransitionOptions	{}	-	packages/lit-ui-router/src/ui-sref.ts:183
params	RawParams	{}	-	packages/lit-ui-router/src/ui-sref.ts:182
parentView	UiView | null	null	-	packages/lit-ui-router/src/ui-sref.ts:188
state	string | null	null	-	packages/lit-ui-router/src/ui-sref.ts:181
targetState	| TargetState | null	null	-	packages/lit-ui-router/src/ui-sref.ts:194
uiRouter	UIRouterLit | undefined	undefined	-	packages/lit-ui-router/src/ui-sref.ts:187
uiSrefOptions	UiSrefOptions	{}	this directive's own options, stripped from the transition options	packages/lit-ui-router/src/ui-sref.ts:191

Methods

doRender()

doRender(): typeof noChange;

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

Returns

typeof noChange

---

getOptions()

getOptions(opts?): TransitionOptions;

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

Parameters

Parameter	Type
opts	TransitionOptions

Returns

TransitionOptions

---

onClick()

onClick(event): void;

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

Parameters

Parameter	Type
event	MouseEvent

Returns

void

---

render()

render(
   state, 
   params?, 
   options?
): typeof noChange;

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

Parameters

Parameter	Type
state	string
params?	RawParams
options?	TransitionOptions

Returns

typeof noChange

Overrides

AsyncDirective.render

---

update()

update(part, __namedParameters): typeof noChange;

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

Parameters

Parameter	Type
part	ElementPart
__namedParameters	[string, RawParams?, UiSrefTransitionOptions?]

Returns

typeof noChange

Overrides

AsyncDirective.update