README.textile

compass-jquery-plugin

Get gem from Gemcutter.
Get source from github.

Description

A Sass-based Meta-Framework for Compass that allows you to mix and match any of the following:

• jRails with jQuery 1.4.4 and jQuery.UI 1.8.6 including themes
• jQuery Tools 1.2.5
• jquery.jstree.js V1.0rc3
• jquery.dynatree.js V1.0.2
• jquery.ribbon.js
• jquery.jqGrid.js V3.8.1 (with minor changes to make in RESTful)
• jquery.mobile.js 1.0a2
• jquery.jqtouch.js V1.0b2

This library requires Compass.

jRails, jQuery and jQuery.UI including themes

Use compass to install the jRails, jQuery and jQuery.UI javascript library including themes into your project.

For jQuery:

compass install [-r jquery] jquery/jrails 

You will find all the stylesheets in easy-to-read Sass format at:

stylesheets/jquery.ui

To use the localized stylesheets and javacripts for jQuery include (using the rails_xss plugin):

= stylesheet_link_tag "compiled/jquery/ui/[theme].css", :media => 'screen, projection'
= javascript_include_tag :defaults
= raw jrails_javascripts(I18n.locale)

alternatively you can include:

= stylesheet_link_tag “compiled/jquery/ui/[theme].css”, :media => ‘screen, projection’

= javascript_include_tag :jquery_ui

= javascript_include_tag :jrails

= raw jrails_javascripts(I18n.locale)

into your layouts.

jQuery TOOLS

Use compass to install the jQuery TOOLS javascript library into your project.

compass install [-r jquery] jquery/tools <project name>

To use the javacripts include:

= javascript_include_tag :tools

jQuery Dynatree Plugin

Use compass to install the jQuery Dynatree javascript library into your project.

compass install [-r jquery] jquery/dynatree <project name>

You will find all the stylesheets in easy-to-read Sass format at:

stylesheets/jquery.ui

To use the localized stylesheets and javacripts include:

= stylesheet_link_tag 'compiled/jquery/dynatree/[skin].css', :media => 'screen, projection'
= javascript_include_tag :dynatree

jQuery jsTree Plugin

Use compass to install the jQuery jsTree javascript library into your project.

compass install [-r jquery] jquery/jstree <project name>

You will find all the stylesheets in easy-to-read Sass format at:

stylesheets/jquery.ui

To use the localized stylesheets and javacripts include:

= stylesheet_link_tag 'compiled/jquery/jstree/[theme].css', :media => 'screen, projection'
= javascript_include_tag :jstree

jQuery Ribbon Plugin

Use compass to install the jQuery Ribbon javascript library into your project.

compass install [-r jquery] jquery/ribbon <project name>

You will find all the stylesheets in easy-to-read Sass format at:

stylesheets/jquery.ui

To use the localized stylesheets and javacripts include:

= stylesheet_link_tag 'compiled/jquery/ribbon/[theme].css', :media => 'screen, projection'
= javascript_include_tag :ribbon

jqGrid

Use compass to install the jqGrid javascript library into your project.

compass install [-r jquery] jquery/jqgrid <project name>

You will find the jqGrid stylesheet in easy-to-read Sass format at:

stylesheets/jquery.ui

To use the localized stylesheets and javacripts include:

= stylesheet_link_tag 'compiled/jquery/jqGrid.css', :media => 'screen, projection'
= raw jqgrid_javascripts(I18n.locale)

Secret Sauce

Use compass to install the Secret Sauce for jqGrid javascript library into your project.

compass install [-r jquery] jquery/secret_sauce <project name>

You will find all the stylesheets in easy-to-read Sass format.

stylesheets/jquery.ui

To use the localized stylesheets and javacripts include:

= stylesheet_link_tag 'compiled/jquery/secret_sauce.css', :media => 'screen, projection'
= javascript_include_tag :secret_sauce

jquery.ical

Use compass to install the jquery.ical javascript library into your project.

compass install [-r jquery] jquery/ical <project name>

You will find all the stylesheets in easy-to-read Sass format.

stylesheets/jquery.ui

To use the (localized) stylesheets and javacripts include:

  = stylesheet_link_tag 'compiled/jquery/ical.css', :media => 'screen, projection'
  = javascript_include_tag :ical

Emulators

Use compass to install the emulator stylesheets and fullsize images for iPhone and iPad into your project.

compass install [-r jquery] jquery/emulators <project name>

You will find all the stylesheets in easy-to-read Sass format at:

stylesheets/emulators

To use the localized stylesheets and javacripts include:

= stylesheet_link_tag 'compiled/emulators/ipad.landscape.css', :media => 'screen, projection'
= stylesheet_link_tag 'compiled/emulators/iphone.portrait.css', :media => 'screen, projection'

jQuery mobile

Use compass to install the jQuery mobile javascript library and themes into your project.

compass install [-r jquery] jquery/mobile <project name>

You will find all the stylesheets in easy-to-read Sass format at:

stylesheets/mobile

To use the localized stylesheets and javacripts include:

= stylesheet_link_tag "compiled/jquery/mobile/[theme].css", :media => 'screen, projection'
= javascript_include_tag :mobile'

jQTouch

Use compass to install the jQTouch javascript library into your project.

compass install [-r jquery] jquery/jqtouch <project name>

You will find all the stylesheets in easy-to-read Sass format at:

stylesheets/jqtouch

To use the localized stylesheets and javacripts include:

= stylesheet_link_tag 'compiled/jquery/touch/[theme].css', :media => 'screen, projection'
= javascript_include_tag :jqtouch'

Thanks to the Contributors:

Rails

• aaron for jRails
• David Turnbull for compass-jquery
• Jonathan Linowes for gridify
• ahe for 2dc_jqgrid
• scrubber for jquery_grid_for_rails
• ariesroyaal for secret_sauce now at.
• Ryan Heath for pretty_flash

jQuery Plugins included

• Chris Domigan for jQuery ContextMenu Plugin
• Kalus Hartl for jQuery Cookie Plugin
• Martin Wendt for jQuery Dynatree Plugin
• John Reisig et. al. for jQuery Form Plugin
• Tony Tomov for jQuery Grid Plugin
• Tim Caswell for jQuery haml Plugin
• Ivan Bozhanov for jQuery jsTree Plugin
• Fabrizio Balliano and Fabrizio Balliano for jQuery Layout Plugin
• Andreas Eberhard for jQuery PngFix Plugin
• Mikael Soederstroem for jQuery Ribbon Plugin
• Gareth Watts from Splunk Inc for jQuery Sparklines plugin
• Denis Howlett for jQuery Table Drag and Drop Plugin
• John Reisig et. al. for jQuery Templating Plugin
• Juan G. Hurtado for jQuery TOOLS
• Michael Aufreiter for jQuery UI Multiselect Plugin

• David Kaneda for jQTouch
• Andrew M Andrews III for Any+Time
• Steven Wittens for Farbtastic Colorpicker plugin
• Adam Shaw for FullCalendar

Other stuff included

• Tim Caswell for halm-js Server side templating language for JavaScript
• Rick DeNatale for ri_cal

Note on Patches/Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Add tests for it. This is important so I don’t break it in a
  future version unintentionally.
• Commit, do not mess with rakefile, version, or history.
  (if you want to have your own version, that is fine but
  bump version in a commit by itself I can ignore when I pull)
• Send me a pull request. Bonus points for topic branches.

Copyright

Copyright © 2009-2010 Kosmas Schuetz. See LICENSE for details.