diff --git a/docs/content/1.getting-started/6.shortcuts.md b/docs/content/2.composables/1.define-shortcuts.md similarity index 91% rename from docs/content/1.getting-started/6.shortcuts.md rename to docs/content/2.composables/1.define-shortcuts.md index 88ea16ec..d811f4d0 100644 --- a/docs/content/1.getting-started/6.shortcuts.md +++ b/docs/content/2.composables/1.define-shortcuts.md @@ -1,4 +1,5 @@ --- +title: defineShortcuts description: 'Learn how to display and define keyboard shortcuts in your app.' --- @@ -124,18 +125,3 @@ defineShortcuts({ '?': () => openHelpModal() }) ``` - -## `useShortcuts` - -To display shortcuts in your app according to the user's OS, you can use the `useShortcuts` composable. - -```vue - - - -``` -_`metaSymbol` will display either `⌘` on MacOS or `Ctrl` on any other OS_ diff --git a/docs/content/2.components/0.app.md b/docs/content/3.components/0.app.md similarity index 100% rename from docs/content/2.components/0.app.md rename to docs/content/3.components/0.app.md diff --git a/docs/content/2.components/accordion.md b/docs/content/3.components/accordion.md similarity index 100% rename from docs/content/2.components/accordion.md rename to docs/content/3.components/accordion.md diff --git a/docs/content/2.components/alert.md b/docs/content/3.components/alert.md similarity index 100% rename from docs/content/2.components/alert.md rename to docs/content/3.components/alert.md diff --git a/docs/content/2.components/avatar-group.md b/docs/content/3.components/avatar-group.md similarity index 100% rename from docs/content/2.components/avatar-group.md rename to docs/content/3.components/avatar-group.md diff --git a/docs/content/2.components/avatar.md b/docs/content/3.components/avatar.md similarity index 100% rename from docs/content/2.components/avatar.md rename to docs/content/3.components/avatar.md diff --git a/docs/content/2.components/badge.md b/docs/content/3.components/badge.md similarity index 81% rename from docs/content/2.components/badge.md rename to docs/content/3.components/badge.md index 9aad3b8d..fb5a0b37 100644 --- a/docs/content/2.components/badge.md +++ b/docs/content/3.components/badge.md @@ -53,6 +53,21 @@ slots: --- :: +## Examples + +### `class` prop + +Use the `class` prop to override the base styles of the Badge. + +::component-code +--- +props: + class: 'font-bold rounded-full' +slots: + default: Badge +--- +:: + ## API ### Props diff --git a/docs/content/2.components/breadcrumb.md b/docs/content/3.components/breadcrumb.md similarity index 100% rename from docs/content/2.components/breadcrumb.md rename to docs/content/3.components/breadcrumb.md diff --git a/docs/content/2.components/button-group.md b/docs/content/3.components/button-group.md similarity index 100% rename from docs/content/2.components/button-group.md rename to docs/content/3.components/button-group.md diff --git a/docs/content/2.components/button.md b/docs/content/3.components/button.md similarity index 85% rename from docs/content/2.components/button.md rename to docs/content/3.components/button.md index f1fbc33b..f25fb6ea 100644 --- a/docs/content/2.components/button.md +++ b/docs/content/3.components/button.md @@ -145,6 +145,40 @@ slots: Button :: +## Examples + +### `class` prop + +Use the `class` prop to override the base styles of the Button. + +::component-code +--- +props: + class: 'font-bold rounded-full' +slots: + default: Button +--- +:: + +### `ui` prop + +Use the `ui` prop to override the slots styles of the Button. + +::component-code +--- +ignore: + - ui +props: + icon: i-heroicons-rocket-launch + color: gray + variant: outline + ui: + leadingIcon: 'text-primary-500 dark:text-primary-400' +slots: + default: Button +--- +:: + ## API ### Props diff --git a/docs/content/2.components/card.md b/docs/content/3.components/card.md similarity index 100% rename from docs/content/2.components/card.md rename to docs/content/3.components/card.md diff --git a/docs/content/2.components/carousel.md b/docs/content/3.components/carousel.md similarity index 100% rename from docs/content/2.components/carousel.md rename to docs/content/3.components/carousel.md diff --git a/docs/content/2.components/checkbox.md b/docs/content/3.components/checkbox.md similarity index 100% rename from docs/content/2.components/checkbox.md rename to docs/content/3.components/checkbox.md diff --git a/docs/content/2.components/chip.md b/docs/content/3.components/chip.md similarity index 100% rename from docs/content/2.components/chip.md rename to docs/content/3.components/chip.md diff --git a/docs/content/2.components/collapsible.md b/docs/content/3.components/collapsible.md similarity index 100% rename from docs/content/2.components/collapsible.md rename to docs/content/3.components/collapsible.md diff --git a/docs/content/2.components/command-palette.md b/docs/content/3.components/command-palette.md similarity index 100% rename from docs/content/2.components/command-palette.md rename to docs/content/3.components/command-palette.md diff --git a/docs/content/2.components/container.md b/docs/content/3.components/container.md similarity index 100% rename from docs/content/2.components/container.md rename to docs/content/3.components/container.md diff --git a/docs/content/2.components/context-menu.md b/docs/content/3.components/context-menu.md similarity index 100% rename from docs/content/2.components/context-menu.md rename to docs/content/3.components/context-menu.md diff --git a/docs/content/2.components/drawer.md b/docs/content/3.components/drawer.md similarity index 100% rename from docs/content/2.components/drawer.md rename to docs/content/3.components/drawer.md diff --git a/docs/content/2.components/dropdown-menu.md b/docs/content/3.components/dropdown-menu.md similarity index 100% rename from docs/content/2.components/dropdown-menu.md rename to docs/content/3.components/dropdown-menu.md diff --git a/docs/content/2.components/form-field.md b/docs/content/3.components/form-field.md similarity index 100% rename from docs/content/2.components/form-field.md rename to docs/content/3.components/form-field.md diff --git a/docs/content/2.components/form.md b/docs/content/3.components/form.md similarity index 100% rename from docs/content/2.components/form.md rename to docs/content/3.components/form.md diff --git a/docs/content/2.components/icon.md b/docs/content/3.components/icon.md similarity index 100% rename from docs/content/2.components/icon.md rename to docs/content/3.components/icon.md diff --git a/docs/content/2.components/input-menu.md b/docs/content/3.components/input-menu.md similarity index 100% rename from docs/content/2.components/input-menu.md rename to docs/content/3.components/input-menu.md diff --git a/docs/content/2.components/input.md b/docs/content/3.components/input.md similarity index 100% rename from docs/content/2.components/input.md rename to docs/content/3.components/input.md diff --git a/docs/content/2.components/kbd.md b/docs/content/3.components/kbd.md similarity index 100% rename from docs/content/2.components/kbd.md rename to docs/content/3.components/kbd.md diff --git a/docs/content/2.components/link.md b/docs/content/3.components/link.md similarity index 100% rename from docs/content/2.components/link.md rename to docs/content/3.components/link.md diff --git a/docs/content/2.components/meter.md b/docs/content/3.components/meter.md similarity index 100% rename from docs/content/2.components/meter.md rename to docs/content/3.components/meter.md diff --git a/docs/content/2.components/modal.md b/docs/content/3.components/modal.md similarity index 100% rename from docs/content/2.components/modal.md rename to docs/content/3.components/modal.md diff --git a/docs/content/2.components/navigation-menu.md b/docs/content/3.components/navigation-menu.md similarity index 100% rename from docs/content/2.components/navigation-menu.md rename to docs/content/3.components/navigation-menu.md diff --git a/docs/content/2.components/pagination.md b/docs/content/3.components/pagination.md similarity index 100% rename from docs/content/2.components/pagination.md rename to docs/content/3.components/pagination.md diff --git a/docs/content/2.components/popover.md b/docs/content/3.components/popover.md similarity index 100% rename from docs/content/2.components/popover.md rename to docs/content/3.components/popover.md diff --git a/docs/content/2.components/progress.md b/docs/content/3.components/progress.md similarity index 100% rename from docs/content/2.components/progress.md rename to docs/content/3.components/progress.md diff --git a/docs/content/2.components/radio-group.md b/docs/content/3.components/radio-group.md similarity index 100% rename from docs/content/2.components/radio-group.md rename to docs/content/3.components/radio-group.md diff --git a/docs/content/2.components/select-menu.md b/docs/content/3.components/select-menu.md similarity index 100% rename from docs/content/2.components/select-menu.md rename to docs/content/3.components/select-menu.md diff --git a/docs/content/2.components/select.md b/docs/content/3.components/select.md similarity index 100% rename from docs/content/2.components/select.md rename to docs/content/3.components/select.md diff --git a/docs/content/2.components/separator.md b/docs/content/3.components/separator.md similarity index 100% rename from docs/content/2.components/separator.md rename to docs/content/3.components/separator.md diff --git a/docs/content/2.components/skeleton.md b/docs/content/3.components/skeleton.md similarity index 100% rename from docs/content/2.components/skeleton.md rename to docs/content/3.components/skeleton.md diff --git a/docs/content/2.components/slideover.md b/docs/content/3.components/slideover.md similarity index 100% rename from docs/content/2.components/slideover.md rename to docs/content/3.components/slideover.md diff --git a/docs/content/2.components/slider.md b/docs/content/3.components/slider.md similarity index 100% rename from docs/content/2.components/slider.md rename to docs/content/3.components/slider.md diff --git a/docs/content/2.components/switch.md b/docs/content/3.components/switch.md similarity index 100% rename from docs/content/2.components/switch.md rename to docs/content/3.components/switch.md diff --git a/docs/content/2.components/table.md b/docs/content/3.components/table.md similarity index 100% rename from docs/content/2.components/table.md rename to docs/content/3.components/table.md diff --git a/docs/content/2.components/tabs.md b/docs/content/3.components/tabs.md similarity index 100% rename from docs/content/2.components/tabs.md rename to docs/content/3.components/tabs.md diff --git a/docs/content/2.components/textarea.md b/docs/content/3.components/textarea.md similarity index 100% rename from docs/content/2.components/textarea.md rename to docs/content/3.components/textarea.md diff --git a/docs/content/2.components/toast.md b/docs/content/3.components/toast.md similarity index 100% rename from docs/content/2.components/toast.md rename to docs/content/3.components/toast.md diff --git a/docs/content/2.components/tooltip.md b/docs/content/3.components/tooltip.md similarity index 100% rename from docs/content/2.components/tooltip.md rename to docs/content/3.components/tooltip.md