Button: Add route types to to prop (RouteLocation | RouteLocationRaw)

[madebyfabian]

Is your feature request related to a problem? Please describe.

I am using Nuxt with the experimental.typedRoutes feature. When I use the button for creating a link, like this

<template>
  <UButton
    variant="link"
    :to="{ name: 'admin-content-jobs' }">
    Jobs
  </UButton>
</template>

The to prop is not defined as a prop in the types of the library (in the Button.vue.d.ts inside the node_modules folder).
So I don't get type checks and also no errors if I add a wrong route in there.

Describe the solution you'd like

Ideally, these two types (RouteLocation | RouteLocationRaw) would be added to the to prop by nuxthq/ui, so that the prop is typed.

Describe alternatives you've considered

What I can do is something like this:

<template>
  <UButton
    variant="link"
    :to="to">
    Jobs
  </UButton>
</template>

<script lang="ts" setup>
import type { RouteLocation, RouteLocationRaw } from '#vue-router'
const to: RouteLocation | RouteLocationRaw = { name: 'admin-content-jobs' }
// Or
const router = useRouter()
const to = router.resolve({ name: 'admin-content-jobs' })
</script>

Now the route object is typechecked and I can add it to the to field. Works, but not ideal.

[benjamincanac]

I'm aware of this, we should have a ...NuxtLink.props inside the Button props.

I've removed it as it breaks nuxt-component-meta for the docs as I didn't find a workaround.