Grain

class NonKeyedGrain :: (Type -> Type) -> Type -> Constraintclass (Grain p a) <= NonKeyedGrain p a 

Instances

• (GlobalGrain a) => NonKeyedGrain GProxy a
• (LocalGrain a) => NonKeyedGrain LProxy a

data GProxy a

A type of global state proxy.

Constructors

• GProxy

class GlobalGrain a 

Representation of a partial state of application state.

You can use this to define global state.

TypeRef is used as state key internally for uniqueness.

data KGProxy k a

A type of keyed global state proxy.

Constructors

• KGProxy

class GrainKey a 

Representation of key type for keyed global state.

This class's instances can be key for keyed global state.

Instances

• GrainKey String

class (GrainKey k) <= KeyedGlobalGrain k a | a -> k

Representation of a partial state of application state.

You can use this to define global state with key for dynamic items.

The first parameter is a type of key for each item, and the second parameter is a type of item.

TypeRef is used as state key internally for uniqueness.

data LProxy a

A type of component-local state proxy.

Constructors

• LProxy

class LocalGrain a 

Representation of a component-local state.

TypeRef is used as state key internally for uniqueness.

fromConstructor :: forall a. a -> TypeRef

Create a TypeRef.

Treat a constructor function as reference of type.

data VNode

The type of virtual node.

newtype Render a

The type of component renderer.

In this monad, you can declare that you use some states and updaters.

Instances

• Functor Render
• Apply Render
• Applicative Render
• Bind Render
• Monad Render
• (Semigroup a) => Semigroup (Render a)
• (Monoid a) => Monoid (Render a)
• MonadRec Render

useValue :: forall p a. NonKeyedGrain p a => p a -> Render a

Listen a state, then return it.

If the state is changed, the component will be rerendered.

useUpdater :: forall p a. NonKeyedGrain p a => p a -> Render ((a -> a) -> Effect Unit)

Get an updater of a state.

usePortal :: Effect Node -> Render (VNode -> VNode)

Get portal function.

useKeyedValue :: forall k a. KeyedGlobalGrain k a => KGProxy k a -> k -> Render a

Listen a keyed global state, then return it.

If the state is changed, the component will be rerendered.

useKeyedUpdater :: forall k a. KeyedGlobalGrain k a => KGProxy k a -> Render (k -> (a -> a) -> Effect Unit)

Get an updater of a keyed global state.

useKeyedFinder :: forall k a. KeyedGlobalGrain k a => KGProxy k a -> Render (k -> Effect a)

Get a finder of a keyed global state.

useFinder :: forall p a. NonKeyedGrain p a => p a -> Render (Effect a)

Get a finder of a state.

mount :: VNode -> Node -> Effect Unit

Mount a VNode to a parent node.