Class Index [+]

Quicksearch

ActionView::Helpers::JavaScriptHelper

Constants

JS_ESCAPE_MAP

Public Instance Methods

button_to_function(name, function=nil, html_options={}) click to toggle source

Returns a button whose onclick handler triggers the passed JavaScript.

The helper receives a name, JavaScript code, and an optional hash of HTML options. The name is used as button label and the JavaScript code goes into its onclick attribute. If html_options has an :onclick, that one is put before function.

  button_to_function "Greeting", "alert('Hello world!')", :class => "ok"
  # => <input class="ok" onclick="alert('Hello world!');" type="button" value="Greeting" />
    # File lib/action_view/helpers/javascript_helper.rb, line 84
84:       def button_to_function(name, function=nil, html_options={})
85:         ActiveSupport::Deprecation.warn("button_to_function is deprecated and will be removed from Rails 4.0")
86: 
87:         onclick = "#{"#{html_options[:onclick]}; " if html_options[:onclick]}#{function};"
88: 
89:         tag(:input, html_options.merge(:type => 'button', :value => name, :onclick => onclick))
90:       end
escape_javascript(javascript) click to toggle source

Escapes carriage returns and single and double quotes for JavaScript segments.

Also available through the alias j(). This is particularly helpful in JavaScript responses, like:

  $('some_element').replaceWith('<%=j render 'some/element_template' %>');
    # File lib/action_view/helpers/javascript_helper.rb, line 28
28:       def escape_javascript(javascript)
29:         if javascript
30:           result = javascript.gsub(/(\\|<\/|\r\n|\3342\2200\2250|[\n\r"'])/) {|match| JS_ESCAPE_MAP[match] }
31:           javascript.html_safe? ? result.html_safe : result
32:         else
33:           ''
34:         end
35:       end
Also aliased as: j
j(javascript) click to toggle source
Alias for: escape_javascript
javascript_tag(content_or_options_with_block = nil, html_options = {}, &block) click to toggle source

Returns a JavaScript tag with the content inside. Example:

  javascript_tag "alert('All is good')"

Returns:

  <script type="text/javascript">
  //<![CDATA[
  alert('All is good')
  //]]>
  </script>

html_options may be a hash of attributes for the <script> tag. Example:

  javascript_tag "alert('All is good')", :defer => 'defer'
  # => <script defer="defer" type="text/javascript">alert('All is good')</script>

Instead of passing the content as an argument, you can also use a block in which case, you pass your html_options as the first parameter.

  <%= javascript_tag :defer => 'defer' do -%>
    alert('All is good')
  <% end -%>
    # File lib/action_view/helpers/javascript_helper.rb, line 59
59:       def javascript_tag(content_or_options_with_block = nil, html_options = {}, &block)
60:         content =
61:           if block_given?
62:             html_options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
63:             capture(&block)
64:           else
65:             content_or_options_with_block
66:           end
67: 
68:         content_tag(:script, javascript_cdata_section(content), html_options.merge(:type => Mime::JS))
69:       end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.