2
2
3
3
This module defines foreign types and functions which wrap React's functionality.
4
4
5
- #### ` UI `
5
+ #### ` ReactElement `
6
6
7
7
``` purescript
8
- data UI :: *
8
+ data ReactElement :: *
9
9
```
10
10
11
11
A virtual DOM node, or component.
12
12
13
- #### ` UIRef `
13
+ #### ` ReactThis `
14
14
15
15
``` purescript
16
- data UIRef :: *
16
+ data ReactThis :: *
17
17
```
18
18
19
19
A reference to a component, essentially React's ` this ` .
@@ -147,90 +147,90 @@ A function which handles events.
147
147
#### ` Render `
148
148
149
149
``` purescript
150
- type Render props state eff = UIRef -> Eff (props :: ReactProps props, refs :: ReactRefs Disallowed, state :: ReactState ReadOnly state | eff) UI
150
+ type Render props state eff = ReactThis -> Eff (props :: ReactProps props, refs :: ReactRefs Disallowed, state :: ReactState ReadOnly state | eff) ReactElement
151
151
```
152
152
153
153
A rendering function.
154
154
155
- #### ` UISpec `
155
+ #### ` ReactSpec `
156
156
157
157
``` purescript
158
- type UISpec props state eff = { render :: Render props state eff, displayName :: String, getInitialState :: UIRef -> Eff (props :: ReactProps props, state :: ReactState Disallowed state, refs :: ReactRefs Disallowed | eff) state, componentWillMount :: UIRef -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs Disallowed | eff) Unit, componentDidMount :: UIRef -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs ReadOnly | eff) Unit, componentWillReceiveProps :: UIRef -> props -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs ReadOnly | eff) Unit, shouldComponentUpdate :: UIRef -> props -> state -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs ReadOnly | eff) Boolean, componentWillUpdate :: UIRef -> props -> state -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs ReadOnly | eff) Unit, componentDidUpdate :: UIRef -> props -> state -> Eff (props :: ReactProps props, state :: ReactState ReadOnly state, refs :: ReactRefs ReadOnly | eff) Unit, componentWillUnmount :: UIRef -> Eff (props :: ReactProps props, state :: ReactState ReadOnly state, refs :: ReactRefs ReadOnly | eff) Unit }
158
+ type ReactSpec props state eff = { render :: Render props state eff, displayName :: String, getInitialState :: ReactThis -> Eff (props :: ReactProps props, state :: ReactState Disallowed state, refs :: ReactRefs Disallowed | eff) state, componentWillMount :: ReactThis -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs Disallowed | eff) Unit, componentDidMount :: ReactThis -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs ReadOnly | eff) Unit, componentWillReceiveProps :: ReactThis -> props -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs ReadOnly | eff) Unit, shouldComponentUpdate :: ReactThis -> props -> state -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs ReadOnly | eff) Boolean, componentWillUpdate :: ReactThis -> props -> state -> Eff (props :: ReactProps props, state :: ReactState ReadWrite state, refs :: ReactRefs ReadOnly | eff) Unit, componentDidUpdate :: ReactThis -> props -> state -> Eff (props :: ReactProps props, state :: ReactState ReadOnly state, refs :: ReactRefs ReadOnly | eff) Unit, componentWillUnmount :: ReactThis -> Eff (props :: ReactProps props, state :: ReactState ReadOnly state, refs :: ReactRefs ReadOnly | eff) Unit }
159
159
```
160
160
161
161
A specification of a component.
162
162
163
- #### ` UIFactory `
163
+ #### ` spec `
164
164
165
165
``` purescript
166
- type UIFactory props = props -> UI
166
+ spec :: forall props state eff. state -> Render props state eff -> ReactSpec props state eff
167
167
```
168
168
169
- Factory function for components .
169
+ Create a component specification .
170
170
171
- #### ` spec `
171
+ #### ` ReactClass `
172
172
173
173
``` purescript
174
- spec :: forall props state eff. state -> Render props state eff -> UISpec props state eff
174
+ data ReactClass :: * -> *
175
175
```
176
176
177
- Create a component specification .
177
+ React class for components .
178
178
179
179
#### ` getProps `
180
180
181
181
``` purescript
182
- getProps :: forall props eff. UIRef -> Eff (props :: ReactProps props | eff) props
182
+ getProps :: forall props eff. ReactThis -> Eff (props :: ReactProps props | eff) props
183
183
```
184
184
185
185
Read the component props.
186
186
187
187
#### ` getRefs `
188
188
189
189
``` purescript
190
- getRefs :: forall write eff. UIRef -> Eff (refs :: ReactRefs (Read write) | eff) Refs
190
+ getRefs :: forall write eff. ReactThis -> Eff (refs :: ReactRefs (Read write) | eff) Refs
191
191
```
192
192
193
193
Read the component refs.
194
194
195
195
#### ` getChildren `
196
196
197
197
``` purescript
198
- getChildren :: forall props eff. UIRef -> Eff (props :: ReactProps props | eff) (Array UI )
198
+ getChildren :: forall props eff. ReactThis -> Eff (props :: ReactProps props | eff) (Array ReactElement )
199
199
```
200
200
201
201
Read the component children property.
202
202
203
203
#### ` writeState `
204
204
205
205
``` purescript
206
- writeState :: forall state eff. UIRef -> state -> Eff (state :: ReactState ReadWrite state | eff) state
206
+ writeState :: forall state eff. ReactThis -> state -> Eff (state :: ReactState ReadWrite state | eff) state
207
207
```
208
208
209
209
Write the component state.
210
210
211
211
#### ` readState `
212
212
213
213
``` purescript
214
- readState :: forall state write eff. UIRef -> Eff (state :: ReactState (Read write) state | eff) state
214
+ readState :: forall state write eff. ReactThis -> Eff (state :: ReactState (Read write) state | eff) state
215
215
```
216
216
217
217
Read the component state.
218
218
219
219
#### ` transformState `
220
220
221
221
``` purescript
222
- transformState :: forall state statePerms eff. UIRef -> (state -> state) -> Eff (state :: ReactState ReadWrite state | eff) state
222
+ transformState :: forall state eff. ReactThis -> (state -> state) -> Eff (state :: ReactState ReadWrite state | eff) state
223
223
```
224
224
225
225
Transform the component state by applying a function.
226
226
227
- #### ` mkUI `
227
+ #### ` createClass `
228
228
229
229
``` purescript
230
- mkUI :: forall props state eff. UISpec props state eff -> UIFactory props
230
+ createClass :: forall props state eff. ReactSpec props state eff -> ReactClass props
231
231
```
232
232
233
- Create a component from a component spec .
233
+ Create a React class from a specification .
234
234
235
235
#### ` handle `
236
236
@@ -240,36 +240,36 @@ handle :: forall eff ev props state result. (ev -> EventHandlerContext eff props
240
240
241
241
Create an event handler.
242
242
243
- #### ` renderToString `
243
+ #### ` createElement `
244
244
245
245
``` purescript
246
- renderToString :: UI -> String
246
+ createElement :: forall props. ReactClass props -> props -> Array ReactElement -> ReactElement
247
247
```
248
248
249
- Render a component as a string .
249
+ Create an element from a React class .
250
250
251
- #### ` renderToBody `
251
+ #### ` createFactory `
252
252
253
253
``` purescript
254
- renderToBody :: forall eff. UI -> Eff (dom :: DOM | eff) UI
254
+ createFactory :: forall props. ReactClass props -> props -> ReactElement
255
255
```
256
256
257
- Render a component to the document body .
257
+ Create a factory from a React class .
258
258
259
- #### ` renderToElementById `
259
+ #### ` render `
260
260
261
261
``` purescript
262
- renderToElementById :: forall eff. String -> UI -> Eff (dom :: DOM | eff) UI
262
+ render :: forall eff. ReactElement -> Element -> Eff (dom :: DOM | eff) ReactElement
263
263
```
264
264
265
- Render a component to the element with the specified ID .
265
+ Render a React element in a document element .
266
266
267
- #### ` createElement `
267
+ #### ` renderToString `
268
268
269
269
``` purescript
270
- createElement :: forall props. UIFactory props -> props -> Array UI -> UI
270
+ renderToString :: ReactElement -> String
271
271
```
272
272
273
- Create an element from a component factory .
273
+ Render a React element as a string .
274
274
275
275
0 commit comments