Components

Stimulus Reveal Controller

A Stimulus controller to toggle a class on one or multiple items to show or hide them.


Installation

  1. Install the package

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

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

Usage

Toggle

app/views/index.html
<div data-controller="reveal" data-reveal-hidden-class="d-none">
  <button data-action="click->reveal#toggle" type="button" class="btn">Toggle me!</button>

  <p data-reveal-target="item" class="d-none mt-4">Hey πŸ‘‹</p>
  <p data-reveal-target="item" class="d-none mt-4">You can have multiple items</p>
</div>

Show

app/views/index.html
<div data-controller="reveal">
  <button data-action="click->reveal#show" type="button" class="btn">Show me!</button>

  <p data-reveal-target="item" class="hidden mt-4">Hey πŸ‘‹</p>
</div>

Hide

app/views/index.html
<div data-controller="reveal">
  <button data-action="click->reveal#hide" type="button" class="btn">Hide me!</button>

  <p data-reveal-target="item" class="mt-4">Hey πŸ‘‹</p>
</div>

Configuration

AttributeDefaultDescriptionOptional
data-reveal-hidden-classhiddenCSS class to toggleβœ…

Extending Controller

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

app/javascript/controllers/reveal_controller.js
import Reveal from '@stimulus-components/reveal'

export default class extends Reveal {
  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.