Boolean if the height changes should be animated when the resize prop is
set to "auto".
Optional areaClassName
areaClassName?:string
An optional className to apply to the textarea element. The base style
prop is applied to the surrounding div instead.
Optional areaStyle
areaStyle?:CSSProperties
An optional style to apply to the textarea element. The base style prop
is applied to the surrounding div instead.
Optional aria-activedescendant
aria-activedescendant?:string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optional aria-atomic
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.
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.
Optional aria-busy
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.
Indicates what functions can be performed when a dragged object is released on the drop target.
deprecated
in ARIA 1.1
Optional aria-errormessage
aria-errormessage?:string
Identifies the element that provides an error message for the object.
see
aria-invalid @see aria-describedby.
Optional aria-expanded
aria-expanded?:Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optional aria-flowto
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.
Optional aria-grabbed
aria-grabbed?:Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
Indicates the entered value does not conform to the format expected by the application.
see
aria-errormessage.
Optional aria-keyshortcuts
aria-keyshortcuts?:string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optional aria-label
aria-label?:string
Defines a string value that labels the current element.
see
aria-labelledby.
Optional aria-labelledby
aria-labelledby?:string
Identifies the element (or elements) that labels the current element.
see
aria-describedby.
Optional aria-level
aria-level?:number
Defines the hierarchical level of an element within a structure.
Optional aria-live
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.
Optional aria-modal
aria-modal?:Booleanish
Indicates whether an element is modal when displayed.
Optional aria-multiline
aria-multiline?:Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
Optional aria-multiselectable
aria-multiselectable?:Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
Optional aria-orientation
aria-orientation?:"horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optional aria-owns
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.
Optional aria-placeholder
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.
Optional aria-posinset
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.
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
Optional containerRef
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.
Optional contentEditable
contentEditable?:Booleanish | "inherit"
Optional contextMenu
contextMenu?:string
Optional dangerouslySetInnerHTML
dangerouslySetInnerHTML?:{ __html: string }
Type declaration
__html: string
Optional datatype
datatype?:string
Optional defaultChecked
defaultChecked?:boolean
Optional defaultValue
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.
Optional dense
dense?:boolean
Boolean if the form components should be using the dense spec to reduce
the sizing slightly.
Optional dir
dir?:string
Optional dirName
dirName?:string
Optional disabled
disabled?:boolean
Optional draggable
draggable?:Booleanish
Optional error
error?:boolean
Boolean if the text field should gain the error state and update the
colors.
Optional form
form?:string
Optional hidden
hidden?:boolean
id
id:string
An id to apply to the text area. This is required for a11y.
Optional inline
inline?:boolean
Boolean if the component should be rendered inline with
display: inline-flex instead of display: flex.
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.
Optional isRightAddon
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.
Optional itemID
itemID?:string
Optional itemProp
itemProp?:string
Optional itemRef
itemRef?:string
Optional itemScope
itemScope?:boolean
Optional itemType
itemType?:string
Optional label
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.
Optional labelClassName
labelClassName?:string
An optional className to apply to the label wrapper.
Optional labelStyle
labelStyle?:CSSProperties
An optional style to apply to the label wrapper.
Optional lang
lang?:string
Optional leftChildren
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.
Optional maxLength
maxLength?:number
Optional maxRows
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.
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.
Optional resource
resource?:string
Optional results
results?:number
Optional rightChildren
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.
Optional role
role?:AriaRole
Optional rows
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".
Optional security
security?:string
Optional slot
slot?:string
Optional spellCheck
spellCheck?:Booleanish
Optional stretch
stretch?:boolean
Boolean if the component should gain flex: 1 1 auto; which is useful for
full-width behavior within flex containers.
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.
Boolean if the height changes should be animated when the
resizeprop is set to"auto".