From 368054456b9e73240f3cc8fcba03e6c3c8a9f708 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Thu, 18 Jul 2024 17:48:03 +0200 Subject: [PATCH] docs(breadcrumb): update --- .../examples/breadcrumb/BreadcrumbExample.vue | 18 --------- .../breadcrumb/BreadcrumbSeparatorExample.vue | 6 ++- .../BreadcrumbSeparatorSlotExample.vue | 20 ---------- docs/content/3.components/breadcrumb.md | 37 +++++++++++++++++-- docs/nuxt.config.ts | 1 + 5 files changed, 40 insertions(+), 42 deletions(-) delete mode 100644 docs/app/components/content/examples/breadcrumb/BreadcrumbExample.vue delete mode 100644 docs/app/components/content/examples/breadcrumb/BreadcrumbSeparatorSlotExample.vue diff --git a/docs/app/components/content/examples/breadcrumb/BreadcrumbExample.vue b/docs/app/components/content/examples/breadcrumb/BreadcrumbExample.vue deleted file mode 100644 index 97a57269..00000000 --- a/docs/app/components/content/examples/breadcrumb/BreadcrumbExample.vue +++ /dev/null @@ -1,18 +0,0 @@ - - - diff --git a/docs/app/components/content/examples/breadcrumb/BreadcrumbSeparatorExample.vue b/docs/app/components/content/examples/breadcrumb/BreadcrumbSeparatorExample.vue index 4a87867b..2d31ccc8 100644 --- a/docs/app/components/content/examples/breadcrumb/BreadcrumbSeparatorExample.vue +++ b/docs/app/components/content/examples/breadcrumb/BreadcrumbSeparatorExample.vue @@ -12,5 +12,9 @@ const items = [{ diff --git a/docs/app/components/content/examples/breadcrumb/BreadcrumbSeparatorSlotExample.vue b/docs/app/components/content/examples/breadcrumb/BreadcrumbSeparatorSlotExample.vue deleted file mode 100644 index 2d31ccc8..00000000 --- a/docs/app/components/content/examples/breadcrumb/BreadcrumbSeparatorSlotExample.vue +++ /dev/null @@ -1,20 +0,0 @@ - - - diff --git a/docs/content/3.components/breadcrumb.md b/docs/content/3.components/breadcrumb.md index abf35a95..0a8a54a6 100644 --- a/docs/content/3.components/breadcrumb.md +++ b/docs/content/3.components/breadcrumb.md @@ -17,7 +17,22 @@ Use the `items` prop as an array of objects with the following properties: You can also pass any property from [NuxtLink](https://nuxt.com/docs/api/components/nuxt-link#props) component such as `to`, `target`, etc. -:component-example{name="breadcrumb-example"} +::component-code +--- +external: + - items +props: + items: + - label: 'Home' + icon: 'i-heroicons-home' + - label: 'Components' + icon: 'i-heroicons-cube-transparent' + to: '/components' + - label: 'Breadcrumb' + icon: 'i-heroicons-link' + to: '/components/breadcrumb' +--- +:: ::tip A `span` will be rendered instead of a link when the `to` property is not defined. @@ -27,7 +42,23 @@ A `span` will be rendered instead of a link when the `to` property is not define Use the `separator-icon` prop to customize the [Icon](/components/icon) between each item. Defaults to `i-heroicons-chevron-right-20-solid`. -:component-example{name="breadcrumb-separator-example"} +::component-code +--- +external: + - items +props: + separatorIcon: 'i-heroicons-arrow-right-20-solid' + items: + - label: 'Home' + icon: 'i-heroicons-home' + - label: 'Components' + icon: 'i-heroicons-cube-transparent' + to: '/components' + - label: 'Breadcrumb' + icon: 'i-heroicons-link' + to: '/components/breadcrumb' +--- +:: ::tip You can customize this icon globally in your `app.config.ts` under `ui.icons.chevronRight` key. @@ -45,7 +76,7 @@ Use the `slot` property to customize a specific item with a dropdown menu for ex Use the `#separator` slot to customize the separator between each item. -:component-example{name="breadcrumb-separator-slot-example"} +:component-example{name="breadcrumb-separator-example"} ## API diff --git a/docs/nuxt.config.ts b/docs/nuxt.config.ts index 8ddf3f6f..9c3331bd 100644 --- a/docs/nuxt.config.ts +++ b/docs/nuxt.config.ts @@ -121,6 +121,7 @@ export default defineNuxtConfig({ 'UAvatar', 'UAvatarGroup', 'UBadge', + 'UBreadcrumb', 'UButton', 'UButtonGroup', 'UIcon',