PageRenderTime 43ms CodeModel.GetById 14ms RepoModel.GetById 0ms app.codeStats 0ms

/JS/Backbone/about-backbone.md

https://github.com/sujumayas/documentacion
Markdown | 272 lines | 164 code | 108 blank | 0 comment | 0 complexity | ac26f3bafd3de77f9c2740227b1c323b MD5 | raw file
  1. Backbone
  2. ==
  3. Sirve porque es ordenado.
  4. Su nombre mismo lo dice. Columna vertebral. Da ORDEN.
  5. Depende de:
  6. - underscore.js
  7. - jquery.js
  8. Sirve tener:
  9. - zepto.js
  10. - lodash.js
  11. - json.js
  12. RESUMEN DEL CURSO DE TUTSPLUS - Uso interno
  13. ==
  14. --
  15. Models
  16. ==
  17. Aquí podemos ver una típica forma de extender un modelo de Backbone:
  18. var Person = Backbone.Model.extend({
  19. defaults: {
  20. name = "Anonimo",
  21. age = 30,
  22. ocupation = 'worker'
  23. },
  24. validate: function(atrrs){
  25. if ( attrs.age < 0 ) {
  26. return 'Age must be positive, stupid.';
  27. }
  28. if ( ! attrs.name ) {
  29. return 'Every person must have a name, fool.';
  30. }
  31. },
  32. work: function(){
  33. return this.get('nombre') + ' is working.';
  34. }
  35. });
  36. Cosas importantes a recordar:
  37. 1. Los métodos (work) se guardan en el modelo, y la instanciación del modelo Persona solo los llama como pointers. Tal y como si usásemos prototype en javascript plano.
  38. 2. "defaults" es un objeto que determina las características por default que llevará cada objeto instanciado, de no recibir otro valor para esas características.
  39. 3. "validate" por otro lado, es un método que determina las condiciones básicas que tienen que pasar el cambio o instanciación de atributos de nuestro modelo. Si el método validate, retorna un mensaje, eso significa que no ha pasado. A Backbone le vasta esto (que retornes un mensaje) para blokear el cambio del elemento que se iba a cambiar. Entonces, por ejemplo, en el primer if vemos que si la edad es negativa (< 0), se retornará un mensaje. Y, en el segundo caso, si no hay nombre (!name), también se retornará un mensaje y esto invalidará la acción.
  40. Views
  41. ==
  42. Aquí podemos ver una típica forma de extender un View de Backbone:
  43. var PersonView = Backbone.View.extend({
  44. tagName: 'li',
  45. initialize: function() {
  46. this.render();
  47. },
  48. render: function() {
  49. // anti-pattern
  50. this.$el.html( this.model.get('name') + ' (' + this.model.get('age') + ') - ' + this.model.get('occupation') );
  51. }
  52. });
  53. var person = new Person;
  54. var personView = new PersonView({ model: person });
  55. Cosas importantes:
  56. 1. Como pueden ver hemos instanciado al modelo y a la vista al final del código. Esto lo hemos hecho para que puedan ver en qué momento la vista recibe el modelo que va a mostrar. Ahí, estamos creando la vista inicializándola como vista del modelo "person" que es a su vez una instancia del modelo Person.
  57. 2. "tagName" representa el elemento html que envolverá cada instancia del modelo "person" al interior de la vista.
  58. 3. "initialize" es una función de la vista que, en este caso simplificado, únicamente está llamando al render, método que hace en realidad todo el trabajo.
  59. 4. "render", finalmente, hace el trabajo de convertir los contenidos del modelo en contenido html. En este caso, de manera intuitiva pero poco profesional, hemos colocado los contenidos llamándolos diréctamente con el prefijo "this" y colocándolos para que se muestren con el formato "Nombre (edad) - trabajo".
  60. Una forma mucho mejor de hacer esto, sin embargo, es haciendo templates:
  61. Templating - Internal:
  62. ==
  63. Aquí podemos ver una repetición del código pero bastante similar.
  64. var Person = Backbone.Model.extend({
  65. defaults: {
  66. name: 'John Doe',
  67. age: 30,
  68. occupation: 'worker'
  69. }
  70. });
  71. var PersonView = Backbone.View.extend({
  72. tagName: 'li',
  73. template: _.template("<strong><%= name %></strong> (<%= age %>) - <%= occupation %>"),
  74. initialize: function() {
  75. this.render();
  76. },
  77. render: function() {
  78. this.$el.html( this.template(this.model.toJSON()) );
  79. }
  80. });
  81. var person = new Person;
  82. var personView = new PersonView({ model: person });
  83. Cosas importantes:
  84. 1. Como pueden ver hemos agregado "template" a la lista de elementos de nuestra vista. Este método utiliza underscore (_.template();) para convertir la información que nos interesa en html de manera simplificada.
  85. 2. Luego, en el render, hacemos un "this.$el.html();" para setear el html que irá dentro del "tagName". Y le pasamos de parámetros el "this.model.toJSON();" que es una función de Backbone que convierte el modelo this en un JSON, para poder acceder a sus propiedades básicas de manera sensilla.
  86. ¿Genial no?
  87. Es aún mejor. Podemos colocar este template en el HTML mismo y llamarlo desde backbone, con lo cual lo hacemos mucho más ordenado.
  88. Templating - External:
  89. ==
  90. Colocamos el template de la siguiente manera en el html:
  91. <body>
  92. <script id="personTemplate" type="text/template">
  93. <strong><%= name %></strong> (<%= age %>) - <%= occupation %>
  94. </script>
  95. </body>
  96. Algo importante:
  97. - Es fundamental que coloquemos el 'type="text/template"' en el script y que le coloquemos un id. Sin esto, no vemos nada.
  98. Y entonces, en nuestro documento de js colocamos:
  99. var PersonView = Backbone.View.extend({
  100. tagName: 'li',
  101. template: _.template( $('#personTemplate').html() ),
  102. initialize: function() {
  103. this.render();
  104. },
  105. render: function() {
  106. this.$el.html( this.template(this.model.toJSON()) );
  107. }
  108. });
  109. Es decir, lo único que tenemos que cambiar es la parte interior del método "template". Así de simple.
  110. Y listo.
  111. Collections:
  112. ==
  113. Lo mínimo que tenemos que agregarle a nuestro código para tener una colección es lo siguiente:
  114. var PeopleCollection = Backbone.Collection.extend({
  115. model: Person
  116. });
  117. Con estas pocas líneas de código hemos extendido la funcionalidad de las Collection de Backbone a nuestro nuevo Collection: "PeopleCollection", que depende del modelo Person.
  118. Como puedes notar, aquí, a diferencia de los views, no le pasamos el modelo instanceado, sino el modelo en . HAY QUE EXPLICAR ESTO MEJOR.
  119. Collections Views:
  120. ==
  121. var PeopleView = Backbone.View.extend({
  122. tagName: 'ul',
  123. render: function() {
  124. this.collection.each(function(person) {
  125. var personView = new PersonView({ model: person });
  126. this.$el.append(personView.render().el);
  127. }, this);
  128. return this;
  129. }
  130. });
  131. var peopleView = new PeopleView({ collection: peopleCollection });
  132. Cosas importantes:
  133. 1. El Collection View es muy similar a la vista de un modelo individual. Sin embargo, al instanciarla, la llamamos con una colección.
  134. 2. Hay otras diferencias básicas. Lo que va a hacer la vista de una colección es crear/instanciar una vista individual (del modelo que pertenezca a esa colección) para renderizar/imprimir cada modelo, y estos, a su vez, los imprimirá al interior de un tagName 'ul'.
  135. 3. Algo muy importante en las funciones de "render" que ya estamos viendo aquí es que debemos colocar siempre al final "return this". Esto nos permite anidar métodos sobre el render (render().el; por ejemplo).
  136. 4. Si no me equivoco, each() es un método que viene incluído en las colecciones de Backbone. Y pasa cada persona como parámetros de la función que ejecutará para cada uno de ellos. De esta forma, define un nuevo personView y le da "append" sobre "$el" (definido en el tagName, aquí en su versión Jquery).
  137. Template Helper:
  138. ==
  139. Una técnica que enseña Tutplus es el template helper:
  140. var template = function(id) {
  141. return _.template( $('#' + id).html() );
  142. };
  143. Lo único que hace esta función (que puede ser global), es pre-llamar al método de underscore _.template() con el '#' agregado a un id, que será lo único que tengamos que pasarle luego.
  144. De esta forma, cuando antes escribíamos algo así:
  145. var PersonView = Backbone.View.extend({
  146. tagName: 'li',
  147. template: _.template( $('#personTemplate').html() ),
  148. initialize: function() {
  149. this.render();
  150. },
  151. render: function() {
  152. this.$el.html( this.template(this.model.toJSON()) );
  153. }
  154. });
  155. Ahora escribimos algo así:
  156. var PersonView = Backbone.View.extend({
  157. tagName: 'li',
  158. template: template('personTemplate'),
  159. render: function() {
  160. this.$el.html( this.template(this.model.toJSON()) );
  161. return this;
  162. }
  163. });
  164. Esta simple función hace mucho más simple las llamadas al interior de nuestro código al método template.