Stimulus Components

Components

A Stimulus controller to show more or less text.

Installation

Install the package
```
$ yarn add @stimulus-components/read-more
```
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)
```

Example

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque vehicula elit ut urna imperdiet maximus. Praesent quis nisi in velit volutpat consectetur in vitae diam. Nulla auctor nulla sapien, auctor varius est vestibulum ut. Morbi ullamcorper est a ipsum fringilla egestas. Vestibulum sed dictum purus. Aliquam dignissim pellentesque magna, in tempus tortor sollicitudin sed. Vestibulum dictum mattis lorem, eget sollicitudin felis elementum in. In ut quam mi. Fusce ac ultrices mauris. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Fusce nec erat in ex efficitur faucibus a ac nunc. Duis dui ex, blandit ut sem in, finibus tempor magna. Vivamus iaculis ante ut ex dapibus, id convallis tellus tristique. Maecenas et felis urna. Proin nec ipsum ac felis bibendum pretium. Curabitur nec suscipit tellus. Morbi hendrerit placerat tellus vel laoreet. Nulla nec nibh ligula. In commodo semper scelerisque. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Nam vulputate gravida sapien non aliquam. Nullam semper nibh justo, at varius orci facilisis id. Maecenas lacinia massa ut gravida tristique. Quisque tincidunt tellus et tempus interdum. Sed volutpat iaculis gravida. Vivamus faucibus urna ut malesuada ullamcorper. Aliquam lobortis velit dolor, in dapibus nibh viverra quis.

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

Attribute	Default	Description	Optional
`data-read-more-more-text-value`	`undefined`	Text to display to show more text.	✅
`data-read-more-less-text-value`	`undefined`	Text 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.

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.

Read More