My user laughs: {this.props.doesUserLaugh ? "yes" : "no"}
28 |
33 |
All Users
34 |
35 | {this.props.users.map(user => (
36 |
{user.name}
37 | ))}
38 |
39 |
40 | );
41 | }
42 | }
43 |
44 | // Maps Models to properties to give to the React Component. Optional.
45 | // Default behavior is to call `.toJSON()` on every Model and Collection.
46 | // Second argument are props given to the React Component.
47 | const mapModelsToProps = (models, props) => {
48 | const { user, allUsers } = models;
49 | const { showOnlyLaughingUsers } = props;
50 |
51 | // Everything returned from this function will be given as a prop to your Component.
52 | return {
53 | doesUserLaugh: user.get("laughs"),
54 | users: showOnlyLaughingUsers
55 | ? allUsers.toJSON().filter(user => user.laughs === true)
56 | : allUsers.toJSON(),
57 | setUserLaughs(newVal) {
58 | user.set("laughs", newVal);
59 | }
60 | };
61 | };
62 |
63 | // Options.
64 | const options = {
65 | // Should our event handler function be wrapped in a debounce function
66 | // to prevent many re-renders.
67 | debounce: false, // or `true`, or a number that will be used in the debounce function.
68 |
69 | // Define what events you want to listen to on your Backbone Model or Collection
70 | // that will cause your React Component to re-render.
71 | // By default it's ['all'] for every Model and Collection given.
72 | events: {
73 | user: ["change:name", "change:laughs"]
74 | // You can disable listening to events by passing in `false` or an empty array.
75 | },
76 |
77 | // Define what modelTypes you expect to be contained on your `modelsMap` object.
78 | // Useful for validating that you'll be given what model type you expect.
79 | // Uses instanceof, and throws an error if instanceof returns false.
80 | // By default no modelTypes are defined.
81 | modelTypes: {
82 | user: UserModel,
83 | allUsers: UserCollection
84 | },
85 |
86 | // Enable access to the wrapped component's ref with the `withRef` option.
87 | // You can then access the wrapped component from the connected component's `getWrappedInstance()`.
88 | // This is similar to react-redux's connectAdvanced() HOC.
89 | // By default, `withRef` is false.
90 | withRef: true
91 | };
92 |
93 | const { connectBackboneToReact } = require("connect-backbone-to-react");
94 |
95 | // Create our Connected Higher order Component (HOC).
96 | const MyComponentConnected = connectBackboneToReact(
97 | mapModelsToProps,
98 | options
99 | )(MyComponent);
100 | ```
101 |
102 | Now that you've created your HOC you can use it!
103 |
104 | ```javascript
105 | // Map your Backbone Model and Collections to names that will be provided to
106 | // your mapModelsToProps function.
107 | const modelsMap = {
108 | user: userInstance,
109 | allUsers: userCollection
110 | };
111 |
112 | ReactDOM.render(
113 | // Pass the modelsMap to the HOC via the models prop.
114 | ,
115 | document.getElementById("app")
116 | );
117 | ```
118 |
119 | ### BackboneProvider
120 |
121 | Alternatively you might have a tree of connected Components. We shouldn't pass that `modelsMap` object from one component to another. Instead we can take inspiration from [react-redux's Provider component](https://github.com/reactjs/react-redux/blob/master/docs/api.md#provider-store).
122 |
123 | ```javascript
124 | const { BackboneProvider } = require('connect-backbone-to-react');
125 |
126 | const modelsMap = {
127 | user: userInstance,
128 | allUsers: userCollection,
129 | },
130 |
131 | ReactDOM.render(
132 | // Pass the modelsMap to the BackboneProvider via the models prop.
133 | // It will then get shared to every child connected component via React's context.
134 |
135 |
136 |
137 |
138 | ,
139 | document.getElementById('app')
140 | );
141 | ```
142 |
143 | ## Rendering React Within Backbone.View
144 |
145 | This library's focus is on sharing Backbone.Models with React Components. It is not concerned with how to render React Components within Backbone.Views. [The React docs provide a possible implementation for this interopt.](https://reactjs.org/docs/integrating-with-other-libraries.html#embedding-react-in-a-backbone-view)
146 |
147 | ## Local development
148 |
149 | To develop this library locally, run the following commands in the project root directory:
150 |
151 | 1. `npm run watch`. The library will be automatically compiled in the background as you make changes.
152 | 2. `npm link` and then follow the instructions to use the local version of this library in another project that uses `connect-backbone-to-react`.
153 |
154 | Run `npm test` to run the unit tests.
155 |
156 | ### Releasing a new version
157 |
158 | 1. Make sure you have up to date `node_modules` before you proceed. Can be done via `npm ci`
159 | 2. Update the version via: `npm run release -- --release-as=major|minor|patch`
160 | 3. Optionally manually edit the revised `CHANGELOG.md` file. Commit changes.
161 | 4. Follow the directions from step 2: run `git push --follow-tags origin master; npm publish` to publish
162 | 5. Rejoice!
163 |
164 | ## License
165 |
166 | Apache 2.0
167 |
168 | [travis_img]: https://img.shields.io/travis/mongodb-js/connect-backbone-to-react.svg
169 | [travis_url]: https://travis-ci.org/mongodb-js/connect-backbone-to-react
170 | [npm_img]: https://img.shields.io/npm/v/connect-backbone-to-react.svg
171 | [npm_url]: https://npmjs.org/package/connect-backbone-to-react
172 |
--------------------------------------------------------------------------------
/lib/connect-backbone-to-react.js:
--------------------------------------------------------------------------------
1 | const hoistStatics = require('hoist-non-react-statics');
2 | const { Component, createElement } = require('react');
3 | const PropTypes = require('prop-types');
4 | const debounceFn = require('lodash.debounce');
5 | const BackboneToReactContext = require('./context');
6 |
7 | function getDisplayName(name) {
8 | return `connectBackboneToReact(${name})`;
9 | }
10 |
11 | function defaultMapModelsToProps(models) {
12 | return Object.keys(models).reduce((acc, modelKey) => {
13 | const model = models[modelKey];
14 | if (!model) return;
15 |
16 | acc[modelKey] = model.toJSON();
17 | return acc;
18 | }, {});
19 | }
20 |
21 | module.exports = function connectBackboneToReact(
22 | mapModelsToProps,
23 | options = {}
24 | ) {
25 | if (typeof mapModelsToProps !== 'function') {
26 | mapModelsToProps = defaultMapModelsToProps;
27 | }
28 |
29 | const {
30 | debounce = false,
31 | events = {},
32 | modelTypes = {},
33 | withRef = false,
34 | } = options;
35 |
36 | function getEventNames(modelName) {
37 | let eventNames = events[modelName];
38 |
39 | // Allow turning off event handlers by setting events to false.
40 | if (eventNames === false) {
41 | return [];
42 | }
43 |
44 | if (!Array.isArray(eventNames)) {
45 | return ['all'];
46 | }
47 |
48 | return eventNames;
49 | }
50 |
51 | function validateModelTypes(modelsMap) {
52 | return Object.keys(modelTypes).forEach(modelKey => {
53 | const ModelConstructor = modelTypes[modelKey];
54 | const modelInstance = modelsMap[modelKey];
55 |
56 | const isInstanceOfModel = modelInstance instanceof ModelConstructor;
57 | if (!isInstanceOfModel) {
58 | throw new Error(`"${modelKey}" model found on modelsMap does not match type required.`);
59 | }
60 | });
61 | }
62 |
63 | return function createWrapper(WrappedComponent) {
64 | const wrappedComponentName = WrappedComponent.displayName
65 | || WrappedComponent.name
66 | || 'Component';
67 |
68 | const displayName = getDisplayName(wrappedComponentName);
69 |
70 | class ConnectBackboneToReact extends Component {
71 | constructor(props, context) {
72 | super(props, context);
73 |
74 | this.componentIsMounted = false;
75 |
76 | this.createNewProps = this.createNewProps.bind(this);
77 | this.setWrappedInstance = this.setWrappedInstance.bind(this);
78 |
79 | if (debounce) {
80 | const debounceWait = typeof debounce === 'number' ? debounce : 0;
81 | this.createNewProps = debounceFn(this.createNewProps, debounceWait);
82 | }
83 |
84 | this.createEventListeners();
85 | }
86 |
87 | getModels() {
88 | const models = Object.assign({}, this.context, this.props.models);
89 | validateModelTypes(models);
90 | return models;
91 | }
92 |
93 | createEventListeners() {
94 | const models = this.getModels();
95 | Object.keys(models).forEach(mapKey => {
96 | const model = models[mapKey];
97 | // Do not attempt to create event listeners on an undefined model.
98 | if (!model) return;
99 |
100 | this.createEventListener(mapKey, model);
101 | });
102 |
103 | // Store a reference to the models with event listeners for the next update.
104 | this.prevModels = models;
105 | }
106 |
107 | createEventListener(modelName, model) {
108 | getEventNames(modelName).forEach(name => {
109 | model.on(name, this.createNewProps, this);
110 | });
111 | }
112 |
113 | removeEventListener(modelName, model) {
114 | getEventNames(modelName).forEach(name => {
115 | model.off(name, this.createNewProps, this);
116 | });
117 | }
118 |
119 | createNewProps() {
120 | // Bail out if our component has been unmounted.
121 | // The only case where this flag is encountered is when this component
122 | // is unmounted within an event handler but the 'all' event is still triggered.
123 | // It is covered in a test case.
124 | // Also bails if we haven't yet mounted, to avoid warnings in strict mode.
125 | if (!this.componentIsMounted) {
126 | return;
127 | }
128 | this.forceUpdate();
129 | }
130 |
131 | setWrappedInstance(ref) {
132 | this.wrappedInstance = ref;
133 | }
134 |
135 | getWrappedInstance() {
136 | if (!withRef) {
137 | throw new Error('getWrappedInstance() requires withRef to be true.');
138 | }
139 |
140 | return this.wrappedInstance;
141 | }
142 |
143 | componentDidMount() {
144 | this.componentIsMounted = true;
145 | }
146 |
147 | componentDidUpdate() {
148 | // add and remove listeners
149 | const models = this.getModels();
150 | const prevModels = this.prevModels;
151 |
152 | // Bind event listeners for each model that changed.
153 | Object.keys(Object.assign({}, models, prevModels)).forEach(mapKey => {
154 | const model = models[mapKey];
155 | const prevModel = prevModels[mapKey];
156 |
157 | // Do not attempt to create event listeners on an undefined model.
158 | if (!model) {
159 | // Instead, if it was previously defined, remove the old listeners.
160 | if (prevModel) {
161 | this.removeEventListener(mapKey, prevModel);
162 | }
163 | return;
164 | }
165 |
166 | if (prevModel === model) return; // Did not change.
167 |
168 | this.createEventListener(mapKey, model);
169 | });
170 |
171 | // Store a reference to the models with event listeners for the next update.
172 | this.prevModels = models;
173 | }
174 |
175 | componentWillUnmount() {
176 | if (debounce) {
177 | this.createNewProps.cancel();
178 | }
179 |
180 | Object.keys(this.prevModels).forEach(mapKey => {
181 | const model = this.prevModels[mapKey];
182 | // Do not attempt to remove event listeners on an undefined model.
183 | if (!model) return;
184 | this.removeEventListener(mapKey, model);
185 | });
186 |
187 | this.componentIsMounted = false;
188 | }
189 |
190 | render() {
191 | const wrappedProps = Object.assign(
192 | {},
193 | mapModelsToProps(this.getModels(), this.props),
194 | this.props
195 | );
196 |
197 | // Don't pass through models prop.
198 | wrappedProps.models = undefined;
199 |
200 | if (withRef) {
201 | wrappedProps.ref = this.setWrappedInstance;
202 | }
203 |
204 | return createElement(WrappedComponent, wrappedProps);
205 | }
206 | }
207 |
208 | const propTypes = {
209 | models: PropTypes.object,
210 | };
211 |
212 | ConnectBackboneToReact.WrappedComponent = WrappedComponent;
213 | ConnectBackboneToReact.displayName = displayName;
214 | ConnectBackboneToReact.propTypes = propTypes;
215 | ConnectBackboneToReact.contextType = BackboneToReactContext;
216 |
217 | return hoistStatics(ConnectBackboneToReact, WrappedComponent);
218 | };
219 | };
220 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright 2017 MongoDB Inc.
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/test/connect-backbone-to-react.test.js:
--------------------------------------------------------------------------------
1 | const assert = require('assert');
2 | const { mount } = require('enzyme');
3 | const sinon = require('sinon');
4 | const React = require('react');
5 | const { Component } = React;
6 | const { Model, Collection } = require('backbone');
7 | const connectBackboneToReact = require('../lib/connect-backbone-to-react');
8 |
9 | describe('connectBackboneToReact', function() {
10 | let sandbox;
11 | let wrapper;
12 | let stub;
13 | let modelsMap;
14 | let mapModelsToProps;
15 |
16 | let userModel;
17 | const UserModel = Model.extend({});
18 |
19 | let userCollection;
20 | const UserCollection = Collection.extend({
21 | model: UserModel,
22 | });
23 |
24 | let settingsModel;
25 | const SettingsModel = Model.extend({});
26 |
27 | let userOnSpy;
28 | let userOffSpy;
29 | let collOnSpy;
30 | let collOffSpy;
31 |
32 | class TestComponent extends Component {
33 | render() {
34 | return (
35 |