Introducing Backbone.js

Slide 1

Slide 1 text

/ Toon Ketels @toonketels

Slide 2

Slide 2 text

Drupal Developer backbone.js - d3.js - grunt.js @toonketels

Slide 3

Slide 3 text

What is Backbone Models Collections Views Wrap up

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

Backbone.js gives structure to web applications by providing models with key- value binding and custom events, collections with a rich API of enumerable functions, views with declarative event handling, and connects it all to your existing API over a RESTful JSON interface. backbonejs.org

Slide 6

Slide 6 text

structure models collections views connect to backend over JSON

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

angular.js ember.js spine.js knockout.js sammy.js

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

marionette.js chaplin.js vertebrae.js backbone boilerplate thorax

Slide 11

Slide 11 text

underscore.js / lo-dash.js json2.js jQuery / Zepto

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

the fundamental building blocks of backbone how they relate together how they help you structure your code

Slide 15

Slide 15 text

How to use Backbone and Drupal Tutorial on building your first backbone app

Slide 16

Slide 16 text

Let's focus on understanding the fundamentals, so we can hack existing apps, know were everything goes and don't curse backbone.js for all the complexity it adds, 'cause... it is making our lives easier.

Slide 17

Slide 17 text

Committed and pushed to 8.x webchick

Slide 18

Slide 18 text

n e w B a c k b o n e . M o d e l ( )

Slide 19

Slide 19 text

No content

Slide 20

Slide 20 text

Models are the heart of any JavaScript application, containing the interactive data as well as a large part of the logic surrounding it: conversions, validation, computed properties, and access control. backbonejs.org/#Model

Slide 21

Slide 21 text

An object to group data and functions related to the data together.

Slide 22

Slide 22 text

node user post comment

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

v a r t o o n = n e w B a c k b o n e . M o d e l ( { n a m e : " T o o n K e t e l s " , a g e : 3 0 , j o b : " D e v e l o p e r " , b i o : " S c r u m m a s t e r , b a c k e n d D r u p a l d e v e l o p e r . " , u i d : 7 5 4 4 } ) ;

Slide 25

Slide 25 text

{ _ c h a n g i n g : f a l s e , _ p e n d i n g : f a l s e , _ p r e v i o u s A t t r i b u t e s : { / * . . . * / } , _ a t t r i b u t e s : { / * . . . * / } , c h a n g e d : { / * . . . * / } , c i d : " c i d " } ;

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

t o o n . h a s ( ' a g e ' ) ; t o o n . g e t ( ' a g e ' ) ; t o o n . e s c a p e ( ' b i o ' ) ;

Slide 28

Slide 28 text

t o o n . s e t ( ' a g e ' , 3 1 ) ; t o o n . c h a n g e d ; t o o n . p r e v i o u s A t t r i b u t e s ( ) ;

Slide 29

Slide 29 text

Hey, I've changed!

Slide 30

Slide 30 text

t o o n . o n ( ' c h a n g e ' , f u n c t i o n ( m o d e l ) { c o n s o l e . l o g ( ' c h a n g e d ' ) ; c o n s o l e . l o g ( m o d e l ) ; } ) ;

Slide 31

Slide 31 text

t o o n . o n ( ' c h a n g e : a g e ' , f u n c t i o n ( m o d e l , v a l u e ) { c o n s o l e . l o g ( ' A g e h a s h a n g e d ' ) ; c o n s o l e . l o g ( m o d e l ) ; c o n s o l e . l o g ( v a l u e ) ; } ) ;

Slide 32

Slide 32 text

No content

Slide 33

Slide 33 text

v a r P e r s o n = B a c k b o n e . M o d e l . e x t e n d ( { / / C u s t o m m e t h o d s } ) ; v a r t o o n = n e w P e r s o n ( { . . . } ) ;

Slide 34

Slide 34 text

No content

Slide 35

Slide 35 text

v a r P e r s o n = B a c k b o n e . M o d e l . e x t e n d ( { i n i t i a l i z e : f u n c t i o n ( ) { c o n s o l e . l o g ( ' I r u n o n s t a r t u p ' ) ; } } ) ;

Slide 36

Slide 36 text

