Skip to content
PHP Ecosystem
Explore

TextArea

API reference › HTML › Form › TextArea

final classUIAwesome\Html\Form\TextArea
ExtendsUIAwesome\Html\Core\Element\BaseBlock » UIAwesome\Html\Core\Base\BaseTag
ImplementsUIAwesome\Html\Contracts\Form\FormControlInterface, UIAwesome\Html\Contracts\Form\PlaceholderInterface, UIAwesome\Html\Contracts\Attribute\AttributesInterface, UIAwesome\Html\Contracts\Element\BlockInterface, UIAwesome\Html\Contracts\Element\ClearableContentInterface, UIAwesome\Html\Contracts\RenderableInterface
Uses traitsUIAwesome\Html\Attribute\CanBeDisabled, UIAwesome\Html\Attribute\Global\HasAutocapitalize, UIAwesome\Html\Attribute\Global\HasAutocorrect, UIAwesome\Html\Form\Mixin\HasMaxlength, UIAwesome\Html\Form\Mixin\HasMinlength, UIAwesome\Html\Attribute\HasName, UIAwesome\Html\Form\Mixin\HasPlaceholder, UIAwesome\Html\Attribute\Global\CanBeAutofocus, UIAwesome\Html\Attribute\Global\CanBeHidden, UIAwesome\Html\Attribute\Global\HasAccesskey, UIAwesome\Html\Attribute\Global\HasAria, UIAwesome\Html\Mixin\HasAttributes, UIAwesome\Html\Attribute\Global\HasClass, UIAwesome\Html\Mixin\HasContent, UIAwesome\Html\Attribute\Global\HasContentEditable, UIAwesome\Html\Attribute\Global\HasData, UIAwesome\Html\Attribute\Global\HasDir, UIAwesome\Html\Attribute\Global\HasDraggable, UIAwesome\Html\Attribute\Global\HasEvents, UIAwesome\Html\Attribute\Global\HasId, UIAwesome\Html\Attribute\Global\HasLang, UIAwesome\Html\Attribute\Global\HasMicroData, UIAwesome\Html\Attribute\Global\HasRole, UIAwesome\Html\Attribute\Global\HasSpellcheck, UIAwesome\Html\Attribute\Global\HasStyle, UIAwesome\Html\Attribute\Global\HasTabindex, UIAwesome\Html\Attribute\Global\HasTitle, UIAwesome\Html\Attribute\Global\HasTranslate, UIAwesome\Html\Core\Event\HasAfterRun, UIAwesome\Html\Core\Event\HasBeforeRun
Sourcesrc/Form/TextArea.php

Renders the HTML <textarea> element for multiline plain-text input.

See also: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/textarea (BaseBlock for the base implementation.).

