Fermer le menu

Forresst's Blog

Menu

Depuis une liste vers une vue détail en utilisant jQueryMobile et Backbone.js

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

Dans mon précédent article, j'ai construit une application de base pour démontrer l'utilisation de Backbone.js avec jQueryMobile (JQM). L'introduction peut être trouvée ici, et un bref article ultérieure sur le tri des collections ici . Dans cet article, je veut ajouter la possibilité de visualiser le détail des éléments présentés dans la liste.

La première étape consiste à créer une nouvelle page JQM pour afficher la vue du détail. JQM fait cela facilement pour ajouter des pages à votre application. J'ai ajouté le code suivant dans le fichier index.html :

1     <div data-role="page" id="activity-details" data-add-back-btn="true">
2       <div data-role="header">
3         <a href="#" data-role="button" data-icon="arrow-d" id="edit-activity-button" class="ui-btn-right">Edit</a>
4         <h1>Activity Details</h1>
5       </div>
6       <div data-role="content" id="activity-details-content">
7           <!-- the contents of the list view will be rendered via the backbone view -->
8       </div>
9     </div>

Cela va créer la structure de la page, et Backbone.js sera l'utiliser pour remplir le contenu du div basé sur l'enregistrement tapé (ou cliqué) dans la liste. L'étape suivante consiste à définir le template de la vue du détail. C'est le pattern que je suis lors de l'élaboration à l'aide jQueryMobile et Backbone.js. Le template peut être inséré sous le template de la liste d'éléments dans le fichier index.html .

1     <script type="text/template" id="activity-details-template">    
2         <h3><%= type %></h3>
3         <ul data-role="listview" id="activitiy-fields" data-inset="true">
4           <li>Date: <%= date %></li>
5           <li>Minutes: <%= minutes %></li>
6           <li>Distance: <%= distance %></li>
7           <li>Comments: <%= comments %></li>
8         </ul>
9     </script>

J'ai décidé d'intégrer le détail dans une liste en lecture seule, de ce fait, jQueryMobile fournira un peu de style raisonnable. Comme le point ici est de démontrer que Backbone et jQueryMobile jouent ensemble, je ne voulais pas avoir à dépenser beaucoup de temps sur le style :)

Ensuite, nous avons besoin de définir la vue Backbone qui va utiliser le template pour rendre le contenu approprié. Toutes ces vues ont besoin de faire appliquer le modèle dans le template et l'ajouter au conteneur HTML défini lorsque la vue est instanciée.

 1     exercise.ActivityDetailsView = Backbone.View.extend({
 2         //since this template will render inside a div, we don't need to specify a tagname
 3         initialize: function() {
 4             this.template = _.template($('#activity-details-template').html());
 5         },
 6         
 7         render: function() {
 8             var container = this.options.viewContainer,
 9                 activity = this.model,
10                 renderedContent = this.template(this.model.toJSON());
11                 
12             container.html(renderedContent);
13             container.trigger('create');
14             return this;
15         }
16     });

Afin de récupérer le modèle correct à lier à la vue du détail, nous avons besoin de savoir quel enregistrement dans la vue liste a été cliqué (ou tappé). Pour faire cela, nous pouvons lier l'évenement click à l'élément dans la liste. Ceci peut être accompli en modifiant la méthode de rendu de ActivityListView. Voici la version actuelle de la liste :

 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     });

La partie intéressante ici se trouve dans les lignes 18 à20, où l'élément HTML de activity est rendu et ajouté à la liste. C'est là que la modification doit avoir lieu. Chaque élément HTML activity doit être lié à un événement click. Dans cet événement click, l'id de activity devra en quelque sorte être passé à la vue du détail afin que l'affichage appropriée puissent se déclencher. Il y a plusieurs façons de le faire. L'approche que j'ai utilisés dans le passé incluent l'utilisation de jQuery.jqmData(...) ou le stockage locale d'une session (en supposant que nous soyons en HTML5). Dans cet exemple, nous utiliserons la méthode jqmData. L'astuce consiste à capturer l'id lors de rendu de la liste afin qu'il puisse être utilisé pendant l'exécution de l'événement click. Voici les modifications requises aux lignes 18 à 20 du code précédent.

 1 activities.each(function(activity){
 2    var renderedItem = template(activity.toJSON()),
 3        $renderedItem = $(renderedItem);  //convert the html into an jQuery object
 4    $renderedItem.jqmData('activityId', activity.get('id'));  //set the data on it for use in the click event
 5    $renderedItem.bind('click', function(){
 6          //set the activity id on the page element for use in the details pagebeforeshow event
 7         $('#activity-details').jqmData('activityId', $(this).jqmData('activityId'));  //'this' represents the element being clicked
 8    });
 9    listView.append($renderedItem);
10 });

La première chose est de capturer le rendu de l'élément HTML de activity dans une variable et de le mettre dans un objet jQuery, comme on peut le voir dans les lignes 2-3 . La ligne 4 est l'endroit où la donnée id d'activity est attaché à notre élément HTML activity. Ensuite, le bind de l'événement (lignes 5-8) récupère les données attachées et définit l'élément HTML du détail de l'activity, qui est notre HTML de la page détail de activity. D'après la documentation de jQuery, la méthode bind se réfère à l'élément DOM auquel le gestionnaire d'événements est lié. Nous pouvons l'utiliser pour obtenir les données de l'id d'activity et l'attacher à la vue du détail. Cela nous donne la possibilité de passer l'id approprié lors de l'exécution de la page du détail.

Maintenant nous avons besoin de lier tout cela ensemble. Le pattern typique que je suis, est d'utiliser l' événement pagebeforeshow de jQueryMobile pour mettre en place tout le nécessaire pour rendre une page complète. Cela agit comme mon contrôleur.

1 $('#activity-details').on('pagebeforeshow', function(){
2     var activitiesDetailsContainer = $('#activity-details').find(":jqmData(role='content')"),
3         activityDetailsView,
4         activityId = $('#activity-details').jqmData('activityId'),
5         activityModel = exercise.activities.get(activityId);
6     
7     activityDetailsView = new exercise.ActivityDetailsView({model: activityModel, viewContainer: activitiesDetailsContainer});
8     activityDetailsView.render();
9 });

Ce code récupère la donnée id attachée à l'élément détails de activity, regardez le modèle utilisant l'API Backbone (ligne 5), il instancie la vue avec le modèle et la vue du conteneur, et appelle la méthode render pour rendre le code HTML final. Le résultat final ressemble à ceci :

Alt "ListDetails.png"

Le code source pour ce poste peuvent être trouvés ici. Notez que ceci est une branche de mon dépôt de cette application. Chaque article du blog associé à cette base de code se trouve sur une branche distincte.


blog comments powered by Disqus
Fork Me