Textarea

Props#

The Textarea composes the Input component.

`colorScheme`

Description

The visual color appearance of the component

Type

"whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan" | "purple" | "pink"

`errorBorderColor`

Description

The border color when the textarea is invalid. Use color keys in `theme.colors`

Type

string

`focusBorderColor`

Description

The border color when the textarea is focused. Use color keys in `theme.colors`

Type

string

`isDisabled`

Description

If true, the form control will be disabled. This has 2 side effects: - The FormLabel will have `data-disabled` attribute - The form element (e.g, Input) will be disabled

Type

boolean

Default

false

`isInvalid`

Description

If true, the form control will be invalid. This has 2 side effects: - The FormLabel and FormErrorIcon will have `data-invalid` set to true - The form element (e.g, Input) will have `aria-invalid` set to true

Type

boolean

Default

false

`isReadOnly`

Description

If true, the form control will be readonly

Type

boolean

Default

false

`isRequired`

Description

If true, the form control will be required. This has 2 side effects: - The FormLabel will show a required indicator - The form element (e.g, Input) will have `aria-required` set to true

Type

boolean

Default

false

`size`

Description

The size of the Textarea

Type

"xs" | "sm" | "md" | "lg"

Default

md

`variant`

Description

The variant of the Textarea

Type

"outline" | "flushed" | "filled" | "unstyled"

Default

outline

Props#

The Textarea composes the Input component.

`colorScheme`

Description

The visual color appearance of the component

Type

"whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan" | "purple" | "pink"

`errorBorderColor`

Description

The border color when the textarea is invalid. Use color keys in `theme.colors`

Type

string

`focusBorderColor`

Description

The border color when the textarea is focused. Use color keys in `theme.colors`

Type

string

`isDisabled`

Description

If true, the form control will be disabled. This has 2 side effects: - The FormLabel will have `data-disabled` attribute - The form element (e.g, Input) will be disabled

Type

boolean

Default

false

`isInvalid`

Description

If true, the form control will be invalid. This has 2 side effects: - The FormLabel and FormErrorIcon will have `data-invalid` set to true - The form element (e.g, Input) will have `aria-invalid` set to true

Type

boolean

Default

false

`isReadOnly`

Description

If true, the form control will be readonly

Type

boolean

Default

false

`isRequired`

Description

If true, the form control will be required. This has 2 side effects: - The FormLabel will show a required indicator - The form element (e.g, Input) will have `aria-required` set to true

Type

boolean

Default

false

`size`

Description

The size of the Textarea

Type

"xs" | "sm" | "md" | "lg"

Default

md

`variant`

Description

The variant of the Textarea

Type

"outline" | "flushed" | "filled" | "unstyled"

Default

outline

The Textarea component is a single part component. All of the styling is applied directly to the textarea element.

To learn more about styling single part components, visit the Component Style page.

Theming properties#

The properties that affect the theming of the Textarea component are:

variant: The visual variant of the textarea. Defaults to outline.
size: The size of the textarea. Defaults to md.

Theming utilities#

defineStyle: a function used to create style objects.
defineStyleConfig: a function used to define the style configuration for a single part component.

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

Customizing the default theme#

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

const outline = defineStyle({
  border: '2px dashed', // change the appearance of the border
  borderRadius: 0, // remove the border radius
  fontWeight: 'semibold', // change the font weight
})

export const textareaTheme = defineStyleConfig({
  variants: { outline },
})

After the customization of the textarea theme, we can import it in our theme file and add it in the components property:

import { extendTheme } from '@chakra-ui/react'
import { textareaTheme } from './components/textarea'

export const theme = extendTheme({
  components: { Textarea: textareaTheme },
})

Adding a custom size#

Let's assume you want to add a custom size of your textarea. Here's how we can do that:

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

const xl = defineStyle({
  fontSize: 'xl',
  px: '6',
  h: '16',
  borderRadius: 'md',
})

export const textareaTheme = defineStyleConfig({
  sizes: { xl },
})

// Now we can use the new `xl` size
<Textarea size="xl">...</Textarea>

Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.

Adding a custom variant#

Let's assume we want to include a custom branded variant. Here's how we can do that:

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

const brandPrimary = defineStyle({
  background: 'orange.500',
  color: 'white',
  fontFamily: 'serif',
  fontWeight: 'normal',

  // let's also provide dark mode alternatives
  _dark: {
    background: 'orange.300',
    color: 'orange.800',
  }
})

export const textareaTheme = defineStyleConfig({
  variants: { brandPrimary },
})

// Now we can use the new `brandPrimary` variant
<Textarea variant="brandPrimary">...</Textarea>

Changing the default properties#

Let's assume we want to change the default size or variant of every textarea in our app. Here's how we can do that:

import { defineStyleConfig } from '@chakra-ui/react'

export const textareaTheme = defineStyleConfig({
  defaultProps: {
    size: 'lg',
    variant: 'outline',
    colorScheme: 'brand',
  },
})

// This saves you time, instead of manually setting the size and
// variant every time you use the textarea component:
<Textarea size="lg" variant="outline">...</Textarea>

Showcase#

import { Box, SimpleGrid, IconButton, Textarea, useColorMode } from "@chakra-ui/react";
import { FaMoon, FaSun } from "react-icons/fa";

export default function App() {
  const { toggleColorMode, colorMode } = useColorMode();

  return (
    <Box position="relative" h="100vh">
      <SimpleGrid gap={12} p={12} columns={2}>
        <Textarea variant="flushed" placeholder="Flushed variant" />
        <Textarea variant="filled" placeholder="Filled variant" />
        <Textarea variant="outline" placeholder="Outlined variant" />
        <Textarea variant="brandPrimary" placeholder="Custom variant" />
      </SimpleGrid>

      <IconButton
        aria-label="toggle theme"
        rounded="full"
        size="xs"
        position="absolute"
        bottom={4}
        left={4}
        onClick={toggleColorMode}
        icon={colorMode === "dark" ? <FaSun /> : <FaMoon />}
      />
    </Box>
  );
}

Open Sandbox