React

type TagName = String

Name of a tag.

data ReactElement :: Type

A virtual DOM node, or component.

Instances

• Semigroup ReactElement
• Monoid ReactElement
• IsReactElement ReactElement
• IsReactElement (Array ReactElement)

data ReactComponent :: Type

A mounted react component

data ReactThis :: Type -> Type -> Type

A reference to a component, essentially React's this.

data ReactUnusedSnapshot :: Type

type SyntheticEventHandler event = EffectFn1 event Unit

type Render = Effect ReactElement

A render effect.

type ComponentWillMount = Effect Unit

A component will mount effect.

type ComponentDidMount = Effect Unit

A component did mount effect.

type ComponentDidCatch = Error -> { componentStack :: String } -> Effect Unit

A component did catch effect.

type ComponentWillReceiveProps props = props -> Effect Unit

A component will receive props function.

type ShouldComponentUpdate props state = props -> state -> Effect Boolean

A should component update function.

type ComponentWillUpdate props state = props -> state -> Effect Unit

A component will update function.

type ComponentDidUpdate props state snapshot = props -> state -> snapshot -> Effect Unit

A component did update function.

type GetSnapshotBeforeUpdate props state snapshot = props -> state -> Effect snapshot

type ComponentWillUnmount = Effect Unit

A component will unmount effect.

type ReactSpecRequired state r = (state :: state, render :: Render | r)

Required fields for constructing a ReactClass.

type ReactSpecUnsafe props state r = (unsafeComponentWillMount :: ComponentWillMount, unsafeComponentWillReceiveProps :: ComponentWillReceiveProps props, unsafeComponentWillUpdate :: ComponentWillUpdate props state | r)

type ReactSpecOptional props state snapshot r = (componentDidMount :: ComponentDidMount, componentDidCatch :: ComponentDidCatch, componentWillUnmount :: ComponentWillUnmount, componentDidUpdate :: ComponentDidUpdate props state snapshot, getSnapshotBeforeUpdate :: GetSnapshotBeforeUpdate props state snapshot | ReactSpecUnsafe props state r)

Optional fields for constructing a ReactClass.

type ReactSpecShouldComponentUpdate props state = (shouldComponentUpdate :: ShouldComponentUpdate props state)

type ReactSpecAll props state snapshot = (ReactSpecRequired state) + (ReactSpecOptional props state snapshot) + (ReactSpecShouldComponentUpdate props state)

type ReactSpecPure props state snapshot = (ReactSpecRequired state) + (ReactSpecOptional props state snapshot ())

type ReactClassConstructor props state r = ReactThis props state -> Effect ({  | r })

The signature for a ReactClass constructor. A constructor takes the ReactThis context and returns a record with appropriate lifecycle methods.

