React.Router
- Package
- purescript-cofree-react-router
- Repository
- coot/purescript-cofree-react-router
Re-exports from React.Router.Components
#BrowserRouter Source
newtype BrowserRouter props arg notFoundProps
BrowserRouter prop type
Constructors
BrowserRouter { config :: RouterConfig, notFound :: Maybe { cls :: ReactClass notFoundProps, props :: notFoundProps }, router :: Cofree List (Tuple (Route props arg) (Maybe (IndexRoute props arg))) }
#linkClass Source
linkClass :: forall eff. ReactClass (LinkProps eff)
React class for the link
element.
#link' Source
link' :: RouterConfig -> URL -> Array ReactElement -> ReactElement
as link
, but with empty props.
#link Source
link :: RouterConfig -> URL -> Array Props -> Array ReactElement -> ReactElement
link
element; use it instead of a
to route the user through
application with the default action goto cfg url
and custom properties.
#browserRouterClass Source
browserRouterClass :: forall notfound arg props. RoutePropsClass props arg => ReactClass (BrowserRouter props arg notfound)
React class for the browerRouter
element. Use it to init your application.
router = ... :: Router _
main = void $ elm >>= render (createElement browserRouterClass {router, notFound: Nothing} [])
where
elm = do
elm_ <- window >>= document >>= getElementById (ElementId "app") <<< documentToNonElementParentNode <<< htmlDocumentToDocument
pure $ unsafePartial fromJust (toMaybe elm_)
```
#browserRouter Source
browserRouter :: forall notfound arg props eff. RoutePropsClass props arg => ReactSpec (BrowserRouter props arg notfound) Location (console :: CONSOLE, dom :: DOM, history :: HISTORY | eff)
ReactSpec
for the browserRouterClass
- the main entry point react
class for the router.
Re-exports from React.Router.Routing
#runRouter' Source
runRouter' :: forall arg props. RoutePropsClass props arg => Route -> Cofree List (Tuple (Route props arg) (Maybe (IndexRoute props arg))) -> Maybe ReactElement
#runRouter Source
runRouter :: forall arg props. RoutePropsClass props arg => URL -> Cofree List (Tuple (Route props arg) (Maybe (IndexRoute props arg))) -> Maybe ReactElement
Main entry point for running Router
, it returns ReactElement
that can
be injected into React vDOM.
#matchRouter Source
matchRouter :: forall arg props. RoutePropsClass props arg => Route -> Router props arg -> Maybe (Cofree List (LeafVal props arg))
Re-exports from React.Router.Types
#RouterConfig Source
#Router Source
type Router props arg = RoutePropsClass props arg => Cofree List ((Route props arg) /\ (Maybe (IndexRoute props arg)))
Router
router :: Router RouteProps Unit
router =
Route "main" (unit <$ lit "") mainClass :+
(Route "home" (unit <$ lit "home") homeClass :+ Nil)
: (Tuple (Route "user" (unit <$ (lit "user" *> int)) userClass) (Just $ IndexRoute "user-index" userIndexClass) :<
(Route "book" (unit <$ (lit "books" *> int)) bookClass :+
(Route "pages" (unit <$ lit "pages") pagesClass :+
(Route "page" (unit <$ int) pageClass :+ Nil)
: Nil)
: Nil)
: Nil)
: (Route "user-settings" (unit <$ (lit "user" *> int *> lit "settings")) settingsClass :+ Nil)
: Nil
#RouteProps Source
newtype RouteProps arg
RouteProps
type keeps track route related data: id, currently matched
argument and array of arguments - if the route is nested this will hold
list of all parent arguments.
Constructors
RouteProps { arg :: arg, args :: List arg, id :: String, query :: Map String String, tail :: List (Cofree List (RouteLeaf arg)), url :: Route }
Instances
(Eq arg) => Eq (RouteProps arg)
RoutePropsClass RouteProps arg
Newtype (RouteProps arg) _
#RouteClass Source
type RouteClass props arg = RoutePropsClass props arg => ReactClass (props arg)
React component which will be mounted at matching node It recieves array of all matching routes.
#IndexRoute Source
data IndexRoute props arg
IndexRoute type The first parameter is the id property.
Constructors
IndexRoute String (RouteClass props arg)
#RoutePropsClass Source
class RoutePropsClass props arg | props -> arg where
The RoutePropsClass
type class let one extend the properties passed to
each RouteClass
react class component. There is one instance
RouteProps
defined in the React.Router.Type
module.
The mkProps
member function receives the name of the route and an
nonempty array of args read from the url. You can use
React.Router.Utils.last
function to get the last element of the array
with arguments obtained from the corrsponding url part.
Members
idLens :: Lens' (props arg) String
mkProps :: String -> arg -> List arg -> Map String String -> List (Cofree List (RouteLeaf arg)) -> Route -> props arg
Instances
#withoutIndex Source
withoutIndex :: forall arg props. RoutePropsClass props arg => Route props arg -> List (Cofree List ((Route props arg) /\ (Maybe (IndexRoute props arg)))) -> Cofree List ((Route props arg) /\ (Maybe (IndexRoute props arg)))
#_cls Source
_cls :: forall arg props. RoutePropsClass props arg => (Route props arg) -> (RouteClass props arg)