Register a screen in a Router. Use it in an app with component routes, rather than file routes.

Register a parameterized detail screen

tsx
import { Link, Route, Router, Text, VStack, routes, type RouteTo, type ScreenProps } from 'kuito';

declare module 'kuito' {
  interface Routes {
    index: RouteTo;
    show: RouteTo<{ id: number }>;
    settings: RouteTo;
  }
}

function Home() {
  return (
    <VStack padding={16}>
      <Link to={routes.show({ id: 42 })}>
        <Text>Show 42</Text>
      </Link>
    </VStack>
  );
}

function Show({ id }: ScreenProps<{ id: number }>) {
  return <Text padding={16}>{`Show ${id}`}</Text>;
}

function Settings() {
  return <Text padding={16}>Settings</Text>;
}

export default function App() {
  return (
    <Router>
      <Route name="index" path="/" screen={Home} title="Home" />
      <Route
        name="show"
        path="/show/:id"
        params={{ id: Number }}
        screen={Show}
        title={({ id }) => `Show ${id}`}
      />
      <Route name="settings" path="/settings" screen={Settings} presentation="sheet" />
    </Router>
  );
}

Behavior

name identifies the destination, path matches links, and screen renders it. Declare parameter types with params. Route is navigation configuration rather than a visible layout container.

Continue

Read Navigation for a complete workflow. See the complete prop reference for types and documented defaults.

Reference

Signatures

ts
<P extends object, R>(_props: RouteProps<P, R>): KuitoNode

Type parameters

NameConstraintDefault
Pobject—
R——

Parameters

NameTypeRequiredDescription
_propsRouteProps<P, R>Yes—

Returns

KuitoNode

Props: RouteProps<P, R>

Props (including inherited props) 10

NameTypeRequiredDescription
namestringYesIts key in routes.
pathstringYesSegments, :name params and a final *name: what a deep link's path matches.
params{ [K in keyof P]?: ParamType; }NoHow a link's text parses into each param; a path param left out is a string.
screenComponent<ScreenProps<P, R>>Yes—
titlestring | ((params: P) => string)NoThe native header's title.
presentationPresentationNo—
backgroundColorstringNoThe screen's color, under the bars too; the platform's background without.
snapPointsreadonly SnapPoint[]NoA sheet route's heights, as <Sheet snapPoints> takes them; the platform's default without.
headerfalse | ScreenHeader | ((params: P) => false | ScreenHeader)NoThe native header: false hides it; its items, large title and search otherwise (docs/navigation.md#headers).
systemBarsSystemBarsPropsNoThe system bars while this screen is focused, as a <SystemBars>'s props (docs/system-ui.md).
screen — method signatures

Signatures

ts
(props: ScreenProps<P, R>): KuitoNode

Parameters

NameTypeRequiredDescription
propsScreenProps<P, R>Yes—

Returns

KuitoNode

systemBars — nested fields

systemBars fields

NameTypeRequiredDescription
statusBarStatusBarOptionsNoThe status bar's content color, visibility and, on Android, color.
backgroundColorstringNoThe root view's color, seen behind the app's views.
navigationBarColorstringNoAndroid: drawn behind the navigation bar.
navigationBarButtonStyleNavigationBarButtonStyleNoAndroid: light buttons for a dark navigation bar, dark buttons for a light one.
navigationBarHiddenbooleanNoAndroid: hides the navigation bar; a swipe from the edge shows it for a moment.
immersivebooleanNoFull screen: hides the status bar, the navigation bar and the home indicator, and on iOS edge swipes reach the app first. The entry's own props, and later entries, win over what it hides.
homeIndicatorAutoHiddenbooleanNoiOS: lets the home indicator fade out while the user doesn't touch the screen.
statusBar — nested fields

statusBar fields

NameTypeRequiredDescription
contentStatusBarContentNoThe color of the status bar's text and icons.
hiddenbooleanNo—
animatedbooleanNoWhether changes to content, hidden and backgroundColor animate.
transitionStatusBarTransitionNoiOS: how showing and hiding animates, when animated.
backgroundColorstringNoAndroid: drawn behind the status bar; a hex color.
translucentbooleanNoAndroid: false lays the app out below the status bar instead of under it.
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.