giggles
Router

API Reference

API reference for the screen router

Router

Manages a stack of screens. Only the top screen is visible; others remain mounted but hidden.

Prop

Type

Throws a GigglesError if initialScreen does not match any registered Screen name.

Screen

Declarative route definition. Renders nothing — used by Router to register screens.

Prop

Type

useNavigation()

Returns navigation methods and current route state. Must be used within a Router.

Type Signature
function useNavigation(): NavigationContextValue

Prop

Type

push, replace, and reset throw a GigglesError if the screen name is not registered.

ScreenRoute

Prop

Type

On this page