Module | ActionView::Helpers::JavaScriptHelper |
In: |
vendor/rails/actionpack/lib/action_view/helpers/javascript_helper.rb
|
Provides functionality for working with JavaScript in your views.
Rails includes the Prototype JavaScript framework and the Scriptaculous JavaScript controls and visual effects library. If you wish to use these libraries and their helpers (ActionView::Helpers::PrototypeHelper and ActionView::Helpers::ScriptaculousHelper), you must do one of the following:
For documentation on javascript_include_tag see ActionView::Helpers::AssetTagHelper.
JAVASCRIPT_PATH | = | File.join(File.dirname(__FILE__), 'javascripts') |
Returns a button that’ll trigger a JavaScript function using the onclick handler.
The function argument can be omitted in favor of an update_page block, which evaluates to a string when the template is rendered (instead of making an Ajax request first).
Examples:
button_to_function "Greeting", "alert('Hello world!')" button_to_function "Delete", "if (confirm('Really?')) do_delete()" button_to_function "Details" do |page| page[:details].visual_effect :toggle_slide end
# File vendor/rails/actionpack/lib/action_view/helpers/javascript_helper.rb, line 107 107: def button_to_function(name, function = '', html_options = {}, &block) 108: html_options.symbolize_keys! 109: function = update_page(&block) if block_given? 110: tag(:input, html_options.merge({ 111: :type => "button", :value => name, 112: :onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};" 113: })) 114: end
Includes the Action Pack JavaScript libraries inside a single <script> tag. The function first includes prototype.js and then its core extensions, (determined by filenames starting with "prototype"). Afterwards, any additional scripts will be included in undefined order.
Note: The recommended approach is to copy the contents of lib/action_view/helpers/javascripts/ into your application’s public/javascripts/ directory, and use javascript_include_tag to create remote <script> links.
# File vendor/rails/actionpack/lib/action_view/helpers/javascript_helper.rb, line 125 125: def define_javascript_functions 126: javascript = '<script type="text/javascript">' 127: 128: # load prototype.js and its extensions first 129: prototype_libs = Dir.glob(File.join(JAVASCRIPT_PATH, 'prototype*')).sort.reverse 130: prototype_libs.each do |filename| 131: javascript << "\n" << IO.read(filename) 132: end 133: 134: # load other librairies 135: (Dir.glob(File.join(JAVASCRIPT_PATH, '*')) - prototype_libs).each do |filename| 136: javascript << "\n" << IO.read(filename) 137: end 138: javascript << '</script>' 139: end
Escape carrier returns and single and double quotes for JavaScript segments.
# File vendor/rails/actionpack/lib/action_view/helpers/javascript_helper.rb, line 142 142: def escape_javascript(javascript) 143: (javascript || '').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" } 144: end
Returns a JavaScript tag with the content inside. Example:
javascript_tag "alert('All is good')" # => <script type="text/javascript">alert('All is good')</script>
# File vendor/rails/actionpack/lib/action_view/helpers/javascript_helper.rb, line 148 148: def javascript_tag(content) 149: content_tag("script", javascript_cdata_section(content), :type => "text/javascript") 150: end
Returns a link that will trigger a JavaScript function using the onclick handler and return false after the fact.
The function argument can be omitted in favor of an update_page block, which evaluates to a string when the template is rendered (instead of making an Ajax request first).
Examples:
link_to_function "Greeting", "alert('Hello world!')" Produces: <a onclick="alert('Hello world!'); return false;" href="#">Greeting</a> link_to_function(image_tag("delete"), "if (confirm('Really?')) do_delete()") Produces: <a onclick="if (confirm('Really?')) do_delete(); return false;" href="#"> <img src="/images/delete.png?" alt="Delete"/> </a> link_to_function("Show me more", nil, :id => "more_link") do |page| page[:details].visual_effect :toggle_blind page[:more_link].replace_html "Show me less" end Produces: <a href="#" id="more_link" onclick="try { $("details").visualEffect("toggle_blind"); $("more_link").update("Show me less"); } catch (e) { alert('RJS error:\n\n' + e.toString()); alert('$(\"details\").visualEffect(\"toggle_blind\"); \n$(\"more_link\").update(\"Show me less\");'); throw e }; return false;">Show me more</a>
# File vendor/rails/actionpack/lib/action_view/helpers/javascript_helper.rb, line 82 82: def link_to_function(name, function = '', html_options = {}, &block) 83: html_options.symbolize_keys! 84: function = update_page(&block) if block_given? 85: content_tag( 86: "a", name, 87: html_options.merge({ 88: :href => html_options[:href] || "#", 89: :onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function}; return false;" 90: }) 91: ) 92: end
# File vendor/rails/actionpack/lib/action_view/helpers/javascript_helper.rb, line 161 161: def array_or_string_for_javascript(option) 162: js_option = if option.kind_of?(Array) 163: "['#{option.join('\',\'')}']" 164: elsif !option.nil? 165: "'#{option}'" 166: end 167: js_option 168: end