v a r P e r s o n = B a c k b o n e . M o d e l . e x t e n d ( { d e f a u l t s : { c o u n t r y : " B e l g i u m " , p r o f e s s i o n : " A n a l y s t " } } ) ;

Slide 37

Slide 37 text

v a r P e r s o n = B a c k b o n e . M o d e l . e x t e n d ( { v a l i d a t e : f u n c t i o n ( a t t r i b u t e s , o p t i o n s ) { i f ( t y p e o f a t t r i b u t e s . a g e ! = = " n u m b e r " ) { r e t u r n " A g e s h o u l d b e a n u m b e r " ; } } } ) ;

Slide 38

Slide 38 text

t o o n . s e t ( ' a g e ' , ' n o n e ' ) ; t o o n . i s V a l i d ( ) ; / / f a l s e t o o n . v a l i d a t i o n E r r o r ; / / " A g e s h o u l d b e a n u m b e r " t o o n . s e t ( ' a g e ' , ' n o n e ' , { v a l i d a t e : t r u e } ) ;

Slide 39

Slide 39 text

v a r P e r s o n = B a c k b o n e . M o d e l . e x t e n d ( { i d A t t r i b u t e : ' u i d ' } ) ;

Slide 40

Slide 40 text

v a r P e r s o n = B a c k b o n e . M o d e l . e x t e n d ( { i d A t t r i b u t e : ' u i d ' , u r l R o o t : ' u s e r ' } ) ;

Slide 41

Slide 41 text

v a r t o o n = n e w P e r s o n ( { u i d : 1 } ) ; t o o n . f e t c h ( ) ; t o o n . s e t ( ' a g e ' , 3 1 ) ; t o o n . s a v e ( ) ;

Slide 42

Slide 42 text

No content

Slide 43

Slide 43 text

Create a model Get/set attributes, previousAttributes Emit events Subclass Defaults Validate ID & url fetch & save

Slide 44

Slide 44 text

Separation data/functionality Tie data related functions related together with the data No polling, get alerted on changes (events) Easy communication with server

Slide 45

Slide 45 text

n e w B a c k b o n e . C o l l e c t i o n ( )

Slide 46

Slide 46 text

No content

Slide 47

Slide 47 text

Collections are ordered sets of models. backbonejs.org/#Collection

Slide 48

Slide 48 text

Users Latest articles Articles promoted to frontpage All pages All nodes

Slide 49

Slide 49 text

Controls on a slideshow Main menu links Pager in search results

Slide 50

Slide 50 text

No content

Slide 51

Slide 51 text

v a r C o w o r k e r s = B a c k b o n e . C o l l e c t i o n . e x t e n d ( { m o d e l : P e r s o n } ) ;

Slide 52

Slide 52 text

