Link#

Declarative navigation — the JSX flavor of nav.push. Render a <Link to="…"> and a tap pushes (or replaces) that route, with the same per-route param inference as the imperative Nav API.

Import#

import { Link } from '@sigx/lynx-navigation';

Basic usage#

Link wraps a native <view> that fires nav.push on bindtap. The to prop is a registered route name, and — exactly like nav.push — params is required if and only if that route declares a params schema. Route names, params and search are all inferred from your augmented Register route map, so a wrong route name or a missing/extra param is a TypeScript error.

import { Link } from '@sigx/lynx-navigation';

// `profile` declares a params schema → `params` is required.
<Link to="profile" params={{ id: 'alice' }} search={{ tab: 'about' }}>
  Open Alice
</Link>;

// `home` has no params schema → `params` is forbidden.
<Link to="home">Go home</Link>;

Replacing instead of pushing#

Pass replace to navigate with nav.replace rather than nav.push — useful for "reset" style links that should not add a back-stack entry.

import { Link } from '@sigx/lynx-navigation';

<Link to="home" replace>Reset</Link>;

Because Link resolves the navigator from context, it must be rendered inside a NavigationRoot subtree — see Usage for the full setup.

Props#

The full prop type is LinkProps — LinkPropsByRoute & { replace?: boolean; children?: unknown }, where LinkPropsByRoute conditionally requires params per route. It mirrors the per-route overloads of Nav.push.

See also#

• Usage — the typed-routes setup and the imperative useNav API.
• API reference — Link, LinkProps, Nav and every related type.