Description

A description component for form fields and UI elements with proper accessibility support

Installation

Terminal
pnpm add @choice-ui/description

Import

Component.tsx
import { Description, type DescriptionProps } from "@choice-ui/description"

Basic

Basic description usage.
Use the `Description` component to provide supplementary text for form fields.

We'll never share your email with anyone else.

Disabled

Disabled description.
Use the `disabled` prop to match the disabled state of form fields.

This field is currently disabled.

Multiple Descriptions

Multiple descriptions.
You can use multiple descriptions to provide different types of information.

Choose a strong password.

Must be at least 8 characters with one uppercase letter.

API reference

DescriptionPropsTypeDefault
disabled
boolean
|
undefined
-