Sha256: 794b6548f53fb001825eeff41b4d55f7e15276dea77e0b84b7bade649a42cf8d

Contents?: true

Size: 1.57 KB

Versions: 57

Compression:

Stored size: 1.57 KB

Contents

# frozen_string_literal: true

module ActionCable
  module Helpers
    module ActionCableHelper
      # Returns an "action-cable-url" meta tag with the value of the URL specified in your
      # configuration. Ensure this is above your JavaScript tag:
      #
      #   <head>
      #     <%= action_cable_meta_tag %>
      #     <%= javascript_include_tag 'application', 'data-turbo-track' => 'reload' %>
      #   </head>
      #
      # This is then used by Action Cable to determine the URL of your WebSocket server.
      # Your JavaScript can then connect to the server without needing to specify the
      # URL directly:
      #
      #   import Cable from "@rails/actioncable"
      #   window.Cable = Cable
      #   window.App = {}
      #   App.cable = Cable.createConsumer()
      #
      # Make sure to specify the correct server location in each of your environment
      # config files:
      #
      #   config.action_cable.mount_path = "/cable123"
      #   <%= action_cable_meta_tag %> would render:
      #   => <meta name="action-cable-url" content="/cable123" />
      #
      #   config.action_cable.url = "ws://actioncable.com"
      #   <%= action_cable_meta_tag %> would render:
      #   => <meta name="action-cable-url" content="ws://actioncable.com" />
      #
      def action_cable_meta_tag
        tag "meta", name: "action-cable-url", content: (
          ActionCable.server.config.url ||
          ActionCable.server.config.mount_path ||
          raise("No Action Cable URL configured -- please configure this at config.action_cable.url")
        )
      end
    end
  end
end

Version data entries

57 entries across 54 versions & 7 rubygems

Version Path
actioncable-7.0.8.1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.1.3 lib/action_cable/helpers/action_cable_helper.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/actioncable-7.0.2.3/lib/action_cable/helpers/action_cable_helper.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/actioncable-7.0.3.1/lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.1.2 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.1.1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.1.0 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.1.0.rc2 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.1.0.rc1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.1.0.beta1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.0.8 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.0.7.2 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.0.7.1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.0.7 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.0.6 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.0.5.1 lib/action_cable/helpers/action_cable_helper.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/actioncable-7.0.2.3/lib/action_cable/helpers/action_cable_helper.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/actioncable-7.0.3.1/lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.0.5 lib/action_cable/helpers/action_cable_helper.rb
actioncable-7.0.4.3 lib/action_cable/helpers/action_cable_helper.rb