@wordpress/components
Version:
UI components for WordPress.
23 lines (20 loc) • 612 B
text/typescript
import { useContext } from '@wordpress/element';
import { NavigatorContext } from './context';
import type { Navigator } from './types';
/**
* Retrieves a `navigator` instance. This hook provides advanced functionality,
* such as imperatively navigating to a new location (with options like
* navigating back or skipping focus restoration) and accessing the current
* location and path parameters.
*/
export function useNavigator(): Navigator {
const { location, params, goTo, goBack, goToParent } =
useContext( NavigatorContext );
return {
location,
goTo,
goBack,
goToParent,
params,
};
}