Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
paf31 committed Jun 13, 2018
1 parent 46aa6d9 commit 1ce2617
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 14 deletions.
10 changes: 1 addition & 9 deletions generated-docs/React/Basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#### `react`

``` purescript
react :: forall props state fx. { displayName :: String, initialState :: { | state }, receiveProps :: { | props } -> { | state } -> (SetState state fx) -> Eff (react :: ReactFX | fx) Unit, render :: { | props } -> { | state } -> (SetState state fx) -> JSX } -> ReactComponent { | props }
react :: forall props state fx. { displayName :: String, initialState :: { | state }, receiveProps :: { | props } -> { | state } -> (SetState state fx) -> Effect Unit, render :: { | props } -> { | state } -> (SetState state fx) -> JSX } -> ReactComponent { | props }
```

Create a React component from a _specification_ of that component.
Expand Down Expand Up @@ -95,12 +95,4 @@ data ReactComponent :: Type -> Type

A React component which can be used from JavaScript.

#### `ReactFX`

``` purescript
data ReactFX :: Effect
```

A placeholder effect for all React FFI.


10 changes: 5 additions & 5 deletions generated-docs/React/Basic/Events.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#### `EventHandler`

``` purescript
type EventHandler = EffFn1 (react :: ReactFX) SyntheticEvent Unit
type EventHandler = EffectFn1 SyntheticEvent Unit
```

An event handler, which receives a `SyntheticEvent` and performs some
Expand Down Expand Up @@ -38,7 +38,7 @@ input { onChange: handler (preventDefault >>> targetValue)
``` purescript
Semigroupoid EventFn
Category EventFn
(IsSymbol l, RowCons l (EventFn a b) fns_rest fns, RowCons l b r_rest r, RowLacks l fns_rest, RowLacks l r_rest, Merge rest fns_rest a r_rest) => Merge (Cons l (EventFn a b) rest) fns a r
(IsSymbol l, Cons l (EventFn a b) fns_rest fns, Cons l b r_rest r, Lacks l fns_rest, Lacks l r_rest, Merge rest fns_rest a r_rest) => Merge (Cons l (EventFn a b) rest) fns a r
```

#### `unsafeEventFn`
Expand All @@ -56,7 +56,7 @@ Instead, use the helper functions specific to your platform, such as `React.Basi
#### `handler`

``` purescript
handler :: forall a. EventFn SyntheticEvent a -> (a -> Eff (react :: ReactFX) Unit) -> EventHandler
handler :: forall a. EventFn SyntheticEvent a -> (a -> Effect Unit) -> EventHandler
```

Create an `EventHandler`, given an `EventFn` and a callback.
Expand All @@ -72,7 +72,7 @@ input { onChange: handler targetValue
#### `handler_`

``` purescript
handler_ :: Eff (react :: ReactFX) Unit -> EventHandler
handler_ :: Effect Unit -> EventHandler
```

Create an `EventHandler` which discards the `SyntheticEvent`.
Expand Down Expand Up @@ -116,7 +116,7 @@ class Merge (rl :: RowList) fns a r | rl -> fns, rl a -> r where
##### Instances
``` purescript
Merge Nil () a ()
(IsSymbol l, RowCons l (EventFn a b) fns_rest fns, RowCons l b r_rest r, RowLacks l fns_rest, RowLacks l r_rest, Merge rest fns_rest a r_rest) => Merge (Cons l (EventFn a b) rest) fns a r
(IsSymbol l, Cons l (EventFn a b) fns_rest fns, Cons l b r_rest r, Lacks l fns_rest, Lacks l r_rest, Merge rest fns_rest a r_rest) => Merge (Cons l (EventFn a b) rest) fns a r
```


0 comments on commit 1ce2617

Please sign in to comment.