This repository has been archived by the owner on May 11, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 72c59ad
Showing
17 changed files
with
896 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Automatically normalize line endings for all text-based files | ||
* text=auto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
bower_components | ||
node_modules | ||
coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{ | ||
"node": true, | ||
"browser": true, | ||
"esnext": true, | ||
"bitwise": true, | ||
"camelcase": true, | ||
"curly": true, | ||
"eqeqeq": true, | ||
"immed": true, | ||
"indent": 2, | ||
"latedef": false, | ||
"newcap": true, | ||
"noarg": true, | ||
"quotmark": "single", | ||
"regexp": true, | ||
"smarttabs": true, | ||
"strict": true, | ||
"trailing": true, | ||
"undef": true, | ||
"unused": true, | ||
"validthis": true, | ||
"predef": [ | ||
"$", | ||
"jQuery", | ||
"before", | ||
"beforeEach", | ||
"define", | ||
"describe", | ||
"describeComponent", | ||
"describeMixin", | ||
"expect", | ||
"it", | ||
"jasmine", | ||
"readFixtures", | ||
"requirejs", | ||
"setupComponent", | ||
"spyOnEvent" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
language: node_js | ||
node_js: | ||
- "0.10" | ||
before_script: | ||
- npm install -g bower grunt-cli | ||
- bower install | ||
after_script: | ||
- grunt coveralls |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
# Contributing to flight-scrollspy | ||
|
||
Please take a moment to review this document in order to make the contribution | ||
process easy and effective for everyone involved. | ||
|
||
Following these guidelines helps to communicate that you respect the time of | ||
the developers managing and developing this open source project. In return, | ||
they should reciprocate that respect in addressing your issue or assessing | ||
patches and features. | ||
|
||
## Using the issue tracker | ||
|
||
The issue tracker is the preferred channel for [bug reports](#bugs), | ||
[features requests](#features) and [submitting pull | ||
requests](#pull-requests), but please respect the following restrictions: | ||
|
||
* Please **do not** use the issue tracker for personal support requests. | ||
|
||
* Please **do not** derail or troll issues. Keep the discussion on topic and | ||
respect the opinions of others. | ||
|
||
|
||
<a name="bugs"></a> | ||
## Bug reports | ||
|
||
A bug is a _demonstrable problem_ that is caused by the code in the repository. | ||
Good bug reports are extremely helpful - thank you! | ||
|
||
Guidelines for bug reports: | ||
|
||
1. **Use the issue search** — check if the issue has already been | ||
reported. | ||
|
||
2. **Check if the issue has been fixed** — try to reproduce it using the | ||
latest `master` or development branch in the repository. | ||
|
||
3. **Isolate the problem** – create a live example of a [reduced test | ||
case](http://css-tricks.com/6263-reduced-test-cases/). | ||
|
||
A good bug report shouldn't leave others needing to chase you up for more | ||
information. Please try to be as detailed as possible in your report. What is | ||
your environment? What steps will reproduce the issue? What browser(s) and OS | ||
experience the problem? What would you expect to be the outcome? All these | ||
details will help people to fix any potential bugs. | ||
|
||
Example: | ||
|
||
> Short and descriptive example bug report title | ||
> | ||
> A summary of the issue and the browser/OS environment in which it occurs. If | ||
> suitable, include the steps required to reproduce the bug. | ||
> | ||
> 1. This is the first step | ||
> 2. This is the second step | ||
> 3. Further steps, etc. | ||
> | ||
> `<url>` - a link to the reduced test case | ||
> | ||
> Any other information you want to share that is relevant to the issue being | ||
> reported. This might include the lines of code that you have identified as | ||
> causing the bug, and potential solutions (and your opinions on their | ||
> merits). | ||
|
||
<a name="features"></a> | ||
## Feature requests | ||
|
||
Feature requests are welcome. But take a moment to find out whether your idea | ||
fits with the scope and aims of the project. It's up to *you* to make a strong | ||
case to convince the project's developers of the merits of this feature. Please | ||
provide as much detail and context as possible. | ||
|
||
|
||
<a name="pull-requests"></a> | ||
## Pull requests | ||
|
||
Good pull requests - patches, improvements, new features - are a fantastic | ||
help. They should remain focused in scope and avoid containing unrelated | ||
commits. | ||
|
||
**Please ask first** before embarking on any significant pull request (e.g. | ||
implementing features, refactoring code, porting to a different language), | ||
otherwise you risk spending a lot of time working on something that the | ||
project's developers might not want to merge into the project. | ||
|
||
Please adhere to the coding conventions used throughout a project (indentation, | ||
accurate comments, etc.) and any other requirements (such as test coverage). | ||
|
||
Adhering to the following this process is the best way to get your work | ||
included in the project: | ||
|
||
1. If you do not have permissions to push to the upstream remote origin, | ||
[fork](http://help.github.com/fork-a-repo/) the project, clone your fork, | ||
and configure the remotes: | ||
|
||
```bash | ||
# Clone your fork of the repo into the current directory | ||
git clone <git-forked-repo-url> | ||
# Navigate to the newly cloned directory | ||
cd <repo-name> | ||
# Assign the original repo to a remote called "upstream" | ||
git remote add upstream <git-upstream-repo-url> | ||
``` | ||
|
||
2. If you cloned a while ago, get the latest changes from upstream: | ||
|
||
```bash | ||
git checkout <dev-branch> | ||
git pull upstream <dev-branch> | ||
``` | ||
|
||
3. Create a new topic branch (off the main project development branch) to | ||
contain your feature, change, or fix: | ||
|
||
```bash | ||
git checkout -b <topic-branch-name> | ||
``` | ||
|
||
4. Commit your changes in logical chunks. Please adhere to these [git commit | ||
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) | ||
or your code is unlikely be merged into the main project. Use Git's | ||
[interactive rebase](https://help.github.com/articles/interactive-rebase) | ||
feature to tidy up your commits before making them public. | ||
|
||
5. Locally merge (or rebase) the upstream development branch into your topic branch: | ||
|
||
```bash | ||
git pull [--rebase] upstream <dev-branch> | ||
``` | ||
|
||
6. Push your topic branch up to your fork: | ||
|
||
```bash | ||
git push origin <topic-branch-name> | ||
``` | ||
|
||
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) | ||
with a clear title and description. | ||
|
||
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to | ||
license your work under the same license as that used by the project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
module.exports = function (grunt) { | ||
'use strict'; | ||
|
||
require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks); | ||
|
||
grunt.initConfig({ | ||
bump: { | ||
options: { | ||
files: [ | ||
'package.json', | ||
'bower.json' | ||
], | ||
commit: true, | ||
commitMessage: 'v%VERSION%', | ||
commitFiles: ['-a'], | ||
createTag: true, | ||
tagName: 'v%VERSION%', | ||
tagMessage: 'v%VERSION%', | ||
push: true, | ||
pushTo: 'origin', | ||
gitDescribeOptions: '--tags --always --abbrev=1 --dirty=-d' | ||
} | ||
}, | ||
coveralls: { | ||
options: { | ||
'coverage_dir': 'coverage' | ||
} | ||
} | ||
}); | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright (c) 2014 Björn Andersson | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# flight-scrollspy | ||
|
||
[![Build Status](https://travis-ci.org/gaqzi/flight-scrollspy.png)](http://travis-ci.org/gaqzi/flight-scrollspy) | ||
[![Coverage Status](https://coveralls.io/repos/gaqzi/flight-scrollspy/badge.png)](https://coveralls.io/r/gaqzi/flight-scrollspy) | ||
|
||
A [Flight](https://github.com/flightjs/flight) component for | ||
triggering events when an element is scrolled into view. | ||
|
||
This component was originally built to be able to handle infinity scroll. | ||
|
||
## Installation | ||
|
||
```bash | ||
bower install --save flight-scrollspy | ||
``` | ||
|
||
## Example | ||
|
||
```js | ||
define(function(require) { | ||
'use strict'; | ||
|
||
var scrollSpy = require('flight-scrollspy/lib/scrollspy'); | ||
|
||
return page; | ||
|
||
function page() { | ||
scrollSpy.attachTo('body', { | ||
throttle: 200 // ms, the default is 100ms. | ||
}); | ||
} | ||
}); | ||
|
||
define(function(require) { | ||
var defineComponent = require('flight/lib/component'), | ||
withSpy = require('flight-scrollspy/lib/with_spy'); | ||
|
||
return defineComponent(infiniteScroll, withSpy); | ||
|
||
function infiniteScroll() { | ||
this.fetchMoreComments = function( { ... }; | ||
|
||
this.after('initialize', function() { | ||
this.addSpy('.last-comment', {once: true}) | ||
this.on('uiSpied', this.fetchMoreComments); | ||
|
||
// this.removeSpy('.last-comment'); | ||
}); | ||
} | ||
}); | ||
``` | ||
|
||
## Events | ||
|
||
* `uiScrolled` all the positions of the node element. Top, right, bottom and left | ||
* `uiSpied` when a target element is seen within the viewport | ||
* `addedSpy` when a new spy target is added | ||
* `removedSpy` when a spy target is removed | ||
* `spiesRefreshed` when the spies offsets has been updated after a window resize | ||
|
||
## Development | ||
|
||
Development of this component requires [Bower](http://bower.io) to be globally | ||
installed: | ||
|
||
```bash | ||
npm install -g bower | ||
``` | ||
|
||
Then install the Node.js and client-side dependencies by running the following | ||
commands in the repo's root directory. | ||
|
||
```bash | ||
npm install & bower install flight-scrollspy | ||
``` | ||
|
||
To continuously run the tests in Chrome during development, just run: | ||
|
||
```bash | ||
npm run watch-test | ||
``` | ||
|
||
## Contributing to this project | ||
|
||
Anyone and everyone is welcome to contribute. Please take a moment to | ||
review the [guidelines for contributing](CONTRIBUTING.md). | ||
|
||
* [Bug reports](CONTRIBUTING.md#bugs) | ||
* [Feature requests](CONTRIBUTING.md#features) | ||
* [Pull requests](CONTRIBUTING.md#pull-requests) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"name": "flight-scrollspy", | ||
"version": "1.0.0-alpha", | ||
"main": "lib/scrollspy.js", | ||
"dependencies": { | ||
"flight": "~1.1.0" | ||
}, | ||
"devDependencies": { | ||
"jasmine-flight": "~2.2.0" | ||
}, | ||
"ignore": [ | ||
".gitignore", | ||
".gitattributes", | ||
".travis.yml", | ||
"CONTRIBUTING.md", | ||
"CHANGELOG.md", | ||
"test", | ||
"package.json", | ||
"karma.conf.js", | ||
"Gruntfile.js" | ||
] | ||
} |
Oops, something went wrong.