JSPM

  • Created
  • Published
  • Downloads 1774141
  • Score
    100M100P100Q207247F
  • License MIT

Auto-resizing Input Component for React

Package Exports

  • react-input-autosize

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-input-autosize) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React-Input-Autosize

A text input for React that resizes itself to the current content.

Demo & Examples

Live demo: jedwatson.github.io/react-input-autosize

To run the examples locally, run:

npm install
npm dev

Then open localhost:8000 in a browser.

Installation

The easiest way to use React-Input-Autosize is to install it from NPM and include it in your own React build process (using Browserify, rollup, webpack, etc).

You can also use the umd build by including dist/AutosizeInput.js in your page. If you use this, make sure you have already included a umd React build.

npm install react-input-autosize --save

Usage

React-Input-Autosize generates an input field, wrapped in a <div> tag so it can detect the size of its value. Otherwise it behaves very similarly to a standard React input.

var AutosizeInput = require('react-input-autosize');

<AutosizeInput
    name="form-field-name"
    value={inputValue}
    onChange={function(event) {
        // event.target.value contains the new value
    }}
/>

Gotchas

Custom font sizes

If your input uses custom font sizes, you will need to provide the custom size to AutosizeInput.

<AutosizeInput
    name="form-field-name"
    value={inputValue}
    style={{ fontSize: 36 }}
    onChange={function(event) {
        // event.target.value contains the new value
    }}
/>

Uncontrolled input

AutosizeInput is a controlled input and depends on the value prop to work as intended. It does not support being used as an uncontrolled input.

License

Copyright (c) 2017 Jed Watson. MIT License.