A generic pagination helper for ember applications
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
public
tests
vendor
.bowerrc
.editorconfig
.ember-cli
.gitignore
.jshintrc
.travis.yml
Brocfile.js
README.md
bower.json
package.json
testem.json

README.md

Generic Ember pagination

This is a regular ember-cli applicaiton, so all the goodies applies.

To use the generic pagination helper you must do the following steps.

Extend your route from the PaginatedBase object

Also initiate your route calling _super with the intended model name to be fetched and paginated.

// please note that the path for the pagination dependency might be different
// according with the folder that the dependency will be requested from
// this assumes that this file is in the routes/ folder
import PaginationBase from './pagination-base';

export default PaginationBase.extend({
  init: function(){
    this._super('myModelName');
  }
  // continuation of your route
});

Note that with that you will not need to create the model hook yourself, but if you need to extend it for some reason just call _super and receive the return of that. Like so:

  model: function(){
    myModel = this._super();
    // my extra logic

    return myModel;
  }

Use the Paginated mixin in your controller

Also, create the total computed property for total, to be used to calculate the total number of pages for your model data.

// please note that the path for the pagination dependency might be different
// according with the folder that the dependency will be requested from
// this assumes that this file is in the controllers/ folder
import Paginated from '../mixins/paginated';

export default Ember.ArrayController.extend(Paginated, {
  total: function(){
    return this.store.metadataFor('yourModelName').total;
  }.property('model'),
  // continuation of your controller
});

Fixtures in use...

The PaginationBase route assumes that you will have the application adapter using fixtures. So if you want that your fixtures are able to paginate see how it is being done in /blob/master/app/adapters/application.js. If your backend already supports pagination, just remove the following code from the PaginationBase route:

    // Set's the metaForType manually, on your backend api you would have it
    // like it's documented: http://emberjs.com/guides/models/handling-metadata/
    // once you have the api in place just remove this bit
    this.store.find(this.get('domain')).then(function(that){
      return function(completeList){
        that.store.metaForType(that.get('domain'), {total:completeList.get('length')});
      };
    }(this));

If you are going to build your backend pagination to be used here, please head on to http://emberjs.com/guides/models/handling-metadata/ and http://emberjs.com/guides/models/the-rest-adapter/ to make sure your response follows the expected format. Another resource when building JSON APIs: http://jsonapi.org/

Prerequisites

You will need the following things properly installed on your computer.

Installation

  • git clone <repository-url> this repository
  • change into the new directory
  • npm install
  • bower install

Running / Development