Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TextAreaProps

Hierarchy

Index

Properties

Properties

about?: string
accessKey?: string
animate?: boolean

Boolean if the height changes should be animated when the resize prop is set to "auto".

areaClassName?: string

An optional className to apply to the textarea element. The base style prop is applied to the surrounding div instead.

areaStyle?: CSSProperties

An optional style to apply to the textarea element. The base style prop is applied to the surrounding div instead.

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-autocomplete?: "list" | "none" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

aria-busy?: Booleanish

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

see

aria-pressed @see aria-selected.

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

see

aria-colindex.

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

see

aria-colcount @see aria-colspan.

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

see

aria-colindex @see aria-rowspan.

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

see

aria-owns.

aria-current?: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

Indicates the element that represents the current item within a container or set of related elements.

aria-describedby?: string

Identifies the element (or elements) that describes the object.

see

aria-labelledby

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

see

aria-describedby.

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

see

aria-hidden @see aria-readonly.

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

deprecated

in ARIA 1.1

aria-errormessage?: string

Identifies the element that provides an error message for the object.

see

aria-invalid @see aria-describedby.

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

deprecated

in ARIA 1.1

aria-haspopup?: boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

see

aria-disabled.

aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

see

aria-errormessage.

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-label?: string

Defines a string value that labels the current element.

see

aria-labelledby.

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

see

aria-describedby.

aria-level?: number

Defines the hierarchical level of an element within a structure.

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

see

aria-controls.

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

see

aria-setsize.

aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

see

aria-checked @see aria-selected.

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

see

aria-disabled.

aria-relevant?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

see

aria-atomic.

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

see

aria-rowindex.

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

see

aria-rowcount @see aria-rowspan.

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

see

aria-rowindex @see aria-colspan.

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

see

aria-checked @see aria-pressed.

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

see

aria-posinset.

aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

aria-valuenow?: number

Defines the current value for a range widget.

see

aria-valuetext.

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

autoCapitalize?: string
autoComplete?: string
autoCorrect?: string
autoFocus?: boolean
autoSave?: string
children?: ReactNode
className?: string
color?: string
cols?: number
containerProps?: Omit<HTMLAttributes<HTMLDivElement>, "className" | "style">

Any additional html attributes that should be applied to the main container div. This is probably only going to be used internally so that additional accessibility can be added to text fields for more complex widgets.

remarks

@since 2.5.2

containerRef?: Ref<HTMLDivElement>

An optional ref to apply to the text field's container div element. The default ref is forwarded on to the input element.

contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
defaultValue?: string

The default value for the text field which will make it uncontrolled. If you manually change the defaultValue prop, the input's value will not change unless you provide a different key as well. Use the value prop instead for a controlled input.

dense?: boolean

Boolean if the form components should be using the dense spec to reduce the sizing slightly.

dir?: string
dirName?: string
disabled?: boolean
draggable?: Booleanish
error?: boolean

Boolean if the text field should gain the error state and update the colors.

form?: string
hidden?: boolean
id: string

An id to apply to the text area. This is required for a11y.

inline?: boolean

Boolean if the component should be rendered inline with display: inline-flex instead of display: flex.

inlist?: any
inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

see

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

see

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

isLeftAddon?: boolean

Boolean if the left children should be wrapped in the TextFieldAddon component. This is enabled by default since this is normally the behavior that is desired so that icons can be positioned correctly.

isRightAddon?: boolean

Boolean if the right children should be wrapped in the TextFieldAddon component. This is enabled by default since this is normally the behavior that is desired so that icons can be positioned correctly.

itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
label?: ReactNode

An optional floating label to use for the text field. This should really only be used when the theme prop is not set to "none". This will be wrapped in the <Label> component itself and automatically apply the htmlFor prop for this text field.

labelClassName?: string

An optional className to apply to the label wrapper.

labelStyle?: CSSProperties

An optional style to apply to the label wrapper.

lang?: string
leftChildren?: ReactNode

An optional addon to apply to the left of the text field. This should normally be an icon. This element will not have pointer events so it can be "clicked through" to focus the text field instead.

maxLength?: number
maxRows?: number

The maximum number of rows that are allowed. When this is set to -1, it will infinitely expand based on the text content.

