TextareaSurface

A Famo.us surface in the form of an HTML textarea element. This extends the Surface class.

Overview

Options
placeholder
value
name
wrap
cols
rows
Methods
setPlaceholder
focus
focus
setValue
getValue
setName
getName
setWrap
setColumns
setRows

TextareaSurface(options)

Constructor Parameters

options

Object

overrides of default options

placeholder
String
placeholder text hint that describes the expected value of an textarea element
value
String
value of text
name
String
specifies the name of textarea
wrap
String
specify 'hard' or 'soft' wrap for textarea
cols
Number
number of columns in textarea
rows
Number
number of rows in textarea
Methods

setPlaceholder(str)

Set placeholder text. Note: Triggers a repaint.

Parameters
str
String
Value to set the placeholder to.
Returns
TextareaSurface
this, allowing method chaining.

focus()

Focus on the current input, pulling up the keyboard on mobile.

Returns
TextareaSurface
this, allowing method chaining.

focus()

Blur the current input, hiding the keyboard on mobile.

Returns
TextareaSurface
this, allowing method chaining.

setValue(str)

Set the value of textarea. Note: Triggers a repaint next tick.

Parameters
str
String
Value to set the main textarea value to.
Returns
TextareaSurface
this, allowing method chaining.

getValue()

Get the value of the inner content of the textarea (e.g. the entered text)

Returns
String
value of element

setName(str)

Set the name attribute of the element. Note: Triggers a repaint next tick.

Parameters
str
String
element name
Returns
TextareaSurface
this, allowing method chaining.

getName()

Get the name attribute of the element.

Returns
String
name of element

setWrap(str)

Set the wrap of textarea. Note: Triggers a repaint next tick.

Parameters
str
String
wrap of the textarea surface (e.g. 'soft', 'hard')
Returns
TextareaSurface
this, allowing method chaining.

setColumns(num)

Set the number of columns visible in the textarea. Note: Overridden by surface size; set width to true. (eg. size: [true, *]) Triggers a repaint next tick.

Parameters
num
Number
columns in textarea surface
Returns
TextareaSurface
this, allowing method chaining.

setRows(num)

Set the number of rows visible in the textarea. Note: Overridden by surface size; set height to true. (eg. size: [*, true]) Triggers a repaint next tick.

Parameters
num
Number
rows in textarea surface
Returns
TextareaSurface
this, allowing method chaining.