Skip to content

Remove Array JSX "children" argument #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 6, 2018
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock.json binary
33 changes: 33 additions & 0 deletions DEPENDENCIES
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,36 @@ react-html-attributes is used here during code generation, under the terms of th
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

TypeScript's class polyfill is used for React compatibility in ES5, under the terms of the Apache-2.0 license:

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ This package implements an opinionated set of bindings to the React library, opt

## Features

- All React DOM elements and attributes are supported.
- All React DOM elements and attributes are supported (soon, events are a work in progress).
- An intuitive API for specifying props - no arrays of key value pairs, just records.
- Attributes are optional, but type-checked. It is a type error to specify `href` as an integer, for example.

## Getting Started

You can install this package using Bower:

```
```sh
bower install git@github.com:lumihq/purescript-react-basic.git
```

Expand All @@ -24,36 +24,32 @@ module React.Basic.Example where
import Prelude

import Control.Monad.Eff.Uncurried (mkEffFn1)
import React.Basic as R
import React.Basic (ReactComponent, reactComponent)
import React.Basic.DOM as R

-- The props for the component
type ExampleProps =
{ label :: String
}

-- The internal state of the component
type ExampleState =
{ counter :: Int
}

-- Create a component by passing a record to the `react` function.
-- Create a component by passing a record to the `reactComponent` function.
-- The `render` function takes the props and current state, as well as a
-- state update callback, and produces a document.
example :: R.ReactComponent ExampleProps
example = R.react
example :: ReactComponent ExampleProps
example = reactComponent
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like it was changed back to react?

{ initialState: { counter: 0 }
, receiveProps: \_ _ _ -> pure unit
, render: \{ label } { counter } setState ->
R.button { onClick: mkEffFn1 \_ -> do
setState { counter: counter + 1 }
setState \s -> { counter: s.counter + 1 }
, children: [ R.text (label <> ": " <> show counter) ]
}
[ R.text (label <> ": " <> show counter) ]
}
```

This component can be used directly from JavaScript. For example, if you are using `purs-loader`:

```javascript
```jsx
import {example as Example} from 'React.Basic.Example.purs';

