Textarea

Area where user can enter larger amounts of text. Commonly used in forms.

Summary

Default

Label

Add an id to your Textarea so that clicking the label will move focus directly to the input.

<%= pb_rails("textarea", props: { label: "Label", rows: 4, id: "default-example-1" }) %>

<br/>

<%= pb_rails("textarea", props: { label: "Label", placeholder: "Placeholder text", id: "default-example-2" }) %>

<br/>

<%= pb_rails("textarea", props: { label: "Label", name: "comment", value: "Default value text", id: "default-example-3" }) %>

Custom Textarea Input

Label

<%= pb_rails("textarea", props: { label: "Label"}) do %>
  <textarea class="my_custom_class" name="custom_textarea" rows=4></textarea>
<% end %>

Resize

auto

vertical

both

horizontal

<%= pb_rails("textarea", props: { label: "auto", placeholder: "Resize Auto", resize: "auto" }) %>

<br/>

<%= pb_rails("textarea", props: { label: "vertical", placeholder: "Resize Vertical", resize: "vertical" }) %>

<br/>

<%= pb_rails("textarea", props: { label: "both", placeholder: "Resize Both", resize: "both" }) %>

<br/>

<%= pb_rails("textarea", props: { label: "horizontal", placeholder: "Resize Horizontal", resize: "horizontal" }) %>

Textarea w/ Error

Label

This field has an error!

Textarea w/ Error shows that the input must be filled out (i.e. when used in a form it signals a user to fix an error).

<%= pb_rails("textarea", props: {
  error: raw(pb_rails("icon", props: { icon: "warning" }) + " This field has an error!"),
  label: "Label",
  rows: 4
}) %>

Character Counter

Count Only

Max Characters

20 / 100

Max Characters w/ Blocker

100 / 100

Max Characters w/ Error

Too many characters!

94 / 75

<% text_area_2_value = "Counting characters!" %>
<% text_area_3_value = "This counter prevents the user from exceeding the maximum number of allowed characters. Just try it!" %>
<% text_area_4_value = "This counter alerts the user that they have exceeded the maximum number of allowed characters." %>

<%= pb_rails("textarea", props: {
  character_count: 0,
  id: "text-area-1",
  label: "Count Only",
  onkeyup: "handleChange1(event)",
}) %>

<%= pb_rails("textarea", props: {
  character_count: text_area_2_value.length,
  id: "text-area-2",
  label: "Max Characters",
  max_characters: 100,
  onkeyup: "handleChange2(event, 100)",
  value: text_area_2_value,
}) %>

<%= pb_rails("textarea", props: {
  character_count: text_area_3_value.length,
  id: "text-area-3",
  label: "Max Characters w/ Blocker",
  max_characters: 100,
  onkeyup: "handleChange3(event, 100)",
  value: text_area_3_value,
}) %>

<%= pb_rails("textarea", props: {
  character_count: text_area_4_value.length,
  error: "Too many characters!",
  id: "text-area-4",
  label: "Max Characters w/ Error",
  max_characters: 75,
  onkeyup: "handleChange4(event, 75)",
  value: text_area_4_value,
}) %>

<script type="text/javascript">
  const characterCount1 = document.querySelector("#text-area-1 .pb_caption_kit_xs")
  const characterCount2 = document.querySelector("#text-area-2 .pb_caption_kit_xs")
  const characterCount3 = document.querySelector("#text-area-3 .pb_caption_kit_xs")
  const characterCount4 = document.querySelector("#text-area-4 .pb_caption_kit_xs")

  const textArea3 = document.querySelector("#text-area-3 textarea")
  const textArea4 = document.querySelector("#text-area-4 textarea")

  const handleChange1 = (event) => {
    characterCount1.innerHTML = event.target.value.length
  }

  const handleChange2 = (event, maxCharacters) => {
    characterCount2.innerHTML = `${event.target.value.length} / ${maxCharacters}`
  }

  const handleChange3 = (event, maxCharacters) => {
    if (event.target.value.length > maxCharacters) {
      textArea3.value = event.target.value.substring(0, maxCharacters)
    }

    characterCount3.innerHTML = `${textArea3.value.length} / ${maxCharacters}`
  }

  const handleChange4 = (event, maxCharacters) => {
    characterCount4.innerHTML = `${textArea4.value.length} / ${maxCharacters}`
  }
</script>

Inline

<%= pb_rails("textarea", props: {
  inline: true,
  resize: "auto",
  rows: 1,
  value:"Try clicking into this text."
}) %>

Emoji Mask

Use the emojiMask / emoji_mask prop to prevent users from entering emoji characters (🐸 🐈 🏄‍♂️) in typed or pasted content. It allows accented characters and other non-ASCII letters (é, ü, 文).

<%= pb_rails("textarea", props: {
  emoji_mask: true,
  label: "Emoji Mask",
  placeholder: "Try typing or pasting emojis...",
}) %>

Required Indicator

Label *

The requiredIndicator/required_indicator prop displays a red asterisk (*) next to the label, visually indicating that the field is required. This is purely visual and does not enforce validation.

You can use requiredIndicator/required_indicator with any validation approach: HTML5 validation via the required prop, client-side validation, or backend validation. For this reason, it works independently and doesn't need to be paired with the required prop.

<%= pb_rails("textarea", props: {
  label: "Label",
  placeholder: "Placeholder text",
  required_indicator: true
}) %>

Input Options

ID on Container

ID on Textarea via input_options

Both Container and Textarea IDs

Data and ARIA Attributes

Use the input_options / inputOptions prop to pass additional attributes directly to the underlying <textarea> element instead of the outer wrapper. This is useful for applying data attributes, custom IDs, ARIA attributes, or other HTML attributes that need to be on the textarea element itself.

