From 839b97a9dc038e7f05874a064e91fe38ef02e60f Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Fri, 26 Jul 2024 11:58:43 +0200 Subject: [PATCH] docs(components): update descriptions --- docs/content/3.components/alert.md | 2 +- docs/content/3.components/avatar.md | 2 +- docs/content/3.components/badge.md | 2 +- docs/content/3.components/breadcrumb.md | 2 +- docs/content/3.components/button.md | 2 +- docs/content/3.components/carousel.md | 2 +- docs/content/3.components/checkbox.md | 2 +- docs/content/3.components/chip.md | 2 +- docs/content/3.components/collapsible.md | 2 +- docs/content/3.components/command-palette.md | 2 +- docs/content/3.components/context-menu.md | 2 +- docs/content/3.components/drawer.md | 2 +- docs/content/3.components/dropdown-menu.md | 2 +- docs/content/3.components/form-field.md | 2 +- docs/content/3.components/form.md | 2 +- docs/content/3.components/input-menu.md | 2 +- docs/content/3.components/input.md | 2 +- docs/content/3.components/kbd.md | 2 +- docs/content/3.components/link.md | 2 +- docs/content/3.components/meter.md | 2 +- docs/content/3.components/modal.md | 2 +- docs/content/3.components/navigation-menu.md | 2 +- docs/content/3.components/pagination.md | 2 +- docs/content/3.components/popover.md | 2 +- docs/content/3.components/progress.md | 2 +- docs/content/3.components/radio-group.md | 2 +- docs/content/3.components/select-menu.md | 2 +- docs/content/3.components/select.md | 2 +- docs/content/3.components/separator.md | 2 +- docs/content/3.components/skeleton.md | 2 +- docs/content/3.components/slideover.md | 2 +- docs/content/3.components/table.md | 2 +- docs/content/3.components/textarea.md | 2 +- docs/content/3.components/toast.md | 2 +- docs/content/3.components/tooltip.md | 2 +- 35 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/content/3.components/alert.md b/docs/content/3.components/alert.md index 78673595..64d0b0c5 100644 --- a/docs/content/3.components/alert.md +++ b/docs/content/3.components/alert.md @@ -1,5 +1,5 @@ --- -description: Display a callout to draw user attention. +description: A callout to draw user's attention. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/avatar.md b/docs/content/3.components/avatar.md index c9a6050d..1465f66b 100644 --- a/docs/content/3.components/avatar.md +++ b/docs/content/3.components/avatar.md @@ -1,5 +1,5 @@ --- -description: Display an image element with fallback. +description: An image element with fallback. links: - label: Avatar icon: i-custom-radix-vue diff --git a/docs/content/3.components/badge.md b/docs/content/3.components/badge.md index 54865f45..49a3cbfc 100644 --- a/docs/content/3.components/badge.md +++ b/docs/content/3.components/badge.md @@ -1,5 +1,5 @@ --- -description: Display a short text to represent a status or a category. +description: A short text to represent a status or a category. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/breadcrumb.md b/docs/content/3.components/breadcrumb.md index adad5999..11973ac2 100644 --- a/docs/content/3.components/breadcrumb.md +++ b/docs/content/3.components/breadcrumb.md @@ -1,5 +1,5 @@ --- -description: A list of links that indicate the current page's location within a navigational hierarchy. +description: A hierarchy of links to navigate through a website. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/button.md b/docs/content/3.components/button.md index 2f36968f..42f4351c 100644 --- a/docs/content/3.components/button.md +++ b/docs/content/3.components/button.md @@ -1,5 +1,5 @@ --- -description: Create a button with icon or link capabilities. +description: A button element that can act as a link or trigger an action. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/carousel.md b/docs/content/3.components/carousel.md index d8143dc8..d8a416fa 100644 --- a/docs/content/3.components/carousel.md +++ b/docs/content/3.components/carousel.md @@ -1,5 +1,5 @@ --- -description: Display images or content in a scrollable area. +description: A carousel with motion and swipe support. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/checkbox.md b/docs/content/3.components/checkbox.md index 66d2d1d4..43229d13 100644 --- a/docs/content/3.components/checkbox.md +++ b/docs/content/3.components/checkbox.md @@ -1,5 +1,5 @@ --- -description: Display a checkbox field. +description: An input element to toggle between checked and unchecked states. links: - label: Checkbox icon: i-custom-radix-vue diff --git a/docs/content/3.components/chip.md b/docs/content/3.components/chip.md index 15a1713e..08189282 100644 --- a/docs/content/3.components/chip.md +++ b/docs/content/3.components/chip.md @@ -1,5 +1,5 @@ --- -description: Display a chip indicator on any component. +description: An indicator of a numeric value or a state. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/collapsible.md b/docs/content/3.components/collapsible.md index 48ea8ad9..5388ebe0 100644 --- a/docs/content/3.components/collapsible.md +++ b/docs/content/3.components/collapsible.md @@ -1,5 +1,5 @@ --- -description: A container lets you center and constrain the width of your content. +description: A collapsible element to toggle visibility of its content. links: - label: Collapsible icon: i-custom-radix-vue diff --git a/docs/content/3.components/command-palette.md b/docs/content/3.components/command-palette.md index f69b7e68..8f6f0f5a 100644 --- a/docs/content/3.components/command-palette.md +++ b/docs/content/3.components/command-palette.md @@ -1,6 +1,6 @@ --- title: CommandPalette -description: Add a customizable command palette to your app. +description: A command palette to search and execute commands with full-text search. links: - label: Combobox icon: i-custom-radix-vue diff --git a/docs/content/3.components/context-menu.md b/docs/content/3.components/context-menu.md index 64d1feb6..86fb7d19 100644 --- a/docs/content/3.components/context-menu.md +++ b/docs/content/3.components/context-menu.md @@ -1,6 +1,6 @@ --- title: ContextMenu -description: Display a menu that appears on right click. +description: A menu to display actions when right-clicking on an element. links: - label: ContextMenu icon: i-custom-radix-vue diff --git a/docs/content/3.components/drawer.md b/docs/content/3.components/drawer.md index 61f13fa1..ef8866bd 100644 --- a/docs/content/3.components/drawer.md +++ b/docs/content/3.components/drawer.md @@ -1,5 +1,5 @@ --- -description: Display a drawer element to show additional content. +description: A drawer that slides in from the bottom of the screen. links: - label: Drawer icon: i-custom-radix-vue diff --git a/docs/content/3.components/dropdown-menu.md b/docs/content/3.components/dropdown-menu.md index ff3d09ab..85db2e94 100644 --- a/docs/content/3.components/dropdown-menu.md +++ b/docs/content/3.components/dropdown-menu.md @@ -1,6 +1,6 @@ --- title: DropdownMenu -description: Display a list of actions in a dropdown menu. +description: A menu to display actions when clicking on an element. links: - label: DropdownMenu icon: i-custom-radix-vue diff --git a/docs/content/3.components/form-field.md b/docs/content/3.components/form-field.md index 854a4e28..2f925bdc 100644 --- a/docs/content/3.components/form-field.md +++ b/docs/content/3.components/form-field.md @@ -1,6 +1,6 @@ --- title: FormField -description: Display a label and additional informations around a form element. +description: A wrapper for form elements that provides validation and error handling. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/form.md b/docs/content/3.components/form.md index f7144c45..ae19171a 100644 --- a/docs/content/3.components/form.md +++ b/docs/content/3.components/form.md @@ -1,5 +1,5 @@ --- -description: Collect and validate form data. +description: A form element that provides validation and submission handling. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/input-menu.md b/docs/content/3.components/input-menu.md index 5e4fe106..7386e0bf 100644 --- a/docs/content/3.components/input-menu.md +++ b/docs/content/3.components/input-menu.md @@ -1,6 +1,6 @@ --- title: InputMenu -description: Display an autocomplete input with real-time suggestions. +description: An autocomplete input with real-time suggestions. links: - label: Combobox icon: i-custom-radix-vue diff --git a/docs/content/3.components/input.md b/docs/content/3.components/input.md index 8eae2647..1c8e9727 100644 --- a/docs/content/3.components/input.md +++ b/docs/content/3.components/input.md @@ -1,5 +1,5 @@ --- -description: Display an input field. +description: An input element to enter text. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/kbd.md b/docs/content/3.components/kbd.md index fbf7d15c..a0c94c8a 100644 --- a/docs/content/3.components/kbd.md +++ b/docs/content/3.components/kbd.md @@ -1,6 +1,6 @@ --- title: Keyboard Key -description: Display a keyboard key in a text block. +description: A kbd element to display a keyboard key. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/link.md b/docs/content/3.components/link.md index 5f904acd..336e70fb 100644 --- a/docs/content/3.components/link.md +++ b/docs/content/3.components/link.md @@ -1,5 +1,5 @@ --- -description: Render a NuxtLink but with superpowers. +description: A wrapper around with extra props. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/meter.md b/docs/content/3.components/meter.md index f4ecbf8b..9a1ddcce 100644 --- a/docs/content/3.components/meter.md +++ b/docs/content/3.components/meter.md @@ -1,5 +1,5 @@ --- -description: Display a gauge meter that fills or depletes. +description: A gauge meter that fills or depletes. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/modal.md b/docs/content/3.components/modal.md index fc6d29c7..83421dad 100644 --- a/docs/content/3.components/modal.md +++ b/docs/content/3.components/modal.md @@ -1,5 +1,5 @@ --- -description: Display a modal within your application. +description: A dialog window that can be used to display a message or request user input. links: - label: Dialog icon: i-custom-radix-vue diff --git a/docs/content/3.components/navigation-menu.md b/docs/content/3.components/navigation-menu.md index c24ea8a3..c7d9a5f6 100644 --- a/docs/content/3.components/navigation-menu.md +++ b/docs/content/3.components/navigation-menu.md @@ -1,6 +1,6 @@ --- title: NavigationMenu -description: Display a list of horizontal links. +description: A list of links that can be displayed horizontally or vertically. links: - label: NavigationMenu icon: i-custom-radix-vue diff --git a/docs/content/3.components/pagination.md b/docs/content/3.components/pagination.md index 5f84a817..be4aa074 100644 --- a/docs/content/3.components/pagination.md +++ b/docs/content/3.components/pagination.md @@ -1,5 +1,5 @@ --- -description: Add a pagination to handle pages. +description: A list of buttons or links to navigate through pages. links: - label: Pagination icon: i-custom-radix-vue diff --git a/docs/content/3.components/popover.md b/docs/content/3.components/popover.md index e4af3e84..52ed18ca 100644 --- a/docs/content/3.components/popover.md +++ b/docs/content/3.components/popover.md @@ -1,5 +1,5 @@ --- -description: Display a non-modal dialog that floats around a trigger element. +description: A non-modal dialog that floats around a trigger element. links: - label: Popover icon: i-custom-radix-vue diff --git a/docs/content/3.components/progress.md b/docs/content/3.components/progress.md index a7a1405e..8508382f 100644 --- a/docs/content/3.components/progress.md +++ b/docs/content/3.components/progress.md @@ -1,5 +1,5 @@ --- -description: Show a horizontal bar to indicate task progression. +description: An indicator showing the progress of a task. links: - label: Progress icon: i-custom-radix-vue diff --git a/docs/content/3.components/radio-group.md b/docs/content/3.components/radio-group.md index 0eb311d1..2e94d88a 100644 --- a/docs/content/3.components/radio-group.md +++ b/docs/content/3.components/radio-group.md @@ -1,6 +1,6 @@ --- title: RadioGroup -description: Display a set of radio buttons. +description: A set of radio buttons to select a single option from a list. links: - label: RadioGroup icon: i-custom-radix-vue diff --git a/docs/content/3.components/select-menu.md b/docs/content/3.components/select-menu.md index afce02c6..7a9dbdf7 100644 --- a/docs/content/3.components/select-menu.md +++ b/docs/content/3.components/select-menu.md @@ -1,6 +1,6 @@ --- title: SelectMenu -description: Display a select menu with advanced features. +description: An advanced searchable select element. links: - label: Combobox icon: i-custom-radix-vue diff --git a/docs/content/3.components/select.md b/docs/content/3.components/select.md index 013d84ca..351736a6 100644 --- a/docs/content/3.components/select.md +++ b/docs/content/3.components/select.md @@ -1,5 +1,5 @@ --- -description: Display a select field. +description: A select element to choose from a list of options. links: - label: Select icon: i-custom-radix-vue diff --git a/docs/content/3.components/separator.md b/docs/content/3.components/separator.md index 748bcfe1..b47286ea 100644 --- a/docs/content/3.components/separator.md +++ b/docs/content/3.components/separator.md @@ -1,5 +1,5 @@ --- -description: Display a separator between content. +description: Separates content horizontally or vertically. links: - label: Separator icon: i-custom-radix-vue diff --git a/docs/content/3.components/skeleton.md b/docs/content/3.components/skeleton.md index 6f049209..bf5802a4 100644 --- a/docs/content/3.components/skeleton.md +++ b/docs/content/3.components/skeleton.md @@ -1,5 +1,5 @@ --- -description: Display a placeholder while content is loading. +description: A placeholder to show while content is loading. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/slideover.md b/docs/content/3.components/slideover.md index e91cc44e..5b6c9b9a 100644 --- a/docs/content/3.components/slideover.md +++ b/docs/content/3.components/slideover.md @@ -1,5 +1,5 @@ --- -description: Display a dialog that slides in from the edge of the screen. +description: A dialog that slides in from any side of the screen. links: - label: Dialog icon: i-custom-radix-vue diff --git a/docs/content/3.components/table.md b/docs/content/3.components/table.md index 388217b5..f77a3765 100644 --- a/docs/content/3.components/table.md +++ b/docs/content/3.components/table.md @@ -1,5 +1,5 @@ --- -description: Display data in a table. +description: A responsive table element to display data in rows and columns. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/textarea.md b/docs/content/3.components/textarea.md index 83b102c5..42807cc6 100644 --- a/docs/content/3.components/textarea.md +++ b/docs/content/3.components/textarea.md @@ -1,5 +1,5 @@ --- -description: Display a textarea field. +description: A textarea element to input multi-line text. links: - label: GitHub icon: i-simple-icons-github diff --git a/docs/content/3.components/toast.md b/docs/content/3.components/toast.md index 180e7c74..1b222567 100644 --- a/docs/content/3.components/toast.md +++ b/docs/content/3.components/toast.md @@ -1,5 +1,5 @@ --- -description: Display a toast notification in your app. +description: A succinct message to provide information or feedback to the user. links: - label: Toast icon: i-custom-radix-vue diff --git a/docs/content/3.components/tooltip.md b/docs/content/3.components/tooltip.md index 8bbf85fe..f9c21bfa 100644 --- a/docs/content/3.components/tooltip.md +++ b/docs/content/3.components/tooltip.md @@ -1,5 +1,5 @@ --- -description: Display content that appears on hover next to an element. +description: A popup that reveals information when hovering over an element. links: - label: Tooltip icon: i-custom-radix-vue