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.

Référence

Signatures

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

Paramètres de type

NomContraintePar défaut
Pobject—
R——

Paramètres

NomTypeRequisDescription
_propsRouteProps<P, R>Oui—

Retourne

KuitoNode

Props: RouteProps<P, R>

Props (props héritées incluses) 10

NomTypeRequisDescription
namestringOuiIts key in routes.
pathstringOuiSegments, :name params and a final *name: what a deep link's path matches.
params{ [K in keyof P]?: ParamType; }NonHow a link's text parses into each param; a path param left out is a string.
screenComponent<ScreenProps<P, R>>Oui—
titlestring | ((params: P) => string)NonThe native header's title.
presentationPresentationNon—
backgroundColorstringNonThe screen's color, under the bars too; the platform's background without.
snapPointsreadonly SnapPoint[]NonA sheet route's heights, as <Sheet snapPoints> takes them; the platform's default without.
headerfalse | ScreenHeader | ((params: P) => false | ScreenHeader)NonThe native header: false hides it; its items, large title and search otherwise (docs/navigation.md#headers).
systemBarsSystemBarsPropsNonThe system bars while this screen is focused, as a <SystemBars>'s props (docs/system-ui.md).
screen — signatures de méthode

Signatures

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

Paramètres

NomTypeRequisDescription
propsScreenProps<P, R>Oui—

Retourne

KuitoNode

systemBars — champs imbriqués

systemBars champs

NomTypeRequisDescription
statusBarStatusBarOptionsNonThe status bar's content color, visibility and, on Android, color.
backgroundColorstringNonThe root view's color, seen behind the app's views.
navigationBarColorstringNonAndroid: drawn behind the navigation bar.
navigationBarButtonStyleNavigationBarButtonStyleNonAndroid: light buttons for a dark navigation bar, dark buttons for a light one.
navigationBarHiddenbooleanNonAndroid: hides the navigation bar; a swipe from the edge shows it for a moment.
immersivebooleanNonFull 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.
homeIndicatorAutoHiddenbooleanNoniOS: lets the home indicator fade out while the user doesn't touch the screen.
statusBar — champs imbriqués

statusBar champs

NomTypeRequisDescription
contentStatusBarContentNonThe color of the status bar's text and icons.
hiddenbooleanNon—
animatedbooleanNonWhether changes to content, hidden and backgroundColor animate.
transitionStatusBarTransitionNoniOS: how showing and hiding animates, when animated.
backgroundColorstringNonAndroid: drawn behind the status bar; a hex color.
translucentbooleanNonAndroid: false lays the app out below the status bar instead of under it.
Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.