This component is available on GitHub.
Stimulus Character Counter
A Stimulus controller that counts the number of characters in any input fields.
Installation
$ yarn add stimulus-character-counter
And use it in your JS file:
// Probably in app/javascript/controllers/index.js
import { Application } from 'stimulus'
import CharacterCounter from 'stimulus-character-counter'
const application = Application.start()
application.register('character-counter', CharacterCounter)
π Demo
See demo βUsage
In your view:
<div data-controller="character-counter">
<textarea data-character-counter-target="input"></textarea>
<p>
There are
<strong data-character-counter-target="counter"></strong> characters in this textarea.
</p>
</div>
You can use it in countdown mode, add the correct value and a maxlength
attribute on the input
/textarea
field:
<div data-controller="character-counter" data-character-counter-countdown-value="true">
<textarea data-character-counter-target="input" maxlength="280"></textarea>
<p>
There are
<strong data-character-counter-target="counter"></strong> characters remaining.
</p>
</div>
π Configuration
Attribute | Default | Description | Optional |
---|---|---|---|
data-character-counter-countdown-value | undefined | Activate the countdown mode. | β |
π Extending Controller
You can use inheritance to extend the functionality of any Stimulus component:
import CharacterCounter from 'stimulus-character-counter'
export default class extends CharacterCounter {
connect() {
super.connect()
console.log('Do what you want here.')
this.count // Will return the number of characters in the input/texterea.
}
}
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.