minLength?: number
name?: string
onAbort?: ReactEventHandler<HTMLTextAreaElement>
onAbortCapture?: ReactEventHandler<HTMLTextAreaElement>
onAnimationEnd?: AnimationEventHandler<HTMLTextAreaElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLTextAreaElement>
onAnimationIteration?: AnimationEventHandler<HTMLTextAreaElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLTextAreaElement>
onAnimationStart?: AnimationEventHandler<HTMLTextAreaElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLTextAreaElement>
onAuxClick?: MouseEventHandler<HTMLTextAreaElement>
onAuxClickCapture?: MouseEventHandler<HTMLTextAreaElement>
onBeforeInput?: FormEventHandler<HTMLTextAreaElement>
onBeforeInputCapture?: FormEventHandler<HTMLTextAreaElement>
onBlur?: FocusEventHandler<HTMLTextAreaElement>
onBlurCapture?: FocusEventHandler<HTMLTextAreaElement>
onCanPlay?: ReactEventHandler<HTMLTextAreaElement>
onCanPlayCapture?: ReactEventHandler<HTMLTextAreaElement>
onCanPlayThrough?: ReactEventHandler<HTMLTextAreaElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLTextAreaElement>
onChange?: ChangeEventHandler<HTMLTextAreaElement>
onChangeCapture?: FormEventHandler<HTMLTextAreaElement>
onClick?: MouseEventHandler<HTMLTextAreaElement>
onClickCapture?: MouseEventHandler<HTMLTextAreaElement>
onCompositionEnd?: CompositionEventHandler<HTMLTextAreaElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLTextAreaElement>
onCompositionStart?: CompositionEventHandler<HTMLTextAreaElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLTextAreaElement>
onCompositionUpdate?: CompositionEventHandler<HTMLTextAreaElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLTextAreaElement>
onContextMenu?: MouseEventHandler<HTMLTextAreaElement>
onContextMenuCapture?: MouseEventHandler<HTMLTextAreaElement>
onCopy?: ClipboardEventHandler<HTMLTextAreaElement>
onCopyCapture?: ClipboardEventHandler<HTMLTextAreaElement>
onCut?: ClipboardEventHandler<HTMLTextAreaElement>
onCutCapture?: ClipboardEventHandler<HTMLTextAreaElement>
onDoubleClick?: MouseEventHandler<HTMLTextAreaElement>
onDoubleClickCapture?: MouseEventHandler<HTMLTextAreaElement>
onDrag?: DragEventHandler<HTMLTextAreaElement>
onDragCapture?: DragEventHandler<HTMLTextAreaElement>
onDragEnd?: DragEventHandler<HTMLTextAreaElement>
onDragEndCapture?: DragEventHandler<HTMLTextAreaElement>
onDragEnter?: DragEventHandler<HTMLTextAreaElement>
onDragEnterCapture?: DragEventHandler<HTMLTextAreaElement>
onDragExit?: DragEventHandler<HTMLTextAreaElement>
onDragExitCapture?: DragEventHandler<HTMLTextAreaElement>
onDragLeave?: DragEventHandler<HTMLTextAreaElement>
onDragLeaveCapture?: DragEventHandler<HTMLTextAreaElement>
onDragOver?: DragEventHandler<HTMLTextAreaElement>
onDragOverCapture?: DragEventHandler<HTMLTextAreaElement>
onDragStart?: DragEventHandler<HTMLTextAreaElement>
onDragStartCapture?: DragEventHandler<HTMLTextAreaElement>
onDrop?: DragEventHandler<HTMLTextAreaElement>
onDropCapture?: DragEventHandler<HTMLTextAreaElement>
onDurationChange?: ReactEventHandler<HTMLTextAreaElement>
onDurationChangeCapture?: ReactEventHandler<HTMLTextAreaElement>
onEmptied?: ReactEventHandler<HTMLTextAreaElement>
onEmptiedCapture?: ReactEventHandler<HTMLTextAreaElement>
onEncrypted?: ReactEventHandler<HTMLTextAreaElement>
onEncryptedCapture?: ReactEventHandler<HTMLTextAreaElement>
onEnded?: ReactEventHandler<HTMLTextAreaElement>
onEndedCapture?: ReactEventHandler<HTMLTextAreaElement>
onError?: ReactEventHandler<HTMLTextAreaElement>
onErrorCapture?: ReactEventHandler<HTMLTextAreaElement>
onFocus?: FocusEventHandler<HTMLTextAreaElement>
onFocusCapture?: FocusEventHandler<HTMLTextAreaElement>
onGotPointerCapture?: PointerEventHandler<HTMLTextAreaElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLTextAreaElement>
onInput?: FormEventHandler<HTMLTextAreaElement>
onInputCapture?: FormEventHandler<HTMLTextAreaElement>
onInvalid?: FormEventHandler<HTMLTextAreaElement>
onInvalidCapture?: FormEventHandler<HTMLTextAreaElement>
onKeyDown?: KeyboardEventHandler<HTMLTextAreaElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLTextAreaElement>
onKeyPress?: KeyboardEventHandler<HTMLTextAreaElement>
deprecated
onKeyPressCapture?: KeyboardEventHandler<HTMLTextAreaElement>
deprecated
onKeyUp?: KeyboardEventHandler<HTMLTextAreaElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLTextAreaElement>
onLoad?: ReactEventHandler<HTMLTextAreaElement>
onLoadCapture?: ReactEventHandler<HTMLTextAreaElement>
onLoadStart?: ReactEventHandler<HTMLTextAreaElement>
onLoadStartCapture?: ReactEventHandler<HTMLTextAreaElement>
onLoadedData?: ReactEventHandler<HTMLTextAreaElement>
onLoadedDataCapture?: ReactEventHandler<HTMLTextAreaElement>
onLoadedMetadata?: ReactEventHandler<HTMLTextAreaElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLTextAreaElement>
onLostPointerCapture?: PointerEventHandler<HTMLTextAreaElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLTextAreaElement>
onMouseDown?: MouseEventHandler<HTMLTextAreaElement>
onMouseDownCapture?: MouseEventHandler<HTMLTextAreaElement>
onMouseEnter?: MouseEventHandler<HTMLTextAreaElement>
onMouseLeave?: MouseEventHandler<HTMLTextAreaElement>
onMouseMove?: MouseEventHandler<HTMLTextAreaElement>
onMouseMoveCapture?: MouseEventHandler<HTMLTextAreaElement>
onMouseOut?: MouseEventHandler<HTMLTextAreaElement>
onMouseOutCapture?: MouseEventHandler<HTMLTextAreaElement>
onMouseOver?: MouseEventHandler<HTMLTextAreaElement>
onMouseOverCapture?: MouseEventHandler<HTMLTextAreaElement>
onMouseUp?: MouseEventHandler<HTMLTextAreaElement>
onMouseUpCapture?: MouseEventHandler<HTMLTextAreaElement>
onPaste?: ClipboardEventHandler<HTMLTextAreaElement>
onPasteCapture?: ClipboardEventHandler<HTMLTextAreaElement>
onPause?: ReactEventHandler<HTMLTextAreaElement>
onPauseCapture?: ReactEventHandler<HTMLTextAreaElement>
onPlay?: ReactEventHandler<HTMLTextAreaElement>
onPlayCapture?: ReactEventHandler<HTMLTextAreaElement>
onPlaying?: ReactEventHandler<HTMLTextAreaElement>
onPlayingCapture?: ReactEventHandler<HTMLTextAreaElement>
onPointerCancel?: PointerEventHandler<HTMLTextAreaElement>
onPointerCancelCapture?: PointerEventHandler<HTMLTextAreaElement>
onPointerDown?: PointerEventHandler<HTMLTextAreaElement>
onPointerDownCapture?: PointerEventHandler<HTMLTextAreaElement>
onPointerEnter?: PointerEventHandler<HTMLTextAreaElement>
onPointerEnterCapture?: PointerEventHandler<HTMLTextAreaElement>
onPointerLeave?: PointerEventHandler<HTMLTextAreaElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLTextAreaElement>
onPointerMove?: PointerEventHandler<HTMLTextAreaElement>
onPointerMoveCapture?: PointerEventHandler<HTMLTextAreaElement>
onPointerOut?: PointerEventHandler<HTMLTextAreaElement>
onPointerOutCapture?: PointerEventHandler<HTMLTextAreaElement>
onPointerOver?: PointerEventHandler<HTMLTextAreaElement>
onPointerOverCapture?: PointerEventHandler<HTMLTextAreaElement>
onPointerUp?: PointerEventHandler<HTMLTextAreaElement>
onPointerUpCapture?: PointerEventHandler<HTMLTextAreaElement>
onProgress?: ReactEventHandler<HTMLTextAreaElement>
onProgressCapture?: ReactEventHandler<HTMLTextAreaElement>
onRateChange?: ReactEventHandler<HTMLTextAreaElement>
onRateChangeCapture?: ReactEventHandler<HTMLTextAreaElement>
onReset?: FormEventHandler<HTMLTextAreaElement>
onResetCapture?: FormEventHandler<HTMLTextAreaElement>
onScroll?: UIEventHandler<HTMLTextAreaElement>
onScrollCapture?: UIEventHandler<HTMLTextAreaElement>
onSeeked?: ReactEventHandler<HTMLTextAreaElement>
onSeekedCapture?: ReactEventHandler<HTMLTextAreaElement>
onSeeking?: ReactEventHandler<HTMLTextAreaElement>
onSeekingCapture?: ReactEventHandler<HTMLTextAreaElement>
onSelect?: ReactEventHandler<HTMLTextAreaElement>
onSelectCapture?: ReactEventHandler<HTMLTextAreaElement>
onStalled?: ReactEventHandler<HTMLTextAreaElement>
onStalledCapture?: ReactEventHandler<HTMLTextAreaElement>
onSubmit?: FormEventHandler<HTMLTextAreaElement>
onSubmitCapture?: FormEventHandler<HTMLTextAreaElement>
onSuspend?: ReactEventHandler<HTMLTextAreaElement>
onSuspendCapture?: ReactEventHandler<HTMLTextAreaElement>
onTimeUpdate?: ReactEventHandler<HTMLTextAreaElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLTextAreaElement>
onTouchCancel?: TouchEventHandler<HTMLTextAreaElement>
onTouchCancelCapture?: TouchEventHandler<HTMLTextAreaElement>
onTouchEnd?: TouchEventHandler<HTMLTextAreaElement>
onTouchEndCapture?: TouchEventHandler<HTMLTextAreaElement>
onTouchMove?: TouchEventHandler<HTMLTextAreaElement>
onTouchMoveCapture?: TouchEventHandler<HTMLTextAreaElement>
onTouchStart?: TouchEventHandler<HTMLTextAreaElement>
onTouchStartCapture?: TouchEventHandler<HTMLTextAreaElement>
onTransitionEnd?: TransitionEventHandler<HTMLTextAreaElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLTextAreaElement>
onVolumeChange?: ReactEventHandler<HTMLTextAreaElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLTextAreaElement>
onWaiting?: ReactEventHandler<HTMLTextAreaElement>
onWaitingCapture?: ReactEventHandler<HTMLTextAreaElement>
onWheel?: WheelEventHandler<HTMLTextAreaElement>
onWheelCapture?: WheelEventHandler<HTMLTextAreaElement>
placeholder?: string
prefix?: string
property?: string
radioGroup?: string
readOnly?: boolean
required?: boolean

Updates the resize ability for the textarea. Native textareas are resizable both horizontally and vertically, but this component will prevent resizing by default and instead animate height changes as the user types.

resource?: string
results?: number
rightChildren?: ReactNode

An optional addon to apply to the right of the text field. This should be a clickable button such as a password field toggle or a reset button for the field.

role?: AriaRole
rows?: number

The number of rows to display by default. The textarea will automatically update and animate its height when the users types if the resize prop is set to "auto".

security?: string
slot?: string
spellCheck?: Booleanish
stretch?: boolean

Boolean if the component should gain flex: 1 1 auto; which is useful for full-width behavior within flex containers.

defaultvalue

false

remarks

@since 5.0.0

style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
theme?: FormTheme

The current theme type.

title?: string
translate?: "yes" | "no"
typeof?: string
underlineDirection?: FormUnderlineDirection

The current underline direction.

unselectable?: "on" | "off"
value?: string

The value to use for the text field. This will make the component controlled and require the onChange prop to be provided as well otherwise this will act as a read only text field.

vocab?: string
wrap?: string

Generated using TypeDoc