scrollinity 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/Gemfile +3 -0
- data/LICENSE.txt +22 -0
- data/README.md +48 -0
- data/Rakefile +1 -0
- data/lib/scrollinity/version.rb +3 -0
- data/lib/scrollinity.rb +8 -0
- data/scrollinity.gemspec +23 -0
- data/vendor/assets/javascripts/scrollinity.js +39 -0
- metadata +88 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 HeeL
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
# Scrollinity
|
2
|
+
|
3
|
+
Add effect of infinite scroll on the page. Good replacement for traditional pagination.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'scrollinity'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install scrollinity
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
You have to require the scrollinity js file in your application.js manifest:
|
22
|
+
|
23
|
+
```javascript
|
24
|
+
//= require scrollinity
|
25
|
+
```
|
26
|
+
|
27
|
+
On the page where you want to use the infinite scroll, you have to define some required variables. To do that, you have to set the data attributes to the element. Here is an example of such a page:
|
28
|
+
|
29
|
+
```
|
30
|
+
<div data-scrollinity-loading-pic="1" style="display: none">Loading...</div>
|
31
|
+
|
32
|
+
<div data-scrollinity-data-container="load_here" data-scrollinity-bottom-px-limit="50" data-scrollinity-path="/path/to/get/new/data">
|
33
|
+
|
34
|
+
<div id="load_here"></div>
|
35
|
+
```
|
36
|
+
|
37
|
+
`data-scrollinity-loading-pic` - define the element that should appear when user is waiting for the server response. Normally that would be an image with a spinning wheel.
|
38
|
+
|
39
|
+
`data-scrollinity-data-container` - define the id of the element to which the response from the server will be appended. In the example above, we load coming data to the div with an id "load_here".
|
40
|
+
|
41
|
+
`data-scrollinity-bottom-px-limit` - define the distance to the bottom of the page in pixels when should we start to load new data.
|
42
|
+
|
43
|
+
`data-scrollinity-path` - path to remote that will recieve an ajax call and return some data that will be appended.
|
44
|
+
|
45
|
+
|
46
|
+
## Sample Application
|
47
|
+
|
48
|
+
You can find a sample application written on Rails 4 to demonstrate how the gem can be used: https://github.com/HeeL/scrollinity_sample_app
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/lib/scrollinity.rb
ADDED
data/scrollinity.gemspec
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'scrollinity/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "scrollinity"
|
8
|
+
spec.version = Scrollinity::VERSION
|
9
|
+
spec.authors = ["HeeL"]
|
10
|
+
spec.email = ["parizhskiy@gmail.com"]
|
11
|
+
spec.description = %q{Add effect of infinite scroll on the page. Good replacement for traditional pagination.}
|
12
|
+
spec.summary = %q{Add effect of infinite scroll on the page}
|
13
|
+
spec.homepage = "https://github.com/HeeL/scrollinity"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
$(document).ready(function(){
|
2
|
+
if($('*[data-scrollinity-path]').length > 0) {
|
3
|
+
var page_num = 1
|
4
|
+
load_path = $('*[data-scrollinity-path]').data('scrollinity-path');
|
5
|
+
loading_pic = $('*[data-scrollinity-loading-pic]');
|
6
|
+
data_container = $('#' + $('*[data-scrollinity-data-container]').data('scrollinity-data-container'));
|
7
|
+
bottom_px_limit = $('*[data-scrollinity-bottom-px-limit]').data('scrollinity-bottom-px-limit');
|
8
|
+
|
9
|
+
$(window).on('scroll', function(){
|
10
|
+
if(loading_hidden() && near_bottom()) {
|
11
|
+
if(page_num > 0) {
|
12
|
+
loading_pic.show();
|
13
|
+
load_new_items();
|
14
|
+
}
|
15
|
+
}
|
16
|
+
});
|
17
|
+
|
18
|
+
function load_new_items(){
|
19
|
+
sign = load_path.indexOf('?') >= 0 ? '&' : '?'
|
20
|
+
$.get(load_path + sign + 'page=' + (++page_num), function(data, e) {
|
21
|
+
if(data.length < 5) {
|
22
|
+
page_num = 0;
|
23
|
+
return false;
|
24
|
+
}
|
25
|
+
data_container.append(data);
|
26
|
+
}).complete(function() {
|
27
|
+
loading_pic.hide();
|
28
|
+
});
|
29
|
+
}
|
30
|
+
|
31
|
+
function loading_hidden(){
|
32
|
+
return !loading_pic.is(':visible');
|
33
|
+
}
|
34
|
+
|
35
|
+
function near_bottom(){
|
36
|
+
return $(window).scrollTop() > $(document).height() - $(window).height() - bottom_px_limit;
|
37
|
+
}
|
38
|
+
}
|
39
|
+
});
|
metadata
ADDED
@@ -0,0 +1,88 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: scrollinity
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- HeeL
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-11-29 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.3'
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '1.3'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: rake
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
description: Add effect of infinite scroll on the page. Good replacement for traditional
|
47
|
+
pagination.
|
48
|
+
email:
|
49
|
+
- parizhskiy@gmail.com
|
50
|
+
executables: []
|
51
|
+
extensions: []
|
52
|
+
extra_rdoc_files: []
|
53
|
+
files:
|
54
|
+
- .gitignore
|
55
|
+
- Gemfile
|
56
|
+
- LICENSE.txt
|
57
|
+
- README.md
|
58
|
+
- Rakefile
|
59
|
+
- lib/scrollinity.rb
|
60
|
+
- lib/scrollinity/version.rb
|
61
|
+
- scrollinity.gemspec
|
62
|
+
- vendor/assets/javascripts/scrollinity.js
|
63
|
+
homepage: https://github.com/HeeL/scrollinity
|
64
|
+
licenses:
|
65
|
+
- MIT
|
66
|
+
post_install_message:
|
67
|
+
rdoc_options: []
|
68
|
+
require_paths:
|
69
|
+
- lib
|
70
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
71
|
+
none: false
|
72
|
+
requirements:
|
73
|
+
- - ! '>='
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
77
|
+
none: false
|
78
|
+
requirements:
|
79
|
+
- - ! '>='
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '0'
|
82
|
+
requirements: []
|
83
|
+
rubyforge_project:
|
84
|
+
rubygems_version: 1.8.23
|
85
|
+
signing_key:
|
86
|
+
specification_version: 3
|
87
|
+
summary: Add effect of infinite scroll on the page
|
88
|
+
test_files: []
|