Components

Textarea Autogrow

A Stimulus controller for autogrowing textarea.


Installation

  1. Install the package

    $ yarn add stimulus-textarea-autogrow
    
  2. Register the controller in your application

    app/javascript/controllers/index.js
    import { Application } from '@hotwired/stimulus'
    import TextareaAutogrow from 'stimulus-textarea-autogrow'
    
    const application = Application.start()
    application.register('textarea-autogrow', TextareaAutogrow)
    

Usage

app/views/index.html
<textarea data-controller="textarea-autogrow">
Very long text here.
</textarea>

<textarea data-controller="textarea-autogrow" data-textarea-autogrow-resize-debounce-delay-value="500">
Very long text here.
</textarea>

Configuration

The height is calculated on window resize to match the content height.

AttributeDefaultDescriptionOptional
data-textarea-autogrow-resize-debounce-delay-value100Delay before autogrow on resize in milliseconds (0 to disable).

Extending Controller

You can use inheritance to extend the functionality of any Stimulus component:

app/javascript/controllers/textarea_autogrow_controller.js
import TextareaAutogrow from "stimulus-textarea-autogrow"

export default class extends TextareaAutogrow {
  connect() {
    super.connect()
    console.log("Do what you want here.")
  }
}

This controller will automatically have access to targets defined in the parent class.

If you override the connect, disconnect or any other methods from the parent, you'll want to call super.method() to make sure the parent functionality is executed.

Sponsors

Stimulus Component is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support Stimulus Components development on GitHub Sponsors. 🙏

Contributing

Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.

Don't forget to drop a 🌟 on GitHub to support the project.

License

This project is released under the MIT license.