@x-edu/route
v0.0.2
Published
Downloads
4
Keywords
Readme
@x-edu/route
发布
发布到 npm 官方 registry 上,注意不要发到 npm.sdp.nd 上
npm publish
发布后需要同步版本,依次访问如下地址,进行同步
- https://npmmirror.com/sync/@x-edu/route
- http://npm.sdp.nd/sync/@x-edu/route 访问 https://npmmirror.com/package/route 查看版本是否正确
API
React Router Components
AsyncRoute
异步加载路由组件,用于按需加载React组件。
| 参数 | 类型 | 描述 |
|----------------|----------|--------------------------------------------------------------|
| module
| Function | 返回一个Promise的函数,用于动态加载React组件。 |
| path
| string | 路由的路径。 |
| ...rest
| RouteProps | 其他传递给Route
组件的属性。 |
removeLoginParam
移除URL查询参数中的登录参数。
| 参数 | 类型 | 描述 |
|--------|----------|------------------|
| search
| string | URLSearchParams | URL的查询字符串。 |
Route
带权限控制的路由组件。
| 参数 | 类型 | 描述 |
|------------------|-----------|--------------------------------------------------------------|
| permission
| (props: RouteProps & { history: ReturnType<H> }) => Promise<boolean> \| boolean \| ComponentType
| 权限控制逻辑,可以是布尔值、Promise或组件。 |
| path
| string | 路由的路径。 |
| ...rest
| any | 其他传递给PureRoute
组件的属性。 |
Switch
用于包裹多个Route
组件,提供路由切换功能。
| 参数 | 类型 | 描述 |
|----------|----------|------------------|
| prefix
| string | 路由前缀,默认为空。 |
| children
| React.ReactNode | 包含多个Route
组件的子元素。 |