Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Plugin adds jQuery to compass framework.

This branch is 97 commits behind kosmas58:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
gem_tasks
lib
spec
src
templates
.gitignore
.loadpath
.project
Gemfile
LICENSE.md
README.md
Rakefile
VERSION.yml
compass-jquery-plugin.gemspec

README.md

compass-jquery-plugin

Get gem from Gemcutter.

Get source from github.

Get example application showing everything live from github.

Description

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

  • jquery-rails with jQuery 1.6.1 and jQuery.UI 1.8.13 including themes
  • jQuery Tools 1.2.5
  • jquery.jstree.js V1.0rc3
  • jquery.dynatree.js V1.1.1
  • jquery.ribbon.js
  • jquery.jqGrid.js V4.0 (with minor changes to make it RESTful)
  • jquery.tinymce.js V3.4

and for mobile devices (using pure haml/sass without compass):

  • jquery.mobile.js 1.0a4.1
  • jquery.jqtouch.js V1.0b3

This library requires Compass.

For the moment this plugin supports Rails 2.3.

An upgrade to Rails 3.x is planned, but depends on the upgrade of compass which actually has alpha state.

Hint: When trying to build the gem under Windows, bundler can't locate the rakefile. Apply the patch from Arve Knudsen to fix it.

jquery-rails, jQuery and jQuery.UI including themes

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

For jQuery:

compass install [-r jquery] jquery/jquery 

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 :jquery_ui
= javascript_include_tag :jrails
= raw jquery_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 

To use the javascripts 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 

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

stylesheets/jquery/ui

To use the stylesheets and javascripts include:

= stylesheet_link_tag :dynatree_[skin], :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 

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

stylesheets/jquery/ui

To use the stylesheets and javascripts include:

= stylesheet_link_tag :jstree_[theme], :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 

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

stylesheets/jquery/ui

To use the stylesheets and javascripts include:

= stylesheet_link_tag :ribbon_[theme], :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 

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

stylesheets/jquery/ui

To use the stylesheets and javascripts include:

= stylesheet_link_tag :jqGrid, :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 

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

stylesheets/jquery/ui

To use the stylesheets and javascripts include:

= stylesheet_link_tag :secret_sauce, :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 

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

stylesheets/jquery/ui

To use the stylesheets and javacripts include:

  = stylesheet_link_tag :ical, :media => 'screen, projection'
  = javascript_include_tag :ical

jQuery TinyMCE Plugin

Use compass to install the jQuery TinyMCE Javascript WYSIWYG Editor into your project.

compass install [-r jquery] jquery/tiny_mce 

To use the javascripts include:

= javascript_include_tag :tiny_mce

jQuery markItUp! Plugin

Use compass to install the jQuery markItUp! Editor J into your project.

compass install [-r jquery] jquery/markitup 

To use the javascripts include:

= javascript_include_tag :markitup

Graphics

Use compass to install the jquery.ganttView, jquery.highcharts and jquery.sparklines javascript libraries into your project.

compass install [-r jquery] jquery/graphics 

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

stylesheets/jquery/ui

To use the stylesheets and javascripts include:

  = stylesheet_link_tag :ganttView', :media => 'screen, projection'
  = javascript_include_tag :ganttView
  = javascript_include_tag :highcharts
  = javascript_include_tag :sparkline

Emulators

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

compass install [-r jquery] jquery/emulators 

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

stylesheets/emulators

To use the stylesheets and javacripts include:

= stylesheet_link_tag :ipad_landscape, :media => 'screen, projection'
= stylesheet_link_tag :iphone_portrait, :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 

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

stylesheets/mobile

To use the stylesheets and javascripts include:

= stylesheet_link_tag :mobile_[theme], :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 

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

stylesheets/jqtouch

To use the stylesheets and javascripts include:

= stylesheet_link_tag :jqt_[theme], :media => 'screen, projection'
= javascript_include_tag :jqtouch'

Thanks to the Contributors:

Rails:

jQuery Plugins included:

Other stuff included:

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-2011 Kosmas Schuetz. See LICENSE for details.

Something went wrong with that request. Please try again.