import { getPathFromState, NavigationAction, NavigationContainerRefContext, NavigationHelpersContext, NavigatorScreenParams, ParamListBase, } from '@react-navigation/core'; import type { NavigationState, PartialState } from '@react-navigation/routers'; import * as React from 'react'; import { GestureResponderEvent, Platform } from 'react-native'; import LinkingContext from './LinkingContext'; import useLinkTo, { To } from './useLinkTo'; type Props = { to: To; action?: NavigationAction; }; const getStateFromParams = ( params: NavigatorScreenParams | undefined ): PartialState | NavigationState | undefined => { if (params?.state) { return params.state; } if (params?.screen) { return { routes: [ { name: params.screen, params: params.params, // @ts-expect-error state: params.screen ? getStateFromParams( params.params as | NavigatorScreenParams | undefined ) : undefined, }, ], }; } return undefined; }; /** * Hook to get props for an anchor tag so it can work with in page navigation. * * @param props.to Absolute path to screen (e.g. `/feeds/hot`). * @param props.action Optional action to use for in-page navigation. By default, the path is parsed to an action based on linking config. */ export default function useLinkProps< ParamList extends ReactNavigation.RootParamList >({ to, action }: Props) { const root = React.useContext(NavigationContainerRefContext); const navigation = React.useContext(NavigationHelpersContext); const { options } = React.useContext(LinkingContext); const linkTo = useLinkTo(); const onPress = ( e?: React.MouseEvent | GestureResponderEvent ) => { let shouldHandle = false; if (Platform.OS !== 'web' || !e) { shouldHandle = e ? !e.defaultPrevented : true; } else if ( !e.defaultPrevented && // onPress prevented default // @ts-expect-error: these properties exist on web, but not in React Native !(e.metaKey || e.altKey || e.ctrlKey || e.shiftKey) && // ignore clicks with modifier keys // @ts-expect-error: these properties exist on web, but not in React Native (e.button == null || e.button === 0) && // ignore everything but left clicks // @ts-expect-error: these properties exist on web, but not in React Native [undefined, null, '', 'self'].includes(e.currentTarget?.target) // let browser handle "target=_blank" etc. ) { e.preventDefault(); shouldHandle = true; } if (shouldHandle) { if (action) { if (navigation) { navigation.dispatch(action); } else if (root) { root.dispatch(action); } else { throw new Error( "Couldn't find a navigation object. Is your component inside NavigationContainer?" ); } } else { linkTo(to); } } }; const getPathFromStateHelper = options?.getPathFromState ?? getPathFromState; const href = typeof to === 'string' ? to : getPathFromStateHelper( { routes: [ { name: to.screen, // @ts-expect-error params: to.params, // @ts-expect-error state: getStateFromParams(to.params), }, ], }, options?.config ); return { href, accessibilityRole: 'link' as const, onPress, }; }