Skip to content

marcoroth/cable-streams-rails

Repository files navigation

CableStreams Rails

This is a Rails helper gem for the cable-streams NPM package. CableStreams extends Turbo Streams with Custom Turbo Stream Actions and all CableReady operations.

Installation

bundle add cable_streams

Using the Tag Helpers

The cable_streams gem ships view helpers for all CableReady operations. All options are identical to the regular CableReady operations.

Here's an example of the console_log operation:

<%= turbo_stream.console_log(message: "hello world") %>

Which renders to:

<turbo-stream action="consoleLog" target="body">
  <template>
    [
      { "message": "hello world", "operation": "consoleLog" }
    ]
  </template>
</turbo-stream>