Fermer le menu

Forresst's Blog

Menu

Tri des collections avec Backbone.js et jQuery Mobile

Ceci est une traduction d'un article du blog de CHARIOT Solutions, voici le lien vers la version originale

Dans un précédent article, j'ai fourni un exemple simple de rendu d'une liste HTML utilisant Backbone.js et jQuery Mobile. Le code de cet exemple a fini par rendre une liste comme celle-ci :

Alt "ListView.png"

Notez que la liste est présentée dans l'ordre d'apparition dans le JSON.

 1 [
 2   {
 3     "id":1,
 4     "date": "12/12/2011",
 5     "type": "Run",
 6     "distance": "3 miles",
 7     "comments": "This was really hard",
 8     "minutes": 36
 9   },
10   {
11     "id":2,
12     "date": "12/11/2011",
13     "type": "Bike",
14     "distance": "6 miles",
15     "comments": "All down hill...felt like nothing",
16     "minutes": 30
17   },
18   {
19     "id":3,
20     "date": "12/10/2011",
21     "type": "Walk",
22     "distance": "2.5 miles",
23     "comments": "Shouldn't have taken the dog",
24     "minutes": 45
25   },
26   {
27     "id":4,
28     "date": "12/09/2011",
29     "type": "Run",
30     "distance": "Long",
31     "comments": "Legs felt good",
32     "minutes": 75
33   }
34 ]

Aussi, lorsqu'un élément est ajouté, il s'affiche en bas de la liste. Bien que facile, ce n'est pas le meilleur. Dans cet article, je vais ajouter un tri à la collection Backbone et faire un petit changement à la vue de telle sorte que les nouveaux éléments soient ajoutés et que la liste soit automatiquement triée.

Backbone.js fait ces changements très facilement. D'abord, pour qu'une collection Backbone soit triéé, vous devez mettre en œuvre une méthode comparator sur la collection. Comme les modèles sont ajoutés à la collection, Backbone s'assurera que le tri est maintenue sur la base de l'implémentation de comparator. D'après la documentation Backbone, "les fonctions comparator prennent un modèle et renvoient une valeur numérique ou une chaîne par laquelle le modèle doit être trié par rapport aux autres".

Nous allons trier la liste selon la date de l'activité de l'exercice. Comme comparators doit retourner un nombre ou une chaîne de tri, nous allons retourner le temps en millisecondes depuis le 01/01/70. Notre nouvelle définition de la collection ressemble à ceci :

1 exercise.Activities = Backbone.Collection.extend({
2   model: exercise.Activity,
3   url: "exercise.json",
4   comparator: function(activity){
5     var date = new Date(activity.get('date'));
6     return date.getTime();
7   }
8 });

Si nous rafraichissons notre navigateur avec l'implementation de la collection mise à jour, notez que la liste est maintenant triée par date.

Alt "ListViewSort.png"

Si nous voulions qu'elle soit triée par ordre décroissant, nous aurions tout simplement retourner la valeur négative de la méthode getTime().

Si vous avez essayé d'ajouter une nouvelle activité, vous remarquerez qu'elle se présente à la fin de la liste. Cela est dû au fait que nous avons lier un écouteur (listener) à la méthode add de la collection (ligne 7 ci-dessous), et tout cela est ajouté au HTML à la fin de l'affichage de la liste (ligne 30 ci-dessous).

 1 exercise.ActivityListView = Backbone.View.extend({
 2   tagName: 'ul',
 3   id: 'activities-list',
 4   attributes: {"data-role": 'listview'},
 5 
 6   initialize: function() {
 7     this.collection.bind('add', this.add, this);
 8     this.template = _.template($('#activity-list-item-template').html());
 9   },
10 
11   render: function() {
12     var container = this.options.viewContainer,
13         activities = this.collection,
14         template = this.template,
15         listView = $(this.el);
16 
17     $(this.el).empty();
18     activities.each(function(activity){
19       listView.append(template(activity.toJSON()));
20     });
21     container.html($(this.el));
22     container.trigger('create');
23     return this;
24   },
25 
26   add: function(item) {
27     var activitiesList = $('#activities-list'),
28         template = this.template;
29 
30     activitiesList.append(template(item.toJSON()));
31     activitiesList.listview('refresh');
32   }
33 });

Si vous ouvrez une console JS dans le navigateur et enquêtez sur la collection en entrant

JSON.stringify(exercise.activities)

vous verrez que la collection est triée. Pour corriger la représentation HTML de la collection, tout ce que nous devons faire est de remplacer l'événement add lié à l'appel du render. Ce sera un nouveau rendu HTML basé sur la collection. Nous pouvons aussi retirer la méthode add dans la vue, car elle n'est plus nécessaire. Notre configuration de la vue modifiée ressemble à ceci :

 1 exercise.ActivityListView = Backbone.View.extend({
 2   tagName: 'ul',
 3   id: 'activities-list',
 4   attributes: {"data-role": 'listview'},
 5 
 6   initialize: function() {
 7     this.collection.bind('add', this.render, this);
 8     this.template = _.template($('#activity-list-item-template').html());
 9   },
10 
11   render: function() {
12     var container = this.options.viewContainer,
13         activities = this.collection,
14         template = this.template,
15         listView = $(this.el);
16 
17     $(this.el).empty();
18     activities.each(function(activity){
19       listView.append(template(activity.toJSON()));
20     });
21     container.html($(this.el));
22     container.trigger('create');
23     return this;
24   }
25 });

Après l'actualisation de la vue, la liste continuera à être triée, même lors de l'ajout de nouvelles activités. Comme le code ne fait qu'ajouter un élément avec la date d'aujourd'hui, essayez de taper le texte suivant dans la console JS

exercise.activities.add({id:12, date:"12/01/2011", type:"Interval Run"});

Cela devrait ajouter un élément en haut de la liste. Maintenant, votre liste sera toujours triée.

Le code source peut être trouvé dans mon dépôt git ici. Cette URL vous amène à la branche "sort". La branche principale représente le code d'introduction du billet du blog trouvée ici.


blog comments powered by Disqus
Fork Me