useRouterContext

A custom React hook that retrieves the RouterContext, throwing an error if used outside a RouterContextProvider.

Installation

import { useRouterContext } from 'uxp/components';

Signature

function useRouterContext(): RouterContextValue

Examples

const MyComponent = () => {
  const routerContext = useRouterContext();
  return <div>{routerContext.someProperty}</div>;
};

const MyComponent = () => {
  const { someProperty, navigate } = useRouterContext();
  return (
    <div>
      <p>{someProperty}</p>
      <button onClick={() => navigate('/dashboard')}>
        Go to Dashboard
      </button>
    </div>
  );
};

Related Types

• RouterContextValue

• EnhancedNavigateFunction

• GenerateURLOptions