forms

Textarea

Display a textarea field.

Usage

Use a v-model to make the Textarea reactive.

<script setup>const value = ref('')</script><template>  <UTextarea v-model="value" /></template>

Style

Use the color and variant props to change the visual style of the Textarea.

<UTextarea  color="primary"  variant="outline"  name="textarea"  placeholder="Search..."/>

Besides all the colors from the ui.colors object, you can also use the white (default) and gray colors with their pre-defined variants.

White

<UTextarea  color="white"  variant="outline"  name="textarea"  placeholder="Search..."/>

Gray

<UTextarea  color="gray"  variant="outline"  name="textarea"  placeholder="Search..."/>

Size

Use the size prop to change the size of the Textarea.

<UTextarea size="sm" name="textarea" />

Placeholder

Use the placeholder prop to set a placeholder text.

<UTextarea placeholder="Search..." name="textarea" />

Rows

Use the rows prop to set the number of rows of the Textarea.

<UTextarea :rows="1" name="input" placeholder="Search..." />

Disabled

Use the disabled prop to disable the Textarea.

<UTextarea disabled name="input" placeholder="Search..." />

Autoresize

Use the autoresize prop to enable the autoresize. Writing more lines than the rows prop will make the Textarea grow up.

<UTextarea  autoresize  name="input"  placeholder="Search..."  value="Here is an autoresize Textarea, write new lines to make the Textarea grow up..."/>

Resize

Use the resize prop to enable the resize control.

<UTextarea resize name="input" placeholder="Search..." />

Props

name
string
null
size
"sm" | "2xs" | "xs" | "md" | "lg" | "xl"
null
ui
any
undefined
id
string
null
placeholder
string
null
color
any
config.default.color
modelValue
string | number
""
variant
"outline" | "none"
config.default.variant
autofocusDelay
number
100
rows
number
3
textareaClass
string
null
required
boolean
false
disabled
boolean
false
autofocus
boolean
false
padded
boolean
true
autoresize
boolean
false
resize
boolean
false

Preset

{  "wrapper": "relative",  "base": "relative block w-full disabled:cursor-not-allowed disabled:opacity-75 focus:outline-none border-0",  "rounded": "rounded-md",  "placeholder": "placeholder-gray-400 dark:placeholder-gray-500",  "size": {    "2xs": "text-xs",    "xs": "text-xs",    "sm": "text-sm",    "md": "text-sm",    "lg": "text-sm",    "xl": "text-base"  },  "gap": {    "2xs": "gap-x-1",    "xs": "gap-x-1.5",    "sm": "gap-x-1.5",    "md": "gap-x-2",    "lg": "gap-x-2.5",    "xl": "gap-x-2.5"  },  "padding": {    "2xs": "px-2 py-1",    "xs": "px-2.5 py-1.5",    "sm": "px-2.5 py-1.5",    "md": "px-3 py-2",    "lg": "px-3.5 py-2.5",    "xl": "px-3.5 py-2.5"  },  "leading": {    "padding": {      "2xs": "ps-7",      "xs": "ps-8",      "sm": "ps-9",      "md": "ps-10",      "lg": "ps-11",      "xl": "ps-12"    }  },  "trailing": {    "padding": {      "2xs": "pe-7",      "xs": "pe-8",      "sm": "pe-9",      "md": "pe-10",      "lg": "pe-11",      "xl": "pe-12"    }  },  "color": {    "white": {      "outline": "shadow-sm bg-white dark:bg-gray-900 text-gray-900 dark:text-white ring-1 ring-inset ring-gray-300 dark:ring-gray-700 focus:ring-2 focus:ring-primary-500 dark:focus:ring-primary-400"    },    "gray": {      "outline": "shadow-sm bg-gray-50 dark:bg-gray-800 text-gray-900 dark:text-white ring-1 ring-inset ring-gray-300 dark:ring-gray-700 focus:ring-2 focus:ring-primary-500 dark:focus:ring-primary-400"    }  },  "variant": {    "outline": "shadow-sm bg-transparent text-gray-900 dark:text-white ring-1 ring-inset ring-{color}-500 dark:ring-{color}-400 focus:ring-2 focus:ring-{color}-500 dark:focus:ring-{color}-400",    "none": "bg-transparent focus:ring-0 focus:shadow-none"  },  "icon": {    "base": "flex-shrink-0 text-gray-400 dark:text-gray-500",    "color": "text-{color}-500 dark:text-{color}-400",    "size": {      "2xs": "h-4 w-4",      "xs": "h-4 w-4",      "sm": "h-5 w-5",      "md": "h-5 w-5",      "lg": "h-5 w-5",      "xl": "h-6 w-6"    },    "leading": {      "wrapper": "absolute inset-y-0 start-0 flex items-center",      "pointer": "pointer-events-none",      "padding": {        "2xs": "ps-2",        "xs": "ps-2.5",        "sm": "ps-2.5",        "md": "ps-3",        "lg": "ps-3.5",        "xl": "ps-3.5"      }    },    "trailing": {      "wrapper": "absolute inset-y-0 end-0 flex items-center",      "pointer": "pointer-events-none",      "padding": {        "2xs": "pe-2",        "xs": "pe-2.5",        "sm": "pe-2.5",        "md": "pe-3",        "lg": "pe-3.5",        "xl": "pe-3.5"      }    }  },  "default": {    "size": "sm",    "color": "white",    "variant": "outline"  }}