Module ActionView::Helpers::JavaScriptHelper
In: lib/action_view/helpers/javascript_helper.rb

Methods

Constants

JS_ESCAPE_MAP = { '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n', "\r" => '\n', '"' => '\\"', "'" => "\\'"

Public Instance methods

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" />

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' %>');
j(javascript)

Alias for escape_javascript

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 -%>

Returns a link 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 the link text and the JavaScript code goes into the onclick attribute. If html_options has an :onclick, that one is put before function. Once all the JavaScript is set, the helper appends "; return false;".

The href attribute of the tag is set to "#" unless html_options has one.

  link_to_function "Greeting", "alert('Hello world!')", :class => "nav_link"
  # => <a class="nav_link" href="#" onclick="alert('Hello world!'); return false;">Greeting</a>

[Validate]