mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-29 15:44:22 +00:00
47c47eaed2
* feat: add base and radix docs * feat: transform code for display * fix * fix * fix * fix * fix * chore: remove claude files * fix * fix * fix * chore: run format:write * fix * feat: add more examples * fix * feat: add aspect-ratio * feat: add avatar * feat: add badge * feat: add breadcrumb * fix * feat: add button * fix * fix * fix * feat: add calendar and card * feat: add carousel * fix: chart * feat: add checkbox * feat: add collapsible * feat: add combobox * feat: add command * feat: add context menu * feat: add data-table dialog and drawer * feat: dropdown-menu * feat: add date-picker * feat: add empty * feat: add field and hover-card * fix: input * feat: add input * feat: add input-group * feat: add input-otp * feat: add item * feat: add kbd and label * feat: add menubar * feat: add native-select * feat: add more components * feat: more components * feat: more components * feat: add skeleton, slider and sonner * feat: add spinner and switch * feat: add more components * fix: tabs * fix: tabs * feat: add docs for sidebar * fix * fix * fi * docs: update * fix: create page * fix * fix * chore: add changelog * fix
91 lines
1.7 KiB
Plaintext
91 lines
1.7 KiB
Plaintext
---
|
|
title: Label
|
|
description: Renders an accessible label associated with controls.
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/label
|
|
api: https://base-ui.com/react/components/label#api-reference
|
|
---
|
|
|
|
<ComponentPreview styleName="base-nova" name="label-demo" />
|
|
|
|
<Callout>
|
|
For form fields, use the [Field](/docs/components/base/field) component which
|
|
includes built-in label, description, and error handling.
|
|
</Callout>
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add label
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install @base-ui/react
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="label"
|
|
title="components/ui/label.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Label } from "@/components/ui/label"
|
|
```
|
|
|
|
```tsx
|
|
<Label htmlFor="email">Your email address</Label>
|
|
```
|
|
|
|
## Label in Field
|
|
|
|
For form fields, use the [Field](/docs/components/base/field) component which
|
|
includes built-in `FieldLabel`, `FieldDescription`, and `FieldError` components.
|
|
|
|
```tsx
|
|
<Field>
|
|
<FieldLabel htmlFor="email">Your email address</FieldLabel>
|
|
<Input id="email" />
|
|
</Field>
|
|
```
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="field-demo"
|
|
previewClassName="h-[44rem]"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI Label](https://base-ui.com/react/components/label#api-reference) documentation for more information.
|