Method NavLink

Namespace

Velvet

Assembly

Velvet.Docs.dll

NavLink(string, string, string?, string?, string?, VNode?[]?, bool, bool, bool, string?, FiberEventBinding[]?, object?, RelativeRoutingType)

Adds current-location active styling to Link(string, string?, string?, string?, VNode?[]?, bool, string?, FiberEventBinding[]?, object?, RelativeRoutingType).

public static ComponentNode NavLink(string to, string activeClass, string? text = null, string? className = null, string? name = null, VNode?[]? children = null, bool end = false, bool replace = false, bool caseSensitive = false, string? key = null, FiberEventBinding[]? events = null, object? state = null, RelativeRoutingType relative = RelativeRoutingType.Route)

Parameters

to string

Absolute or route-relative navigation target. A relative one takes the same resolution for the active comparison that it takes to navigate.

activeClass string

Appended to className while non-empty and active.

text string

className string

name string

children VNode[]

end bool

Restricts active state to an exact path match instead of a segment-prefix match.

replace bool

Selects replacement instead of push navigation.

caseSensitive bool

Uses ordinal matching instead of the case-insensitive default.

key string

events FiberEventBinding[]

Event bindings applied to the button, as on Link(string, string?, string?, string?, VNode?[]?, bool, string?, FiberEventBinding[]?, object?, RelativeRoutingType).

state object

Stored on the new history entry, as on Link(string, string?, string?, string?, VNode?[]?, bool, string?, FiberEventBinding[]?, object?, RelativeRoutingType).

relative RelativeRoutingType

How a relative to resolves, as on Link(string, string?, string?, string?, VNode?[]?, bool, string?, FiberEventBinding[]?, object?, RelativeRoutingType); the active comparison resolves it the same way.

Returns

ComponentNode