replacement for built-in textarea which auto resizes itself
npm install react-autosize-textarea component which automatically adjusts its height to match the content.NB: It does not require any polyfill
``jsx
import ReactDOM from 'react-dom';
import TextareaAutosize from 'react-autosize-textarea';
ReactDOM.renderComponent(
document.body
);
`
npm install --save react-autosize-textarea
`
`
yarn add react-autosize-textarea
`Demo
Live ExamplesUsage
TextareaAutosize is perfectly compatible with ReactJS default one, so to get started you can simply replace any with . It's that easy :)$3
You can pass any prop you're allowed to use with the default React textarea (valueLink too).In addition to them,
TextareaAutosize comes with some optional custom props to facilitate its usage:|Name|Type|Default|Description|
|----|----|-------|-----------|
| onResize | Function | | optional. Called whenever the textarea resizes |
| rows | Number | | optional. Minimum number of visible rows |
| maxRows | Number | | optional. Maximum number of visible rows |
| async | Boolean | false | optional. Initialize
autosize asynchronously. Enable it if you are using StyledComponents. This is forced to true when maxRows is set. Async initialization will make your page "jump" when the component appears, as it will first be rendered with the normal size, then resized to content.
| ref | Function | | optional. Ref to the DOM node |
####
onResizeSometimes you may need to react any time
TextareaAutosize resizes itself. To do so, you should use the optional callback onResize which will be triggered at any resize with the autosize:resized event object:`jsx
function onResize(event) {
console.log(event.type); // -> "autosize:resized"
}
`#### Set min/max height
You can set
minHeight and maxHeight through CSS or inline-style as usual:`jsx
// min-height: 20px; max-height: 80px;
`NB: you may need to take into account borders and/or padding.
In addition to
minHeight, you can force TextareaAutosize to have a minimum number of rows by passing the prop rows:`jsx
// minimun height is three rows
`In addition to
maxHeight, you can force TextareaAutosize to have a maximum number of rows by passing the prop maxRows:`jsx
// maximum height is three rows
`#### Refs to DOM nodes
In order to manually call
textarea's DOM element functions like focus() or blur(), you need a ref to the DOM node.You get one by using the prop
ref as shown in the example below:`jsx
class Form extends React.Component {
constructor() {
this.textarea = React.createRef()
}
componentDidMount() {
this.textarea.current.focus();
} render() {
return (
);
}
}
``