Components

Stimulus Notification

A Stimulus controller for showing notifications.


Installation

  1. Install the package

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

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

This controller uses stimulus-use/use-transition under the hood. You can change the animation behavior as you want.

Usage

app/views/index.html
<div
  data-controller="notification"
  data-notification-delay-value="2000"
  class="transition transform duration-1000 hidden"
  data-transition-enter-from="opacity-0 translate-x-6"
  data-transition-enter-to="opacity-100 translate-x-0"
  data-transition-leave-from="opacity-100 translate-x-0"
  data-transition-leave-to="opacity-0 translate-x-6"
>
  <p>This alert will magically disappear!</p>

  <button data-action="notification#hide">Close</button>
</div>

You can hide the notification by default and open it programmatically. Use a CustomEvent and set the correct value and action.

For instance:

app/views/index.html
<div
  data-controller="notification"
  data-notification-hidden-value="true"
  data-action="awesome@window->notification#show"
  class="transition transform duration-1000 hidden"
  data-transition-enter-from="opacity-0 translate-x-6"
  data-transition-enter-to="opacity-100 translate-x-0"
  data-transition-leave-from="opacity-100 translate-x-0"
  data-transition-leave-to="opacity-0 translate-x-6"
>
  <p>This alert will magically disappear!</p>

  <button data-action="notification#hide">Close</button>
</div>

<script>
  document.addEventListener('DOMContentLoaded', () => {
    const event = new CustomEvent('awesome')

    window.dispatchEvent(event)
  })
</script>

Configuration

AttributeDefaultDescriptionOptional
data-notification-delay-value3000Delay in milliseconds before closing the notification.βœ…
data-notification-hidden-valuefalseHide the notification by default to open it programmatically.βœ…

Extending Controller

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

app/javascript/controllers/notification_controller.js
import Notification from '@stimulus-components/notification'

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