• Index
• Search by APIs
• Search by Words
• Project Search

• Java
• Python
• JavaScript
• TypeScript
• C++
• Scala
• Blog

• rocon-master
  • .github
    • workflows
      • node.js.yml
      • publish.yml
  • .eslintignore
  • src
    • jest.setup.ts
    • integrationTests
      • LocationResolving.test.ts
      • issue-24.test.tsx
    • react
      • logic
        • getNavigationBaseLocation.ts
      • hooks
        • useNavigate.test.tsx
        • useRoutes.test.tsx
        • useNavigate.ts
        • useHistory.ts
        • useRoutes.tsx
        • useLocation.ts
      • index.ts
      • components
        • Link.test.tsx
        • Link.tsx
        • Redirect.test.tsx
        • RoconRoot.tsx
        • Redirect.tsx
      • shorthand.ts
      • Rocon.ts
      • types
        • NavigateFunction.ts
        • ReactRouteBuilder.ts
        • ReactElement.ts
        • ReactRouteRecord.ts
      • contexts
        • LocationContext.ts
        • RouteContext.ts
        • HistoryContext.ts
      • test-utils
        • index.tsx
      • errors
        • LocationNotFoundError.ts
    • builder
      • RootRouteBuilder
        • RootRouteBuilder.test.ts
        • fillOptions.ts
        • index.ts
      • RouteBuilderLink.ts
      • SearchRouteBuilder
        • index.ts
        • SearchRouteBuilder.test.ts
      • SingleHashRouteBuilder
        • index.ts
        • SingleHashRouteBuilder.test.ts
      • RoutePathResolver
        • index.ts
      • SingleRouteAbstractBuilder
        • index.ts
      • StateRouteBuilder
        • StateRouteBuilder.test.ts
        • index.ts
      • WildcardFlagType.ts
      • RoutesDefinitionObject.ts
      • symbols.ts
      • RouteRecord
        • ConstRouteRecord.ts
        • MatchingRouteRecord.ts
        • RouteRecordBase.ts
        • PathRouteRecord.ts
        • index.ts
        • getRouteRecordLocation.ts
        • RouteRecordType.ts
      • composers
        • SearchLocationComposer
          • index.ts
          • SearchLocationComposer.test.ts
        • ConstLocationComposer
          • index.ts
        • StateLocationComposer
          • index.ts
          • StateLocationComposer.test.ts
        • SingleHashLocationComposer
          • SingleHashLocationComposer.test.ts
          • index.ts
        • PathLocationComposer
          • composePath.ts
          • decomposePath.ts
          • composePath.test.ts
          • PathLocationComposer.test.ts
          • index.ts
          • decomposePath.test.ts
      • PathRouteBuilder
        • PathRouteBuilder.test.ts
        • index.ts
        • PathSingleRouteInterface.ts
        • isRootPath.ts
    • index.ts
    • validator
      • index.ts
    • util
      • locationToURL.ts
      • noop.ts
      • types
        • Clean.ts
        • PartialIf.ts
        • OptionalIf.ts
        • PartiallyPartial.ts
      • useIsFirstRendering.ts
      • TODO.ts
      • locationToURL.test.ts
      • assert.ts
    • shorthand.ts
    • Rocon.ts
    • __mocks__
      • _history.ts
    • core
      • LocationComposer.ts
      • Location.ts
      • BuilderLink
        • BuilderLinkState.ts
        • BuilderLink.test.ts
        • fillOptions.ts
        • index.ts
        • HasBuilderLink.ts
        • SegmentResolver.ts
        • BuilderLinkOptions.ts
      • RouteResolver
        • RouteResolver.test.ts
        • index.ts
        • ResolvedRoute.ts
        • resolveChain.ts
  • jest.config.js
  • .husky
    • commit-msg
    • pre-commit
  • .prettierrc.json
  • LICENSE
  • react.js
  • babel.config.esm.js
  • commitlint.config.js
  • CONTRIBUTING.md
  • .editorconfig
  • CHANGELOG.md
  • babel.config.js
  • react.d.ts
  • configs
    • tsconfig.base.json
    • babel.js
    • tsconfig.test.json
    • tsconfig.main.json
  • README.md
  • package.json
  • .eslintrc.js
  • tsconfig.json
  • .gitignore
  • .prettierignore
  • .vscode
    • settings.json

import { History } from "history";
import { ReactElement, useContext, useMemo } from "react";
import { RouteRecordType } from "../../builder/RouteRecord";
import { getRouteRecordLocation } from "../../builder/RouteRecord/getRouteRecordLocation";
import { HistoryContext } from "../contexts/HistoryContext";
import { RouteContext } from "../contexts/RouteContext";
import { getNavigationBaseLocation } from "../logic/getNavigationBaseLocation";
import { Navigate, NavigateFunction } from "../types/NavigateFunction";

const cache = new WeakMap<History, Navigate>();

/**
 * Returns the navigate function.
 */
export const useNavigate = (): Navigate => {
  const historyContextObject = useContext(HistoryContext);
  const parentRoute = useContext(RouteContext);
  if (historyContextObject === undefined) {
    throw new Error(
      "No history found in the context. Please make sure you have placed RoconRoot above."
    );
  }
  const { history } = historyContextObject;

  const navigate = useMemo<Navigate>(() => {
    // create navigate function.
    const push = (<Match>(
      route: RouteRecordType<ReactElement | null, Match, boolean>,
      match: Match
    ) => {
      const baseLocation = getNavigationBaseLocation(parentRoute, route);
      history.push(
        getRouteRecordLocation(route, (match || {}) as Match, baseLocation)
      );
    }) as NavigateFunction;
    const replace = (<Match>(
      route: RouteRecordType<ReactElement | null, Match, boolean>,
      match: Match
    ) => {
      const baseLocation = getNavigationBaseLocation(parentRoute, route);
      history.replace(
        getRouteRecordLocation(route, (match || {}) as Match, baseLocation)
      );
    }) as NavigateFunction;
    return Object.assign(push, { push, replace });
  }, [history, parentRoute]);

  return navigate;
};