RouteOptions — Kuito Documentation

Utilisation

Return a result from a presented screen

tsx

import type { RouteOptions } from 'kuito';

export const options: RouteOptions = { presentation: 'sheet', snapPoints: ['50%', '100%'] };

Déclaration du type

export type RouteOptions<P extends object = {}> = Omit<
  RouteProps<P>,
  'name' | 'path' | 'params' | 'screen'
>;

Membres 6

Nom	Type	Requis	Description
`presentation`	`Presentation`	Non	—
`backgroundColor`	`string`	Non	The screen's color, under the bars too; the platform's background without.
`snapPoints`	`readonly SnapPoint[]`	Non	A sheet route's heights, as `<Sheet snapPoints>` takes them; the platform's default without.
`title`	`string \| ((params: P) => string)`	Non	The native header's title.
`header`	`false \| ScreenHeader \| ((params: P) => false \| ScreenHeader)`	Non	The native header: false hides it; its items, large title and search otherwise (docs/navigation.md#headers).
`systemBars`	`SystemBarsProps`	Non	The system bars while this screen is focused, as a `<SystemBars>`'s props (docs/system-ui.md).

systemBars — champs imbriqués

systemBars champs

Nom	Type	Requis	Description
`statusBar`	`StatusBarOptions`	Non	The status bar's content color, visibility and, on Android, color.
`backgroundColor`	`string`	Non	The root view's color, seen behind the app's views.
`navigationBarColor`	`string`	Non	Android: drawn behind the navigation bar.
`navigationBarButtonStyle`	`NavigationBarButtonStyle`	Non	Android: light buttons for a dark navigation bar, dark buttons for a light one.
`navigationBarHidden`	`boolean`	Non	Android: hides the navigation bar; a swipe from the edge shows it for a moment.
`immersive`	`boolean`	Non	Full 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.
`homeIndicatorAutoHidden`	`boolean`	Non	iOS: lets the home indicator fade out while the user doesn't touch the screen.

statusBar — champs imbriqués

statusBar champs

Nom	Type	Requis	Description
`content`	`StatusBarContent`	Non	The color of the status bar's text and icons.
`hidden`	`boolean`	Non	—
`animated`	`boolean`	Non	Whether changes to content, hidden and backgroundColor animate.
`transition`	`StatusBarTransition`	Non	iOS: how showing and hiding animates, when animated.
`backgroundColor`	`string`	Non	Android: drawn behind the status bar; a hex color.
`translucent`	`boolean`	Non	Android: 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.