class ReactComponentSpec props state snapshot (given :: # Type) (spec :: # Type) 

Instances

• (Union given (ReactSpecAll props state ReactUnusedSnapshot) spec, Nub spec (ReactSpecAll props state snapshot)) => ReactComponentSpec props state snapshot given spec

class ReactPureComponentSpec props state snapshot (given :: # Type) (spec :: # Type) 

Instances

• (Union given (ReactSpecPure props state ReactUnusedSnapshot) spec, Nub spec (ReactSpecPure props state snapshot)) => ReactPureComponentSpec props state snapshot given spec

component :: forall props state snapshot given spec. ReactComponentSpec ({  | props }) ({  | state }) snapshot given spec => String -> ReactClassConstructor ({  | props }) ({  | state }) given -> ReactClass ({  | props })

Creates a ReactClass`` inherited fromReact.Component`.

componentWithDerivedState :: forall props state snapshot given spec. ReactComponentSpec ({  | props }) ({  | state }) snapshot given spec => String -> ({  | props } -> {  | state } -> {  | state }) -> ReactClassConstructor ({  | props }) ({  | state }) given -> ReactClass ({  | props })

Like component, but takes a getDerivedStateFromProps handler.

pureComponent :: forall props state snapshot given spec. ReactPureComponentSpec ({  | props }) ({  | state }) snapshot given spec => String -> ReactClassConstructor ({  | props }) ({  | state }) given -> ReactClass ({  | props })

Creates a ReactClass`` inherited fromReact.PureComponent`.

pureComponentWithDerivedState :: forall props state snapshot given spec. ReactPureComponentSpec ({  | props }) ({  | state }) snapshot given spec => String -> ({  | props } -> {  | state } -> {  | state }) -> ReactClassConstructor ({  | props }) ({  | state }) given -> ReactClass ({  | props })

Like pureComponent, but takes a getDerivedStateFromProps handler.

statelessComponent :: forall props. ({  | props } -> ReactElement) -> ReactClass ({  | props })

data ReactClass :: Type -> Type

React class for components.

data ReactRef :: Type

Type for React refs. This type is opaque, but you can use Data.Foreign and DOM to validate the underlying representation.

getProps :: forall props state. ReactThis props state -> Effect props

Read the component props.

getState :: forall props state. ReactThis props state -> Effect state

Get the component state.

setState :: forall props given rest all. Union given rest all => ReactThis props ({  | all }) -> {  | given } -> Effect Unit

Update component state given some sub-set of state properties.

setStateWithCallback :: forall props given rest all. Union given rest all => ReactThis props ({  | all }) -> {  | given } -> Effect Unit -> Effect Unit

Update component state given some sub-set of state properties, while also invoking a callback when applied.

writeState :: forall props all. ReactThis props ({  | all }) -> {  | all } -> Effect Unit

Update component state.

writeStateWithCallback :: forall props all. ReactThis props ({  | all }) -> {  | all } -> Effect Unit -> Effect Unit

Update component state, while also invoking a callback when applied.

modifyState :: forall props state. ReactThis props state -> (state -> state) -> Effect Unit

Update component state given a modification function.

modifyStateWithCallback :: forall props state. ReactThis props state -> (state -> state) -> Effect Unit -> Effect Unit

Update component state given a modification function, while also invoking a callback when applied.

forceUpdate :: forall props state. ReactThis props state -> Effect Unit

Force render of a react component.

forceUpdateWithCallback :: forall props state. ReactThis props state -> Effect Unit -> Effect Unit

Force render and then run an Effect.

class ReactPropFields (required :: # Type) (given :: # Type) 

Instances

• (Union given optional (ReservedReactPropFields required), Union optional leftover (ReservedReactPropFields ())) => ReactPropFields required given

type ReservedReactPropFields r = (key :: String, ref :: SyntheticEventHandler (Nullable ReactRef) | r)

createElement :: forall required given. ReactPropFields required given => ReactClass { children :: Children | required } -> {  | given } -> Array ReactElement -> ReactElement

Create an element from a React class spreading the children array. Used when the children are known up front.

unsafeCreateElement :: forall props. ReactClass { children :: Children | props } -> {  | props } -> Array ReactElement -> ReactElement

An unsafe version of createElement which does not enforce the reserved properties "key" and "ref".

createElementDynamic :: forall required given. ReactPropFields required given => ReactClass { children :: Children | required } -> {  | given } -> Array ReactElement -> ReactElement

Create an element from a React class passing the children array. Used for a dynamic array of children.

unsafeCreateElementDynamic :: forall props. ReactClass { children :: Children | props } -> {  | props } -> Array ReactElement -> ReactElement

An unsafe version of createElementDynamic which does not enforce the reserved properties "key" and "ref".

createLeafElement :: forall required given. ReactPropFields required given => ReactClass {  | required } -> {  | given } -> ReactElement

Create an element from a React class that does not require children.

unsafeCreateLeafElement :: forall props. ReactClass props -> props -> ReactElement

An unsafe version of createLeafElement which does not enforce the reserved properties "key" and "ref".

createElementTagName :: forall props. TagName -> props -> Array ReactElement -> ReactElement

Create an element from a tag name spreading the children array. Used when the children are known up front.

createElementTagNameDynamic :: forall props. TagName -> props -> Array ReactElement -> ReactElement

Create an element from a tag name passing the children array. Used for a dynamic array of children.

data Children :: Type

Internal representation for the children elements passed to a component

Instances

• IsReactElement Children

childrenToArray :: Children -> Array ReactElement

Internal conversion function from children elements to an array of React elements

childrenCount :: Children -> Int

Returns the number of children.

class IsReactElement a  where

Members

• toElement :: a -> ReactElement

Instances

• IsReactElement String
• IsReactElement Number
• IsReactElement Int
• IsReactElement Children
• IsReactElement ReactElement
• IsReactElement (Array ReactElement)

fragmentWithKey :: String -> Array ReactElement -> ReactElement

Creates a keyed fragment.

type Context a = { consumer :: ContextConsumer a, provider :: ContextProvider a }

type ContextProvider a = ReactClass { children :: Children, value :: a }

type ContextConsumer a = ReactClass { children :: a -> ReactElement }

createContext :: forall a. a -> Context a

Create a new context provider/consumer pair given a default value.