const myComponent = () => (
Expand Down
43 changes: 25 additions & 18 deletions codegen/index.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
const props = require('react-html-attributes');
const voids = ['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', 'track', 'wbr'];
const props = require("react-html-attributes");
const voids = ["area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta", "param", "source", "track", "wbr"];
const types = {
"allowFullScreen": "Boolean",
"async": "Boolean",
"autoPlay": "Boolean",
"capture": "Boolean",
"checked": "Boolean",
"children": "Array JSX",
"cols": "Number",
"controls": "Boolean",
"default": "Boolean",
Expand All @@ -30,29 +31,35 @@ const types = {
"selected": "Boolean",
"size": "Number",
"span": "Number",
"start": "Number",
"zoomAndPan": "String"
"start": "Number"
};
const reserved = ["module", "data", "type", "newtype", "class", "instance", "where", "derive", "if", "then", "else", "case", "of"];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're using these as record labels, there's no need to escape keywords (at least in recent versions of PureScript).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They become function names though, like div. The one that was giving me problems was data. Apparently it's an HTML tag.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't realize data was a html tag. None of the others listed in reserved are html tags are they? @paf31 Was data not causing a problem in the previous version of this script?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assumed I got a newer version of react-html-attributes or something. It seemed safer to add everything to the reserved list than have to remember and go back later if type or module become elements.


printRecord = (elProps) => `
printRecord = (elProps) => elProps.length ? `
( ${ elProps.map((p) =>
`${p} :: ${types[p] || 'String'}`).join('\n , ')
`${p} :: ${types[p] || "String"}`).join("\n , ")
}
)`
)` : "()"

props.elements.html
.map((e) =>`
type Props_${e} = ${
props[e]
? printRecord(props[e])
: '()'
}
.map((e) => {
const noChildren = voids.includes(e);
const symbol = reserved.includes(e) ? `${e}'` : e;
return `
type Props_${e} = ${printRecord(
(noChildren ? [] : ["children"]).concat(props[e] || []).sort()
)}

${e}
${symbol}
:: forall attrs attrs_
. Union attrs attrs_ (SharedProps Props_${e}))
. Union attrs attrs_ (SharedProps Props_${e})
=> Record attrs
-> Array JSX
-> JSX
${e} = ${voids.indexOf(e) >= 0 ? 'createElementNoChildren' : 'createElement'} "${e}"
`).forEach((x) => console.log(x.replace(/^\n\ {4}/, '').replace(/\n\ {4}/g, '\n')))
${symbol} = createElement (stringComponent "${e}")${
noChildren ? "" : `

${e}_ :: Array JSX -> JSX
${e}_ children = ${symbol} { children }`
}
`;
}).forEach((x) => console.log(x.replace(/^\n\ {4}/, "").replace(/\n\ {4}/g, "\n")))
5 changes: 2 additions & 3 deletions examples/component/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
"keywords": [],
"author": "",
"dependencies": {
"create-react-class": "^15.6.2",
"react": "^15.6.2",
"react-dom": "^15.6.2"
"react": "^16.2.0",
"react-dom": "^16.2.0"
},
"devDependencies": {
"browserify": "^16.1.0"
Expand Down
35 changes: 19 additions & 16 deletions examples/component/src/Container.purs
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
module Container where

import Prelude

import React.Basic as R
import ToggleButton as ToggleButton

component :: R.ReactComponent Unit
component = R.react
{ initialState: unit
, receiveProps: \_ _ _ -> pure unit
, render: \_ _ setState ->
R.div { } [ R.component ToggleButton.component { on: true }
, R.component ToggleButton.component { on: false }
]
}
module Container where

import Prelude

import React.Basic (ReactComponent, createElement, react)
import React.Basic.DOM as R
import ToggleButton as ToggleButton

component :: ReactComponent Unit
component = react
{ displayName: "Container"
, initialState: unit
, receiveProps: \_ _ _ -> pure unit
, render: \_ _ setState ->
R.div { children: [ createElement ToggleButton.component { on: true }
, createElement ToggleButton.component { on: false }
]
}
}
46 changes: 22 additions & 24 deletions examples/component/src/ToggleButton.purs
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
module ToggleButton where

import Prelude

import Control.Monad.Eff.Uncurried (mkEffFn1)
import React.Basic as R

type ExampleProps =
{ on :: Boolean
}

type ExampleState =
{ on :: Boolean
}

component :: R.ReactComponent ExampleProps
component = R.react
{ initialState: { on: false }
, receiveProps: \{ on } _ setState -> setState { on }
, render: \_ { on } setState ->
R.button { onClick: mkEffFn1 \_ -> setState { on: not on }
}
[ R.text if on then "On" else "Off" ]
}
module ToggleButton where

import Prelude

import Control.Monad.Eff.Uncurried (mkEffFn1)
import React.Basic (ReactComponent, react)
import React.Basic.DOM as R

type ExampleProps =
{ on :: Boolean
}

component :: ReactComponent ExampleProps
component = react
{ displayName: "ToggleButton"
, initialState: { on: false }
, receiveProps: \{ on } _ setState -> setState (const { on })
, render: \_ { on } setState ->
R.button { onClick: mkEffFn1 \_ -> setState \s -> { on: not s.on }
, children: [ R.text if on then "On" else "Off" ]
}
}
4 changes: 2 additions & 2 deletions examples/counter/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"author": "",
"dependencies": {
"create-react-class": "^15.6.2",
"react": "^15.6.2",
"react-dom": "^15.6.2"
"react": "^16.2.0",
"react-dom": "^16.2.0"
},
"devDependencies": {
"browserify": "^16.1.0"
Expand Down
57 changes: 27 additions & 30 deletions examples/counter/src/Counter.purs
Original file line number Diff line number Diff line change
@@ -1,30 +1,27 @@
module Counter where

import Prelude

import Control.Monad.Eff.Uncurried (mkEffFn1)
import React.Basic as R

-- The props for the component
type ExampleProps =
{ label :: String
}

-- The internal state of the component
type ExampleState =
{ counter :: Int
}

-- Create a component by passing a record to the `react` function.
-- The `render` function takes the props and current state, as well as a
-- state update callback, and produces a document.
component :: R.ReactComponent ExampleProps
component = R.react
{ initialState: { counter: 0 }
, receiveProps: \_ _ _ -> pure unit
, render: \{ label } { counter } setState ->
R.button { onClick: mkEffFn1 \_ -> do
setState { counter: counter + 1 }
}
[ R.text (label <> ": " <> show counter) ]
}
module Counter where

import Prelude

import Control.Monad.Eff.Uncurried (mkEffFn1)
import React.Basic (ReactComponent, react)
import React.Basic.DOM as R

-- The props for the component
type ExampleProps =
{ label :: String
}

-- Create a component by passing a record to the `react` function.
-- The `render` function takes the props and current state, as well as a
-- state update callback, and produces a document.
component :: ReactComponent ExampleProps
component = react
{ displayName: "Counter"
, initialState: { counter: 0 }
, receiveProps: \_ _ _ -> pure unit
, render: \{ label } { counter } setState ->
R.button { onClick: mkEffFn1 \_ -> do
setState \s -> { counter: s.counter + 1 }
, children: [ R.text (label <> ": " <> show counter) ]
}
}
Loading