Skip to content

Commit

Permalink
Update structure, add bower.json
Browse files Browse the repository at this point in the history
  • Loading branch information
shira-374 committed May 23, 2014
1 parent 4c8e3fc commit 74613ba
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 29 deletions.
42 changes: 18 additions & 24 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# jQuery ScrollWatch 1.3
# jQuery ScrollWatch

jQuery plugin to implement navigation or any other functionality based on current scrolling position of the page or inside a custom element.

See [demo.html](demo.html) for an example.
See `demo.html` for an example.

## Functionality

Expand All @@ -16,13 +16,7 @@ Tested in Mozilla Firefox, Google Chrome, Safari, Opera and MSIE 7+

## Known limitations

- hash links between different instances are not fully supported (yet)



----------


- hash links between different instances are not fully supported

## Usage

Expand Down Expand Up @@ -98,14 +92,14 @@ Both `$().scrollWatch()` and `$().scrollWatchMenu()` return an object with follo
<th>Description</th>
</tr>
</thead>

<tbody>
<tr>
<th>scroller</th>
<td>window</td>
<td>Element to watch for scrolling events (must have <code>position: relative or absolute</code> if not window)</td>
</tr>

<tr>
<th>resolutionMode</th>
<td>0</td>
Expand All @@ -120,11 +114,11 @@ Both `$().scrollWatch()` and `$().scrollWatchMenu()` return an object with follo
</ul>
</td>
</tr>

<tr>
<th>callback</th>
<td>required</td>

<td>
Callback invoked when the focus is updated. It is passed three arguments: <ol>
<li>
Expand All @@ -149,7 +143,7 @@ Both `$().scrollWatch()` and `$().scrollWatchMenu()` return an object with follo
</li>
</ul>
</li>

<li>
top coordinate of the view
</li>
Expand All @@ -159,7 +153,7 @@ Both `$().scrollWatch()` and `$().scrollWatchMenu()` return an object with follo
</ol>
</td>
</tr>

<tr>
<th>focusRatio</th>
<td>0.3819..</td>
Expand All @@ -179,25 +173,25 @@ Both `$().scrollWatch()` and `$().scrollWatchMenu()` return an object with follo
<td>false</td>
<td>Display position of the focus line (for debugging purposes).</td>
</tr>

<tr>
<th>topDownWeight</th>
<td>0</td>
<td>Extra focus height added to the section if it preceedes the other (used in **resolutionMode** 0 only).</td>
</tr>

<tr>
<th>viewMarginTop</th>
<td>0</td>
<td>Height of an area at the top of the view to be excluded (e.g. a fixed navigation menu).</td>
</tr>

<tr>
<th>viewMarginBottom</th>
<td>0</td>
<td>Height of an area at the bottom of the view to be excluded (e.g. a fixed navigation menu).</td>
</tr>

<tr>
<th>multiMode</th>
<td>false</td>
Expand All @@ -218,20 +212,20 @@ These options are active only when `$().scrollWatchMenu()` is used.
<th>Description</th>
</tr>
</thead>

<tbody>
<tr>
<th>menuActiveClass</th>
<td>active</td>
<td>Class of the active menu item.</td>
</tr>

<tr>
<th>menuItemSelector</th>
<td>*</td>
<td>Selector to match menu items, <code>*</code> matches all direct children of the menu element.</td>
</tr>

<tr>
<th>menuWindowScrollOffset</th>
<td>0</td>
Expand All @@ -243,7 +237,7 @@ These options are active only when `$().scrollWatchMenu()` is used.
<td>0</td>
<td>Scroll offset applied to the scroller (not window) when a menu link containing a hash is clicked.</td>
</tr>

<tr>
<th>menuScrollSpeed</th>
<td>500</td>
Expand All @@ -267,7 +261,7 @@ These options are active only when `$().scrollWatchMenu()` is used.
<td>true</td>
<td>Handle scroll offset when loading the page.</td>
</tr>

<tr>
<th>menuInitialHashOffsetTolerance</th>
<td>40</td>
Expand Down
21 changes: 21 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "jquery-scrollwatch",
"description": "jQuery plugin to implement navigation or any other functionality based on current scrolling position of the page or inside a custom element.",
"version": "1.0.0",
"keywords": [
"js",
"jquery",
"scroll",
"watch"
],
"main": [
"src/jquery.scrollwatch.js"
],
"ignore": [
".*",
"src/demo.html"
],
"dependencies": {
"jquery": ">= 1.9.0"
}
}
5 changes: 0 additions & 5 deletions jquery.scrollwatch.min.js

This file was deleted.

File renamed without changes.
File renamed without changes.

0 comments on commit 74613ba

Please sign in to comment.