Textarea With Description

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

import type { ReactNode, TextareaHTMLAttributes } from "react";
import { useId } from "react";

function cx(...parts: Array<string | false | null | undefined>): string {
  return parts.filter(Boolean).join(" ");
}

const TEXTAREA_BASE =
  "w-full min-h-[80px] resize-y rounded-[var(--ds-radius-sm)] border bg-[var(--ds-color-input)] px-3 py-2 text-sm leading-5 text-[var(--ds-color-foreground)] shadow-none transition-colors duration-150 ease-out placeholder:text-[var(--ds-color-muted-foreground)] hover:bg-[var(--ds-color-input-hover,var(--ds-color-input))] focus:bg-[var(--ds-color-input-focus,var(--ds-color-input))] focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[var(--ds-color-focus-ring)] disabled:pointer-events-none disabled:bg-[var(--ds-color-muted)] disabled:text-[var(--ds-color-muted-foreground)] disabled:opacity-60 read-only:bg-[var(--ds-color-surface-subtle)] read-only:text-[var(--ds-color-muted-foreground)] motion-reduce:transition-none";

const TEXTAREA_BORDER =
  "border-[var(--ds-color-border)] focus:border-[var(--ds-color-border-strong)]";

export interface TextareaWithDescriptionProps extends TextareaHTMLAttributes<HTMLTextAreaElement> {
  /** Visible label — required. */
  label: ReactNode;
  /** Supporting description between the label and the control — required. */
  description: ReactNode;
}

/**
 * Textarea with a label and a supporting description stacked above the
 * control. The description is linked to the textarea with
 * `aria-describedby`, so assistive tech reads it as part of the field's
 * description. Use this when the field needs a sentence of context before
 * the user starts typing (what to include, format expectations, audience).
 */
export function TextareaWithDescription({ label, description, id, className, rows = 3, required, ...props }: TextareaWithDescriptionProps) {
  const generatedId = useId();
  const textareaId = id ?? `textarea-${generatedId}`;
  const descriptionId = `${textareaId}-description`;

  return (
    <div className="w-full">
      <label
        htmlFor={textareaId}
        className="block text-[13px] font-medium leading-5 text-[var(--ds-color-foreground)]"
      >
        {label}
        {required ? (
          <span aria-hidden="true" className="ml-0.5 text-[var(--ds-color-destructive)]">*</span>
        ) : null}
      </label>
      <p id={descriptionId} className="mb-2 mt-1 text-xs leading-4 text-[var(--ds-color-muted-foreground)]">
        {description}
      </p>
      <textarea
        id={textareaId}
        rows={rows}
        required={required}
        aria-describedby={descriptionId}
        className={cx(TEXTAREA_BASE, TEXTAREA_BORDER, className)}
        {...props}
      />
    </div>
  );
}

export default TextareaWithDescription;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

/* DevSnips React — JavaScript parity build.
 * Same API, behavior, and classes as code.tsx; TypeScript types removed.
 * Regenerated from code.tsx — edit code.tsx and re-run the generator.
 */