Additional HTML attributes (e.g. data or ARIA attributes) can also be passed directly to the <textarea> via input_options.

<%= pb_rails("textarea", props: { 
  label: "ID on Container", 
  id: "container-id",
  name: "comment",
  rows: 4
}) %>

<br/>

<%= pb_rails("textarea", props: { 
  label: "ID on Textarea via input_options", 
  input_options: { id: "textarea-id" },
  name: "comment",
  rows: 4
}) %>

<br/>

<%= pb_rails("textarea", props: { 
  label: "Both Container and Textarea IDs", 
  id: "container-id-2",
  input_options: { id: "textarea-id-2" },
  name: "comment",
  rows: 4
}) %>

<br/>

<%= pb_rails("textarea", props: { 
  label: "Data and ARIA Attributes", 
  name: "description",
  rows: 4,
  input_options: {
    'aria-label': "Enter description",
    'aria-describedby': "help-text",
    data: { controller: "textarea", action: "focus->handleFocus" },
    id: "description-textarea"
  }
}) %>

Things to Avoid

Do not use for small text amounts (use Text Input instead). Avoid using textarea without validation if it is required and using with validation if not required.

Available Props

Props	Type	Values
gap	array	none xxs xs sm md lg xl
max_width	array	0% xs sm md lg xl xxl 0 none 100%
min_width	array	0% xs sm md lg xl xxl 0 none 100%
width	array	0% xs sm md lg xl xxl 0 none 100%
z_index	array	1 2 3 4 5 6 7 8 9 10 max
number_spacing	array	tabular
shadow	array	none deep deeper deepest
line_height	array	tightest tighter tight normal loose looser loosest
display	array	block inline_block inline flex inline_flex none grid
cursor	array	auto default none contextMenu help pointer progress wait cell crosshair text verticalText alias copy move noDrop notAllowed grab grabbing eResize nResize neResize nwResize sResize seResize swResize wResize ewResize nsResize neswResize nwseResize colResize rowResize allScroll zoomIn zoomOut
flex_direction	array	row column rowReverse columnReverse
flex_wrap	array	wrap nowrap wrapReverse
justify_content	array	start end center spaceBetween spaceAround spaceEvenly
justify_self	array	auto start end center stretch
align_items	array	flexStart flexEnd start end center baseline stretch
align_content	array	start end center spaceBetween spaceAround spaceEvenly
align_self	array	auto start end center stretch baseline
flex	array	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_grow	array	1 0
flex_shrink	array	1 0
order	array	1 2 3 4 5 6 7 8 9 10 11 12
position	array	relative absolute fixed sticky
hover	array
border_radius	array	none xs sm md lg xl rounded
text_align	array	start end left right center justify justify-all match-parent
overflow	array	visible hidden scroll auto
truncate	array	1 2 3 4 5
left	array	0 xxs xs sm md lg xl auto initial inherit
top	array	0 xxs xs sm md lg xl auto initial inherit
right	array	0 xxs xs sm md lg xl auto initial inherit
bottom	array	0 xxs xs sm md lg xl auto initial inherit
vertical_align	array	baseline super top middle bottom sub text-top text-bottom
height	array	auto xs sm md lg xl xxl xxxl
min_height	array	auto xs sm md lg xl xxl xxxl
max_height	array	auto xs sm md lg xl xxl xxxl
overflow_x	array	visible hidden scroll auto
overflow_y	array	visible hidden scroll auto
classname	string
dark	boolean
column_gap	string
row_gap	string
margin	array	none xxs xs sm md lg xl
margin_bottom	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_right	array	none xxs xs sm md lg xl
margin_top	array	none xxs xs sm md lg xl
margin_x	array	none xxs xs sm md lg xl
margin_y	array	none xxs xs sm md lg xl
padding	array	none xxs xs sm md lg xl
padding_bottom	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_right	array	none xxs xs sm md lg xl
padding_top	array	none xxs xs sm md lg xl
padding_x	array	none xxs xs sm md lg xl
padding_y	array	none xxs xs sm md lg xl
group_hover	boolean
id	string
data	hashprop
aria	hashprop
html_options	hashprop
children	proc
style	hashprop

Props	Type	Values	Default
emoji_mask	boolean		false
error	string
inline	boolean		false
input_options	hashprop
label	string
method	string
name	string
placeholder	string
resize	enum	none both horizontal vertical auto	none
rows	number		4
value	string
character_count	string
onkeyup	string
max_characters	string
required_indicator	boolean		false

Contribute to Playbook

When you start designing a new feature, you may come across a Design Token or Component that isn’t defined in Playbook. If so, you should open an issue or reach out to the team to make a contribution.

Contribute on GitHub

As the highest-rated residential remodeler in the nation, our international technology team builds a custom suite of products that continuously transform our business.

Power

Tech @ Power

Open Positions

About Power

Connect

Github

Connect Chat

Textarea

Things to Avoid

Available Props

gap

max_width

min_width

width

z_index

number_spacing

shadow

line_height

display

cursor

flex_direction

flex_wrap

justify_content

justify_self

align_items

align_content

align_self

flex

flex_grow

flex_shrink

order

position

hover

border_radius

text_align

overflow

truncate

left

top

right

bottom

vertical_align

height

min_height

max_height

overflow_x

overflow_y

classname

dark

column_gap

row_gap

margin

margin_bottom

margin_left

margin_right

margin_top

margin_x

margin_y

padding

padding_bottom

padding_left

padding_right

padding_top

padding_x

padding_y

group_hover

id

data

aria

html_options

children

style

emoji_mask

error

inline

input_options

label

method

name

placeholder

resize

rows

value

character_count

onkeyup

max_characters

required_indicator