105 lines
1.9 KiB
Plaintext
105 lines
1.9 KiB
Plaintext
---
|
|
title: Textarea
|
|
description: Displays a form textarea or a component that looks like a textarea.
|
|
base: base
|
|
component: true
|
|
---
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="textarea-demo"
|
|
previewClassName="*:max-w-xs"
|
|
/>
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add textarea
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="textarea"
|
|
title="components/ui/textarea.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { Textarea } from "@/components/ui/textarea"
|
|
```
|
|
|
|
```tsx
|
|
<Textarea />
|
|
```
|
|
|
|
## Field
|
|
|
|
Use `Field`, `FieldLabel`, and `FieldDescription` to create a textarea with a label and description.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="textarea-field"
|
|
previewClassName="*:max-w-xs"
|
|
/>
|
|
|
|
## Disabled
|
|
|
|
Use the `disabled` prop to disable the textarea. To style the disabled state, add the `data-disabled` attribute to the `Field` component.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="textarea-disabled"
|
|
previewClassName="*:max-w-xs"
|
|
/>
|
|
|
|
## Invalid
|
|
|
|
Use the `aria-invalid` prop to mark the textarea as invalid. To style the invalid state, add the `data-invalid` attribute to the `Field` component.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="textarea-invalid"
|
|
previewClassName="*:max-w-xs"
|
|
/>
|
|
|
|
## Button
|
|
|
|
Pair with `Button` to create a textarea with a submit button.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="textarea-button"
|
|
previewClassName="*:max-w-xs"
|
|
/>
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="base-nova" name="textarea-rtl" direction="rtl" />
|