Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhaynikam/page_piling_rails
Create a scrolling pile of sections.
https://github.com/abhaynikam/page_piling_rails
Last synced: about 2 months ago
JSON representation
Create a scrolling pile of sections.
- Host: GitHub
- URL: https://github.com/abhaynikam/page_piling_rails
- Owner: abhaynikam
- License: mit
- Created: 2016-12-25T14:46:11.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-25T20:18:53.000Z (about 8 years ago)
- Last Synced: 2024-10-23T10:41:59.306Z (3 months ago)
- Language: Ruby
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PagePilingRails
- [Live demo](http://alvarotrigo.com/pagePiling/)
- [Page Piling JS](https://github.com/alvarotrigo/pagePiling.js/)
[](https://rubygems.org/gems/page_piling_rails)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'page_piling_rails'
```
And then execute:
$ bundle
And then execute:
$ bundle exec rails generate page_piling_rails:install
If rake task fails to require the js,
Add this line to your applications's `app/assets/javascripts/application.js`
```
//= require jquery.pagepiling.min.js
```
and also add this line to your applications's `app/assets/stylesheets/application.css`
```
*= require jquery.pagepiling.css
```
Or install it yourself as:
$ gem install page_piling_rails
## Required HTML structure
Each section will be defined with a `div` containing the `section` class.
The active section by default will be the first section, which is taken as the home page.
```html
Some section
Some section
Some section
Some section
```
## Initialization
All you need to do is call the plugin inside a `$(document).ready` function:
```javascript
$(document).ready(function() {
$('#pagepiling').pagepiling();
});
```
## Example:
```javascript
$('#pagepiling').pagepiling({
sectionsColor: ['#f2f2f2', '#4BBFC3', '#7BAABE', 'whitesmoke', '#000'],
});
```
## Options
For more options checkout - [Page Piling JS](https://github.com/alvarotrigo/pagePiling.js/)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/page_piling_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).