Components

Stimulus Read More

A Stimulus controller to show more or less text.


Installation

  1. Install the package

    $ yarn add @stimulus-components/read-more
    
  2. Register the controller in your application

    app/javascript/controllers/index.js
    import { Application } from '@hotwired/stimulus'
    import ReadMore from '@stimulus-components/read-more'
    
    const application = Application.start()
    application.register('read-more', ReadMore)
    

Usage

This controller is based on the Line-clamp CSS property.

It will update the CSS variable --read-more-line-clamp on the element with the value 'unset' to show all the content.

In your CSS:

app/javascript/stylesheets/application.css
.my-content {
  overflow: hidden;
  display: -webkit-box;
  -webkit-box-orient: vertical;
  -webkit-line-clamp: var(--read-more-line-clamp, 2);
}

In this case, --read-more-line-clamp is undefined and 2 is the number of lines displayed by default.

app/views/index.html
<div data-controller="read-more" data-read-more-more-text-value="Read more" data-read-more-less-text-value="Read less">
  <p class="my-content" data-read-more-target="content">
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna
    aliqua. Ut enim ad minim veniam.
  </p>

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

Configuration

AttributeDefaultDescriptionOptional
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:

app/javascript/controllers/read_more_controller.js
import ReadMore from '@stimulus-components/read-more'

export default class extends ReadMore {
  connect() {
    super.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.