Getting Started
Components
- Animated Number
- Auto Submit
- Carousel
- Character Counter
- Chartjs
- Checkbox Select All
- Clipboard
- Color Picker
- Content Loader
- Dialog
- Dropdown
- Glow
- Lightbox
- Notification
- Password Visibility
- Places Autocomplete
- Popover
- Prefetch
- Rails Nested Form
- Read More
- Remote Rails
- Reveal Controller
- Scroll Progress
- Scroll Reveal
- Scroll To
- Sortable
- Sound
- Textarea Autogrow
- Timeago
Installation
Install the package
$ yarn add @stimulus-components/popover
Register the controller in your application
app/javascript/controllers/index.jsimport { Application } from '@hotwired/stimulus' import Popover from '@stimulus-components/popover' const application = Application.start() application.register('popover', Popover)
Usage
With remote content
In your controller:
class UsersController < ApplicationController
def card
render partial: 'users/card', locals: { user: @user }
end
end
In your routes:
Rails.application.routes.draw do
get :card, to: 'users#card'
end
With server rendered content on the fly:
<div data-controller="popover" data-popover-url-value="<%= card_path %>">
You can load popover with AJAX. For instance, this is my
<a href="/profile" data-action="mouseenter->popover#show mouseleave->popover#hide">profile card</a>
</div>
In the card partial app/views/users/_card.html.erb
:
<div data-popover-target="card">
<p>This content is loaded with AJAX.</p>
</div>
With local template
<div data-controller="popover">
This is my GitHub card available on
<a href="/profile" data-action="mouseenter->popover#show mouseleave->popover#hide"> GitHub </a>
<template data-popover-target="content">
<div data-popover-target="card">
<p>This content is in a hidden template.</p>
</div>
</template>
</div>
Configuration
Attribute | Default | Description | Optional |
---|---|---|---|
data-popover-url-value | undefined | URL to fetch the content. | ✅ |
Important note: It's up to you to provide the popover style!
Extending Controller
You can use inheritance to extend the functionality of any Stimulus component:
import Popover from '@stimulus-components/popover'
export default class extends Popover {
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.