Components

Reveal Controller

GitHub

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

Installation

  1. Install the package

    Terminal
    $ 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)

Example

Reveal Controller

Hey 🙈

Usage

Toggle

app/views/index.html
<div data-controller="reveal" data-reveal-hidden-class="d-none">
  <button data-action="reveal#toggle" type="button" class="btn" aria-expanded="false">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="reveal#show" type="button" class="btn" aria-expanded="false">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="reveal#hide" type="button" class="btn" aria-expanded="true">Hide me!</button>

  <p data-reveal-target="item" class="mt-4">Hey 👋</p>
</div>

Accessibility

When the element the action is attached to already has an aria-expanded attribute, the controller keeps it in sync: toggle flips it, show sets it to true and hide sets it to false. Give it the value that matches the initial state of the items, aria-expanded="false" when they start hidden.

The attribute is opt-in. The controller never adds it to an element that does not declare it, because aria-expanded is only valid on a control that shows and hides content.

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.