v a r s o u r c e = [ { n a m e : " T o o n K e t e l s " , a g e : 3 0 , j o b : " D e v e l o p e r " , b i o : " S c r u m m a s t e r , b a c k e n d D r u p a l d e v e l o p e r . " , u i d : 7 5 4 4 , i d : ' t k - 7 5 4 4 - c o r l ' } , { n a m e : " A n K a t r i e n " , a g e : 2 3 , c o u n t r y : " t h e N e t h e r l a n d s " , b i o : " W o r k s i n G e r m a n y . L o v e s t o g a m b l e . " , u i d : 3 4 0 0 , i d : ' a k - 3 4 0 0 - c o r l ' } ,

Slide 53

Slide 53 text

v a r c o w o r k e r s = n e w C o w o r k e r s ( s o u r c e ) ;

Slide 54

Slide 54 text

{ _ b y I d : O b j e c t , l e n g t h : 3 , m o d e l s : A r r a y [ 3 ] }

Slide 55

Slide 55 text

No content

Slide 56

Slide 56 text

c o w o r k e r s . a t ( 1 ) ; c o w o r k e r s . g e t ( 4 1 0 ) ; c o w o r k e r s . w h e r e ( { c o u n t r y : " t h e N e t h e r l a n d s " } ) ;

Slide 57

Slide 57 text

No content

Slide 58

Slide 58 text

v a r s o m e o n e = c o w o r k e r s . a t ( 1 ) ; c o w o r k e r s . r e m o v e ( s o m e o n e ) ;

Slide 59

Slide 59 text

v a r n o o b = n e w P e r s o n ( { n a m e : " D r i e s G a a s t r a " , a g e : 1 9 , c o u n t r y : " t h e N e t h e r l a n d s " , j o b : " T h e m e r " , b i o : " P l a y s w i t h c s s a n d j a v a s c r i p t a l l d a y l o n g . " , u i d : 9 0 1 6 , i d : ' d g - 9 0 1 6 - c o r l ' } ) ; c o w o r k e r s . a d d ( n o o b ) ;

Slide 60

Slide 60 text

v a r C o w o r k e r s = B a c k b o n e . C o l l e c t i o n . e x t e n d ( { m o d e l : P e r s o n , c o m p a r a t o r : ' a g e ' } ) ;

Slide 61

Slide 61 text

c o w o r k e r s . c o m p a r a t o r = f u n c t i o n ( m o d e l ) { r e t u r n m o d e l . g e t ( ' n a m e ' ) ; } c o w o r k e r s . s o r t ( ) ; c o w o r k e r s . c o m p a r a t o r = ' c o u n t r y ' ; c o w o r k e r s . s o r t ( ) ;

Slide 62

Slide 62 text

Hey, I've been sorted!

Slide 63

Slide 63 text

c o w o r k e r s . o n ( ' s o r t ' , f u n c t i o n ( m o d e l , v a l u e ) { / / . . . } ) ;

Slide 64

Slide 64 text

c o w o r k e r s . o n ( ' c h a n g e : a g e ' , f u n c t i o n ( m o d e l , v a l u e ) { / / . . . } ) ;

Slide 65

Slide 65 text

c o w o r k e r s . o n ( ' a l l ' , f u n c t i o n ( ) { c o n s o l e . l o g ( ' e v e n t e m i t t e d ' ) ; c o n s o l e . l o g ( a r g u m e n t s ) ; } ) ;

Slide 66

Slide 66 text

v a r C o w o r k e r s = B a c k b o n e . C o l l e c t i o n . e x t e n d ( { m o d e l : P e r s o n , u r l : ' u s e r ' } ) ; v a r c o w o r k e r s = n e w C o w o r k e r s ( ) ; c o w o r k e r s . f e t c h ( { d a t a : { p a g e : 1 } } ) ;

Slide 67

Slide 67 text

Create a collection Get models Add/remove models Sort Emit events Fetch entire collection from server

Slide 68

Slide 68 text

Organize sets of models into groups Tie collection related functions together with the collection Emit events and aggregate events of models. We no longer need pointers to all the models Easy communication with server

Slide 69

Slide 69 text

n e w B a c k b o n e . V i e w ( )

Slide 70

Slide 70 text

No content

Slide 71

Slide 71 text

Views are objects which do two things: 1) display data (most of the time models) and 2) capture user interaction to trigger code.

Slide 72

Slide 72 text

List of blogposts A blogpost A button to paginate

Slide 73

Slide 73 text

No content

Slide 74

Slide 74 text

root DOM element node v a r v i e w = n e w B a c k b o n e . V i e w ( { e l : $ ( ' # m a i n ' ) } ) ;

Slide 75

Slide 75 text

No content

Slide 76

Slide 76 text

v a r P e r s o n V i e w = B a c k b o n e . V i e w . e x t e n d ( { c l a s s N a m e : ' p e r s o n - v i e w ' , } ) ; v a r v i e w = n e w P e r s o n V i e w ( ) ;

Slide 77

Slide 77 text

The view is just an empty div.

Slide 78

Slide 78 text

v a r P e r s o n V i e w = B a c k b o n e . V i e w . e x t e n d ( { c l a s s N a m e : ' p e r s o n - v i e w ' , r e n d e r : f u n c t i o n ( ) { t h i s . $ e l . h t m l ( ' < h 2 > T o o n K e t e l s < / h 2 > ' ) ; r e t u r n t h i s ; } } ) ;

Slide 79

Slide 79 text

A.K.A. How to insert it into the DOM?

Slide 80

Slide 80 text

v a r v i e w = n e w P e r s o n V i e w ( ) ; $ ( ' # m a i n ' ) . a p p e n d ( v i e w . r e n d e r ( ) . e l ) ;

Slide 81

Slide 81 text

Not the same old string every time again...

Slide 82

