Link options

linkOptions is a function which type checks an object literal with the intention of being used for Link, navigate or redirect

linkOptions props

The linkOptions accepts the following option:

...props

Type: LinkProps & React.RefAttributes<HTMLAnchorElement>
LinkProps

linkOptions returns

An object literal with the exact type inferred from the input

Examples

tsx

const userLinkOptions = linkOptions({
  to: '/dashboard/users/user',
  search: {
    usersView: {
      sortBy: 'email',
      filterBy: 'filter',
    },
    userId: 0,
  },
})

function DashboardComponent() {
  return <Link {...userLinkOptions} />
}

const userLinkOptions = linkOptions({
  to: '/dashboard/users/user',
  search: {
    usersView: {
      sortBy: 'email',
      filterBy: 'filter',
    },
    userId: 0,
  },
})

function DashboardComponent() {
  return <Link {...userLinkOptions} />
}

@Tan_Stack on X.com

@TannerLinsley on X.com

Nozzle.io - Keyword Rank Tracker

Terms of Service

© 2026 TanStack LLC