22
33This module defines foreign types and functions which wrap React's functionality.
44
5- #### ` UI `
5+ #### ` ReactElement `
66
77``` purescript
8- data UI :: *
8+ data ReactElement :: *
99```
1010
1111A virtual DOM node, or component.
1212
13- #### ` UIRef `
13+ #### ` ReactThis `
1414
1515``` purescript
16- data UIRef :: *
16+ data ReactThis :: *
1717```
1818
1919A reference to a component, essentially React's ` this ` .
@@ -147,90 +147,90 @@ A function which handles events.
147147#### ` Render `
148148
149149``` 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
151151```
152152
153153A rendering function.
154154
155- #### ` UISpec `
155+ #### ` ReactSpec `
156156
157157``` 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 }
159159```
160160
161161A specification of a component.
162162
163- #### ` UIFactory `
163+ #### ` spec `
164164
165165``` purescript
166- type UIFactory props = props -> UI
166+ spec :: forall props state eff. state -> Render props state eff -> ReactSpec props state eff
167167```
168168
169- Factory function for components .
169+ Create a component specification .
170170
171- #### ` spec `
171+ #### ` ReactClass `
172172
173173``` purescript
174- spec :: forall props state eff. state -> Render props state eff -> UISpec props state eff
174+ data ReactClass :: * -> *
175175```
176176
177- Create a component specification .
177+ React class for components .
178178
179179#### ` getProps `
180180
181181``` 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
183183```
184184
185185Read the component props.
186186
187187#### ` getRefs `
188188
189189``` 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
191191```
192192
193193Read the component refs.
194194
195195#### ` getChildren `
196196
197197``` 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 )
199199```
200200
201201Read the component children property.
202202
203203#### ` writeState `
204204
205205``` 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
207207```
208208
209209Write the component state.
210210
211211#### ` readState `
212212
213213``` 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
215215```
216216
217217Read the component state.
218218
219219#### ` transformState `
220220
221221``` 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
223223```
224224
225225Transform the component state by applying a function.
226226
227- #### ` mkUI `
227+ #### ` createClass `
228228
229229``` 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
231231```
232232
233- Create a component from a component spec .
233+ Create a React class from a specification .
234234
235235#### ` handle `
236236
@@ -240,36 +240,36 @@ handle :: forall eff ev props state result. (ev -> EventHandlerContext eff props
240240
241241Create an event handler.
242242
243- #### ` renderToString `
243+ #### ` createElement `
244244
245245``` purescript
246- renderToString :: UI -> String
246+ createElement :: forall props. ReactClass props -> props -> Array ReactElement -> ReactElement
247247```
248248
249- Render a component as a string .
249+ Create an element from a React class .
250250
251- #### ` renderToBody `
251+ #### ` createFactory `
252252
253253``` purescript
254- renderToBody :: forall eff. UI -> Eff (dom :: DOM | eff) UI
254+ createFactory :: forall props. ReactClass props -> props -> ReactElement
255255```
256256
257- Render a component to the document body .
257+ Create a factory from a React class .
258258
259- #### ` renderToElementById `
259+ #### ` render `
260260
261261``` purescript
262- renderToElementById :: forall eff. String -> UI -> Eff (dom :: DOM | eff) UI
262+ render :: forall eff. ReactElement -> Element -> Eff (dom :: DOM | eff) ReactElement
263263```
264264
265- Render a component to the element with the specified ID .
265+ Render a React element in a document element .
266266
267- #### ` createElement `
267+ #### ` renderToString `
268268
269269``` purescript
270- createElement :: forall props. UIFactory props -> props -> Array UI -> UI
270+ renderToString :: ReactElement -> String
271271```
272272
273- Create an element from a component factory .
273+ Render a React element as a string .
274274
275275
0 commit comments