Textarea

Easily input and customize larger amounts of text with multi-line functionality.

Installation

API Reference

Important Note

This is the documentation for gluestack-ui v2 (beta). For @gluestack-ui/themed (stable) documentation, refer to gluestack-ui v1.

This is an illustration of Textarea component.

size

isReadOnly

isInvalid

isDisabled

<Textarea
  size="md"
  isReadOnly={false}
  isInvalid={false}
  isDisabled={false}
  className="w-64"
>
  <TextareaInput placeholder="Your text goes here..." />
</Textarea>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add textarea

Step 1: Install the following dependencies:

npm i @gluestack-ui/textarea

Step 2: Copy and paste the following code into your project.

"use client"
import React from "react"
import { createTextarea } from "@gluestack-ui/textarea"
import { View, TextInput, Platform } from "react-native"
import { tva } from "@gluestack-ui/nativewind-utils/tva"
import {
  withStyleContext,
  useStyleContext,
} from "@gluestack-ui/nativewind-utils/withStyleContext"
import { withStyleContextAndStates } from "@gluestack-ui/nativewind-utils/withStyleContextAndStates"
import { cssInterop } from "nativewind"
import { withStates } from "@gluestack-ui/nativewind-utils/withStates"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"

const TextareaWrapper = React.forwardRef<
  React.ElementRef<typeof View>,
  React.ComponentProps<typeof View>
>(({ ...props }, ref) => {
  return <View {...props} ref={ref} />
})

const SCOPE = "TEXTAREA"
const UITextarea = createTextarea({
  Root:
    Platform.OS === "web"
      ? withStyleContext(TextareaWrapper, SCOPE)
      : withStyleContextAndStates(TextareaWrapper, SCOPE),
  Input: Platform.OS === "web" ? TextInput : withStates(TextInput),
})

cssInterop(TextareaWrapper, { className: "style" })
cssInterop(UITextarea.Input, {
  className: { target: "style", nativeStyleToProp: { textAlign: true } },
})

const textareaStyle = tva({
  base: "w-full h-[100px] border border-background-300 rounded data-[hover=true]:border-outline-400 data-[focus=true]:border-primary-700 data-[focus=true]:data-[hover=true]:border-primary-700 data-[disabled=true]:opacity-40 data-[disabled=true]:bg-background-50 data-[disabled=true]:data-[hover=true]:border-background-300",

  variants: {
    variant: {
      default:
        "data-[focus=true]:border-primary-700 data-[focus=true]:web:ring-1 data-[focus=true]:web:ring-inset data-[focus=true]:web:ring-indicator-primary data-[invalid=true]:border-error-700 data-[invalid=true]:web:ring-1 data-[invalid=true]:web:ring-inset data-[invalid=true]:web:ring-indicator-error data-[invalid=true]:data-[hover=true]:border-error-700 data-[invalid=true]:data-[focus=true]:data-[hover=true]:border-primary-700 data-[invalid=true]:data-[focus=true]:data-[hover=true]:web:ring-1 data-[invalid=true]:data-[focus=true]:data-[hover=true]:web:ring-inset data-[invalid=true]:data-[focus=true]:data-[hover=true]:web:ring-indicator-primary data-[invalid=true]:data-[disabled=true]:data-[hover=true]:border-error-700 data-[invalid=true]:data-[disabled=true]:data-[hover=true]:web:ring-1 data-[invalid=true]:data-[disabled=true]:data-[hover=true]:web:ring-inset data-[invalid=true]:data-[disabled=true]:data-[hover=true]:web:ring-indicator-error ",
    },
    size: {
      sm: "",
      md: "",
      lg: "",
      xl: "",
    },
  },
})

const textareaInputStyle = tva({
  base: "p-2 web:outline-0 web:outline-none flex-1 color-typography-900 align-text-top placeholder:text-typography-500 web:cursor-text web:data-[disabled=true]:cursor-not-allowed",
  parentVariants: {
    size: {
      sm: "text-sm",
      md: "text-base",
      lg: "text-lg",
      xl: "text-xl",
    },
  },
})

