lit-ui-router / UiSrefDirective

Class: UiSrefDirective

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

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	Defined in
element	UiSrefElement | null	null	packages/lit-ui-router/src/ui-sref.ts:76
href	string | null	null	packages/lit-ui-router/src/ui-sref.ts:81
options	TransitionOptions	{}	packages/lit-ui-router/src/ui-sref.ts:74
params	RawParams	{}	packages/lit-ui-router/src/ui-sref.ts:73
parentView	UiView | null	null	packages/lit-ui-router/src/ui-sref.ts:79
state	string | null	null	packages/lit-ui-router/src/ui-sref.ts:72
targetState	| TargetState | null	null	packages/lit-ui-router/src/ui-sref.ts:82
uiRouter	UIRouterLit | undefined	undefined	packages/lit-ui-router/src/ui-sref.ts:78

Methods

doRender()

doRender(): symbol;

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

Returns

symbol

---

getOptions()

getOptions(opts): TransitionOptions;

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

Parameters

Parameter	Type
opts	TransitionOptions

Returns

TransitionOptions

---

onClick()

onClick(event): void;

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

Parameters

Parameter	Type
event	MouseEvent

Returns

void

---

render()

render(
   state,
   params?,
   options?): symbol;

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

Parameters

Parameter	Type
state	string
params?	RawParams
options?	TransitionOptions

Returns

symbol

Overrides

AsyncDirective.render;

---

update()

update(part, __namedParameters): symbol;

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

Parameters

Parameter	Type
part	ElementPart
__namedParameters	[string, RawParams, TransitionOptions]

Returns

symbol

Overrides

AsyncDirective.update;