diff --git a/docs/components/content/examples/VerticalNavigationExampleAvatarSlot.vue b/docs/components/content/examples/VerticalNavigationExampleAvatarSlot.vue new file mode 100644 index 00000000..f16ec53c --- /dev/null +++ b/docs/components/content/examples/VerticalNavigationExampleAvatarSlot.vue @@ -0,0 +1,25 @@ + + + diff --git a/docs/components/content/examples/VerticalNavigationExampleBadgeSlot.vue b/docs/components/content/examples/VerticalNavigationExampleBadgeSlot.vue new file mode 100644 index 00000000..701a2330 --- /dev/null +++ b/docs/components/content/examples/VerticalNavigationExampleBadgeSlot.vue @@ -0,0 +1,35 @@ + + + diff --git a/docs/components/content/examples/VerticalNavigationExampleDefaultSlot.vue b/docs/components/content/examples/VerticalNavigationExampleDefaultSlot.vue new file mode 100644 index 00000000..e2dd5b99 --- /dev/null +++ b/docs/components/content/examples/VerticalNavigationExampleDefaultSlot.vue @@ -0,0 +1,31 @@ + + + diff --git a/docs/components/content/examples/VerticalNavigationExampleIconSlot.vue b/docs/components/content/examples/VerticalNavigationExampleIconSlot.vue new file mode 100644 index 00000000..05bda21a --- /dev/null +++ b/docs/components/content/examples/VerticalNavigationExampleIconSlot.vue @@ -0,0 +1,41 @@ + + + diff --git a/docs/content/5.navigation/1.vertical-navigation.md b/docs/content/5.navigation/1.vertical-navigation.md index 2483462e..4dd78ebd 100644 --- a/docs/content/5.navigation/1.vertical-navigation.md +++ b/docs/content/5.navigation/1.vertical-navigation.md @@ -10,12 +10,12 @@ links: Pass an array to the `links` prop of the VerticalNavigation component. Each link can have the following properties: -- `label` - The label of the item. -- `icon` - The icon of the item. -- `iconClass` - The class of the icon of the item. -- `avatar` - The avatar of the item. You can pass all the props of the [Avatar](/elements/avatar) component. +- `label` - The label of the link. +- `icon` - The icon of the link. +- `iconClass` - The class of the icon of the link. +- `avatar` - The avatar of the link. You can pass all the props of the [Avatar](/elements/avatar) component. - `badge` - A badge to display next to the label. -- `click` - The click handler of the item. +- `click` - The click handler of the link. You can also pass any property from the [NuxtLink](https://nuxt.com/docs/api/components/nuxt-link#props) component such as `to`, `exact`, etc. @@ -53,6 +53,198 @@ const links = [{ ``` :: +::callout{icon="i-heroicons-light-bulb"} +Learn how to build a Tailwind like vertical navigation in the [Examples](/getting-started/examples#verticalnavigation) page. +:: + +## Slots + +You can use slots to customize links display. + +### `default` + +Use the `#default` slot to customize the link label. You will have access to the `link` and `isActive` properties in the slot scope. + +::component-example +#default +:vertical-navigation-example-default-slot + +#code +```vue + + + +``` +:: + +### `avatar` + +Use the `#avatar` slot to customize the link avatar. You will have access to the `link` and `isActive` properties in the slot scope. + +::component-example +#default +:vertical-navigation-example-avatar-slot + +#code +```vue + + + +``` +:: + +### `icon` + +Use the `#icon` slot to customize the link icon. You will have access to the `link` and `isActive` properties in the slot scope. + +::component-example +#default +:vertical-navigation-example-icon-slot + +#code +```vue + + + +``` +:: + +### `badge` + +Use the `#badge` slot to customize the link badge. You will have access to the `link` and `isActive` properties in the slot scope. + +::component-example +#default +:vertical-navigation-example-badge-slot + +#code +```vue + + + +``` +:: + ## Props :component-props diff --git a/src/runtime/components/navigation/VerticalNavigation.vue b/src/runtime/components/navigation/VerticalNavigation.vue index 1726a2c0..c3f7d38d 100644 --- a/src/runtime/components/navigation/VerticalNavigation.vue +++ b/src/runtime/components/navigation/VerticalNavigation.vue @@ -11,7 +11,7 @@ @click="link.click" @keyup.enter="$event.target.blur()" > - + - + {{ link.label }}