Socket
Socket
Sign inDemoInstall

react-textarea-autosize

Package Overview
Dependencies
11
Maintainers
3
Versions
98
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    react-textarea-autosize

textarea component for React which grows with content


Version published
Maintainers
3
Install size
202 kB
Created

Package description

What is react-textarea-autosize?

The react-textarea-autosize package is a React component that automatically adjusts the height of a textarea to fit the content. It is useful for creating text input areas in web applications where the amount of text is dynamic and can grow or shrink.

What are react-textarea-autosize's main functionalities?

Auto-resizing textarea

This feature allows the textarea to automatically resize between a minimum and maximum number of rows based on the content.

<TextareaAutosize minRows={3} maxRows={6} />

Minimum and maximum height

You can set a minimum and maximum height for the textarea, which will be respected during auto-resizing.

<TextareaAutosize style={{ minHeight: '100px', maxHeight: '300px' }} />

Controlled component

The component can be used as a controlled component, with its value being managed by the state of the enclosing component.

<TextareaAutosize value={this.state.text} onChange={this.handleChange} />

Uncontrolled component

The component can also be used as an uncontrolled component, where it maintains its own state.

<TextareaAutosize defaultValue='Initial content' />

Ref forwarding

React refs can be forwarded to the underlying textarea element, allowing for direct DOM access if needed.

const ref = React.createRef();
<TextareaAutosize ref={ref} />

Other packages similar to react-textarea-autosize

Changelog

Source

8.0.0

Major Changes

  • The package has been rewritten in TypeScript so type definitions are now included in the package itself. There is no need to install separate types from the DefinitelyTyped.
  • At the same time the package internals have been rewritten to use React's hooks API. This means that the peer dependency requirement for React version had to be changed to ^16.8.0.
  • You can now use ref prop to get access to the underlaying textarea element as React.forwardRef is being used now. The support for innerRef has been completely removed.
  • useCacheForDOMMeasurements prop has been renamed to cacheMeasurements.
  • onHeightChange callback no longer receives the second argument. It was the component's instance (its this), but as the component is now implemented using hooks there no longer is any instance that could be given to a consumer like that.
  • Removed handling props.style.maxHeight and props.style.minHeight values. If you need to control those boundaries you should use maxRows and minRows props respectively.

Minor Changes

  • The height is being set now directly on the underlaying textarea element and not caused by updating internal state and this triggering React's rerender. This shouldn't make for any observable difference for consumers of this package.

Readme

Source

npm version npm

react-textarea-autosize

Drop-in replacement for the textarea component which automatically resizes textarea as content changes. A native React version of the popular jQuery Autosize! Weighs 1.68KB (minified & gzipped).

This module supports IE9 and above.

import TextareaAutosize from 'react-textarea-autosize';

// If you use CommonJS syntax:
// var TextareaAutosize = require('react-textarea-autosize').default;

React.renderComponent(
  <div>
    <TextareaAutosize />
  </div>,
  document.getElementById('element'),
);

Install

npm install react-textarea-autosize

Demo

https://andreypopp.github.io/react-textarea-autosize/

Props

Special props:

proptypedescription
inputReffuncFunction invoked with DOM node as argument. Default: () => {}
maxRowsnumberMaximum number of rows upto which the textarea can grow
minRowsnumberMinimum number of rows to show for textarea
onHeightChangefuncFunction invoked on textarea height change, with height as first argument
cacheMeasurementsbooleanReuse previously computed measurements when computing height of textarea. Default: false

Apart from these, the component accepts all props that are accepted by <textarea/>, like style, onChange, value, etc.

FAQ

How to focus

Get a ref to inner textarea:

<TextareaAutosize inputRef={tag => (this.textarea = tag)} />

And then call a focus on that ref:

this.textarea.focus();

To autofocus:

<TextareaAutosize autoFocus />

(all HTML attributes are passed to inner textarea)

How to test it with jest and react-test-renderer if you need ref

Because jest provides polyfills for DOM objects by requiring jsdom and react-test-renderer doesn't provide refs for rendered components out of the box (calling ref callbacks with null), you need to supply a mocked ref in your tests in you need it for your tests. You can do it like this (more can be read here):

const tree = renderer
  .create(<TextareaAutosize />, {
    createNodeMock: () => document.createElement('textarea'),
  })
  .toJSON();

Keywords

FAQs

Last updated on 23 May 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc