docs(components): update descriptions

This commit is contained in:
Benjamin Canac
2024-07-26 11:58:43 +02:00
parent ce28607d7d
commit 839b97a9dc
35 changed files with 35 additions and 35 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -1,5 +1,5 @@
---
description: Display an input field.
description: An input element to enter text.
links:
- label: GitHub
icon: i-simple-icons-github

View File

@@ -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

View File

@@ -1,5 +1,5 @@
---
description: Render a NuxtLink but with superpowers.
description: A wrapper around <NuxtLink> with extra props.
links:
- label: GitHub
icon: i-simple-icons-github

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -1,5 +1,5 @@
---
description: Display a separator between content.
description: Separates content horizontally or vertically.
links:
- label: Separator
icon: i-custom-radix-vue

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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