Backbone.js 虎の巻 (Cheat Sheet)

イベントのバインド (Binding Events)

.on('event', callback)
.on('event', callback, context)

.on({
  'event1': callback,
  'event2': callback
})

.on('all', callback)

.once('event', callback)   // 1回だけ実行されるカスタムイベントを追加

イベントの解除 (Unbinding Events)

object.off('change', onChange)    // `onChange` コールバックのみ
object.off('change')              // すべての 'change' コールバック
object.off(null, onChange)        // すべてのイベントの `onChange` コールバック
object.off(null, null, context)   // 指定した `context` のすべてのイベントのすべてのコールバック
object.off()                      // すべて

イベントの発火 (Trigger Events)

object.trigger('event')

view.listenTo(object, event, callback)
view.stopListening()

ビルトインイベント一覧 (Built-in Events)

コレクション (Collection):
- add (model, collection, options)
- remove (model, collection, options)
- reset (collection, options)
- sort (collection, options)
モデル (Model):
- change (model, options)
- change:[attr] (model, value, options)
- destroy (model, collection, options)
- error (model, xhr, options)
モデルとコレクション:
- request (model, xhr, options)
- sync (model, resp, options)
ルーター (Router):
- route:[name] (params)
- route (router, route, params)

ビュー (Views)

ビューの定義

// すべての属性は任意です
var View = Backbone.View.extend({
  model: doc,

  tagName: 'div',
  className: 'document-item',
  id: "document-" + doc.id,
  attributes: { href: '#' },

  el: 'body',

  events: {
    'click button.save': 'save',
    'click .cancel': function() { ··· },
    'click': 'onclick'
  },

  constructor: function() { ··· },
  render: function() { ··· }
})

ビューのインスタンス化 (View Instantiation)

view = new View()
view = new View({ el: ··· })

ビューのメソッド (View Methods)

view.$el.show()
view.$('input')

view.remove()

view.delegateEvents()
view.undelegateEvents()

モデル (Models)

モデルの定義

// すべての属性は任意です
var Model = Backbone.Model.extend({
  defaults: {
    'author': 'unknown'
  },
  idAttribute: '_id',
  parse: function() { ··· }
})

モデルのインスタンス化 (Model Instantiation)

var obj = new Model({ title: 'Lolita', author: 'Nabokov' })

var obj = new Model({ collection: ··· })

モデルのメソッド (Model Methods)

obj.id
obj.cid   // → 'c38' (クライアントサイド ID)

obj.clone()

obj.hasChanged('title')
obj.changedAttributes()  // false または hash
obj.previousAttributes() // false または hash
obj.previous('title')

obj.isNew()

obj.set({ title: 'A Study in Pink' })
obj.set({ title: 'A Study in Pink' }, { validate: true, silent: true })
obj.unset('title')

obj.get('title')
obj.has('title')
obj.escape('title')     /* .get() と同様だが HTML エスケープされる */

obj.clear()
obj.clear({ silent: true })

obj.save()
obj.save({ attributes })
obj.save(null, {
  silent: true, patch: true, wait: true,
  success: callback, error: callback
})

obj.destroy()
obj.destroy({
  wait: true,
  success: callback, error: callback
})

obj.toJSON()

obj.fetch()
obj.fetch({ success: callback, error: callback })

バリデーション (Validation)

var Model = Backbone.Model.extend({
  validate: function(attrs, options) {
    if (attrs.end < attrs.start) {
      return "Can't end before it starts"
    }
  }
})

{: data-line=“2”}

obj.validationError  //=> "Can't end before it starts"
obj.isValid()
obj.on('invalid', function (model, error) { ··· })

// 以下でトリガーされます:
obj.save()
obj.set({ ··· }, { validate: true })

カスタム URL (Custom URLs)

var Model = Backbone.Model.extend({
  // 単一の URL (文字列または関数)
  url: '/account',
  url: function() { return '/account' },

  // どちらも同じように動作します
  url: function() { return '/books/' + this.id }),
  urlRoot: '/books'
})

var obj = new Model({ url: ··· })
var obj = new Model({ urlRoot: ··· })