@cable_ready/element
v5.0.0
Published
CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.
Downloads
3
Keywords
Readme
<cable-ready>
Element
Install
Rubygem
bundle add cable_ready-element
JavaScript
There are a few ways to install the CableReady JavaScript client, depending on your application setup.
ESBuild / Webpacker
yarn add @cable_ready/element
Importmaps:
# config/importmap.rb
# ...
pin 'cable_ready', to: 'cable_ready.min.js', preload: true
pin '@cable_ready/element', to: 'cable_ready-element.min.js', preload: true
Rails Asset pipeline (Sprockets):
<!-- app/views/layouts/application.html.erb -->
<%= javascript_include_tag "cable_ready-element.umd.min.js", "data-turbo-track": "reload" %>
Installing the element
Within your application.js
import the @cable_ready/element
package:
// app/javascript/application.js
import "@cable_ready/element"
Contributing
Code of Conduct
Everyone interacting with CableReady is expected to follow the Code of Conduct
Coding Standards
This project uses Standard and prettier-standard to minimize bike shedding related to code formatting.
Please run ./bin/standardize
prior submitting pull requests.
Releasing
- Make sure that you run
yarn
andbundle
to pick up the latest. - Bump version number at
lib/cable_ready/element/version.rb
. Pre-release versions use.preN
- Run
rake build
andyarn build
- Commit and push changes to github
- Run
rake release
- Run
yarn publish --no-git-tag-version
- Yarn will prompt you for the new version. Pre-release versions use
-preN
- Commit and push changes to GitHub
- Create a new release on GitHub (here) and generate the changelog for the stable release for it
License
CableReady is released under the MIT License.