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
Components
Stimulus Remote Rails
A Stimulus controller to handle Rails UJS events.
Installation
Install the package
$ yarn add @stimulus-components/remote-rails
Register the controller in your application
app/javascript/controllers/index.jsimport { Application } from '@hotwired/stimulus' import RemoteRails from '@stimulus-components/remote-rails' const application = Application.start() application.register('remote', RemoteRails)
Usage
class CommentsController < ApplicationController
def create
@comment = Comment.new(comment_params)
if @comment.save
render @comment
else
render partial: 'comments/form', locals: { comment: @comment }, status: :unprocessable_entity
end
end
private
def comment_params
params
.require(:comment)
.permit(:content)
end
end
<%= form_with model: @comment, data: { controller: 'remote', action: 'ajax:success->remote#append ajax:error->remote#replace' } do |f| %>
<% if f.object.errors.any? %>
<% f.object.errors.full_messages.each do |error| %>
<p><%= error %></p>
<% end %>
<% end %>
<%= f.label :content %>
<%= f.text_field :content %>
<%= f.submit 'Save comment' %>
<% end %>
With a link_to
:
<%= link_to 'Click me to append content', content_path, remote: true, data: { controller: 'remote', action: 'ajax:success->remote#append' } %>
<%= link_to 'Click me to prepend content', content_path, remote: true, data: { controller: 'remote', action: 'ajax:success->remote#prepend' } %>
<%= link_to 'Click me to replace content', content_path, remote: true, data: { controller: 'remote', action: 'ajax:success->remote#replace' } %>
You can use append
, prepend
or replace
methods with the events of your choice.
Don't forget to add the remote: true
attribute in your link_to
!
You can use it with all remote elements available in Rails UJS.
Extending Controller
You can use inheritance to extend the functionality of any Stimulus component:
import Remote from 'stimulus-remote-rails'
export default class extends Remote {
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.