274bc97d63
* Add Bun support to `rails new -j` generator * Add additional generation consideration for Bun * Use development gems to test the whole workflow * Remove custom gems from local testing * Revert lock * Revert errant custom gem declaration * Fix linting errors * Fix remnants of bad merge * Always use latest bun * Update actioncable/lib/rails/generators/channel/channel_generator.rb Co-authored-by: Cadu Ribeiro <mail@cadu.dev> * Update guides/source/working_with_javascript_in_rails.md Co-authored-by: Rafael Mendonça França <rafael@franca.dev> * Only use the latest bun if nothing is specified * Hardcode known good version --------- Co-authored-by: Cadu Ribeiro <mail@cadu.dev> Co-authored-by: Rafael Mendonça França <rafael@franca.dev> |
||
|---|---|---|
| .. | ||
| rails-ujs | ||
| MIT-LICENSE | ||
| README.md | ||
README.md
Ruby on Rails unobtrusive scripting adapter
This unobtrusive scripting support file is developed for the Ruby on Rails framework, but is not strictly tied to any specific backend. You can drop this into any application to:
- force confirmation dialogs for various actions;
- make non-GET requests from hyperlinks;
- make forms or hyperlinks submit data asynchronously with Ajax;
- have submit buttons become automatically disabled on form submit to prevent double-clicking.
These features are achieved by adding certain data attributes to your HTML markup. Documentation about the various supported data attributes is available here. In Rails, they are added by the framework's template helpers.
Optional prerequisites
Note that the data attributes this library adds are a feature of HTML5. If you're not targeting HTML5, these attributes may make your HTML to fail validation. However, this shouldn't create any issues for web browsers or other user agents.
Installation
Bun
bun add @rails/ujs
npm
npm install @rails/ujs --save
Yarn
yarn add @rails/ujs
Ensure that .yarnclean does not include assets if you use yarn autoclean.
Usage
Asset pipeline
In a conventional Rails application that uses the asset pipeline, require rails-ujs in your application.js manifest:
//= require rails-ujs
ES2015+
If you're using a JavaScript bundler, add the following to your main JS file:
import Rails from "@rails/ujs"
Rails.start()
How to run tests
Run bundle exec rake ujs:server first, and then run the web tests by visiting http://localhost:4567 in your browser.
License
rails-ujs is released under the MIT License.