diff --git a/docs/content/2.elements/9.link.md b/docs/content/2.elements/9.link.md new file mode 100644 index 00000000..6b59da7a --- /dev/null +++ b/docs/content/2.elements/9.link.md @@ -0,0 +1,24 @@ +--- +title: 'Link' +description: Render a NuxtLink but with superpowers. +links: + - label: GitHub + icon: i-simple-icons-github + to: https://github.com/nuxtlabs/ui/blob/dev/src/runtime/components/elements/Link.vue +navigation: + badge: Edge +--- + +## Usage + +The Link component is a wrapper around [``](https://nuxt.com/docs/api/components/nuxt-link) through the [custom](https://router.vuejs.org/api/interfaces/RouterLinkProps.html#Properties-custom) prop that provides a few extra props: + +- `inactive-class` prop to set a class when the link is inactive, `active-class` is used when active. +- `exact` prop to style with `active-class` when the link is active and the route is exactly the same as the current route. +- `exact-query` and `exact-hash` props to style with `active-class` when the link is active and the query or hash is exactly the same as the current query or hash. + +The incentive behind this is to provide the same API as NuxtLink back in Nuxt 2 / Vue 2. You can read more about it in the Vue Router [migration from Vue 2](https://router.vuejs.org/guide/migration/#removal-of-the-exact-prop-in-router-link) guide. + +It also renders an `` tag when a `to` prop is provided, otherwise it renders a `