Merge pull request #5 from atomic-router/feat/use-link

Author: sergeysova

README.md

@@ -78,3 +78,21 @@ import { Route } from 'atomic-router-react'
 
 <Route route={homeRoute} view={HomePage} />
 ```
+
+### `useLink` — resolve path from route
+
+```tsx
+import { useLink } from 'atomic-router-react'
+import { createRoute } from 'atomic-router'
+
+// example path: /some/route/:someId
+const someRoute = createRoute<{ someId: number }>()
+
+function SomeComponent() {
+  const path = useLink(someRoute, { someId: 1 })
+  // -> /some/route/1
+}
+```
+
+Be sure, route is passed into `routes` for `createHistoryRoutes`.
+Else hook will throw `[useLink] Route not found`.

package.json

@@ -70,6 +70,7 @@
     "atomic-router": "^0.6.1",
     "effector": "^22.3.0",
     "effector-react": "^22.1.6",
+    "history": "^5.3.0",
     "jest": "^28.1.0",
     "jest-environment-jsdom": "^28.1.3",
     "prettier": "^2.7.1",

src/index.tsx

@@ -3,3 +3,4 @@ export * from './route';
 export * from './router-provider';
 export * from './create-route-view';
 export * from './create-routes-view';
+export * from './use-link'

src/use-link.ts

@@ -0,0 +1,21 @@
+import { buildPath, RouteInstance, RouteParams, RouteQuery } from "atomic-router";
+import { useRouter } from "./router-provider";
+
+export function useLink<T extends RouteParams>(
+  route: RouteInstance<T>,
+  params: T,
+  query: RouteQuery = {},
+): string {
+  const router = useRouter()
+  const routeObj = router.routes.find((routeObj) => routeObj.route === route);
+
+  if (!routeObj) {
+    throw new Error(`[useLink] Route not found. Maybe it is not passed into createHistoryRouter`)
+  }
+
+  return buildPath({
+    pathCreator: routeObj.path,
+    params: params,
+    query: query,
+  })
+}

yarn.lock

@@ -973,7 +973,7 @@
     "@babel/helper-validator-option" "^7.18.6"
     "@babel/plugin-transform-typescript" "^7.18.6"
 
-"@babel/runtime@^7.12.5", "@babel/runtime@^7.8.4", "@babel/runtime@^7.9.2":
+"@babel/runtime@^7.12.5", "@babel/runtime@^7.7.6", "@babel/runtime@^7.8.4", "@babel/runtime@^7.9.2":
   version "7.18.9"
   resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.18.9.tgz#b4fcfce55db3d2e5e080d2490f608a3b9f407f4a"
   integrity sha512-lkqXDcvlFT5rvEjiu6+QYO+1GXrEHRo2LOtS7E4GtX5ESIZOgepqsZBVIj6Pv+a6zqsya9VCgiK1KAK4BvJDAw==
@@ -2351,6 +2351,13 @@ has@^1.0.3:
   dependencies:
     function-bind "^1.1.1"
 
+history@^5.3.0:
+  version "5.3.0"
+  resolved "https://registry.yarnpkg.com/history/-/history-5.3.0.tgz#1548abaa245ba47992f063a0783db91ef201c73b"
+  integrity sha512-ZqaKwjjrAYUYfLG+htGaIIZ4nioX2L70ZUMIFysS3xvBsSG4x/n1V6TXV3N8ZYNuFGlDirFg32T7B6WOUPDYcQ==
+  dependencies:
+    "@babel/runtime" "^7.7.6"
+
 html-encoding-sniffer@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/html-encoding-sniffer/-/html-encoding-sniffer-3.0.0.tgz#2cb1a8cf0db52414776e5b2a7a04d5dd98158de9"