headroom-rails

headroom-rails

Headroom.js is a JS library that makes room on your page, by reacting to the users scroll to hide/display the header.

License: MIT License (just as headroom.js is)

Installation

Add this line to your application's Gemfile:

gem 'headroom-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install headroom-rails

Usage

For CoffeeScript

(jQuery)
#= require _headroom.jquery.js

(Angular)
#= require _headroom.angular.js

For JavaScript

(jQuery)
//= require '_headroom.jquery'

(Angular)
//= require '_headroom.angular'

Contributing

1. Fork it ( https://github.com/tarellel/headroom-rails/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request