import { useId } from "react";
function cx(...parts) {
  return parts.filter(Boolean).join(" ");
}
const TEXTAREA_BASE = "w-full min-h-[80px] resize-y rounded-[var(--ds-radius-sm)] border bg-[var(--ds-color-input)] px-3 py-2 text-sm leading-5 text-[var(--ds-color-foreground)] shadow-none transition-colors duration-150 ease-out placeholder:text-[var(--ds-color-muted-foreground)] hover:bg-[var(--ds-color-input-hover,var(--ds-color-input))] focus:bg-[var(--ds-color-input-focus,var(--ds-color-input))] focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[var(--ds-color-focus-ring)] disabled:pointer-events-none disabled:bg-[var(--ds-color-muted)] disabled:text-[var(--ds-color-muted-foreground)] disabled:opacity-60 read-only:bg-[var(--ds-color-surface-subtle)] read-only:text-[var(--ds-color-muted-foreground)] motion-reduce:transition-none";
const TEXTAREA_BORDER = "border-[var(--ds-color-border)] focus:border-[var(--ds-color-border-strong)]";
export function TextareaWithDescription({ label, description, id, className, rows = 3, required, ...props }) {
  const generatedId = useId();
  const textareaId = id ?? `textarea-${generatedId}`;
  const descriptionId = `${textareaId}-description`;
  return <div className="w-full">
      <label
    htmlFor={textareaId}
    className="block text-[13px] font-medium leading-5 text-[var(--ds-color-foreground)]"
  >
        {label}
        {required ? <span aria-hidden="true" className="ml-0.5 text-[var(--ds-color-destructive)]">*</span> : null}
      </label>
      <p id={descriptionId} className="mb-2 mt-1 text-xs leading-4 text-[var(--ds-color-muted-foreground)]">
        {description}
      </p>
      <textarea
    id={textareaId}
    rows={rows}
    required={required}
    aria-describedby={descriptionId}
    className={cx(TEXTAREA_BASE, TEXTAREA_BORDER, className)}
    {...props}
  />
    </div>;
}

export default TextareaWithDescription;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# Textarea With Description

Textarea with a strong label plus a supporting description above the field, wired via aria-describedby.

## Usage

```tsx
<TextareaWithDescription label="Bug report" description="Include steps to reproduce and what you expected to happen." rows={5} />
```

## JavaScript

A `code.jsx` build is provided for projects that ship plain JSX. It exposes the same API and behavior as `code.tsx` — only the TypeScript types are removed.

```jsx
<TextareaWithDescription label="Bug report" description="Include steps to reproduce and what you expected to happen." rows={5} />
```

## Props

| Name | Type | Default | Description |
|---|---|---:|---|
| `label` | `ReactNode` (required) | — | Visible label above the control. |
| `value` / `defaultValue` | `string` | — | Controlled / uncontrolled value. |
| `onChange` | `(event) => void` | — | Native change callback. |
| `rows` | `number` | `3` | Visible rows — the natural height floor (with `min-h-[80px]`). |
| `placeholder` | `string` | — | Muted placeholder (never critical information). |
| `disabled` | `boolean` | — | Native disabled — not focusable, not submitted. |
| `readOnly` | `boolean` | — | Native read-only — focusable, selectable, submitted. |
| `required` / `name` / `id` | `boolean` / `string` | — | Native form semantics (`id` also the label `htmlFor`). |
| `minLength` / `maxLength` | `number` | — | Native length constraints. |
| `className` | `string` | — | Extra Tailwind classes merged onto the control. |
| other native props / `aria-*` | — | — | Passed through to the `<textarea>`. |
| `description` | `ReactNode` (required) | — | Supporting description linked with `aria-describedby`. |

## States

Native textarea with a label and a muted description block stacked between the label and the control. The description frames the field before typing — what to include, the expected format, who will read it. It is linked to the control with `aria-describedby`.

## Accessibility

`<label htmlFor>` + `aria-describedby={descriptionId}` on the native textarea, so screen readers announce both the name and the description. Visible `focus-visible` ring.

## Styling

Built with React, Tailwind CSS, and DevSnips design tokens. The component consumes the `--ds-*` semantic tokens via arbitrary values (for example `bg-[var(--ds-color-input)]`). Define the tokens once in your theme — no component-specific CSS file is required.

## Design Tokens

See [React/DESIGN_TOKENS.md](../../../DESIGN_TOKENS.md) for the authoritative token specification. This textarea uses the semantic color, radius, spacing, and motion tokens.

## Notes

Use this when the field needs a sentence of explanation before the user starts typing — e.g. a bug report that needs repro steps, or a documentation summary with an expected scope. For shorter after-the-fact guidance, use `textarea-with-helper`.