Skip to content

Topic/implementation #1

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 2 commits into from
Jan 25, 2016
Merged
Show file tree
Hide file tree
Changes from all 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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,13 @@
Low-level React DOM bindings for PureScript

- [Module Documentation](docs/)

## Installation

```
bower install purescript-react-dom
```

## Example

Please refer to [purescript-react-example](https://github.com/ethul/purescript-react-example)
16 changes: 15 additions & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
{
"name": "purescript-react-dom",
"description": "PureScript bindings for react-dom",
"main": "",
"keywords": [
"purescript",
"react"
],
"license": "MIT",
"ignore": [
"*",
"!src/**/*"
]
],
"repository": {
"type": "git",
"url": "git://github.com/purescript-contrib/purescript-react-dom.git"
},
"dependencies": {
"purescript-dom": "~0.2.15",
"purescript-react": "~0.6.0"
}
}
43 changes: 43 additions & 0 deletions docs/ReactDOM.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## Module ReactDOM

#### `render`

``` purescript
render :: forall eff. ReactElement -> Element -> Eff (dom :: DOM | eff) (Maybe ReactComponent)
```

Render a React element in a document element. Returns Nothing for stateless components.

#### `unmountComponentAtNode`

``` purescript
unmountComponentAtNode :: forall eff. Element -> Eff (dom :: DOM | eff) Boolean
```

Removes a mounted React element in a document element. Returns true if it was unmounted, false otherwise.

#### `findDOMNode`

``` purescript
findDOMNode :: forall eff. ReactComponent -> Eff (dom :: DOM | eff) Element
```

Finds the DOM node rendered by the component.

#### `renderToString`

``` purescript
renderToString :: ReactElement -> String
```

Render a React element as a string.

#### `renderToStaticMarkup`

``` purescript
renderToStaticMarkup :: ReactElement -> String
```

Render a React element as static markup string without extra DOM attributes.


7 changes: 7 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"name": "purescript-react-dom",
"files": [],
"peerDependencies": {
"react-dom": "^0.14.6"
}
}
34 changes: 34 additions & 0 deletions src/ReactDOM.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/* global exports */
"use strict";

// module ReactDOM

var ReactDOM = require('react-dom');

var ReactDOMServer = require('react-dom/server');

function renderFn(nothing, just, element, container) {
return function(){
var result = ReactDOM.render(element, container);
return result === null ? nothing : just(result);
}
}
exports.renderFn = renderFn;

function unmountComponentAtNode(container) {
return function(){
return ReactDOM.unmountComponentAtNode(container);
};
}
exports.unmountComponentAtNode = unmountComponentAtNode;

function findDOMNode(component) {
return function(){
return ReactDOM.findDOMNode(component);
};
}
exports.findDOMNode = findDOMNode;

exports.renderToString = ReactDOMServer.renderToString;

exports.renderToStaticMarkup = ReactDOMServer.renderToStaticMarkup;
40 changes: 40 additions & 0 deletions src/ReactDOM.purs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
module ReactDOM
( render
, unmountComponentAtNode
, findDOMNode
, renderToString
, renderToStaticMarkup
) where

import Control.Monad.Eff (Eff())

import Data.Function (Fn4(), runFn4)
import Data.Maybe (Maybe(..))

import DOM (DOM())
import DOM.Node.Types (Element())

import React (ReactElement(), ReactComponent())

-- | Render a React element in a document element. Returns Nothing for stateless components.
render :: forall eff. ReactElement -> Element -> Eff (dom :: DOM | eff) (Maybe ReactComponent)
render = runFn4 renderFn Nothing Just

foreign import renderFn
:: forall eff. Fn4 (Maybe ReactComponent)
(ReactComponent -> Maybe ReactComponent)
ReactElement
Element
(Eff (dom :: DOM | eff) (Maybe ReactComponent))

-- | Removes a mounted React element in a document element. Returns true if it was unmounted, false otherwise.
foreign import unmountComponentAtNode :: forall eff. Element -> Eff (dom :: DOM | eff) Boolean

-- | Finds the DOM node rendered by the component.
foreign import findDOMNode :: forall eff. ReactComponent -> Eff (dom :: DOM | eff) Element

-- | Render a React element as a string.
foreign import renderToString :: ReactElement -> String

-- | Render a React element as static markup string without extra DOM attributes.
foreign import renderToStaticMarkup :: ReactElement -> String