Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/instructure/ic-lazy-list

lazily loads remote records
https://github.com/instructure/ic-lazy-list

Last synced: 7 days ago
JSON representation

lazily loads remote records

Awesome Lists containing this project

README

        

ic-lazy-list
============

Lazily loads records from an href as the user scrolls down the page, all
in your template.

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

`npm install ic-lazy-list`

... or ...

`bower install ic-lazy-list`

... or just include `dist/main.js` into your app however you want.

Module Support
--------------

- AMD

`define(['ic-lazy-list'], function() {});`

- Node.JS (CJS)

`require('ic-lazy-list')`

- Globals

`ic.LazyListComponent;`

All instructure canvas stuff lives on the `ic` global.

Usage
-----

Once you've required ic-lazy-list into your application, you can use it
in your templates.

```handlebars
{{#ic-lazy-list
href="http://addressbook-api.herokuapp.com/contacts"
data-key="contacts"
data=contacts
}}


    {{#each contacts}}
  • {{first}} {{last}}

  • {{/each}}

{{/ic-lazy-list}}
```

- `href` - the url to load
- `data-key` - optional, the key in the response your data lives on
- `data` - data-binding, when the data loads it will be bound to
whatever you map it to

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

After cloning this repo, install dependencies:

```sh
$ npm install
$ bower install
```

Fire up the grunt watcher:

```sh
$ grunt
```

Then in a different tab run the tests with testem:

```sh
$ testem
```