# scroll-indicator

**Repository Path**: mirrors_hfeeki/scroll-indicator

## Basic Information

- **Project Name**: scroll-indicator
- **Description**: This repo will no longer be updated. GoInstant will be discontinued as of August 31, 2014. Read our blog for more details.
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/goinstant/scroll-indicator.png?branch=master)](https://travis-ci.org/goinstant/scroll-indicator)

## [Scroll Indicator Widget](https://developers.goinstant.com/v1/widgets/scroll_indicator.html)

The [GoInstant](https://goinstant.com) Scroll Indicator [widget](https://developers.goinstant.com/v1/widgets/index.html)
shows a notification when remote users that you're collaborating with scroll
their browser viewport, and when they're viewing a different part of the page.

![Scroll Indicator](scroll-indicator.png)

[Sign up](https://goinstant.com/signup) and build a GoInstant application today.
You can learn more in our [guides](https://developers.goinstant.com/v1/widgets/guides/index.html),
and [documentation](https://developers.goinstant.com/v1/widgets/scroll_indicator.html).

Have questions? Contact us using [this form](https://goinstant.com/contact) or
chat with us on IRC. #goinstant on [Freenode](http://freenode.net/).

## Packaging
For your convenience, we've packaged the Scroll Indicator widget in several
ways.

#### Using our CDN

We host a copy on our CDN. Have a look at the [docs](https://developers.goinstant.com/v1/widgets/scroll_indicator.html)
to see how to reference those files, as well as how to initialize the component.

#### How do I build the script myself?

You may have your own build process. We've tried to make it easy to include
the Scroll Indicator widget in your build process.

#### Bower

We've packaged the Scroll Indicator widget as a [bower](http://bower.io/)
component.

```
bower install goinstant-scroll-indicator
```

#### Component

We've packaged the Scroll Indicator widget as a [component](http://component.io/).

```
component install goinstant/scroll-indicator
```

## Contributing

### Development Dependencies

- [node.js](http://nodejs.org/) >= 0.8.0
- [grunt-cli installed globally](http://gruntjs.com/getting-started)
  - `npm install -g grunt-cli`

### Set-Up

The following assumes that you have already installed the dependencies above.

```
git clone https://github.com/goinstant/scroll-indicator.git
cd scroll-indicator
npm install
```

#### Building Scroll Indicator for Development

The Scroll Indicator widget is built as a [component](https://github.com/component/component).
Feel free to manually install dependencies and build using the `component`
command line tool.

For convenience, we've included a simple grunt command for installing
component dependencies and building:

```
grunt build
```

If this command runs succesfully you'll now have `components` and `build`
directories in your Git repo root.

### Running Tests

Tests are written in [mocha](http://visionmedia.github.io/mocha/). They're run
in an [HTML file](http://visionmedia.github.io/mocha/#html-reporter).

Just open the test/index.html file to run the tests.

On Mac OS, you can just run this command to open the HTML Runner in your
default browser:

```
open test/index.html
```

### Running Examples

This will open up an example of Scroll Indicator at work, using your local
build.

You should have run `grunt build` already.

#### 1. Copy the example config.

```
cp config/config.example.js config/config.js
```

#### 2. Replace the connectUrl with your GoInstant application's connectUrl.

If you haven't signed up for GoInstant yet, you can [sign up and create an
application here](https://goinstant.com/signup).

After you have an application's `connectUrl` set inside of config.js:

##### config.js

```js
window.config = {
  connectUrl: 'https://goinstant.net/YOUR_ACCOUNT/YOUR_APP',
  room: 'goinstant-widget-examples'
};
```

#### 3. Open the example index and click an example.

```
open examples/index.html
```
## Widgets are built on top of GoInstant

[GoInstant](https://goinstant.com) is an API for integrating realtime,
multi-user functionality into your app. You can check it out and [sign up for free](https://goinstant.com/signup).

## License

© 2013 GoInstant Inc., a salesforce.com company

Licensed under the BSD 3-clause license.