Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bradleftley/ember-scroll-spy

Scroll spy for Ember.js
https://github.com/bradleftley/ember-scroll-spy

ember ember-scroll-spy viewport

Last synced: 19 days ago
JSON representation

Scroll spy for Ember.js

Awesome Lists containing this project

README

        

ember-scroll-spy
==============================================================================

Ember scroll spy allows you to easily replicate bootstrap's scroll spy functionality. Based on the anchor being in the viewport the scroll-container with the corresponding Id will be updated with an active class.

Simply pass through the the id to each component and the addon does the rest.

Compatibility
------------------------------------------------------------------------------

* Ember.js v3.16 or above
* Ember CLI v2.13 or above
* Node.js v10 or above

Installation
------------------------------------------------------------------------------

```
ember install ember-scroll-spy
```

Usage
------------------------------------------------------------------------------

In this current version `0.0.6` you have two components an `scroll-container` and an `anchor`.
```


About

```
The id `about` will now be tracked and if it is found in the viewport the corresponding `scroll-container` with the same `id` it will be given an active class in which you can style from.

```



Some content


```
Simply embed the `anchor` into your section, divs or any template and begin adding scroll spy to your apps.

Contributing
------------------------------------------------------------------------------

See the [Contributing](CONTRIBUTING.md) guide for details.

License
------------------------------------------------------------------------------

This project is licensed under the [MIT License](LICENSE.md).