Router and Nav

Last updated on 2021-05-07 16:29:08

Routing and menus are the key skeletons for organizing an application. The routes in pro are centrally managed in a convenient way to manage and manage them in config.ts.

Basic Structure

In this part, scaffolding builds the basic framework of routing and menus by combining some configuration files, basic algorithms and tool functions, mainly involving the following modules/functions:

  • Routing Management Configure the route in config.ts according to the agreed syntax.
  • Menu generation Generates a menu based on the routing configuration. The name of the menu item, the nested path is highly coupled to the route.
  • Breadcrumbs component The breadcrumbs built into PageHeader can also be generated by RouteContext.

The following is a brief introduction to the basic ideas of each module. If you are not interested in the implementation process, just want to know how to implement the relevant requirements, you can directly view requirements instance.


At present, all the routes in the scaffolding are managed by config.ts. In the configuration of umi, we add some parameters, such as name, icon, hideChildren, authority, to assist the generation. menu. among them:

  • name and icon represent the icon and text of the generated menu item, respectively.
  • hideChildrenInMenu is used to hide sub-routes that do not need to be displayed in the menu. Usage can view the configuration of the Step by Step Form.
  • hideInMenu can not display this route in the menu, including sub-routing. The effect can be viewed on the exception/trigger page.
  • authority is used to configure the permissions of this route. If configured, it will verify the permissions of the current user and decide whether to display it.

    You may notice that the name in the configuration is different from the actual display of the menu. This is because we use the global component, see i18n.

The menu is generated according to config.ts.

If your project does not require a menu, you can do it at src/layouts/BasicLayout.tsx by setting menuRender={false}.

Fetch menu from server

Just update menuData in models/menu, which is a json array. Just the server returns a json of similar format.

You need to update menuDataRender prop in src/layouts/BasicLayout.tsx as below, fetch menuData from your service.

const [menuData, setMenuData] = useState([]);

useEffect(() => {
  // just for sample
  // please use dva dispatch or umi-request in real world
    .then(response => response.json())
    .then(data => {
      setMenuData(data || []);
}, []);


return (
    // ...
    menuDataRender={() => menuData}
    // ...

The above menuData definite is MenuDataItem.

    "path": "/dashboard",
    "name": "dashboard",
    "icon": "dashboard",
    "children": [
        "path": "/dashboard/analysis",
        "name": "analysis",
        "exact": true
        "path": "/dashboard/monitor",
        "name": "monitor",
        "exact": true
        "path": "/dashboard/workplace",
        "name": "workplace",
        "exact": true
  // ....

Note that path must be defined in config.ts. (All you need in Conventional Routing is the correct page.)

Breadcrumbs are implemented by PageContainer, Layout will be rendered according to breadcrumb generated by MenuData and rendered by PageContainer. PageContainer is packaged into Ant Design's PageHeader, and the api is identical.


The above outlines the implementation of this part, and then through the actual case to explain what to do.

You can fill the url directly into the path and the framework will handle it automatically.

    path: '',
    name: "Docs"

If you need to customize the click logic of the menuItem, you can use menuItemRender to fulfill.

Add Page

Please read through the block new Block

Scaffolding provides two layout templates by default: Basic Layout - BasicLayout and Account Layout - UserLayout:



If your page can take advantage of both layouts, you only need to add one to the corresponding routing configuration:

  // app
    path: '/',
    component: '../layouts/BasicLayout',
    routes: [
      // dashboard
      { path: '/', redirect: '/dashboard/analysis' },
      { path: '/dashboard/test', component:"./Dashboard/Test" },

When added, the relevant routing and navigation will be automatically generated.

Add layout

In the scaffolding we implement the layout template by nesting the route. config.ts is an array, the first level of which is our layout. If you need to add a new layout, you can directly add a new first-level element in the array.

module.exports = [
   // user
    path: '/user',
    component: '../layouts/UserLayout',
   // app
    path: '/',
    component: '../layouts/BasicLayout',
   // new
    path: '/new',
    component: '../layouts/new_page',

Use a custom icon in the menu

Due to umi's limitations, the config.ts is not directly With components, Pro temporarily supports the use of its own icon type, and the url of an img. Just configure it directly on the icon property. If it's a url, Pro will automatically process it as an img tag.

If this does not meet the requirements, you can customize getIcon method.

If you need to use the iconfont icon, you can try the custom icon for ant.desgin.

Routing with parameters

Scaffolding supports routing with parameters by default, but it is not a good idea to display a route with parameters in the menu. We will not automatically inject a parameter for you, you may need to handle it yourself in the code.

{ path: '/dashboard/:page', hideInMenu: true, name: 'analysis', component: './Dashboard/Analysis' },

You can jump to this route with the following code:

import { history } from 'umi';



import { Link } from 'umi';

<Link to="/dashboard/anyParams">go</Link>;

In the routing component, routing parameters can be obtained via this.props.match.params.

See more details:umi#router