An open API service indexing awesome lists of open source software.

https://github.com/matthiasmullie/jquery-autoexpand

Auto-expands textareas so they grow as you type
https://github.com/matthiasmullie/jquery-autoexpand

Last synced: about 1 month ago
JSON representation

Auto-expands textareas so they grow as you type

Awesome Lists containing this project

README

        

# jquery-autoexpand

[![Latest version](https://img.shields.io/npm/dt/jquery-autoexpand.svg)](https://www.npmjs.com/package/jquery-autoexpand)
[![Downloads total](https://img.shields.io/npm/v/jquery-autoexpand.svg)](https://www.npmjs.com/package/jquery-autoexpand)
[![License](https://img.shields.io/npm/l/jquery-autoexpand.svg)](https://github.com/matthiasmullie/jquery-autoexpand/blob/master/LICENSE)

A textarea will automatically grow and shrink in height as you add or remove content to it.

* The textarea will never shrink smaller than its original height
* The textarea will never grow beyond the bottom edge of the window. Instead, a scroll bar show up in the textarea as more text is added to the textarea.

## Demo

Try it out here: http://www.mullie.eu/jquery-autoexpand/

## Usage

```javascript
$('textarea').autoExpand();
```

Or if you want to customize some of the options:

```javascript
$('textarea').autoExpand({ animationTime: 0, windowPadding: 100 });
```

## Remove

If you no longer need the textarea to auto-expand and you want to reset it:

```javascript
$('textarea').autoExpand('destroy');
```

## Options

Options can be passed in as a `{ key: value }` object literal. Available options are:

| property | default value | description |
|---------------|:-------------:|---------------------------------------------------------------|
| animationTime | 50 | Time in milliseconds to animate to new height |
| windowPadding | 20 | Amount of pixels to preserve between textarea & window bottom |

You can remove the auto-expander from a textarea by passing 'destroy' (as string, not in an object literal).

## Installation

Install this package via [npm](https://www.npmjs.org/):

```sh
npm install jquery-autoexpand
```

Or simply copy jquery.autoexpand.js into your project.

## License
jquery-autoexpand is [MIT](http://opensource.org/licenses/MIT) licensed.