TextArea
Inmatningsfält som används när användaren behöver fylla i längre information t.ex. en beskrivning, kommentar eller fritext. För kortare, striktare inmatning används TextField.
import { TextArea } from '@midas-ds/components'
<TextArea
label='Kommentar'
description='Skriv en kommentar'
/>
Beskrivning
TextArea är en komposition av <TextField>, <TextArea>, <Label>, <FieldError> och <Text> som alla är React Aria-komponenter.
Med undantag för type-attributet erbjuder TextArea samma API som TextField, vänligen använd dokumentationen för TextField för mer information.
API
| Name | Type | Default | Description |
|---|---|---|---|
children | ReactNode | - | The children of the component. A function may be provided to alter the children based on component state. |
isDisabled | boolean | - | Whether the input is disabled. |
style | StyleOrFunction<DisclosureRenderProps> | - | The inline style for the element. A function may be provided to compute the style based on component state. |
slot | string | - | A slot name for the component. Slots allow the component to receive props from a parent component.
An explicit |
label | string | - | Specify label displayed above the TextField |
autoFocus | boolean | - | Whether the element should receive focus on render. |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | - | An enumerated attribute that defines what action label or icon to preset for the enter key on virtual keyboards. See MDN. |
size | Size | 'large' | Component size (large: height 48px, medium: height 40px) |
value | DateValue | - | The current value (controlled). |
defaultValue | DateValue | - | The default value (uncontrolled). |
isReadOnly | boolean | - | Whether the input can be selected but not changed by the user. |
isRequired | boolean | - | Whether user input is required on the input before form submission. |
isInvalid | boolean | - | Whether the value is invalid. |
validationBehavior | "aria" | "native" | 'native' | Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA. |
validate | (value: boolean) => true | ValidationError | - | A function that returns an error message if a given value is invalid.
Validation errors are displayed to the user when the form is submitted
if |
description | string | - | Specify description displayed below the label |
errorMessage | string | ((validation: ValidationResult) => string) | - | Custom error messages |
errorPosition | "top" | "bottom" | - | |
showCounter | boolean | false | Whether to show the character counter or not |
popover | InfoPopoverProps | - | |
className | ClassNameOrFunction<DisclosureRenderProps> | - | The CSS className for the element. A function may be provided to compute the class based on component state. |