mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-23 04:35:46 +00:00
38de7fddc2
* feat: rtl * feat * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * feat: add sidebar * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * chore: changeset * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix
97 lines
1.9 KiB
Plaintext
97 lines
1.9 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]"
|
|
/>
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="base-nova" name="label-rtl" direction="rtl" />
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI Label](https://base-ui.com/react/components/label#api-reference) documentation for more information.
|