useScreenState | Screen Transitions

useScreenState() returns screen and focused-route state from the current Blank Stack.

TSX

1import { useScreenState } from "react-native-screen-transitions";
2
3const {
4  index,
5  routes,
6  focusedRoute,
7  focusedIndex,
8  options,
9  meta,
10  navigation,
11  snapTo,
12} = useScreenState();

Field	Meaning
`index`	Index of the current screen in the stack
`routes`	Routes in the current stack
`focusedRoute`	Focused route in the stack
`focusedIndex`	Index of the focused route
`options`	Resolved options for the focused screen
`meta`	Metadata from the focused screen options
`navigation`	Navigation object for the current screen
`snapTo(index)`	Snap the focused screen to a configured snap-point index