2007-01-28 02:16:55 -05:00
|
|
|
require 'action_view/helpers/tag_helper'
|
|
|
|
require 'action_view/helpers/prototype_helper'
|
2005-03-11 21:42:48 -05:00
|
|
|
|
2005-03-11 21:59:12 -05:00
|
|
|
module ActionView
|
|
|
|
module Helpers
|
2005-11-14 17:28:47 -05:00
|
|
|
# Provides functionality for working with JavaScript in your views.
|
|
|
|
#
|
|
|
|
# == Ajax, controls and visual effects
|
|
|
|
#
|
|
|
|
# * For information on using Ajax, see
|
|
|
|
# ActionView::Helpers::PrototypeHelper.
|
|
|
|
# * For information on using controls and visual effects, see
|
|
|
|
# ActionView::Helpers::ScriptaculousHelper.
|
2005-03-22 07:33:47 -05:00
|
|
|
#
|
2005-11-14 17:28:47 -05:00
|
|
|
# == Including the JavaScript libraries into your pages
|
2005-10-15 01:08:59 -04:00
|
|
|
#
|
2005-11-14 17:28:47 -05:00
|
|
|
# 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:
|
2005-10-15 01:08:59 -04:00
|
|
|
#
|
2005-11-14 17:28:47 -05:00
|
|
|
# * Use <tt><%= javascript_include_tag :defaults %></tt> in the HEAD
|
|
|
|
# section of your page (recommended): This function will return
|
|
|
|
# references to the JavaScript files created by the +rails+ command in
|
|
|
|
# your <tt>public/javascripts</tt> directory. Using it is recommended as
|
|
|
|
# the browser can then cache the libraries instead of fetching all the
|
|
|
|
# functions anew on every request.
|
|
|
|
# * Use <tt><%= javascript_include_tag 'prototype' %></tt>: As above, but
|
|
|
|
# will only include the Prototype core library, which means you are able
|
|
|
|
# to use all basic AJAX functionality. For the Scriptaculous-based
|
|
|
|
# JavaScript helpers, like visual effects, autocompletion, drag and drop
|
|
|
|
# and so on, you should use the method described above.
|
|
|
|
# * Use <tt><%= define_javascript_functions %></tt>: this will copy all the
|
|
|
|
# JavaScript support functions within a single script block. Not
|
|
|
|
# recommended.
|
2005-03-22 07:41:34 -05:00
|
|
|
#
|
2005-11-14 17:28:47 -05:00
|
|
|
# For documentation on +javascript_include_tag+ see
|
|
|
|
# ActionView::Helpers::AssetTagHelper.
|
|
|
|
module JavaScriptHelper
|
|
|
|
unless const_defined? :JAVASCRIPT_PATH
|
2005-03-20 19:57:08 -05:00
|
|
|
JAVASCRIPT_PATH = File.join(File.dirname(__FILE__), 'javascripts')
|
|
|
|
end
|
2006-04-19 14:08:15 -04:00
|
|
|
|
|
|
|
include PrototypeHelper
|
2005-03-20 19:57:08 -05:00
|
|
|
|
2006-09-02 15:41:04 -04:00
|
|
|
# Returns a link that will trigger a JavaScript +function+ using the
|
2005-03-20 19:57:08 -05:00
|
|
|
# onclick handler and return false after the fact.
|
2005-03-12 12:00:03 -05:00
|
|
|
#
|
2006-04-19 14:08:15 -04:00
|
|
|
# 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).
|
|
|
|
#
|
2005-03-12 12:00:03 -05:00
|
|
|
# Examples:
|
|
|
|
# link_to_function "Greeting", "alert('Hello world!')"
|
2006-09-02 15:41:04 -04:00
|
|
|
# Produces:
|
|
|
|
# <a onclick="alert('Hello world!'); return false;" href="#">Greeting</a>
|
|
|
|
#
|
2006-04-19 14:08:15 -04:00
|
|
|
# link_to_function(image_tag("delete"), "if (confirm('Really?')) do_delete()")
|
2006-09-02 15:41:04 -04:00
|
|
|
# Produces:
|
|
|
|
# <a onclick="if (confirm('Really?')) do_delete(); return false;" href="#">
|
|
|
|
# <img src="/images/delete.png?" alt="Delete"/>
|
|
|
|
# </a>
|
|
|
|
#
|
2006-04-19 14:08:15 -04:00
|
|
|
# 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
|
2006-09-02 15:41:04 -04:00
|
|
|
# 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>
|
|
|
|
#
|
2006-09-05 21:31:04 -04:00
|
|
|
def link_to_function(name, *args, &block)
|
|
|
|
html_options = args.last.is_a?(Hash) ? args.pop : {}
|
|
|
|
function = args[0] || ''
|
|
|
|
|
2005-12-30 22:50:08 -05:00
|
|
|
html_options.symbolize_keys!
|
2006-04-19 14:08:15 -04:00
|
|
|
function = update_page(&block) if block_given?
|
2005-03-11 21:59:12 -05:00
|
|
|
content_tag(
|
|
|
|
"a", name,
|
2005-12-30 22:50:08 -05:00
|
|
|
html_options.merge({
|
|
|
|
:href => html_options[:href] || "#",
|
2005-12-30 22:51:43 -05:00
|
|
|
:onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function}; return false;"
|
2005-12-30 22:50:08 -05:00
|
|
|
})
|
2005-03-11 21:59:12 -05:00
|
|
|
)
|
|
|
|
end
|
2006-01-02 23:11:51 -05:00
|
|
|
|
2006-04-19 14:08:15 -04:00
|
|
|
# Returns a button that'll trigger a JavaScript +function+ using the
|
2006-01-02 23:11:51 -05:00
|
|
|
# onclick handler.
|
|
|
|
#
|
2006-04-19 14:08:15 -04:00
|
|
|
# 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).
|
|
|
|
#
|
2006-01-02 23:11:51 -05:00
|
|
|
# Examples:
|
|
|
|
# button_to_function "Greeting", "alert('Hello world!')"
|
2006-04-19 14:08:15 -04:00
|
|
|
# button_to_function "Delete", "if (confirm('Really?')) do_delete()"
|
|
|
|
# button_to_function "Details" do |page|
|
|
|
|
# page[:details].visual_effect :toggle_slide
|
|
|
|
# end
|
2006-09-05 21:31:04 -04:00
|
|
|
# button_to_function "Details", :class => "details_button" do |page|
|
|
|
|
# page[:details].visual_effect :toggle_slide
|
|
|
|
# end
|
|
|
|
def button_to_function(name, *args, &block)
|
|
|
|
html_options = args.last.is_a?(Hash) ? args.pop : {}
|
|
|
|
function = args[0] || ''
|
|
|
|
|
2006-01-02 23:11:51 -05:00
|
|
|
html_options.symbolize_keys!
|
2006-04-19 14:08:15 -04:00
|
|
|
function = update_page(&block) if block_given?
|
2006-01-02 23:11:51 -05:00
|
|
|
tag(:input, html_options.merge({
|
|
|
|
:type => "button", :value => name,
|
|
|
|
:onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};"
|
|
|
|
}))
|
|
|
|
end
|
2005-03-11 21:42:48 -05:00
|
|
|
|
2005-06-29 04:09:00 -04:00
|
|
|
# Includes the Action Pack JavaScript libraries inside a single <script>
|
2005-06-26 08:03:43 -04:00
|
|
|
# tag. The function first includes prototype.js and then its core extensions,
|
|
|
|
# (determined by filenames starting with "prototype").
|
2005-11-14 17:28:47 -05:00
|
|
|
# Afterwards, any additional scripts will be included in undefined order.
|
2005-03-20 19:57:08 -05:00
|
|
|
#
|
|
|
|
# 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.
|
2005-03-11 21:59:12 -05:00
|
|
|
def define_javascript_functions
|
2007-03-06 04:46:04 -05:00
|
|
|
javascript = "<script type=\"#{Mime::JS}\">"
|
2005-06-26 08:03:43 -04:00
|
|
|
|
|
|
|
# load prototype.js and its extensions first
|
|
|
|
prototype_libs = Dir.glob(File.join(JAVASCRIPT_PATH, 'prototype*')).sort.reverse
|
|
|
|
prototype_libs.each do |filename|
|
|
|
|
javascript << "\n" << IO.read(filename)
|
|
|
|
end
|
|
|
|
|
|
|
|
# load other librairies
|
|
|
|
(Dir.glob(File.join(JAVASCRIPT_PATH, '*')) - prototype_libs).each do |filename|
|
|
|
|
javascript << "\n" << IO.read(filename)
|
|
|
|
end
|
2005-03-20 19:57:08 -05:00
|
|
|
javascript << '</script>'
|
|
|
|
end
|
2005-03-11 21:42:48 -05:00
|
|
|
|
2005-06-29 04:09:00 -04:00
|
|
|
# Escape carrier returns and single and double quotes for JavaScript segments.
|
2005-03-20 19:57:08 -05:00
|
|
|
def escape_javascript(javascript)
|
2006-10-08 20:34:43 -04:00
|
|
|
(javascript || '').gsub('\\','\0\0').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
|
2005-03-20 19:57:08 -05:00
|
|
|
end
|
2005-03-26 09:03:55 -05:00
|
|
|
|
2005-06-29 04:09:00 -04:00
|
|
|
# Returns a JavaScript tag with the +content+ inside. Example:
|
2006-10-08 20:15:28 -04:00
|
|
|
# javascript_tag "alert('All is good')"
|
|
|
|
#
|
|
|
|
# Returns:
|
|
|
|
#
|
|
|
|
# <script type="text/javascript">
|
|
|
|
# //<![CDATA[
|
|
|
|
# alert('All is good')
|
|
|
|
# //]]>
|
|
|
|
# </script>
|
2006-10-08 20:50:11 -04:00
|
|
|
#
|
|
|
|
# +html_options+ may be a hash of attributes for the <script> tag. Example:
|
|
|
|
# javascript_tag "alert('All is good')", :defer => 'true' # => <script defer="true" type="text/javascript">alert('All is good')</script>
|
|
|
|
def javascript_tag(content, html_options = {})
|
2007-03-06 04:46:04 -05:00
|
|
|
content_tag("script", javascript_cdata_section(content), html_options.merge(:type => Mime::JS))
|
2005-06-26 08:03:43 -04:00
|
|
|
end
|
|
|
|
|
2005-10-12 18:47:39 -04:00
|
|
|
def javascript_cdata_section(content) #:nodoc:
|
|
|
|
"\n//#{cdata_section("\n#{content}\n//")}\n"
|
|
|
|
end
|
|
|
|
|
2005-11-14 17:28:47 -05:00
|
|
|
protected
|
2005-06-26 08:03:43 -04:00
|
|
|
def options_for_javascript(options)
|
2005-07-10 01:11:23 -04:00
|
|
|
'{' + options.map {|k, v| "#{k}:#{v}"}.sort.join(', ') + '}'
|
2005-06-26 08:03:43 -04:00
|
|
|
end
|
|
|
|
|
2005-07-17 05:15:41 -04:00
|
|
|
def array_or_string_for_javascript(option)
|
|
|
|
js_option = if option.kind_of?(Array)
|
|
|
|
"['#{option.join('\',\'')}']"
|
|
|
|
elsif !option.nil?
|
|
|
|
"'#{option}'"
|
|
|
|
end
|
|
|
|
js_option
|
|
|
|
end
|
2005-03-11 21:42:48 -05:00
|
|
|
end
|
2005-06-29 04:09:00 -04:00
|
|
|
|
|
|
|
JavascriptHelper = JavaScriptHelper unless const_defined? :JavascriptHelper
|
2005-03-11 21:59:12 -05:00
|
|
|
end
|
2005-03-14 07:47:38 -05:00
|
|
|
end
|