React.Basic.Hooks
- Package
- purescript-react-basic-hooks
- Repository
- spicydonuts/purescript-react-basic-hooks
This is an experimental implementation of React hooks on react-basic.
Warning: This API is experimental and relies on alpha-release React versions. It's here to allow experimentation while we get feedback on the API and wait for an official React release which supports hooks. For more info on hooks, see React's documentation.
It's also recommended while using this module to use PureScript's new "qualified do" syntax (it's used in the examples, React.do
).
It's available in the 0.12.2
release.
If we prefer this API over the existing react-basic API, we may eventually replace it with this.
A note on Refs: The Ref
type is useful for passing to DOM nodes, but while this module remains a small extension to the existing react-basic library it won't be possible to pass a ref
prop to the native DOM components.
In the meantime, use element (unsafeCreateDOMComponent "div") { ref: elementRef }
.
#CreateComponent Source
type CreateComponent props = Effect (ReactComponent props)
Alias for convenience.
#component Source
component :: forall props hooks. Lacks "key" props => Lacks "ref" props => String -> (Record props -> Render Unit hooks JSX) -> CreateComponent (Record props)
Create a React component given a display name and render function. Creating components is effectful because React uses the function instance as the component's "identity" or "type". Components should be created during a bootstrap phase and not within component lifecycles or render functions.
#memo Source
memo :: forall props. CreateComponent props -> CreateComponent props
#useLayoutEffect Source
useLayoutEffect :: forall key. Eq key => key -> Effect (Effect Unit) -> Hook (UseLayoutEffect key) Unit
#useReducer Source
useReducer :: forall action state. state -> (state -> action -> state) -> Hook (UseReducer state action) (state /\ (action -> Effect Unit))
#useContext Source
useContext :: forall a. ReactContext a -> Hook (UseContext a) a
#useCallback Source
useCallback :: forall a key. Eq key => key -> a -> Hook (UseCallback key a) a
#useEqCache Source
useEqCache :: forall a. Eq a => a -> Hook (UseCallback a a) a
#UnsafeReference Source
#Render Source
newtype Render x y a
Render represents the effects allowed within a React component's
body, i.e. during "render". This includes hooks and ends with
returning JSX (see pure
), but does not allow arbitrary side
effects.
Instances
IxFunctor Render
IxApply Render
IxApplicative Render
IxBind Render
Functor (Render x y)
(TypeEquals x y) => Apply (Render x y)
(TypeEquals x y) => Applicative (Render x y)
(TypeEquals x y) => Bind (Render x y)
(TypeEquals x y, Semigroup a) => Semigroup (Render x y a)
(TypeEquals x y, Monoid a) => Monoid (Render x y a)
#displayName Source
displayName :: forall props. ReactComponent props -> String
Retrieve the Display Name from a ReactComponent
. Useful for debugging and improving
error messages in logs.
See also: component
Re-exports from Data.Tuple.Nested
#(/\) Source
Operator alias for Data.Tuple.Tuple (right-associative / precedence 6)
Shorthand for constructing n-tuples as nested pairs.
a /\ b /\ c /\ d /\ unit
becomes Tuple a (Tuple b (Tuple c (Tuple d unit)))
#type (/\) Source
Operator alias for Data.Tuple.Tuple (right-associative / precedence 6)
Shorthand for constructing n-tuple types as nested pairs.
forall a b c d. a /\ b /\ c /\ d /\ Unit
becomes
forall a b c d. Tuple a (Tuple b (Tuple c (Tuple d Unit)))
Re-exports from React.Basic
#ReactContext Source
data ReactContext :: Type -> Type
#ReactComponent Source
data ReactComponent :: Type -> Type
Represents a traditional React component. Useful for JavaScript interop and FFI. For example:
foreign import ComponentRequiringJSHacks :: ReactComponent { someProp :: String }
See also: element
, toReactComponent
#JSX Source
data JSX :: Type
Represents rendered React VDOM (the result of calling React.createElement
in JavaScript).
JSX
is a Monoid
:
append
- Merge two
JSX
nodes usingReact.Fragment
.
- Merge two
mempty
- The
empty
node; renders nothing.
- The
Hint: Many useful utility functions already exist for Monoids. For example,
guard
can be used to conditionally render a subtree of components.
Instances
#provider Source
provider :: forall a. ReactContext a -> a -> Array JSX -> JSX
Create a provider JSX
given a context value and children.
See also: createContext
, consumer
#elementKeyed Source
elementKeyed :: forall props. ReactComponent (Record props) -> { key :: String | props } -> JSX
Create a JSX
node from a ReactComponent
, by providing the props and a key.
This function is for non-React-Basic React components, such as those imported from FFI.
See also: ReactComponent
, element
, React's documentation regarding the special key
prop
#element Source
element :: forall props. ReactComponent (Record props) -> Record props -> JSX
Create a JSX
node from a ReactComponent
, by providing the props.
This function is for non-React-Basic React components, such as those imported from FFI.
See also: ReactComponent
, elementKeyed
#createContext Source
createContext :: forall a. a -> Effect (ReactContext a)
Create a ReactContext
given a default value. Use provider
and consumer
to provide and consume context values. Alternatively, use contextProvider
and contextConsumer
directly if a ReactComponent
is required for interop.
render self =
R.div_
[ R.button
{ onClick: capture_ $ self.setState \s -> s { counter = s.counter + 1 }
, children: [ R.text "Tick!" ]
}
, provider countContext self.state.counter
[ consumer countContext \counter ->
[ R.text $ "Ticks: " <> (show counter)
]
]
]
See also: provider
, consumer
, React's documentation regarding Context
#contextProvider Source
contextProvider :: forall a. ReactContext a -> ReactComponent { children :: Array JSX, value :: a }
#contextConsumer Source
contextConsumer :: forall a. ReactContext a -> ReactComponent { children :: a -> Array JSX }