React.Router.Types

newtype RouteLeaf arg

Constructors

• RouteLeaf { arg :: arg, url :: Route }

Instances

• (Eq arg) => Eq (RouteLeaf arg)
• Newtype (RouteLeaf arg) _

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

• RoutePropsClass RouteProps arg

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) _

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.

data Route props arg

Route type The first parameter is an identifier.

Constructors

• Route String (Match arg) (RouteClass props arg)
• OpenRoute String (Match arg) (RouteClass props arg)

Instances

• Show (Route props arg)

_id :: forall arg props. Route props arg -> String

_url :: forall arg props. Route props arg -> Match arg

_cls :: forall arg props. RoutePropsClass props arg => (Route props arg) -> (RouteClass props arg)

data IndexRoute props arg

IndexRoute type The first parameter is the id property.

Constructors

• IndexRoute String (RouteClass props arg)

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

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)))

Operator alias for React.Router.Types.withoutIndex (right-associative / precedence 5)

:+ lets define routes without index route

newtype RouterConfig

Constructors

• RouterConfig { baseName :: Maybe URL }

Instances

• Newtype RouterConfig _

defaultConfig :: RouterConfig