This component is available on GitHub.

Stimulus Read More

A Stimulus controller to show more or less text.


$ yarn add stimulus-read-more

And use it in your JS file:

// Probably in app/javascript/controllers/index.js

import { Application } from '@hotwired/stimulus'
import ReadMore from 'stimulus-read-more'

const application = Application.start()
application.register('read-more', ReadMore)

πŸ‘€ Demo

See demo


In your view:

<div data-controller="read-more" data-read-more-more-text-value="Read more" data-read-more-less-text-value="Read less">
  <p data-read-more-target="content">Lorem ipsum dolor sit am&hellip;</p>

  <button data-action="read-more#toggle">Read more</button>

  <template data-read-more-target="full">
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna
    aliqua. Ut enim ad minim veniam.

πŸ›  Configuration

data-read-more-more-text-valueundefinedText to display to show more text.βœ…
data-read-more-less-text-valueundefinedText to display to show less text.βœ…

πŸŽ› Extending Controller

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

import ReadMore from 'stimulus-read-more'

export default class extends ReadMore {
  connect() {
    console.log('Do what you want here.')

  // Function to override on toggle.
  toggle(event) {}

  // Function to override when the text is shown.
  show(event) {}

  // Function to override when the text is hidden.
  hide(event) {}

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.