Naughty Platypus Memorabilia
Introducing npm Teams! Private packages + team management tools.Learn more »

virtual-grow-textarea

1.1.3 • Public • Published

virtual-grow-textarea Build Status

Growable textarea for virtual-dom, backed by autosize

Install

$ npm install --save virtual-grow-textarea

Usage

var Textarea = require('virtual-grow-textarea')
 
var textarea = Textarea()
 
function render (state) {
  var vtree = Textarea.render(state)
  // => use virtual-dom to patch vtree into real DOM
}
 
textarea(render)

API

Textarea(data) -> function

data

Type: object

value

Type: string

The value of the textarea.

Textarea.render(state, options) -> vtree

Render a textarea state into a virtual DOM tree.

state

Required Type: object

A textarea state.

options

Type: object

options will be merged with the defaults ({rows: '1'}) and passed to virtual-hyperscript.

Additionally, there are some options that affect the textarea's behavior:

options.enterSubmit

Type: boolean
Default: true

If true, pressing enter will not grow the textarea, and instead will trigger Textarea.onSubmit. The user will have to press shift-enter to grow the textarea.

Suggestion: Set options.enterSubmit to true on desktop and false on mobile.

Textarea.onSubmit(state, listener) -> function

Returns a function that removes the listener.

state

Required
Type: function

An observable Textarea state.

listener

Required
Type: function

A function that will be called when the user submits the textarea with enter while options.enterSubmit is set to true.

Textarea.onInput(state, listener) -> function

Returns a function that removes the listener.

state

Required
Type: function

An observable Textarea state.

listener

Required
Type: function

A function that will be called when the user inputs a value into the textarea.

Textarea.dispose(state)

Disables all listeners that the textarea creates internally.

state

Required
Type: function

An observable Textarea state.

License

MIT © Andrew Joslin

Install

npm i virtual-grow-textarea

DownloadsWeekly Downloads

1

Version

1.1.3

License

MIT

Last publish

Collaborators

  • avatar