[Components](https://oods-foundry.com/components) / primitive

# Textarea

Edits a multiline text value.

Generated from @oods/foundry 0.10.1

- Categories

  primitive

- Contexts

  form

- Readiness

  `proven-in-generated-apps`

## Playground

This component's contract doesn't list typed props, so the playground shows its documented example.

Documented example `textarea-controlled` : append a sentence, updated text emitted.

The render follows the page's theme switch: light, dark or high contrast. Both frameworks render the same example.

The real Textarea, live

React

Notes

Visible to account managers

Vue

Notes

Visible to account managers

Events it emits: input, change, update. Use either render above, and each event shows here with the framework that sent it.



## Code

The documented example. HTML is the markup the React component renders for it, which @oods/component-styles styles.

**React**

```
import { Textarea } from '@oods/components-react';
import '@oods/component-styles/css';

export function Example() {
  return (
    <Textarea
      id="notes"
      label="Notes"
      value="Call before renewal"
      rows={4}
      help="Visible to account managers"
    />
  );
}
```

## Props, slots and events

Contract version 1.1.0. Types are from the React declarations in @oods/components-react.

Props

| Prop | Type | Required | Documented example |
| - | - | - | - |
| `id` | `string` | yes | `notes` |
| `label` | `ReactNode` | yes | `Notes` |
| `value` | `string \| number \| readonly string[] \| undefined` | no | `Call before renewal` |
| `defaultValue` | `string \| number \| readonly string[] \| undefined` | no | |
| `rows` | `number \| undefined` | no | `4` |
| `placeholder` | `string \| undefined` | no | |
| `required` | `boolean \| undefined` | no | |
| `disabled` | `boolean \| undefined` | no | |
| `readOnly` | `boolean \| undefined` | no | |
| `help` | `ReactNode` | no | `Visible to account managers` |
| `validation` | `FieldValidation \| undefined` | no | |

### Slots

label, help, validation

### Events

input, change, update

## States

empty, valued, disabled, readOnly, invalid

## Accessibility

- Role

  `textbox`

- How it gets its name

  `label` on `textarea`

### Keyboard

Keyboard

| Key | What it does |
| - | - |
| `Tab` | Move focus to the named native control |
| `x` | Edit the named control |

### Obligations in the contract

- Native textarea semantics
- Label and help/error descriptions are programmatically associated

Shares the canonical field metadata and validation contract.

## Tokens

The token roles this component reads.

- `input.background`
- `input.border`
- `input.text`
- `input.placeholder`
- `input.focus`
- `field.message`

## Readiness

The evidence recorded for this component, with its label.

`proven-in-generated-apps`: catalog_list gives this label when generated React and Vue apps in the runtime sweep that ships with this version both use the component. That sweep was measured on the published 0.4.1, not on this version.

Readiness evidence

| Evidence | React | Vue |
| - | - | - |
| state | implemented-evidence-complete | implemented-evidence-complete |
| versioned contract | passed | passed |
| target implementation | passed | passed |
| package export | passed | passed |
| public declaration | passed | passed |
| dependency closure | passed | passed |
| framework scenario | passed | passed |
| accessibility | verified | verified |
| interaction | verified | verified |
| visual themes | verified | verified |

## Use your own

You can replace this component with your own React or Vue component. Map it, and generated code imports yours at the exact version you name. A contract report, run in a real browser, lists what your component met, what it didn't, and what wasn't checked.

The `component_map` call, with the parts in angle brackets yours to fill:

```
{
  "action": "create",
  "apply": true,
  "externalSystem": "<your design system>",
  "externalComponent": "<YourTextarea>",
  "oodsTraits": [
    "<trait names>"
  ],
  "substitution": {
    "component": "Textarea",
    "react": {
      "package": "<your-package>/react",
      "version": "<exact version>",
      "export": "<YourTextarea>"
    },
    "vue": {
      "package": "<your-package>/vue",
      "version": "<exact version>",
      "export": "<YourTextarea>"
    }
  }
}
```

## How this page was made

Generated at build from the published data, each source with the hash of what was read. [The page's manifest](https://oods-foundry.com/components/textarea/manifest.json).

- **Contract**: `@oods/component-contracts@0.10.1 componentContracts.Textarea` `sha256:499093e065be…`
- **Documented example**: `@oods/component-contracts@0.10.1 sharedScenarios textarea-controlled` `sha256:5f1c2f1f4d6e…`
- **Catalog entry (catalog_list)**: `generated/0.10.1/system/catalog.json Textarea` `sha256:cbdf2aff5a06…`
- **React readiness**: `@oods/components-react@0.10.1 readiness Textarea` `sha256:54890bba1002…`
- **Vue readiness**: `@oods/components-vue@0.10.1 readiness Textarea` `sha256:de701d8cd7cf…`
- **Prop types**: `generated/0.10.1/components/prop-types.json Textarea` `sha256:30d403ae9547…`