PropertyTypeDescriptionDefined by
$attributes protectedmixed[]HTML attributes array used by the implementing class. Default: [].UIAwesome\Html\Mixin\HasAttributes
$content protectedstringContent string assigned to the element. Default: ''.UIAwesome\Html\Mixin\HasContent
MethodDescriptionDefined by
__construct() finalInitializes a new tag instance.UIAwesome\Html\Core\Base\BaseTag
__toString()Returns the rendered tag string.UIAwesome\Html\Core\Base\BaseTag
accesskey()Sets the accesskey attribute.UIAwesome\Html\Attribute\Global\HasAccesskey
addAriaAttribute()Sets an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
addAttribute()Adds or updates a single HTML attribute for the element.UIAwesome\Html\Mixin\HasAttributes
addDataAttribute()Sets a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
addEvent()Sets an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
ariaAttributes()Sets multiple aria-* attributes.UIAwesome\Html\Attribute\Global\HasAria
attributes()Adds or updates multiple HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
autocapitalize()Sets the autocapitalize attribute.UIAwesome\Html\Attribute\Global\HasAutocapitalize
autocomplete()Sets the autocomplete attribute.TextArea
autocorrect()Sets the autocorrect attribute.UIAwesome\Html\Attribute\Global\HasAutocorrect
autofocus()Sets the autofocus attribute.UIAwesome\Html\Attribute\Global\CanBeAutofocus
begin() finalStarts begin/end rendering for this instance.UIAwesome\Html\Core\Element\BaseBlock
class()Sets the class attribute.UIAwesome\Html\Attribute\Global\HasClass
clearContent()Clears encoded and raw content without changing other component state.UIAwesome\Html\Mixin\HasContent
cols()Sets the cols attribute.TextArea
config()Applies application-scoped config recipes to this tag.UIAwesome\Html\Core\Base\BaseTag
content()Appends encoded content.UIAwesome\Html\Mixin\HasContent
contentEditable()Sets the contenteditable attribute.UIAwesome\Html\Attribute\Global\HasContentEditable
dataAttributes()Sets multiple data-* attributes.UIAwesome\Html\Attribute\Global\HasData
dir()Sets the dir attribute.UIAwesome\Html\Attribute\Global\HasDir
dirname()Sets the dirname attribute.TextArea
disabled()Sets the disabled attribute.UIAwesome\Html\Attribute\CanBeDisabled
draggable()Sets the draggable attribute.UIAwesome\Html\Attribute\Global\HasDraggable
end() static finalEnds the most recent begin/end rendering block for the current class.UIAwesome\Html\Core\Element\BaseBlock
events()Sets multiple on* event attributes.UIAwesome\Html\Attribute\Global\HasEvents
form()Sets the form attribute.TextArea
getAttribute()Returns the value of a single HTML attribute.UIAwesome\Html\Mixin\HasAttributes
getAttributes()Returns the array of HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
getContent()Returns the content assigned to the element.UIAwesome\Html\Mixin\HasContent
hidden()Sets the hidden attribute.UIAwesome\Html\Attribute\Global\CanBeHidden
html()Appends trusted raw HTML content without encoding or sanitizing it.UIAwesome\Html\Mixin\HasContent
id()Sets the id attribute.UIAwesome\Html\Attribute\Global\HasId
itemId()Sets the itemid attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemProp()Sets the itemprop attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemRef()Sets the itemref attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemScope()Sets the itemscope attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemType()Sets the itemtype attribute.UIAwesome\Html\Attribute\Global\HasMicroData
lang()Sets the lang attribute.UIAwesome\Html\Attribute\Global\HasLang
maxlength()Sets the maxlength attribute.UIAwesome\Html\Form\Mixin\HasMaxlength
minlength()Sets the minlength attribute.UIAwesome\Html\Form\Mixin\HasMinlength
name()Sets the name attribute.UIAwesome\Html\Attribute\HasName
placeholder()Sets the placeholder attribute.UIAwesome\Html\Form\Mixin\HasPlaceholder
readonly()Sets the readonly attribute.TextArea
removeAriaAttribute()Removes an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
removeAttribute()Removes a specific HTML attribute from the element.UIAwesome\Html\Mixin\HasAttributes
removeDataAttribute()Removes a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
removeEvent()Removes an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
render() finalRenders the tag with lifecycle hooks.UIAwesome\Html\Core\Base\BaseTag
replaceAttributes()Replaces all HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
required()Sets the required attribute.TextArea
role()Sets the role attribute.UIAwesome\Html\Attribute\Global\HasRole
rows()Sets the rows attribute.TextArea
spellcheck()Sets the spellcheck attribute.UIAwesome\Html\Attribute\Global\HasSpellcheck
style()Sets the style attribute.UIAwesome\Html\Attribute\Global\HasStyle
tabIndex()Sets the tabindex attribute.UIAwesome\Html\Attribute\Global\HasTabindex
tag() staticCreates and configures a new tag instance.UIAwesome\Html\Core\Base\BaseTag
title()Sets the title attribute.UIAwesome\Html\Attribute\Global\HasTitle
translate()Sets the translate attribute.UIAwesome\Html\Attribute\Global\HasTranslate
wrap()Sets the wrap attribute.TextArea
afterRun() protectedPost-processes rendered output.UIAwesome\Html\Core\Event\HasAfterRun
beforeRun() protectedValidates state before rendering.UIAwesome\Html\Core\Event\HasBeforeRun
getTag() protectedReturns the tag enumeration for the <textarea> element.TextArea
isBeginExecuted() protectedIndicates whether this instance has an open or closing operation in the current context.UIAwesome\Html\Core\Element\BaseBlock
loadDefault() protectedReturns class-level default definitions.UIAwesome\Html\Core\Base\BaseTag
run() protectedRenders the block element.UIAwesome\Html\Core\Element\BaseBlock
runBegin() protectedReturns the opening tag for begin/end rendering.UIAwesome\Html\Core\Element\BaseBlock
public function autocomplete(string|Stringable|UnitEnum|null $value): static

Sets the autocomplete attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullAutocomplete value, or null to remove the attribute.

Returns

static: New instance with the updated autocomplete attribute.

public function cols(int|string|null $value): static

Sets the cols attribute.

Parameters

ParameterTypeDescription
$valueint|string|nullVisible width in average character widths (positive integer), or null to remove the attribute.

Returns

static: New instance with the updated cols attribute.

Throws

public function dirname(string|Stringable|UnitEnum|null $value): static

Sets the dirname attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullDirname value, or null to remove the attribute.

Returns

static: New instance with the updated dirname attribute.

public function form(string|Stringable|UnitEnum|null $value): static

Sets the form attribute.

Parameters

ParameterTypeDescription
$valuestring|Stringable|UnitEnum|nullForm ID, or null to remove the attribute.

Returns

static: New instance with the updated form attribute.

public function readonly(bool|null $value): static

Sets the readonly attribute.

Parameters

ParameterTypeDescription
$valuebool|nullReadonly state. Use true to make readonly, false to make editable, or null to remove the attribute.

Returns

static: New instance with the updated readonly attribute.

public function required(bool|null $value): static

Sets the required attribute.

Parameters

ParameterTypeDescription
$valuebool|nullRequired state. Use true to require a value, false to make it optional, or null to remove the attribute.

Returns

static: New instance with the updated required attribute.

public function rows(int|string|null $value): static

Sets the rows attribute.

Parameters

ParameterTypeDescription
$valueint|string|nullNumber of visible text lines (positive integer), or null to remove the attribute.

Returns

static: New instance with the updated rows attribute.

Throws

public function wrap(string|UnitEnum|null $value): static

Sets the wrap attribute.

Parameters

ParameterTypeDescription
$valuestring|UnitEnum|nullLine-wrapping behavior (‘hard’, ‘soft’, or ‘off’), or null to remove the attribute.

Returns

static: New instance with the updated wrap attribute. Wrap for predefined enum values.

Throws

protected function getTag(): UIAwesome\Html\Interop\Block

Returns the tag enumeration for the <textarea> element.

Returns

Block: Tag enumeration instance for <textarea>. Block for valid block-level tags.