Slide 82 text

v a r t o o n = n e w P e r s o n ( { n a m e : " T o o n K e t e l s " , a g e : 3 0 , j o b : " D e v e l o p e r " , b i o : " S c r u m m a s t e r , b a c k e n d D r u p a l d e v e l o p e r . " , u i d : 7 5 4 4 , i d : ' t k - 7 5 4 4 - c o r l ' } ) ; v a r v i e w = n e w P e r s o n V i e w ( { m o d e l : t o o n } ) ;

Slide 83

Slide 83 text

v a r P e r s o n V i e w = B a c k b o n e . V i e w . e x t e n d ( { ' c l a s s N a m e ' : ' p e r s o n - v i e w ' , r e n d e r : f u n c t i o n ( ) { v a r c o n t e n t = ' < h 2 > ' + t h i s . m o d e l . g e t ( ' n a m e ' ) + ' < / h 2 > ' ; t h i s . $ e l . h t m l ( c o n t e n t ) ; r e t u r n t h i s ; } } ) ;

Slide 84

Slide 84 text

The model has changed, the view not.

Slide 85

Slide 85 text

v a r P e r s o n v i e w = B a c k b o n e . V i e w . e x t e n d ( { ' c l a s s N a m e ' : ' p e r s o n - v i e w ' , i n i t i a l i z e : f u n c t i o n ( ) { t h i s . m o d e l . o n ( ' c h a n g e ' , t h i s . r e n d e r ) ; } , r e n d e r : f u n c t i o n ( ) { v a r c o n t e n t = ' < h 2 > ' + t h i s . m o d e l . g e t ( ' n a m e ' ) + ' < / h 2 > ' ; t h i s . $ e l . h t m l ( c o n t e n t ) ; r e t u r n t h i s ; } } ) ;

Slide 86

Slide 86 text

t h i s . m o d e l . o n ( ' c h a n g e ' , t h i s . r e n d e r ) ; t h i s . l i s t e n T o ( t h i s . m o d e l , ' c h a n g e ' , t h i s . r e n d e r ) ;

Slide 87

Slide 87 text

My eyes hurt, it's ugly!

Slide 88

Slide 88 text

_ . t e m p l a t e ( )

Slide 89

Slide 89 text

< s c r i p t t y p e = " t e x t / t e m p l a t e " i d = " p e r s o n - v i e w " > < / s c r i p t > < h 2 > < % = n a m e % > < / h 2 > < s p a n c l a s s = " j o b " > < % = j o b % > < / s p a n > | < s p a n c l a s s = " c o u n t r y " < d i v c l a s s = " c o n t r o l s " > < s p a n c l a s s = ' m o r e ' > M o r e < / s p a n > < s p a n c l a s s < d i v c l a s s = " b i o h i d e " > < % = b i o % > < / d i v >

Slide 90

Slide 90 text

v a r P e r s o n v i e w = B a c k b o n e . V i e w . e x t e n d ( { ' c l a s s N a m e ' : ' p e r s o n - v i e w ' , i n i t i a l i z e : f u n c t i o n ( ) { t h i s . l i s t e n T o ( t h i s . m o d e l , ' c h a n g e ' , t h i s . r e n d e r ) ; } , t e m p l a t e : _ . t e m p l a t e ( $ ( ' # p e r s o n - v i e w ' ) . h t m l ( ) ) , r e n d e r : f u n c t i o n ( ) { v a r c o n t e n t = t h i s . t e m p l a t e ( t h i s . m o d e l . t o J S O N ( ) ) ; t h i s . $ e l . h t m l ( c o n t e n t ) ; r e t u r n t h i s ; } } ) ;

Slide 91

Slide 91 text

t e m p l a t e : _ . t e m p l a t e ( $ ( ' # p e r s o n - v i e w ' ) . h t m l ( ) ) , v a r c o n t e n t = t h i s . t e m p l a t e ( t h i s . m o d e l . t o J S O N ( ) ) ;

Slide 92

Slide 92 text

Views are also about capturing user intent, aren't they?

Slide 93

Slide 93 text

e v e n t s

Slide 94

Slide 94 text

