feat: add useLink hook

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`.

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,
+  })
+}