{"id":15020334,"url":"https://github.com/away0x/react-router-helper","last_synced_at":"2026-01-24T17:34:25.899Z","repository":{"id":41660256,"uuid":"258951335","full_name":"Away0x/react-router-helper","owner":"Away0x","description":"react router helper","archived":false,"fork":false,"pushed_at":"2023-01-06T04:26:11.000Z","size":3257,"stargazers_count":0,"open_issues_count":21,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-16T18:18:27.812Z","etag":null,"topics":["middleware","react","react-router","react-router-config","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Away0x.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-26T05:53:52.000Z","updated_at":"2022-07-26T02:34:17.000Z","dependencies_parsed_at":"2023-02-05T07:30:57.524Z","dependency_job_id":null,"html_url":"https://github.com/Away0x/react-router-helper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Away0x%2Freact-router-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Away0x%2Freact-router-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Away0x%2Freact-router-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Away0x%2Freact-router-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Away0x","download_url":"https://codeload.github.com/Away0x/react-router-helper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239171868,"owners_count":19594050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["middleware","react","react-router","react-router-config","typescript"],"created_at":"2024-09-24T19:54:55.698Z","updated_at":"2026-01-24T17:34:25.885Z","avatar_url":"https://github.com/Away0x.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React Router Helper\n\u003e 类似 react-router-config，可以以配置形式生成路由\n\n## Install\n```bash\nnpm install --save aw-react-router-helper\n```\n\n## Types\n```typescript\ntype RoutesRenderFun = () =\u003e React.ReactNode;\n\ninterface RouteState\u003cMeta = {}\u003e {\n  path: string;\n  meta: Meta;\n  url: string;\n}\n\ninterface RouteConfig\u003cMeta = {}\u003e {\n  // 路径\n  path: string;\n  // 存储一些路由的额外信息\n  meta?: Meta;\n  // 重定向 route path\n  redirect?: string;\n  // 路由的展示组件 (二选一，且必须有其一)\n  component?: React.ComponentType\u003cRouteConfigComponentProps\u003cany, Meta\u003e\u003e | React.ComponentType;\n  render?: (props: RouteConfigComponentProps\u003cany, Meta\u003e) =\u003e React.ReactNode;\n  // 中间件 (路由渲染的拦截器)\n  middlewares?: RouteMiddlewareFunc\u003cMeta\u003e[];\n  // 子路由\n  routes?: RouteConfig\u003cMeta\u003e[];\n}\n\ninterface RouteConfigComponentProps\u003cParams extends {[K in keyof Params]?: string } = {}, Meta = {}\u003e extends RouteComponentProps\u003cParams\u003e {\n  // 路由配置信息\n  route: RouteConfig\u003cMeta\u003e;\n  // 渲染子路由的方法\n  renderRoutes: RoutesRenderFun;\n}\n\ntype RouteMiddlewareFunc\u003cMeta = {}\u003e = (params: RouteState\u003cMeta\u003e) =\u003e undefined | JSX.Element | string;\n\ntype RouteLoadOptions\u003cMeta = {}\u003e = {\n  configs: RouteConfig\u003cMeta\u003e[];\n  middlewares?: RouteMiddlewareFunc\u003cMeta\u003e[];\n}\n\ninterface IRouterHelper\u003cMeta\u003e {\n  load(options: RouteLoadOptions\u003cMeta\u003e): IRouterHelper\u003cMeta\u003e;\n  render(routes?: RouteConfig\u003cMeta\u003e[]): JSX.Element | null;\n}\n```\n\n## Examples\n- [base](examples/src/base.tsx)\n- [auth](examples/src/auth.tsx)\n\n***\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faway0x%2Freact-router-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faway0x%2Freact-router-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faway0x%2Freact-router-helper/lists"}