v a r P e r s o n V i e w = B a c k b o n e . V i e w . e x t e n d ( { / / . . . e v e n t s : { ' c l i c k . m o r e ' : ' s h o w M o r e ' , ' c l i c k . l e s s ' : ' s h o w L e s s ' , ' c l i c k h 2 ' : ' g o T o D e t a i l ' , ' m o u s e o v e r ' : ' s t a r t H i g h l i g h t ' , ' m o u s e o u t ' : ' s t o p H i g h l i g h t ' } , s h o w M o r e : f u n c t i o n ( e v e n t ) { / / . . . } , s h o w L e s s : f u n c t i o n ( e v e n t ) {

Slide 95

Slide 95 text

Person is selected. Selected is a "state", no?

Slide 96

Slide 96 text

v a r P e r s o n V i e w = B a c k b o n e . V i e w . e x t e n d ( { / / . . . e v e n t s : { ' c l i c k h 2 ' : ' s e l e c t P e r s o n ' , / / . . . } , s e l e c t P e r s o n : f u n c t i o n ( e v e n t ) { i f ( t h i s . m o d e l . g e t ( ' s e l e c t e d ' ) ) { t h i s . m o d e l . s e t ( ' s e l e c t e d ' , f a l s e ) ; } e l s e { t h i s . m o d e l . s e t ( ' s e l e c t e d ' , t r u e ) ; } } ,

Slide 97

Slide 97 text

Going back and forth

Slide 98

Slide 98 text

User clicks `h2` title View calls `selectPerson` Function will toggle the `selected` attribute of the model Model emits `change` event Since the view's render function is tied to this event, `render` get's called Render takes the model's attributes (some of them were just updated) and displays itself with the updated values.

Slide 99

Slide 99 text

What you get when data and representation are separate...

Slide 100

Slide 100 text

< s c r i p t t y p e = " t e x t / t e m p l a t e " i d = " l i s t - v i e w " > < / s c r i p t > < t d > < % - t i t l e % > < t d > < t d > < s p a n c l a s s = " l a b e l l a b e l - i n f o " < % - s e l e c t e d % > < / s p a n > < / t d

Slide 101

Slide 101 text

v a r T a b l e R o w V i e w = B a c k b o n e . V i e w . e x t e n d ( { t a g N a m e : ' t r ' , i n i t i a l i z e : f u n c t i o n ( ) { t h i s . l i s t e n T o ( t h i s . m o d e l , ' c h a n g e : s e l e c t e d ' , t h i s . r e n d e r ) ; t h i s . l i s t e n T o ( t h i s . m o d e l , ' c h a n g e : n a m e ' , t h i s . r e n d e r ) ; } , t e m p l a t e : _ . t e m p l a t e ( $ ( ' # t a b l e - r o w - v i e w ' ) . h t m l ( ) ) , r e n d e r : f u n c t i o n ( ) { v a r c o n t e n t = { s e l e c t e d : t h i s . m o d e l . g e t ( ' s e l e c t e d ' ) ? ' s e l e c t e d ' : ' ' , t i t l e : t h i s . m o d e l . g e t ( ' n a m e ' ) } ; t h i s . $ e l . h t m l ( t h i s . t e m p l a t e ( c o n t e n t ) ) ;

Slide 102

Slide 102 text

1. one model, two views 2. view updates itself 3. a different view updates the model

Slide 103

Slide 103 text

Create a view Set its contents Insert it into the DOM Pass models so the content is dynamic Auto update its display when model changes Use templates Catch user interaction with "events" property

Slide 104

Slide 104 text

All user interaction goes via Views, in its events hash Separate data (model) from display (view) allows us to have multiple displays Templates keep the views code tidy By binding to model change event, the view automatically gets updated.

Slide 105

Slide 105 text

By binding to model change event, a view automatically gets updated. A view does not care who updates the model or how. One view can update the display of another view via a model, without even knowing it.

Slide 106

Slide 106 text

No content

Slide 107

Slide 107 text

Models Collections Views

Slide 108

Slide 108 text

No content

Slide 109

Slide 109 text

By binding to model change event, the view automatically gets updated. The view does not care who updates the model or how.

Slide 110

Slide 110 text

No content

Slide 111

Slide 111 text

A view binds to the collections change event to automatically updated itself. A view does not care who updates the collection or how. One view can update the display of another view via a collection, without even knowing it.