@types/gatsbyjs__reach-router

Installation

npm install --save @types/gatsbyjs__reach-router

Summary

This package contains type definitions for @gatsbyjs/reach-router (https://github.com/gatsbyjs/reach-router#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gatsbyjs__reach-router.

index.d.ts

import { WindowLocation } from "@reach/router";
import * as React from "react";

export {
    AnchorProps,
    createHistory,
    createMemorySource,
    globalHistory,
    History,
    HistoryActionType,
    HistoryListener,
    HistoryLocation,
    HistorySource,
    HistoryUnsubscribe,
    HLocation,
    isRedirect,
    Link,
    LinkGetProps,
    LinkProps,
    Match,
    MatchProps,
    MatchRenderFn,
    MatchRenderProps,
    NavigateFn,
    NavigateOptions,
    Redirect,
    RedirectProps,
    RedirectRequest,
    redirectTo,
    RouteComponentProps,
    Router,
    RouterProps,
    ServerLocation,
    ServerLocationProps,
    // Looking for useNavigate? It was removed from @gatsbyjs/reach-router
    // Use import { navigate } from 'gatsby' instead
    useLocation,
    useMatch,
    useParams,
    WindowLocation,
} from "@reach/router";

import { History } from "@reach/router"; // eslint-disable-line no-duplicate-imports

// Override location to remove navigate function for React 18 server components compatibility
// https://github.com/gatsbyjs/reach-router/pull/4

export interface LocationProps {
    children: LocationProviderRenderFn;
}

export class Location extends React.Component<LocationProps> {}

export interface LocationProviderProps {
    history?: History | undefined;
    children?: React.ReactNode | LocationProviderRenderFn | undefined;
}

export type LocationProviderRenderFn = (context: LocationContext) => React.ReactNode;

export interface LocationContext {
    location: WindowLocation;
}

export class LocationProvider extends React.Component<LocationProviderProps> {}

Additional Details

• Last updated: Mon, 14 Oct 2024 10:39:56 GMT
• Dependencies: @types/reach__router, @types/react

Credits

These definitions were written by Adam Jones.