inula/packages/horizon-router
* 948302d341 Match-id-0da000bd383f126fee27c3dc28875883eca9daa4 2023-09-01 11:26:52 +08:00
..
src Match-id-b452299b973063552e691943ce737d3dfb2e6b36 2023-09-01 11:24:31 +08:00
.prettierrc.js Match-id-5ae8e357b37201f329c6f95c7d89b45208d7084f 2023-09-01 09:11:54 +08:00
README.md Match-id-5ae8e357b37201f329c6f95c7d89b45208d7084f 2023-09-01 09:11:54 +08:00
babel.config.js Match-id-5ae8e357b37201f329c6f95c7d89b45208d7084f 2023-09-01 09:11:54 +08:00
build.js Match-id-b452299b973063552e691943ce737d3dfb2e6b36 2023-09-01 11:24:31 +08:00
jest.config.js Match-id-5ae8e357b37201f329c6f95c7d89b45208d7084f 2023-09-01 09:11:54 +08:00
package.json Match-id-b452299b973063552e691943ce737d3dfb2e6b36 2023-09-01 11:24:31 +08:00
tsconfig.json Match-id-5ae8e357b37201f329c6f95c7d89b45208d7084f 2023-09-01 09:11:54 +08:00

README.md

Horizon-router

Horizon-router 是Horizon生态组建的一部分为Horizon提供前端路由的能力是构建大型应用必要组件。

Horizon-router涵盖react-router、history、connect-react-router的功能。

从react-router切换

Horizon-router 在API设计上兼容react-router V5。

在切换时只需在package.json的dependencies中加入horizon-router 并将原有的API引用从react-router-domhistoryconnected-react-router 切换到horizon-router

切换样例代码如下:

react-router-dom

切换前

import { Switch, Route } from 'react-router-dom';

切换后

import { Switch, Route } from 'horizon-router';

history

切换前

import { createHashHistory, createBrowserHistory } from 'history';

切换后

import { createHashHistory, createBrowserHistory } from 'horizon-router';

connected-react-router

切换前

import { ConnectedRouter, routerMiddleware, connectRouter } from 'connected-react-router';

切换后

import { ConnectedRouter, routerMiddleware, connectRouter } from 'horizon-router';

Horizon-router API列表

history 兼容API

  • createBrowserHistory
  • createHashHistory

react-router-dom 兼容API

  • __RouterContext
  • matchPath
  • generatePath
  • useHistory
  • useLocation
  • useParams
  • useRouteMatch
  • Route
  • Router
  • Switch
  • Redirect
  • Prompt
  • withRouter
  • HashRouter
  • BrowserRouter
  • Link
  • NavLink

react-router-dom 类型兼容API

  • RouteComponentProps
  • RouteChildrenProps
  • RouteProps

connected-react-router 兼容API

  • connectRouter
  • routerMiddleware
  • ConnectedRouter

connected-react-router 新增API

  • ConnectedHRouter(在HorizonX的Redux兼容模式中使用)

问题反馈

Horizon-router问题与bug反馈请联系00800104 黄轩