-
Notifications
You must be signed in to change notification settings - Fork 72
/
component.js
410 lines (388 loc) · 15.3 KB
/
component.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
// Backbone React Component
// ========================
//
// Backbone.React.Component v0.10.0
//
// (c) 2014, 2015 "Magalhas" José Magalhães <[email protected]>
// Backbone.React.Component can be freely distributed under the MIT license.
//
//
// `Backbone.React.Component` is a mixin that glues [Backbone](http://backbonejs.org/)
// models and collections into [React](http://facebook.github.io/react/) components.
//
// When the component is mounted, a wrapper starts listening to models and
// collections changes to automatically set your component state and achieve UI
// binding through reactive updates.
//
//
//
// Basic Usage
//
// var MyComponent = React.createClass({
// mixins: [Backbone.React.Component.mixin],
// render: function () {
// return <div>{this.state.model.foo}</div>;
// }
// });
// var model = new Backbone.Model({foo: 'bar'});
// ReactDOM.render(<MyComponent model={model} />, document.body);
(function (root, factory) {
// Universal module definition
if (typeof define === 'function' && define.amd) {
define(['react', 'react-dom', 'backbone', 'underscore', 'prop-types'], factory);
} else if (typeof module !== 'undefined' && module.exports) {
module.exports = factory(require('react'), require('react-dom'), require('backbone'), require('underscore'), require('prop-types'));
} else {
factory(root.React, root.ReactDOM, root.Backbone, root._, root.PropTypes);
}
}(this, function (React, ReactDOM, Backbone, _, PropTypes) {
'use strict';
if (!Backbone.React) {
Backbone.React = {};
}
if (!Backbone.React.Component) {
Backbone.React.Component = {};
}
// Mixin used in all component instances. Exported through `Backbone.React.Component.mixin`.
var mixin = Backbone.React.Component.mixin = {
// Types of the context passed to child components. Only
// `hasParentBackboneMixin` is required all of the others are optional.
childContextTypes: {
hasParentBackboneMixin: PropTypes.bool.isRequired,
parentModel: PropTypes.any,
parentCollection: PropTypes.any
},
// Types of the context received from the parent component. All of them are
// optional.
contextTypes: {
hasParentBackboneMixin: PropTypes.bool,
parentModel: PropTypes.any,
parentCollection: PropTypes.any
},
// Passes data to our child components.
getChildContext: function () {
return {
hasParentBackboneMixin: true,
parentModel: this.getModel(),
parentCollection: this.getCollection()
};
},
// Sets `this.el` and `this.$el` when the component mounts.
componentDidMount: function () {
this.setElement(ReactDOM.findDOMNode(this));
},
// Sets `this.el` and `this.$el` when the component updates.
componentDidUpdate: function () {
this.setElement(ReactDOM.findDOMNode(this));
},
// When the component gets the initial state, instance a `Wrapper` to take
// care of models and collections binding with `this.state`.
getInitialState: function () {
var initialState = {};
if (!this.wrapper) {
this.wrapper = new Wrapper(this, initialState);
}
return initialState;
},
// When the component mounts, instance a `Wrapper` to take care
// of models and collections binding with `this.state`.
componentWillMount: function () {
if (!this.wrapper) {
this.wrapper = new Wrapper(this);
}
},
// When the component unmounts, dispose listeners and delete
// `this.wrapper` reference.
componentWillUnmount: function () {
if (this.wrapper) {
this.wrapper.stopListening();
delete this.wrapper;
}
},
// In order to allow passing nested models and collections as reference we
// filter `nextProps.model` and `nextProps.collection`.
componentWillReceiveProps: function (nextProps) {
var model = nextProps.model;
var collection = nextProps.collection;
if (this.wrapper.model && model) {
if (this.wrapper.model !== model) {
this.wrapper.stopListening();
this.wrapper = new Wrapper(this, void 0, nextProps);
}
} else if (model) {
this.wrapper = new Wrapper(this, void 0, nextProps);
}
if (this.wrapper.collection && collection) {
if (this.wrapper.collection !== collection) {
this.wrapper.stopListening();
this.wrapper = new Wrapper(this, void 0, nextProps);
}
} else if (collection) {
this.wrapper = new Wrapper(this, void 0, nextProps);
}
},
// Shortcut to `@$el.find` if jQuery ins present, else if fallbacks to DOM
// native `querySelector`. Inspired by `Backbone.View`.
$: function () {
var els;
if (this.$el) {
els = this.$el.find.apply(this.$el, arguments);
} else {
var el = ReactDOM.findDOMNode(this);
els = el.querySelector.apply(el, arguments);
}
return els;
},
// Grabs the collection from `@wrapper.collection` or `@context.parentCollection`
getCollection: function () {
return this.wrapper.collection || this.context.parentCollection;
},
// Grabs the model from `@wrapper.model` or `@context.parentModel`
getModel: function () {
return this.wrapper.model || this.context.parentModel;
},
// Sets a DOM element to render/mount this component on this.el and this.$el.
setElement: function (el) {
if (el && Backbone.$ && el instanceof Backbone.$) {
if (el.length > 1) {
throw new Error('You can only assign one element to a component');
}
this.el = el[0];
this.$el = el;
} else if (el) {
this.el = el;
if (Backbone.$) {
this.$el = Backbone.$(el);
}
}
return this;
}
};
// Binds models and collections to a `React.Component`. It mixes `Backbone.Events`.
function Wrapper (component, initialState, nextProps) {
// Object to store wrapper state (not the component state)
this.state = {};
// 1:1 relation with the `component`
this.component = component;
// Use `nextProps` or `component.props` and grab `model` and `collection`
// from there
var props = nextProps || component.props || {};
var model, collection;
if (component.overrideModel && typeof component.overrideModel === 'function'){
// Define overrideModel() method on your `React class` to programatically supply a model object
// Will override `this.props.model`
model = component.overrideModel();
} else {
model = props.model;
}
if (component.overrideCollection && typeof component.overrideCollection === 'function'){
// Define overrideCollection() method on your `React class` to programatically supply a collection object
// Will override `this.props.collection`
collection = component.overrideCollection();
} else {
collection = props.collection;
}
this.setModels(model, initialState);
this.setCollections(collection, initialState);
}
// Mixing `Backbone.Events` into `Wrapper.prototype`
_.extend(Wrapper.prototype, Backbone.Events, {
// Sets `this.state` when a model/collection request results in error. It delegates
// to `this.setState`. It listens to `Backbone.Model#error` and `Backbone.Collection#error`.
onError: function (modelOrCollection, res, options) {
// Set state only if there's no silent option
if (!options.silent) {
this.component.setState({
isRequesting: false,
hasError: true,
error: res
});
}
},
onInvalid: function (model, res, options) {
if (!options.silent) {
this.component.setState({
isInvalid: true
});
}
},
// Sets `this.state` when a model/collection request starts. It delegates to
// `this.setState`. It listens to `Backbone.Model#request` and
// `Backbone.Collection#request`.
onRequest: function (modelOrCollection, xhr, options) {
// Set `state` only if there's no silent option
if (!options.silent) {
this.component.setState({
isRequesting: true,
hasError: false,
isInvalid: false
});
}
},
// Sets `this.state` when a model/collection syncs. It delegates to `this.setState`.
// It listens to `Backbone.Model#sync` and `Backbone.Collection#sync`
onSync: function (modelOrCollection, res, options) {
// Calls `setState` only if there's no silent option
if (!options.silent) {
this.component.setState({isRequesting: false});
}
},
// Check if `models` is a `Backbone.Model` or an hashmap of them, sets them
// to the component state and binds to update on any future changes
setModels: function (models, initialState, isDeferred) {
var isValid = typeof models !== 'undefined';
if (isValid) {
if (!models.attributes) {
if (typeof models === 'object') {
var _values = _.values(models);
isValid = _values.length > 0 && _values[0].attributes;
} else {
isValid = false;
}
}
}
if (isValid) {
this.model = models;
// Set model(s) attributes on `initialState` for the first render
this.setStateBackbone(models, void 0, initialState, isDeferred);
this.startModelListeners(models);
}
},
// Check if `collections` is a `Backbone.Model` or an hashmap of them,
// sets them to the component state and binds to update on any future changes
setCollections: function (collections, initialState, isDeferred) {
if (typeof collections !== 'undefined' && (collections.models ||
typeof collections === 'object' && _.values(collections)[0].models)) {
// The collection(s) bound to this component
this.collection = collections;
// Set collection(s) models on `initialState` for the first render
this.setStateBackbone(collections, void 0, initialState, isDeferred);
this.startCollectionListeners(collections);
}
},
// Used internally to set `this.collection` or `this.model` on `this.state`. Delegates to
// `this.setState`. It listens to `Backbone.Collection` events such as `update`,
// `change`, `sort`, `reset` and to `Backbone.Model` `change`.
setStateBackbone: function (modelOrCollection, key, target, isDeferred) {
if (!(modelOrCollection.models || modelOrCollection.attributes)) {
for (key in modelOrCollection)
this.setStateBackbone(modelOrCollection[key], key, target);
return;
}
this.setState.apply(this, arguments);
},
// Get the attributes for the collection or model as array or hash
getAttributes: function (modelOrCollection){
var attrs = [];
// if a collection, get the attributes of each, otherwise return modelOrCollection
if (modelOrCollection instanceof Backbone.Collection) {
for (var i = 0; i < modelOrCollection.models.length; i++) {
attrs.push(_.clone(modelOrCollection.models[i].attributes));
}
return attrs;
} else {
return _.clone(modelOrCollection.attributes);
}
},
// Sets a model, collection or object into state by delegating to `this.component.setState`.
setState: function (modelOrCollection, key, target, isDeferred) {
var state = {};
var newState = this.getAttributes(modelOrCollection);
if (key) {
state[key] = newState;
} else if (modelOrCollection.models) {
state.collection = newState;
} else {
state.model = newState;
}
if (target) {
_.extend(target, state);
} else if (isDeferred) {
this.nextState = _.extend(this.nextState || {}, state);
_.defer(_.bind(function () {
if (this.nextState) {
this.component.setState(this.nextState);
this.nextState = null;
}
}, this));
} else {
this.component.setState(state);
}
},
// Binds the component to any collection changes.
startCollectionListeners: function (collection, key) {
if (!collection) collection = this.collection;
if (collection) {
if (collection.models)
this
.listenTo(collection, 'update change sort reset',
_.partial(this.setStateBackbone, collection, key, void 0, true))
.listenTo(collection, 'error', this.onError)
.listenTo(collection, 'request', this.onRequest)
.listenTo(collection, 'sync', this.onSync);
else if (typeof collection === 'object')
for (key in collection)
if (collection.hasOwnProperty(key))
this.startCollectionListeners(collection[key], key);
}
},
// Binds the component to any model changes.
startModelListeners: function (model, key) {
if (!model) model = this.model;
if (model) {
if (model.attributes)
this
.listenTo(model, 'change',
_.partial(this.setStateBackbone, model, key, void 0, true))
.listenTo(model, 'error', this.onError)
.listenTo(model, 'request', this.onRequest)
.listenTo(model, 'sync', this.onSync)
.listenTo(model, 'invalid', this.onInvalid);
else if (typeof model === 'object')
for (key in model)
this.startModelListeners(model[key], key);
}
}
});
// Facade method to bypass the `mixin` usage. For use cases such as ES6
// classes or else. It binds any `Backbone.Model` and `Backbone.Collection`
// instance found inside `backboneInstances.models` and
// `backboneInstances.collections` (single instances or objects of them)
mixin.on = function (component, backboneInstances) {
var wrapper;
if (!component.wrapper) {
wrapper = new Wrapper(component);
} else {
wrapper = component.wrapper;
}
if (backboneInstances.models) {
wrapper.setModels(backboneInstances.models);
}
if (backboneInstances.collections) {
wrapper.setCollections(backboneInstances.collections);
}
component.wrapper = wrapper;
};
// Shortcut method to bind a model or multiple models
mixin.onModel = function (component, models) {
mixin.on(component, {models: models});
};
// Shortcut method to bind a collection or multiple collections
mixin.onCollection = function (component, collections) {
mixin.on(component, {collections: collections});
};
// Facade method to dispose of a `component.wrapper`
mixin.off = function (component, modelOrCollection) {
if (arguments.length === 2) {
if (component.wrapper) {
component.wrapper.stopListening(modelOrCollection);
// TODO Remove modelOrCollection from `component.state`?
}
} else {
mixin.componentWillUnmount.call(component);
}
};
// Expose `Backbone.React.Component.mixin`.
return mixin;
}));
// <a href="https:/magalhas/backbone-react-component"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github-camo.global.ssl.fastly.net/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"></a>