react-router-apollo

Keep your router in sync with apollo client cache.

Installation

npm install @idealo/react-router-apollo

How It Works

For every mutation request with context historyPush: true your browser history (push) will be synced. On every pop state the mutate function will be triggered.

Tutorial

Create a history.js:

import { createBrowserHistory } from "history";
export default createBrowserHistory();

import React from 'react';
import ReactDOM from 'react-dom';
import { ApolloProvider } from 'react-apollo';
import { ApolloRoute, createLink as createReactRouterLink} from '@idealo/react-router-apollo';
import { ApolloClient } from 'apollo-client';
import { InMemoryCache } from 'apollo-cache-inmemory';
import { ApolloLink } from 'apollo-link';
import { HttpLink } from 'apollo-link-http';
import history from './history'; // your history.js

// you need a terminating link, here HttpLink
// @see https://www.apollographql.com/docs/link/overview#terminating
const httpLink = new HttpLink({
  uri: 'http://api.githunt.com/graphql'
});

const cache = new InMemoryCache();
const createClient = () => new ApolloClient({
    cache,
    link: ApolloLink.from([
        createReactRouterLink(history),
        httpLink
    ]),
    resolvers: {}
});

class MyComponent extends React.Component {
  render() {
    return <div>MyComponent</div>
  }
}

ReactDOM.render(
    <Router history={history}>
        <ApolloRoute
            client={createClient}
            transform={{
                toState: {
                    outboundDate: (dateString) => dateString ? new Date(dateString).toISOString() : null,
                    returnDate: (dateString) => dateString ? new Date(dateString).toISOString() : null
                },
                toURL: {
                    outboundDate: (isoDateString) => isoDateString ? dateFormat(new Date(isoDateString), URL_DATE_FORMAT) : null,
                    returnDate: (isoDateString) => isoDateString ? dateFormat(new Date(isoDateString), URL_DATE_FORMAT) : null
                },
            }}
            mutate={(client, data) => {
                client.writeData({
                    data: {
                        flightRecommendation: {
                            __typename: "FlightRecommendation",
                            outboundDate: data.outboundDate,
                            returnDate: data.returnDate
                        }
                    }
                })
            }}
            exact
            path={["/", "/foobar/:outboundDate/:returnDate?"]}
            pushPath="/foobar/:outboundDate/:returnDate?"
            component={MyComponent}
        />
    </Router>, document.getElementById("reactRoot"));

mutation example

client.mutate({
    context: {
        historyPush: true
    },
    mutation: gql`..`,
    variables: {
        ...
    }
})

ApolloRoute Properties

client (optional): Pass a function which returns an ApolloClient to wrap your Component with . Without this property you have to wrap with by your own.
transform (optional): Define transform callbacks for push history (toUrl) and pop history (toState) on your path parameters.
mutate (optional): Is called on pop history with apollo client and extracted path parameters.
pushPath (optional): The history path to push local state changes. Default: current path

Complete property list