michalkvasnicak / routex

THIS PROJECT IS NO LONGER MAINTAINED AND HAS BEEN UNPUBLISHED FROM NPM

Hi there 👋

I'm Michal Kvasničák a full stack engineer from 🇸🇰. I ❤️ React, GraphQL, Node.js, Typescript...

I know this README is boring, what'd you like to know? Ask me anything!

routex's Issues

Better testing stack

I want to test routex in browser environment
I want to test edge cases

typo in createRoutex

nextRoute never ends up in routex state: https://github.com/michalkvasnicak/routex/blob/master/src/createRoutex.js#L87

Support history ^2.0.0

The pushState and replaceState methods are now called push and replace.

https://github.com/michalkvasnicak/routex/blob/master/src/Router.js#L143
https://github.com/michalkvasnicak/routex/blob/master/src/Router.js#L146

Use karma for tests

Prever is not really ready for this. So just in case, karma

Initial state rehydration

Right now createRoutex discards the router state that could be generated server side. Is it because of some race condition with async routes or something else?

My use case for having the server state rehydrated is that I'd like to use the routes onEnter to specify data dependencies for the current route. Ideally this callback would be called only once, since the data the route needs should already be there when the page loads.

Multiple routers

Add possibility to have multiple routes on site

Maybe it should store in query string?

How should stores be defined in redux ?

How to prevent other routers to dispatch NOT FOUND?

And how do we know when routing finished?

[request] Support Custom Route attributes

Currently when the routes are instantiated into Route objects only a subset of the original route object copied across into a Route instance.

I'm not using react so the component attribute is of no use.
I'd like to be able to keep any custom attributes on the route e.g

const routes = [
    {
        path: '/',
        specialSauce: 1
    }
];

These are instead silently discarded.

For a router that claims to not require React the definition of the Route class kind of pushes react.

Async route and component definition

Add possibility to load route in async.

Add prop to Link component to call transitionTo with given path (and parse query params from string).
Link should not generate link for this definition of route.

Refactor + Tests

Ability to pass own params to onEnter/onLeave handlers

In case that a user wants to pass optional params to handler (for example in redux apps it can be getState and dispatch functions)

Always call onEnter handlers

If user is on route for example /, router will store state to history api. But then if user is loading something using AJAX and storing to store and he refreshes the page, onEnter handler is not called because history api already contains state and data don't exist.

Solution:

onEnter handlers should be called always and user should manage caching in them by current state.

Cancel transition / Don't allow to change route in the middle of transition

Example:

User is on route A and wants to go to B, he clicks on link, router calls onLeave on the A route. In A.onLeave callback user shows confirmation dialog (for example bootstrap modal, which is async). And waits for confirmation. But somewhere he clicks on link that is routed to C.

Now, we need mechanism to tell the router that he clicked on C but A.onLeave is not resolved yet so C has to be cancelled.

<Link /> should be able to detect if it is active

Probably add active css class automatically?
Or do we want to allow user to define what to add to css classes?
Or callback?

Take a look at rackt/history

I know @mjackson is re-implementing the router primitives (such as histories) in a more functional way in https://github.com/rackt/history. While this is a work in progress, you might be interested to take a look and maybe even use it internally.

Support React 15.0