# NavigationTarget

Source: /tuil/docs/reference/packages/router/api/navigation-target
Locale: en

type exported by @mwillbanks/tuil-router.



{/* Generated by tooling/docs/generate-reference.ts. */}

## type [#type]

Public type exported by `@mwillbanks/tuil-router`.

```ts
export type NavigationTarget<TTo extends string = string, TParams = unknown> = {
  readonly to: TTo;
  readonly surface?: NavigationSurface;
  readonly replace?: boolean;
  readonly signal?: AbortSignal;
} & (unknown extends TParams
  ? { readonly params?: unknown }
  : keyof TParams extends never
    ? { readonly params?: TParams }
    : { readonly params: TParams });
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`NavigationSurface`](/tuil/docs/reference/packages/router/api/navigation-surface)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/router/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-router](/tuil/docs/reference/packages/router)