@react-navigation/native
Version:
React Native integration for React Navigation
152 lines (149 loc) • 6.18 kB
JavaScript
"use strict";
import { getActionFromState as getActionFromStateDefault, getStateFromPath as getStateFromPathDefault, useNavigationIndependentTree } from '@react-navigation/core';
import * as React from 'react';
import { Linking, Platform } from 'react-native';
import { extractPathFromURL } from "./extractPathFromURL.js";
const linkingHandlers = [];
export function useLinking(ref, {
enabled = true,
prefixes,
filter,
config,
getInitialURL = () => Promise.race([Linking.getInitialURL(), new Promise(resolve => {
// Timeout in 150ms if `getInitialState` doesn't resolve
// Workaround for https://github.com/facebook/react-native/issues/25675
setTimeout(resolve, 150);
})]),
subscribe = listener => {
const callback = ({
url
}) => listener(url);
const subscription = Linking.addEventListener('url', callback);
// Storing this in a local variable stops Jest from complaining about import after teardown
// @ts-expect-error: removeEventListener is not present in newer RN versions
const removeEventListener = Linking.removeEventListener?.bind(Linking);
return () => {
// https://github.com/facebook/react-native/commit/6d1aca806cee86ad76de771ed3a1cc62982ebcd7
if (subscription?.remove) {
subscription.remove();
} else {
removeEventListener?.('url', callback);
}
};
},
getStateFromPath = getStateFromPathDefault,
getActionFromState = getActionFromStateDefault
}, onUnhandledLinking) {
const independent = useNavigationIndependentTree();
React.useEffect(() => {
if (process.env.NODE_ENV === 'production') {
return undefined;
}
if (independent) {
return undefined;
}
if (enabled !== false && linkingHandlers.length) {
console.error(['Looks like you have configured linking in multiple places. This is likely an error since deep links should only be handled in one place to avoid conflicts. Make sure that:', "- You don't have multiple NavigationContainers in the app each with 'linking' enabled", '- Only a single instance of the root component is rendered', Platform.OS === 'android' ? "- You have set 'android:launchMode=singleTask' in the '<activity />' section of the 'AndroidManifest.xml' file to avoid launching multiple instances" : ''].join('\n').trim());
}
const handler = Symbol();
if (enabled !== false) {
linkingHandlers.push(handler);
}
return () => {
const index = linkingHandlers.indexOf(handler);
if (index > -1) {
linkingHandlers.splice(index, 1);
}
};
}, [enabled, independent]);
// We store these options in ref to avoid re-creating getInitialState and re-subscribing listeners
// This lets user avoid wrapping the items in `React.useCallback` or `React.useMemo`
// Not re-creating `getInitialState` is important coz it makes it easier for the user to use in an effect
const enabledRef = React.useRef(enabled);
const prefixesRef = React.useRef(prefixes);
const filterRef = React.useRef(filter);
const configRef = React.useRef(config);
const getInitialURLRef = React.useRef(getInitialURL);
const getStateFromPathRef = React.useRef(getStateFromPath);
const getActionFromStateRef = React.useRef(getActionFromState);
React.useEffect(() => {
enabledRef.current = enabled;
prefixesRef.current = prefixes;
filterRef.current = filter;
configRef.current = config;
getInitialURLRef.current = getInitialURL;
getStateFromPathRef.current = getStateFromPath;
getActionFromStateRef.current = getActionFromState;
});
const getStateFromURL = React.useCallback(url => {
if (!url || filterRef.current && !filterRef.current(url)) {
return undefined;
}
const path = extractPathFromURL(prefixesRef.current, url);
return path !== undefined ? getStateFromPathRef.current(path, configRef.current) : undefined;
}, []);
const getInitialState = React.useCallback(() => {
let state;
if (enabledRef.current) {
const url = getInitialURLRef.current();
if (url != null) {
if (typeof url !== 'string') {
return url.then(url => {
const state = getStateFromURL(url);
if (typeof url === 'string') {
// If the link were handled, it gets cleared in NavigationContainer
onUnhandledLinking(extractPathFromURL(prefixes, url));
}
return state;
});
} else {
onUnhandledLinking(extractPathFromURL(prefixes, url));
}
}
state = getStateFromURL(url);
}
const thenable = {
then(onfulfilled) {
return Promise.resolve(onfulfilled ? onfulfilled(state) : state);
},
catch() {
return thenable;
}
};
return thenable;
}, [getStateFromURL, onUnhandledLinking, prefixes]);
React.useEffect(() => {
const listener = url => {
if (!enabled) {
return;
}
const navigation = ref.current;
const state = navigation ? getStateFromURL(url) : undefined;
if (navigation && state) {
// If the link were handled, it gets cleared in NavigationContainer
onUnhandledLinking(extractPathFromURL(prefixes, url));
const rootState = navigation.getRootState();
if (state.routes.some(r => !rootState?.routeNames.includes(r.name))) {
return;
}
const action = getActionFromStateRef.current(state, configRef.current);
if (action !== undefined) {
try {
navigation.dispatch(action);
} catch (e) {
// Ignore any errors from deep linking.
// This could happen in case of malformed links, navigation object not being initialized etc.
console.warn(`An error occurred when trying to handle the link '${url}': ${typeof e === 'object' && e != null && 'message' in e ? e.message : e}`);
}
} else {
navigation.resetRoot(state);
}
}
};
return subscribe(listener);
}, [enabled, getStateFromURL, onUnhandledLinking, prefixes, ref, subscribe]);
return {
getInitialState
};
}
//# sourceMappingURL=useLinking.native.js.map