-
Notifications
You must be signed in to change notification settings - Fork 11
/
FluxibleMixin.js
202 lines (182 loc) · 6.19 KB
/
FluxibleMixin.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
/**
* Copyright 2015, Yahoo Inc.
* Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
*/
'use strict';
/**
* React mixin for staticly declaring and add/remove-ing listeners for Store events.
* @class FluxibleMixin
* @example
* // Register listener default handler function name
* var Component = React.createClass({
* mixins: [FluxibleMixin],
* statics: {
* storeListeners: [FooStore]
* },
* onChange: function () {
* this.setState(this.context.getStore(FooStore).getState());
* },
* ...
* });
* @example
* // Register listener with custom named handler
* var Component = React.createClass({
* mixins: [FluxibleMixin],
* statics: {
* storeListeners: {
* 'onChange2': [FooStore]
* }
* },
* onChange2: function () {
* this.setState(this.context.getStore(FooStore).getState());
* },
* ...
* });
*/
var DEFAULT_CHANGE_HANDLER = 'onChange';
var React = require('react');
var contextTypes = require('fluxible').contextTypes;
var FluxibleMixin = {
contextTypes: contextTypes,
/**
* Registers staticly declared listeners
* @method componentDidMount
*/
componentDidMount: function componentDidMount() {
this.listeners = [];
var self = this;
// Register static listeners
this.getListeners().forEach(function(listener) {
self._attachStoreListener(listener);
});
},
/**
* Calls an action
* @method executeAction
*/
executeAction: function executeAction() {
var context = this.props.context || this.context;
if (!context || !context.executeAction) {
throw new Error('executeAction was called but no context was provided. Pass the fluxible' +
'context via a `context` prop or via React\'s context.');
}
return context.executeAction.apply(context, arguments);
},
/**
* Gets a store instance from the context
* @param {Function|String} store The store to get
* @returns {Object}
* @method getStore
*/
getStore: function (store) {
var storeInstance = store;
if ('object' !== typeof storeInstance) {
var context = this.props.context || this.context;
if (!context) {
throw new Error('storeListener mixin was called but no context was provided for getting the store.' +
'Pass the fluxible context via a `context` prop or via React\'s context.');
}
storeInstance = context.getStore(store);
}
return storeInstance;
},
/**
* Gets from the context all store instances required by this component
* @returns {Object}
* @method getStores
*/
getStores: function() {
var storesByName = this.getListeners().reduce(function (accum, listener) {
accum[listener.store.constructor.storeName] = listener.store;
return accum;
}, {});
return Object.keys(storesByName).map(function(storeName) {
return storesByName[storeName];
});
},
/**
* Gets a store-change handler from the component
* @param {Function|String} handler The handler to get
* @returns {Function}
* @method getHandler
*/
getHandler: function (handler) {
if ('string' === typeof handler) {
handler = this[handler];
}
if (!handler) {
throw new Error('storeListener attempted to add undefined handler. Make sure handlers actually exist.');
}
return handler;
},
/**
* Gets a listener descriptor for a store and store-change handler
* @param {Function|String} store Store
* @param {Function|String} handler The handler function or method name
* @returns {Object}
* @method getListener
*/
getListener: function(store, handler) {
handler = this.getHandler(handler);
var storeInstance = this.getStore(store);
return {
store: storeInstance,
handler: handler
};
},
/**
* Gets all store-change listener descriptors from the component
* @returns {Object}
* @method getListeners
*/
getListeners: function() {
var self = this;
var storeListeners = self.constructor.storeListeners; // Static property on component
// get static listeners
if (storeListeners) {
if (Array.isArray(storeListeners)) {
return storeListeners.map(function(store) {
return self.getListener(store, DEFAULT_CHANGE_HANDLER);
});
} else {
return Object.keys(storeListeners).reduce(function (accum, handlerName) {
var stores = storeListeners[handlerName];
if (!Array.isArray(stores)) {
stores = [stores];
}
return accum.concat(stores.map(function (store) {
return self.getListener(store, handlerName);
}));
}, []);
}
}
return [];
},
/**
* If provided with events, will attach listeners to events on EventEmitter objects(i.e. Stores)
* If the component isn't mounted, events aren't attached.
* @param {Object} listener
* @param {Object} listener.store Store instance
* @param {Object} listener.handler Handler function or method name
* @method _attachStoreListener
* @private
*/
_attachStoreListener: function _attachStoreListener(listener) {
if (this.isMounted && !this.isMounted()) {
throw new Error('storeListener mixin called listen when component wasn\'t mounted.');
}
listener.store.addChangeListener(listener.handler);
this.listeners.push(listener);
},
/**
* Removes all listeners
* @method componentWillUnmount
*/
componentWillUnmount: function componentWillUnmount() {
this.listeners.forEach(function (listener) {
listener.store.removeChangeListener(listener.handler);
});
this.listeners = [];
}
};
module.exports = FluxibleMixin;