Skip to content

Commit

Permalink
descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
huntabyte committed Dec 2, 2023
1 parent 63ce0f8 commit 2a431e5
Show file tree
Hide file tree
Showing 30 changed files with 32 additions and 31 deletions.
2 changes: 1 addition & 1 deletion content/components/accordion.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Accordion
description: Organizes content into collapsible sections.
description: Organizes content into collapsible sections, allowing users to focus on one section at a time.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/alert-dialog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Alert Dialog
description: Presents critical information or prompts to the user, typically requiring their attention or action.
description: A modal window that alerts users with important information and awaits their acknowledgment or action.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/aspect-ratio.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Aspect Ratio
description: Displays content with a specified aspect ratio, ensuring consistent and visually balanced presentation.
description: Displays content while maintaining a specified aspect ratio, ensuring consistent visual proportions.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/avatar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Avatar
description: Displays images with a fallback option for failed loading, ensuring consistent visual representation.
description: Represents a user or entity with a recognizable image or placeholder in UI elements.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/calendar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Calendar
description: A calendar component.
description: Displays dates and days of the week, facilitating date-related interactions.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/checkbox.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Checkbox
description: Allow users to mark options as checked, unchecked, or indeterminate, accommodating versatile states.
description: Allow users to switch between checked, unchecked, and indeterminate states.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/collapsible.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Collapsible
description: An interactive component which expands and collapses content.
description: Conceals or reveals content sections, enhancing space utilization and organization.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/context-menu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Context Menu
description: Displays a menu at the pointer's position when the trigger is right-clicked or long-pressed.
description: Displays options or actions relevant to a specific context or selected item, triggered by a right-click.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/date-field.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Date Field
description: A date field component.
description: Enables users to input specific dates within a designated field.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/date-picker.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Date Picker
description: A date picker component.
description: Facilitates the selection of dates through an input and calendar-based interface.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/date-range-field.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Date Range Field
description: A date range field component.
description: Allows users to input a range of dates within a designated field.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/date-range-picker.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Date Range Picker
description: A date range picker component.
description: Facilitates the selection of date ranges through an input and calendar-based interface.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/dialog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Dialog
description: A window overlaid on either the primary window or another dialog window, rendering the content underneath inert.
description: A modal window presenting content or seeking user input without navigating away from the current context.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/dropdown-menu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Dropdown Menu
description: Displays a menu to the user, which can consist of links or functions, triggered by a button.
description: Displays a menu of items that users can select from when triggered.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/label.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Label
description: An enhanced version of the native HTML label element.
description: Identifies or describes associated UI elements.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/link-preview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Link Preview
description: Enable sighted users to preview content behind a link.
description: Displays a summarized preview of a linked content's details or information.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/menubar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Menubar
description: Displays a list of menus that can be used to control the application.
description: Organizes and presents a collection of menu options or actions within a horizontal bar.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/popover.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Popover
description: Displays content in a floating container that appears above the surrounding content.
description: Display supplementary content or information when users interact with specific elements.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/progress.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Progress
description: A visual indicator that displays the progress of a task, usually in the form of a progress bar.
description: Visualizes the progress or completion status of a task or process.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/radio-group.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Radio Group
description: Allows users to select a single option from a predetermined set of choices.
description: Allows users to select a single option from a list of mutually exclusive choices.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/range-calendar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Range Calendar
description: A calendar component with range selection.
description: Presents a calendar view tailored for selecting date ranges.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/select.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Select
description: Enable users to choose a single option from a dropdown menu that presents a list of selectable items.
description: Enables users to choose from a list of options presented in a dropdown.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/separator.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Separator
description: Visually divide or separate sections or elements, providing clarity and organization.
description: Visually separates content or UI elements for clarity and organization.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/slider.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Slider
description: Enable users to select a value within a specific range with sliding handles.
description: Allows users to select a value from a continuous range by sliding a handle.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/switch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Switch
description: Enables users to toggle between two states.
description: A toggle control enabling users to switch between "on" and "off" states.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/tabs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Tabs
description: Allows users to navigate between different views
description: Organizes content into distinct sections, allowing users to switch between them.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/toggle-group.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Toggle Group
description: An interactive component that toggles between two states.
description: A control element that switches between two states, providing a binary choice.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/toggle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Toggle
description: An interactive component that toggles between two states.
description: Groups multiple toggle controls, allowing users to enable one or multiple options.
---

<script>
Expand Down
2 changes: 1 addition & 1 deletion content/components/tooltip.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Tooltip
description: Displays floating content containing additional information about an action on hover or focus.
description: Provides additional information or context when users hover over or interact with an element.
---

<script>
Expand Down
5 changes: 3 additions & 2 deletions content/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ Under the hood, most of these components are powered by [Melt UI](https://melt-u

## Credits

- [Bitworks](https://bitworks.cz) - The design team behind the Bits UI documentation and example components.
- [Melt UI](https://melt-ui.com) - The underlying builder API that powers Bits.
- [Radix UI](https://radix-ui.com) - The de-facto standard for headless APIs that we've strived to follow.
- [React Spectrum](https://react-spectrum.adobe.com) - Another incredible collection of headless components we've taken inspiration from.
- [Radix UI](https://radix-ui.com) - The incredible headless component APIs that we've taken heavy inspiration from.
- [React Spectrum](https://react-spectrum.adobe.com) - An incredible collection of headless components we've taken inspiration from.

🚧 **UNDER CONSTRUCTION** 🚧

0 comments on commit 2a431e5

Please sign in to comment.