push/replace accepts option for hash, assembles on url

src/services/createRouterResolve.spec.ts

@@ -83,4 +83,10 @@ test('when given an external route with params in host, interpolates param value
   const url = resolve('external', { 'subdomain': 'router' })
 
   expect(url).toBe('https://router.kitbag.dev/')
+})
+
+test('given a route with hash, interpolates hash value', () => {
+  const resolve = createRouterResolve(routes)
+
+  expect(resolve('parentA', { paramA: 'bar' }, { hash: 'foo' })).toBe('/parentA/bar#foo')
 })

src/services/createRouterResolve.ts

@@ -10,6 +10,7 @@ import { AllPropertiesAreOptional } from '@/types/utilities'
 
 export type RouterResolveOptions = {
   query?: Record<string, string>,
+  hash?: string,
 }
 
 type RouterResolveArgs<
@@ -51,6 +52,7 @@ export function createRouterResolve<const TRoutes extends Routes>(routes: TRoute
     const url = assembleUrl(match, {
       params,
       query: options.query,
+      hash: options.hash,
     })
 
     return url

src/services/createRouterRoute.ts

@@ -13,6 +13,7 @@ export type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = Readonly
   matches: TRoute['matches'],
   state: TRoute['state'],
   query: ResolvedRouteQuery,
+  hash: TRoute['hash'],
   params: Writable<TRoute['params']>,
   update: RouteUpdate<TRoute>,
 }>

src/services/urlAssembly.spec.ts

@@ -358,4 +358,15 @@ describe('host params', () => {
 
     expect(url).toBe('ABC.kitbag.dev/')
   })
+})
+
+test('given route with hash, returns url with hash value interpolated', () => {
+  const route = createRoute({
+    name: 'simple',
+    path: '/',
+  })
+
+  const url = assembleUrl(route, { hash: 'foo' })
+
+  expect(url).toBe('/#foo')
 })

src/services/urlAssembly.ts

@@ -11,6 +11,7 @@ import { Route } from '@/types/route'
 type AssembleUrlOptions = {
   params?: Record<string, unknown>,
   query?: Record<string, string>,
+  hash?: string,
 }
 
 export function assembleUrl(route: Route, options: AssembleUrlOptions = {}): string {
@@ -20,7 +21,10 @@ export function assembleUrl(route: Route, options: AssembleUrlOptions = {}): str
   const pathWithParamsSet = assemblePathParamValues(route.path, paramValues)
   const queryWithParamsSet = assembleQueryParamValues(route.query, paramValues)
 
-  return withQuery(`${hostWithParamsSet}${pathWithParamsSet}`, queryWithParamsSet, queryValues)
+  const url = withQuery(`${hostWithParamsSet}${pathWithParamsSet}`, queryWithParamsSet, queryValues)
+  const hash = options.hash ? `#${options.hash.replace(/^#/, '')}` : ''
+
+  return `${url}${hash}`
 }
 
 function assembleHostParamValues(host: Host, paramValues: Record<string, unknown>): string {

src/types/routerPush.ts

@@ -9,6 +9,7 @@ export type RouterPushOptions<
   TState = unknown
 > = {
   query?: Record<string, string>,
+  hash?: string,
   replace?: boolean,
   state?: Partial<TState>,
 }

src/types/routerReplace.ts

@@ -9,6 +9,7 @@ export type RouterReplaceOptions<
   TState = unknown
 > = {
   query?: Record<string, string>,
+  hash?: string,
   state?: Partial<TState>,
 }