Module: Ramaze::Helper::XHTML

Defined in:
lib/ramaze/helper/xhtml.rb

Overview

Provides shortcuts to the link/script tags.

The XHTML helper can be used for generating CSS and Javascript tags. Generating a CSS tag can be done by calling the css() method:

css 'reset', 'screen', :only => 'ie'

This would result in a stylesheet named “reset.css” being loaded only when the user is using Internet Explorer.

Constant Summary collapse 

'<link href=%p media=%p rel="stylesheet" type="text/css" />'
SCRIPT_TAG = 
'<script src=%p type="text/javascript"></script>'

Instance Method Summary collapse

Instance Method Details

#css(name, media = 'screen', options = {}) ⇒ String

Generate a CSS tag based on the name, media type and a hash containing additional options. For example, if we want to load the stylesheet only when the user is using Internet Explorer we would have to add a key ‘only’ with a value of ‘ie’ to the hash.

Examples:

# A very basic example.
css 'reset'

# Oh shiny, IE only
css 'reset', 'screen', :only => 'ie'

Parameters:

  • name (String) —

    The name of the CSS file to load.

  • media (String) (defaults to: 'screen') —

    The media type for which the stylesheet should be loaded.

  • options (Hash) (defaults to: {}) —

    A hash containing additional options for the stylesheet tag.

Returns:

  • (String) —

    String containing the stylesheet tag.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/ramaze/helper/xhtml.rb', line 38

def css(name, media = 'screen', options = {})
  if media.respond_to?(:keys)
    options = media
    media = 'screen'
  end

  if only = options.delete(:only) and only.to_s == 'ie'
    "<!--[if IE]>#{css(name, media, options)}<![endif]-->"
  else
    if name =~ /^http/
      LINK_TAG % [name, media]
    else
      prefix = options[:prefix] || 'css'
      LINK_TAG % [
        "#{Ramaze.options.prefix.chomp("/")}/#{prefix}/#{name}.css",
        media
      ]
    end
  end
end

#css_for(*args) ⇒ String

The css_for method can be used when you want to load multiple stylesheets and don’t want to call the css() method over and over again.

Examples:

# This is pretty basic
css_for 'reset', '960', 'style'

# Loading multiple stylesheets with custom options
css_for ['reset', 'print'], ['960', 'print']

Parameters:

  • args (Array) —

    An array containing either the names of all stylesheets to load or a collection of arrays of which each array defines the name, media and additional parameters.

Returns:

  • (String)

See Also:

  • css()


77
78
79
 
# File 'lib/ramaze/helper/xhtml.rb', line 77

def css_for(*args)
  args.map{|arg| css(*arg) }.join("\n")
end

#js(name, options = {}) ⇒ String

Generates a Javascript tag that loads an external Javascript file. This tag can’t be used for loading inline Javascript files.

Examples:

# Simple isn't it?
js 'jquery'

# Let's change the directory to "some_other_directory"
js 'jquery', :prefix => 'some_other_directory'

Parameters:

  • name (String) —

    The name of the Javascript file that should be loaded.

  • options (Hash) (defaults to: {}) —

    Hash that can contain a :prefix key that defines the directory in which the JS file is located. By default this key is set to “js”.

Returns:

  • (String) 


99
100
101
102
103
104
105
 
# File 'lib/ramaze/helper/xhtml.rb', line 99

def js(name, options={})
  if name =~ /^http/ # consider it external full url
    SCRIPT_TAG % name
  else
    SCRIPT_TAG % "#{Ramaze.options.prefix.chomp("/")}/#{options[:prefix] || 'js'}/#{name}.js"
  end
end

#js_for(*args) ⇒ String

Generate multiple Javascript tags using the js() method.

Examples:

# Pretty simple isn't it?
js_for 'jquery', 'application', 'jquery.gritter'

Parameters:

  • args (Array) —

    Array containing the Javascript files to load.

Returns:

  • (String) 


117
118
119
 
# File 'lib/ramaze/helper/xhtml.rb', line 117

def js_for(*args)
  args.map{|arg| js(*arg) }.join("\n")
end