Jelly.Router

class Router :: (Type -> Type) -> Constraintclass (MonadEffect m) <= Router m  where

Router m represents you can use routing in Monad m.

Members

• usePushRoute :: String -> m Unit

  Push a new Route to the browser history.

• useReplaceRoute :: String -> m Unit

  Replace the current Route in the browser history.

• useCurrentRoute :: m (Signal String)

  Get the current Route.

Instances

• (MonadEffect m) => Router (RouterT m)
• (Router m) => Router (ReaderT r m)

type RouterR = { currentRoute :: Signal String, pushState :: String -> Effect Unit, replaceState :: String -> Effect Unit }

RouterR is a global values for RouterT.

newtype RouterT :: forall k. (k -> Type) -> k -> Typenewtype RouterT m a

RouterT is a Monad for Router.

Constructors

• RouterT (ReaderT RouterR m a)

Instances

• (Monad m) => Functor (RouterT m)
• (Monad m) => Apply (RouterT m)
• (Monad m) => Applicative (RouterT m)
• (Monad m) => Bind (RouterT m)
• (Monad m) => Monad (RouterT m)
• (MonadEffect m) => MonadEffect (RouterT m)
• (MonadRec m) => MonadRec (RouterT m)
• (MonadHooks m) => MonadHooks (RouterT m)
• (MonadEffect m) => Router (RouterT m)

runRouterT :: forall m a. MonadHooks m => RouterT m a -> m a

Run a RouterT.

runMockRouterT :: forall m a. MonadHooks m => RouterT m a -> String -> m a

Run a RouterT outside of the browser. This is useful for SSG.

initRouter :: forall m. MonadHooks m => m RouterR

routerLink :: forall m. MonadEffect m => Router m => String -> Array (Prop m) -> Component m -> Component m

Router link component. This is the a element, but when clicked, it does preventDefault and does SPA routing.

routerLink' :: forall m. MonadEffect m => Router m => String -> Component m -> Component m

Same as routerLink, but without Props.