MobX State Router

MobX State Router

  • Docs
  • GitHub

›API

Guides

  • Getting Started
  • Recipes
  • Examples

API

  • Route
  • RouterLink
  • RouterState
  • RouterStore
  • RouterView
  • HistoryAdapter
  • StaticAdapter

RouterLink

The <RouterLink> component creates an anchor tag that transitions to the specified router state when clicked. It does so without reloading the entire app, thus avoiding potential flickers.

interface RouterLinkProps {
    routeName: string;
    params?: StringMap;
    queryParams?: { [key: string]: any };
    className?: string;
    activeClassName?: string;
    isActive?: (currentState: RouterState, toState: RouterState) => boolean;
}

const RouterLink: React.FC<RouterLinkProps> = () => {...};

RouterLink accepts className and activeClassName as optional properties to control the look of the link in normal and active states. This feature is useful for highlighting the active link in a navbar. The default test for checking if a link is active is very simple - the routeName of the current RouterState should match the target routeName of the link. For more control over this test, you can supply your own custom isActive function.

You can pass other anchor tag attributes (such as onClick and onBlur) to this component. They will be passed through to the child anchor tag except for href, which is fully computed by this component.

← RouteRouterState →
Copyright © 2021 Naresh Bhatia