tanstack-react-router_api

ActiveLinkOptions type

The ActiveLinkOptions type extends the LinkOptions type and contains additional options that can be used to describe how a link should be styled when it is active.

type ActiveLinkOptions = LinkOptions & {
  activeProps?:
    | React.AnchorHTMLAttributes<HTMLAnchorElement>
    | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>)
  inactiveProps?:
    | React.AnchorHTMLAttributes<HTMLAnchorElement>
    | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>)
}

ActiveLinkOptions properties

The ActiveLinkOptions object accepts/contains the following properties:

activeProps

• React.AnchorHTMLAttributes<HTMLAnchorElement>
• Optional
• The props that will be applied to the anchor element when the link is active

inactiveProps

• Type: React.AnchorHTMLAttributes<HTMLAnchorElement>
• Optional
• The props that will be applied to the anchor element when the link is inactive

AsyncRouteComponent type

The AsyncRouteComponent type is used to describe a code-split route component that can be preloaded using a component.preload() method.

type AsyncRouteComponent<TProps> = SyncRouteComponent<TProps> & {
  preload?: () => Promise<void>
}

FileRoute class

[!CAUTION] This class has been deprecated and will be removed in the next major version of TanStack Router. Please use the createFileRoute function instead.

The FileRoute class is a factory that can be used to create a file-based route instance. This route instance can then be used to automatically generate a route tree with the tsr generate and tsr watch commands.

FileRoute constructor

The FileRoute constructor accepts a single argument: the path of the file that the route will be generated for.

Constructor options

• Type: string literal
• Required, but automatically inserted and updated by the tsr generate and tsr watch commands.
• The full path of the file that the route will be generated from.