Class: Textarea

new Textarea(options) → {Class}

A textarea component to use wherever textarea form fields are needed.

Parameters:

Name Type Description

options

object

The options for the component.

Properties

Name	Type	Description
`customAttributes`	object	Any custom attributes for the textarea.
`customClasses`	Array	Any custom classes for the textarea.
`helpText`	string	Optional helper text.
`id`	string	Optional id. Auto generated if not passed.
`label`	string	Label for the textarea.
`labelCustomAttributes`	object	Any custom attributes for the label.
`labelCustomClasses`	Array	Any custom classes for the label.
`labelVisible`	boolean	If the label should be visible. Defaults to true.
`placeholder`	string	Optional placeholder text.
`rendered`	string	Is the component already rendered in the dom, eg by php?
`renderOnInit`	string	Render the component on init of the class?
`spacing`	string	Spacing for the component.
`target`	string	The target to render to. Any valid css selector string.
`targetPosition`	string	The insert position for the component relative to the target.
`theme`	string	Theme for the component, primary or cosmos.
`value`	string	Optional initial value for the textarea.
`wrapperCustomAttributes`	object	Any custom attributes for the textarea wrapper.
`wrapperCustomClasses`	Array	Any custom classes for the textarea wrapper.
`wrapperTagName`	string	Tag to use for the textarea wrapper. Defaults to 'div',

Since: 1.1.18
Source: elements/Textarea/index.js, line 181

Returns:

The class instance.

Type:: Class

Example

import Textarea from '@gravityforms/components/html/admin/elements/Textarea';

function Example() {
     const textareaInstance = new Textarea( {
         id: 'example-textarea',
         renderOnInit: false,
         target: '#example-target',
         targetPosition: 'beforeend',
         theme: 'cosmos',
     } );

     // Some time later we can render it. This is only done if we set renderOnInit to false.
     // If true it will render on initialization.
     textareaInstance.init();
}

Methods

(static) init() → {void}

Initialize the component.

Since: 1.1.16
Source: elements/Textarea/index.js, line 312

Fires:

event:gform/textarea/post_render

Returns:

Type:: void

(static) render() → {void}

Renders the component into the dom.

Since: 1.1.16
Source: elements/Textarea/index.js, line 286

Returns:

Type:: void

(static) textareaTemplate(options) → {string}

The markup for a textarea.

Parameters:

Name Type Description

options

object

The options for the component template.

Properties

Name	Type	Description
`customAttributes`	object	Any custom attributes for the textarea.
`customClasses`	Array	Any custom classes for the textarea.
`helpText`	string	Optional helper text.
`id`	string	Optional id. Auto generated if not passed.
`label`	string	Label for the textarea.
`labelCustomAttributes`	object	Any custom attributes for the label.
`labelCustomClasses`	Array	Any custom classes for the label.
`labelVisible`	boolean	If the label should be visible. Defaults to true.
`disabled`	boolean	If the textarea should be disabled. Defaults to false.
`placeholder`	string	Optional placeholder text.
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`theme`	string	Theme for the toggle, primary or cosmos.
`value`	string	Optional initial value for the textarea.
`wrapperCustomAttributes`	object	Any custom attributes for the textarea wrapper.
`wrapperCustomClasses`	Array	Any custom classes for the textarea wrapper.
`wrapperTagName`	string	Tag to use for the textarea wrapper. Defaults to 'div',

Since: 1.1.18
Source: elements/Textarea/index.js, line 79

Requires:

module:labelTemplate
module:helpTextTemplate

Returns:

Type:: string

Example

import { textareaTemplate } from '@gravityforms/components/html/admin/elements/Textarea';

function Example() {
     const textareaHTML = textareaTemplate( options );
     document.body.insertAdjacentHTML( 'beforeend', textareaHTML );
}