This component is available on GitHub.

Stimulus Rails Autosave

A Stimulus controller to autosubmit Rails forms.

Before starting

You must have @rails/ujs up and running before using this controller.

$ yarn add @rails/ujs

Somewhere in your JS file:

import Rails from '@rails/ujs'

Rails.start()

Installation

$ yarn add stimulus-rails-autosave

And use it in your JS file:

// Probably in app/javascript/controllers/index.js

import { Application } from '@hotwired/stimulus'
import Autosave from 'stimulus-rails-autosave'

const application = Application.start()
application.register('autosave', Autosave)

Usage

<%= form_with model: @todo, data: { controller: 'autosave', autosave_delay_value: '1000' } do |f| %>
  <div class="field">
    <%= f.label :description %>

    <!-- With custom event! -->
    <%= f.text_field :description, data: { action: 'keyup->autosave#save' } %>
  </div>

  <div class="field">
    <%= f.label :completed %>
    <%= f.check_box :completed, data: { action: 'autosave#save' } %>
  </div>

  <%= f.submit %>
<% end %>

πŸ›  Configuration

AttributeDefaultDescriptionOptional
data-autosave-delay-value0Delay before actually submit the form. (0 to disable)βœ…

πŸŽ› Extending Controller

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

import Autosave from 'stimulus-rails-autosave'

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