├── .gitignore ├── LICENSE ├── README.md ├── build.js ├── dist └── functional-react.js ├── examples └── simpleComponent │ ├── FullComponent.js │ ├── InfoText.js │ ├── Page.js │ ├── build.js │ ├── dist │ └── page.js │ ├── output.js │ └── simpleComponent.html ├── index.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # node-waf configuration 20 | .lock-wscript 21 | 22 | # Compiled binary addons (http://nodejs.org/api/addons.html) 23 | build/Release 24 | 25 | # Dependency directory 26 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git 27 | node_modules 28 | -------------------------------------------------------------------------------- /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 {yyyy} {name of copyright owner} 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 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # functional-react 2 | An experiment in making a functional API for React components 3 | 4 | This is an experimental library to see what it would be like to code React components in a completely functional way, inspired by [Deku](https://github.com/dekujs/deku). 5 | 6 | To define a React component in functional-react, you define your render and lifecycle methods as pure functions (without using a `this` pointer) and then pass them to functional-react, which returns a React component. In the simplest case, a component that reads out a single string looks like this: 7 | 8 | ```javascript 9 | import component from "functional-react"; 10 | 11 | const render = ({props}) => { 12 | return
Hello, {props.name}!
; 13 | } 14 | 15 | export default component({render}); 16 | ``` 17 | 18 | Lifecycle methods can be used, too: 19 | 20 | ```javascript 21 | import component from "functional-react"; 22 | 23 | const shouldComponentUpdate = ({props}, {props: nextProps}) => { 24 | // if the name hasn't changed, there's no reason to update. 25 | return props.name !== nextProps.name; 26 | } 27 | 28 | const render = ({props}) => { 29 | return
Hello, {props.name}!
; 30 | } 31 | 32 | export default component({render, shouldComponentUpdate}); 33 | ``` 34 | 35 | One wrinkle occurs when you want to render a component with an event handler, as binding the event handler is problematic; there is no `this` pointer to bind to at render time. For this, there is a second argument passed to `render` which should wrap all event handlers; it makes sure that the event handlers receive the correct props, state, and setState. 36 | 37 | ```javascript 38 | import component from "functional-react"; 39 | 40 | const alertMyName = ({props}, setState) => { 41 | alert(`Hey there, ${props.name}!`); 42 | } 43 | 44 | const render = ({props}, handler) => { 45 | // note that we wrap alertMyName so that it gets bound to the correct 46 | // component props & state. 47 | return
Hello, {props.name}!
; 48 | } 49 | 50 | export default component({render}); 51 | ``` 52 | 53 | ## Component API 54 | 55 | The Component API maps very directly onto the React component API. All of the existing React "instance" methods are passed in a simple object with the current props and state as the first argument, so they use that rather than using `this.props` or `this.state`. In methods where it would be appropriate to call `this.setState()`, that method is passed in as well. 56 | 57 | When `setState` is passed in, it is a function with the same signature and behavior as React's `setState`. 58 | 59 | #### render({props, state}, handler) : ReactElement 60 | The first argument is the current props & state, which should be all that the component needs to render. Note that the second argument is a function that will wrap an event handler function and return a handler that is always bound correctly to the correct component props & state. See the Event API below for event handler signatures. 61 | 62 | #### getInitialState() : object 63 | Returns the initial state of an instance of this component. This method is *not* passed props & state, as the component has not yet been created. 64 | 65 | #### getDefaultProps() : object 66 | Returns the default set of props for an instance of this component; note that the default props are shared amongst all instances. 67 | 68 | #### propTypes : object 69 | Used for validating props that are passed to this component. 70 | 71 | #### displayName : String 72 | This is just passed through to React as the component's `displayName`. 73 | 74 | #### componentWillMount({props, state}, setState) : void 75 | Called before the component is mounted into the DOM, with the current props & state combo and the `setState` function. 76 | 77 | #### componentDidMount({props, state}) 78 | Called after the component is mounted into the DOM, with the current props & state combo. Note that `setState` is not passed in, as it would not do anything meaningful to the component post-mounting. 79 | 80 | #### componentWillReceiveProps({props, state}, nextProps, setState) 81 | The first argument is the current props & state, the second argument is the new props that the component will have, and the third argument is the `setState` function that can change this component's state if necessary. 82 | 83 | #### shouldComponentUpdate({props, state}, ({props, state}) : boolean 84 | The first argument is the current props & state, and the second arg is the next props & state. Returns a boolean indicating whether React should re-render this component. 85 | 86 | #### componentWillUpdate({props, state}, ({props, state}) 87 | The first argument is the current props & state, and the second arg is the next props & state. Note that `setState` is not sent to this function, as [the React documentation states](https://facebook.github.io/react/docs/component-specs.html#updating-componentwillupdate): "You _cannot_ use `this.setState()` in this method. If you need to update state in response to a prop change, use `componentWillReceiveProps` instead." 88 | 89 | #### componentDidUpdate({props, state}, ({props, state}) 90 | The first argument is the current props & state, and the second arg is the previous props & state. Note that, unlike `componentWillUpdate`, the second argument is the earlier props & state; this is because I decided to standardize on the idea that current props & state is always the first argument. 91 | 92 | #### componentWillUnmount({props, state}) 93 | Called before the component is unmounted from the DOM. 94 | 95 | ## Event Handler API 96 | 97 | When an event handler is passed to `handler` in the `render` method, it guarantees that the event handler will always be called with the following arguments: 98 | 99 | #### eventHandler({props, state}, setState) 100 | The first argument is the current props & state, the second argument is the setState function that can change this component's state if necessary. 101 | 102 | ## Is this a good idea? 103 | 104 | I'm not really sure. There's a certain purity to it, and it helps developers make mistakes in the lifecycle, for two reasons that I can see: 105 | 106 | 1. Components can't messily put attributes on the `this` object and expect them to be around during later lifecycle calls. As a result, components have to be more rigorous about using props and state. 107 | 2. It's somewhat clearer that props and state can't be changed in place. Some developers try to change `this.props` or `this.state` directly, and that causes nothing but sadness. 108 | 3. The API is clearer about when `setState` is allowed to be called and when it isn't. In React, developers can sometimes shoot themselves in the foot calling `this.setState` in the wrong method. 109 | 110 | Those seem better, especially for new developers, but frankly, they seem like just marginal wins to me. 111 | 112 | One thing that I haven't fully groked is what this does to mixins. I think that in many cases mixins just become functions that you import. For example, imagine a component whose render only depends on props and state and therefore wants to implement a "pure" `shouldComponentUpdate` function: 113 | 114 | ```javascript 115 | import component from "functional-react"; 116 | import {PureShouldComponentUpdate} from "some-should-component-update-lib-of-your-choosing"; 117 | 118 | const render = ({props}) => { 119 | return
Hello, {props.name}!
; 120 | } 121 | 122 | export default component({render, shouldComponentUpdate:PureShouldComponentUpdate}); 123 | ``` 124 | 125 | You could also imagine composing library functions together into chains to implement a lifecycle method for your component. This seems to me a bit cleaner than the current mixin story, but I doubt I've considered all its contours. -------------------------------------------------------------------------------- /build.js: -------------------------------------------------------------------------------- 1 | var browserify = require('browserify'); 2 | var uglify = require('uglifyify'); 3 | var babelify = require("babelify"); 4 | 5 | var fs = require("fs"); 6 | var b = browserify({ 7 | transform: [babelify, uglify] 8 | }); 9 | b.add('./index.js'); 10 | b.external("react"); 11 | b.bundle().pipe(fs.createWriteStream("./dist/functional-react.js")); 12 | -------------------------------------------------------------------------------- /dist/functional-react.js: -------------------------------------------------------------------------------- 1 | (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o ({buttonPushes: 0}); 6 | 7 | const incrementPushes = ({state}, setState) => { 8 | setState({buttonPushes: state.buttonPushes + 1}); 9 | } 10 | 11 | const render = ({state}, handler) => { 12 | return ( 13 |
14 | 15 | 16 |
17 | ); 18 | } 19 | 20 | export default component({render, getInitialState}); 21 | -------------------------------------------------------------------------------- /examples/simpleComponent/InfoText.js: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import component from "../../index.js"; 3 | 4 | 5 | const render = ({props}) => { 6 | return
The button has been pushed {props.buttonPushes} time(s)
; 7 | } 8 | 9 | export default component({render}); 10 | -------------------------------------------------------------------------------- /examples/simpleComponent/Page.js: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import FullComponent from "./FullComponent"; 3 | 4 | document.addEventListener("DOMContentLoaded", function(event) { 5 | React.render(, document.getElementById("main")); 6 | }); 7 | -------------------------------------------------------------------------------- /examples/simpleComponent/build.js: -------------------------------------------------------------------------------- 1 | var browserify = require('browserify'); 2 | var uglify = require('uglifyify'); 3 | var babelify = require("babelify"); 4 | 5 | var fs = require("fs"); 6 | var b = browserify({ 7 | transform: [babelify, uglify] 8 | }); 9 | b.add('./Page.js'); 10 | b.bundle().pipe(fs.createWriteStream("./dist/page.js")); 11 | -------------------------------------------------------------------------------- /examples/simpleComponent/simpleComponent.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | Simple Component Example 4 | 5 | 6 | 7 |
8 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | 2 | import React from "react"; 3 | 4 | export default function({ 5 | render, 6 | getInitialState, 7 | getDefaultProps, 8 | propTypes, 9 | displayName, 10 | componentWillMount, 11 | componentDidMount, 12 | componentWillReceiveProps, 13 | shouldComponentUpdate, 14 | componentWillUpdate, 15 | componentDidUpdate, 16 | componentWillUnmount, 17 | }) { 18 | 19 | let componentSpec = {}; 20 | 21 | if (render) { 22 | componentSpec.render = function() { 23 | // this method will bind handlers to the correct this pointer; 24 | // could be problematic because this'll be called on every render. 25 | const handler = (impl) => { 26 | return (e) => { 27 | impl({props: this.props, state: this.state}, this.setState.bind(this)); 28 | } 29 | } 30 | return render({props: this.props, state: this.state}, handler); 31 | } 32 | } 33 | 34 | if (getInitialState) { 35 | componentSpec.getInitialState = function() { 36 | return getInitialState(); 37 | } 38 | } 39 | 40 | if (getDefaultProps) { 41 | componentSpec.getDefaultProps = function() { 42 | return getDefaultProps(); 43 | } 44 | } 45 | 46 | if (propTypes) { 47 | componentSpec.propTypes = propTypes; 48 | } 49 | 50 | if (displayName) { 51 | componentSpec.displayName = displayName; 52 | } 53 | 54 | if (componentWillMount) { 55 | componentSpec.componentWillMount = function() { 56 | componentWillMount({props: this.props, state: this.state}, this.setState.bind(this)); 57 | } 58 | } 59 | 60 | if (componentDidMount) { 61 | componentSpec.componentDidMount = function () { 62 | componentDidMount({props: this.props, state: this.state}); 63 | } 64 | } 65 | 66 | if (componentWillReceiveProps) { 67 | componentSpec.componentWillReceiveProps = function(nextProps) { 68 | componentWillReceiveProps({props: this.props, state: this.state}, nextProps, this.setState.bind(this)); 69 | } 70 | } 71 | 72 | if (shouldComponentUpdate) { 73 | componentSpec.shouldComponentUpdate = function(nextProps, nextState) { 74 | return shouldComponentUpdate({props: this.props, state: this.state}, {props: nextProps, state:nextState}); 75 | } 76 | } 77 | 78 | if (componentWillUpdate) { 79 | componentSpec.componentWillUpdate = function(nextProps, nextState) { 80 | componentWillUpdate({props: this.props, state: this.state}, {props: nextProps, state:nextState}); 81 | } 82 | } 83 | 84 | if (componentDidUpdate) { 85 | componentSpec.componentDidUpdate = function(prevProps, prevState) { 86 | componentDidUpdate({props: this.props, state: this.state}, {props: prevProps, state:prevState}); 87 | } 88 | } 89 | 90 | if (componentWillUnmount) { 91 | componentSpec.componentWillUnmount = function() { 92 | componentWillUnmount({props: this.props, state: this.state}); 93 | } 94 | } 95 | 96 | return React.createClass(componentSpec); 97 | }; 98 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "functional-react", 3 | "version": "0.1.3", 4 | "description": "An experiment in making a functional API for React components", 5 | "main": "./dist/functional-react.js", 6 | "homepage": "https://github.com/aickin/functional-react", 7 | "scripts": { 8 | "test": "echo \"Error: no test specified\" && exit 1", 9 | "build": "node ./build.js" 10 | }, 11 | "keywords": [ 12 | "react", 13 | "functional", 14 | "component" 15 | ], 16 | "repository": { 17 | "type": "git", 18 | "url": "https://github.com/aickin/functional-react.git" 19 | }, 20 | "author": "Sasha Aickin", 21 | "license": "Apache 2.0", 22 | "devDependencies": { 23 | "babel": "5.4.3", 24 | "babelify": "6.1.1", 25 | "browserify": "10.2.1", 26 | "gulp": "^3.8.11", 27 | "gulp-babel": "^5.1.0", 28 | "gulp-uglify": "^1.2.0", 29 | "gulp-util": "^3.0.4", 30 | "uglifyify": "3.0.1", 31 | "vinyl-buffer": "^1.0.0", 32 | "vinyl-source-stream": "^1.1.0" 33 | }, 34 | "dependencies": { 35 | "react": "0.13.3" 36 | } 37 | } 38 | --------------------------------------------------------------------------------