type ITextareaProps = React.ComponentProps<typeof UITextarea> &
  VariantProps<typeof textareaStyle>

const Textarea = React.forwardRef<
  React.ElementRef<typeof UITextarea>,
  ITextareaProps
>(({ className, variant = "default", size = "md", ...props }, ref) => {
  return (
    <UITextarea
      ref={ref}
      {...props}
      className={textareaStyle({ variant, class: className })}
      context={{ size }}
    />
  )
})

type ITextareaInputProps = React.ComponentProps<typeof UITextarea.Input> &
  VariantProps<typeof textareaInputStyle>

const TextareaInput = React.forwardRef<
  React.ElementRef<typeof UITextarea.Input>,
  ITextareaInputProps
>(({ className, ...props }, ref) => {
  const { size: parentSize } = useStyleContext(SCOPE)

  return (
    <UITextarea.Input
      ref={ref}
      {...props}
      className={textareaInputStyle({
        parentVariants: {
          size: parentSize,
        },
        class: className,
      })}
    />
  )
})

Textarea.displayName = "Textarea"
TextareaInput.displayName = "TextareaInput"

export { Textarea, TextareaInput }

Step 3: Update the import paths to match your project setup.

API Reference

To use this component in your project, include the following import statement in your file.

import { Textarea } from "@/components/ui/textarea"

export default () => (
  <Textarea>
    <TextareaInput />
  </Textarea>
)

Component Props

This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration.

Textarea

It inherits all the properties of React Native's View component.

Prop	Type	Default	Description
size	'sm' \| 'md' \| 'lg' \| 'xl'	'md'	Changes the size of the Input Text
isInvalid	bool	false	When true, the input displays an error state.
isDisabled	bool	false	When true, the input is disabled and cannot be edited.
isHovered	bool	false	When true, the input displays a hover state.
isFocused	bool	false	When true, the input displays a focus state.
isRequired	bool	false	If true, sets aria-required="true" on the input.
isReadOnly	bool	false	If true, the input value cannot be edited.

Descendants Styling Props Props to style child components.

Sx Prop	Description
_input	Prop to style TextareaInput Component

TextareaInput

Contains all TextInput related layout style props and actions. It inherits all the properties of React Native's TextInput component.

Accessibility

We have outlined the various features that ensure the Textarea component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards.

Keyboard

setting the aria-label and aria-hint

VoiceOver: accessible and aria-label props to describe the input's purpose
aria-traits and aria-hint for the various states of the input, such as "double tap to edit"

Props

Textarea component is created using TextInput component from react-native. It extends all the props supported by React Native Text Input and the props mentioned below.

Textarea

Name	Value	Default
size	xl \| lg \| md \| sm	md

Data Attributes Table

Component receives states as props as boolean values, which are applied as data-* attributes. These attributes are then used to style the component via classNames, enabling state-based styling.

State	Data Attribute	Values
hover	data-hover	true \| false
focus	data-focus	true \| false
disabled	data-disabled	true \| false
invalid	data-invalid	true \| false

Examples

The Examples section provides visual representations of the different variants of the component, allowing you to quickly and easily determine which one best fits your needs. Simply copy the code and integrate it into your project.

FormControl

The Textarea Component can be incorporated within the FormControl.

<FormControl size="sm">
  <FormControlLabel>
    <FormControlLabelText>Write with me</FormControlLabelText>
  </FormControlLabel>
  <Textarea>
    <TextareaInput placeholder="Once upon a time..." />
  </Textarea>
  <FormControlHelper>
    <FormControlHelperText>Start your story</FormControlHelperText>
  </FormControlHelper>
</FormControl>

Textarea

Installation

Run the following command:

Step 1: Install the following dependencies:

Step 2: Copy and paste the following code into your project.

Step 3: Update the import paths to match your project setup.

API Reference

Component Props

Textarea

TextareaInput

Accessibility

Keyboard

Screen Reader

Props

Textarea

Data Attributes Table

Examples

FormControl