🐲 : export MenuDataItem type

README.md

@@ -1,11 +1,64 @@
 # @umi-material/@umijs/route-utils
 
+## Usage
 
+```bash
+# npm
+npm i @umijs/route-utils --save
 
-## Usage
+## yarn
+yarn add @umijs/route-utils
+```
+
+## API
+
+```tsx
+import {
+  transformRoute,
+  getMatchMenu,
+  getMatchMenu,
+} from ' @umijs/route-utils';
+
+const routes = [
+  {
+    path: '/welcome',
+    name: 'welcome',
+  },
+  {
+    path: '/admin',
+    name: 'admin',
+    access: 'canAdmin',
+  },
+  {
+    name: 'list.table-list',
+    path: '/list',
+  },
+];
+
+const { menuData, breadcrumb } = transformRoute(routes);
+
+console.log(menuData[0].name); // welcome
+
+console.log(breadcrumb.get('/welcome').name); // welcome
+```
+
+### MenuDataItem
+
+```tsx
+import { MenuDataItem } from '@umijs/route-utils';
 
-```sh
-umi block https://github.com//tree/master/@umijs/route-utils
+export interface MenuDataItem {
+  children?: MenuDataItem[];
+  hideChildrenInMenu?: boolean;
+  hideInMenu?: boolean;
+  icon?: React.ReactNode;
+  locale?: string | false;
+  name?: string;
+  key?: string;
+  parentKeys?: string[];
+  path?: string;
+  [key: string]: any;
+}
 ```
 
 ## LICENSE

src/index.ts

@@ -1,3 +1,7 @@
+import { MenuDataItem } from './types';
+
 export { default as transformRoute } from './transformRoute/transformRoute';
 export { default as getFlatMenus } from './getFlatMenus/getFlatMenus';
 export { default as getMatchMenu } from './getMatchMenu/getMatchMenu';
+
+export type { MenuDataItem }