Use simple commands on the server to control client browsers in real-time
MIT License
CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby. It establishes a standard for interacting with the client via ActionCable web sockets. No need for custom JavaScript.
Please read the official ActionCable docs to learn more about ActionCable before proceeding.
bundle add cable_ready
There are a few ways to install the CableReady JavaScript client, depending on your application setup.
yarn add cable_ready
# config/importmap.rb
# ...
pin 'cable_ready', to: 'cable_ready.js', preload: true
<!-- app/views/layouts/application.html.erb -->
<%= javascript_include_tag "cable_ready.umd.js", "data-turbo-track": "reload" %>
Checkout the documentation to continue!
Everyone interacting with CableReady is expected to follow the Code of Conduct
This project uses Standard and prettier-standard to minimize bike shedding related to code formatting.
Please run ./bin/standardize
prior submitting pull requests.
yarn
and bundle
to pick up the latest.lib/cable_ready/version.rb
. Pre-release versions use .preN
rake build
and yarn build
rake release
yarn publish --no-git-tag-version
-preN
CableReady is released under the MIT License.