Sha256: 6cdeafcfb6252c521d37b5c25ffe7e3b39ac7810c42d440b33b30dd33bd5ba0c

Contents?: true

Size: 1.52 KB

Versions: 72

Compression:

Stored size: 1.52 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-turbolinks-track' => 'reload' %>
      #   </head>
      #
      # This is then used by Action Cable to determine the URL of your WebSocket server.
      # Your CoffeeScript can then connect to the server without needing to specify the
      # URL directly:
      #
      #   #= require cable
      #   @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

72 entries across 72 versions & 6 rubygems

Version Path
actioncable-5.2.4.1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.2 lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.2.rc2 lib/action_cable/helpers/action_cable_helper.rb
actioncable-5.2.4 lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.2.rc1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-5.2.4.rc1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.1 lib/action_cable/helpers/action_cable_helper.rb
chatops-rpc-0.0.2 fixtures/chatops-controller-example/vendor/bundle/ruby/2.5.0/gems/actioncable-6.0.0/lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.1.rc1 lib/action_cable/helpers/action_cable_helper.rb
chatops-rpc-0.0.1 fixtures/chatops-controller-example/vendor/bundle/ruby/2.5.0/gems/actioncable-6.0.0/lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.0 lib/action_cable/helpers/action_cable_helper.rb
spiral_form-0.1.1 vendor/bundle/gems/actioncable-5.2.3/lib/action_cable/helpers/action_cable_helper.rb
spiral_form-0.1.0 vendor/bundle/gems/actioncable-5.2.3/lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.0.rc2 lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.0.rc1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-5.2.3 lib/action_cable/helpers/action_cable_helper.rb
actioncable-5.2.3.rc1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.0.beta3 lib/action_cable/helpers/action_cable_helper.rb
actioncable-5.2.2.1 lib/action_cable/helpers/action_cable_helper.rb
actioncable-6.0.0.beta2 lib/action_cable/helpers/action_cable_helper.rb