Textarea API

API documentation for Textarea component

Textarea#

Props#

Defines valid properties in Textarea component.

name	type	default	description
ref	Ref<unknown>	null	The reference to the component instance.
pIf	boolean	true	Whether the component should be rendered.
style	CSSProperties \| ((instance?: TextareaInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: TextareaInstance) => string)	null	The class name to apply to the component.
as	string \| number \| bigint \| boolean \| ComponentClass<any, any> \| FunctionComponent<any> \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode, any, any> \| ReactPortal \| Promise<AwaitedReactNode>	null	The component type to render.
asChild	boolean	false	Whether the component should be rendered as a child component.
pt	SafeRecord<TextareaPassThrough>	null	The pass-through props to pass to the component
ptOptions	PassThroughOptions	null	The pass-through options to pass to the component
unstyled	boolean	null	Whether the component should be rendered without classes.
dt	unknown	null	The design token to use for the component.
styles	StylesOptions<ComponentInstance>	null	The styles to use for the component.
children	ReactNode \| ((instance: TextareaInstance) => ReactNode)	null	The children to render.
size	"small" \| "large"	null	Defines the size of the Textarea.
variant	"outlined" \| "filled"	null	Specifies the input variant of the component.
fluid	boolean	null	When enabled, the component will stretch to occupy the full width of its container.
invalid	boolean	false	When present, it specifies that the component should have invalid state style.
autoResize	boolean	false	When present, height of textarea changes as being typed.
[key: string]	any	null
pt-{optionName}-*	-	null	Pass through attributes for customizing component. For more info, see Pass Through tab.

Exposes#

Defines the methods and properties exposed by Textarea component.

name	type	default	description
fluid	FluidInstance	null	The Fluid component instance.
onInput	(event: FormEvent<HTMLTextAreaElement>) => void	null	Event handler for input events on the textarea.

Interfaces#

PassThroughOptions

Defines passthrough(pt) options of Textarea component.

name	type	default	description
root	TextareaPassThroughType<InputHTMLAttributes<HTMLInputElement>>	null	Used to pass attributes to the root's DOM element.

Types#

Instance

Instance of Textarea component.

values
ComponentInstance<TextareaProps, TextareaState, TextareaExposes>

useTextarea#

Props#

Defines valid properties in useTextarea.

name	type	default	description
autoResize	boolean	false	When present, height of textarea changes as being typed.

Exposes#

Defines the methods and properties exposed by useTextarea.

name	type	default	description
onInput	(event: FormEvent<HTMLTextAreaElement>) => void	null	Event handler for input events on the textarea.

Types#

Instance

Instance of useTextarea headless.

values
HeadlessInstance<useTextareaProps, useTextareaState, useTextareaExposes>