# Universal Navigation Strategy for React Development

[Matheus Albuquerque](https://www.strv.com/blog/authors/ythecombinator) Frontend Engineer

---

## A BIT OF CONTEXT

When I joined STRV, they had a specific request ready for me: Build a frontend app for iOS, Android and Web, with shared component and business logic amongst all the platforms.
Since I’m a frontend developer who loves exploring new territory, I jumped at the opportunity.
I ended up facing a variety of challenges—like a lack of real-world-scenarios content related to React Native Web, an unexpected lack of documentation on popular projects and struggling to build some platform-specific modules.
This article focuses on a very important part of this journey: Building a navigation solution.
But first...

## WHAT WE HAVE OUT THERE

Some popular routing solutions on the React.js ecosystem were not meant to support both DOM and native environments; `<div>`s are different from `<View>`s, `<ul>`s are different from `<FlatList>`s and most of the web primitives are different from the mobile ones—which makes it difficult to come up with a universal solution. [@reach/router](https://reach.tech/router) is one example of web solutions that have opted not to face the challenges of supporting both environments.

As of now (February 2020), however, we have a few universal web/native formulas ready. But they all ended up not fully serving our needs. Examples are:

- [react-router](https://github.com/ReactTraining/react-router) is a great option for the web, but on [mobile](https://reacttraining.com/react-router/native), it lacks screen transitions, modals, navbar, back-button support and other essential navigation primitives.
- [react-navigation](https://reactnavigation.org/) suits mobile very well, but given its [web support](https://reactnavigation.org/docs/en/web-support.html), it is still considered to be experimental and has not yet been widely used in production. You're likely to face issues related to history and query parameters. Also, it lacks TypeScript typings—which made me write part of the definitions on my own, since TypeScript was a must-have for the project.

And this brings us to the next part!

## THINKING OF A SOLUTION

*The code from this post is available on GitHub:* [ythecombinator/react-native-web-monorepo-navigation](https://github.com/ythecombinator/react-native-web-monorepo-navigation)

When we started this journey, I admit one of the most puzzling things was not being able to figure out how exactly popular apps using React Native for Web (e.g., Twitter, Uber Eats, and all others mentioned [here](https://github.com/necolas/react-native-web?ref=strv.ghost.io#react-native-for-web)) do the navigation, and how they deal with challenges like the ones I mentioned above.

So, we had to work it out on our own!

Our new solution was based on abstracting on top of the most recent releases of [react-router-dom](https://reactrouter.com/web/guides/quick-start) and [react-navigation](https://reactnavigation.org/). Both have evolved a lot and now they seem to share a few goals which I consider to be key for properly doing navigation/routing in React:

- Hooks-first API
- Declarative way to implement navigation
- First-class types with TypeScript

We subsequently came up with a couple of utils and components which aim at a universal navigation strategy:

### utils/navigation

[https://github.com/ythecombinator/react-native-web-monorepo-navigation/blob/master/packages/components/src/utils/navigation](https://github.com/ythecombinator/react-native-web-monorepo-navigation/blob/master/packages/components/src/utils/navigation)

Exposes two hooks:

- `useNavigation`: which returns a `navigate` function that gets a route as a first param and parameters as other arguments.

It can be used like this:
```javascript
import { useNavigation } from "../utils/navigation";
// Our routes mapping – we'll be discussing about this one in a minute
import { routes } from "../utils/router";

const { navigate } = useNavigation();

// Using the `navigate` method from useNavigation to go to a certain route
navigate(routes.features.codeSharing.path);
```

It also provides you with a few other known routing utilities, like `goBack` and `replace`.

- `useRoute`: which returns some data about the current route (e.g., `path` and `params` passed to that route).

This is how it could be used to get the current `path`:
```javascript
import { useRoute } from "../utils/navigation";

const { path } = useRoute();

console.log(path);

// This will log:  
// "/features/code-sharing" on the web
// "features_code-sharing" on mobile
```

### utils/router

[https://github.com/ythecombinator/react-native-web-monorepo-navigation/tree/master/packages/components/src/utils/router](https://github.com/ythecombinator/react-native-web-monorepo-navigation/tree/master/packages/components/src/utils/router)

This basically contains a `routes` object—which contains different paths and implementations for each platform—that can be used for:

- Navigating with `useNavigation`
- Switching logic based on the current route with `useRoute`
- Specifying the `path` and extra data of each route rendered by the `Router` component

### components/Link

[https://github.com/ythecombinator/react-native-web-monorepo-navigation/tree/master/packages/components/src/Link](https://github.com/ythecombinator/react-native-web-monorepo-navigation/tree/master/packages/components/src/Link)

It provides declarative navigation around the application. It is built on top of `Link` from `react-router-dom` [on web](https://github.com/ythecombinator/react-native-web-monorepo-navigation/blob/master/packages/components/src/Link/index.web.tsx) and `TouchableOpacity` + `useNavigation` hook [on mobile](https://github.com/ythecombinator/react-native-web-monorepo-navigation/blob/master/packages/components/src/Link/index.native.tsx).

Just like `Link` from `react-router-dom`, it can be used like this:
```javascript
import { Text } from "react-native";
import { Link } from "../Link";
import { routes } from "../utils/router";

<Link path={routes.features.webSupport.path}>
  <Text>Check "Web support via react-native-web"</Text>
</Link>
```

### components/Router

[https://github.com/ythecombinator/react-native-web-monorepo-navigation/tree/master/packages/components/src/Router](https://github.com/ythecombinator/react-native-web-monorepo-navigation/tree/master/packages/components/src/Router)

This is the router itself. On the web, it's basically a `BrowserRouter`, using `Switch` to pick a route. On mobile, it’s a combination of `Stack` and `BottomTab` navigators.

Combining everything we’ve mentioned, what you get is going through each [screen](https://github.com/ythecombinator/react-native-web-monorepo-navigation/tree/master/packages/components/src/screens) of the app and seeing how `useRoute()`, `useNavigation()` and `<Link />` can be used regardless of the platform you are.

---

## Future steps

If asked about how I’d approach future work in a similar scenario, I'd say my next steps would be:

1. **Adding more utilities** – e.g., a `Redirect` component aiming at a more declarative navigation approach.
2. Tackling edge cases on both platforms.
3. Reorganizing most of the things inside a navigation library and leaving only the main `Router` component and `utils/router` to be written on the application side.

---

## CONCLUSION

My feeling is that web, mobile web and native application environments all require a specific design and user experience—which, by the way, matches the mentioned *“Learn once, write anywhere.”* [React Native's philosophy](https://reactjs.org/blog/2015/03/26/introducing-react-native.html).

Although codesharing is a great advantage to React and React Native, I’d say that it is very likely that shared cross-platform code should be:

- Business Logic
- Config files, translation files, and most constant data—those that are not render-environment-specific
- API / Formatting; e.g., API calls, authentication and formatting of request and response data

A few other layers of the app—like routing—should use a library that is most appropriate for the platform, i.e., `react-router-dom` for web, and `react-navigation` or similar for native.

Perhaps in the future, we’ll have a truly unified code base. But for now, it doesn't feel like the technology is ready and the approach shared here seems to be the most suitable one.

---

## FOOTNOTES

1. There's an amazing [talk by Evan Bacon on Expo for Web](https://www.youtube.com/watch?v=k1FdrhA2sCY&ref=strv.ghost.io) this year at Reactive Conf. If you haven't checked it out, I really recommend it.
2. This one was authored and is used by Bruno Lemos, the author of [DevHub](https://devhubapp.com/?ref=strv.ghost.io), a Github client that runs on Android, iOS, Web and Desktop—with 95%+ code sharing between them. If you're interested in how he came up with this solution, check [this](https://dev.to/brunolemos/tutorial-100-code-sharing-between-ios-android--web-using-react-native-web-andmonorepo-4pej?ref=strv.ghost.io).
3. These issues include:
   - Functionality-wide
   - Query parameters from URL not passed down ([here](https://github.com/react-navigation/web/issues/45))
   - Pushing back not working ([here](https://github.com/react-navigation/web/issues/22) and [here](https://github.com/react-navigation/web/issues/41))
   - Some params pushed from one route to the other for convenience being encoded to the URL
   - Developer-experience-wide
   - Lack of TypeScript typings ([here](https://github.com/react-navigation/web/issues/34))—which made me write part of the definitions on my own
4. [React Router v5](https://reacttraining.com/blog/react-router-v5) focused mostly on introducing structural improvements and a few new features. But then [v5.1](https://reacttraining.com/blog/react-router-v5-1/) introduced a bunch of useful hooks, enabling us to implement the mentioned ones for the web.
5. [React Navigation v5](https://blog.expo.io/announcing-react-navigation-5-0-bd9e5d45569e) also made many efforts to bring a modern, hooks-first API, allowing implementation for mobile.
6. There's a very good post about doing declarative and composable navigation with `<Redirect />` [here](https://tylermcginnis.com/react-router-programmatically-navigate).
7. If you're interested in this topic, check out [this talk](https://www.ythecombinator.space/talks/code-sharing-at-scale-one-codebase-for-web-mobile-and-desktop). I share lessons learned while building an app with code sharing as a primary objective: from project setup and shared infrastructure to shared components and styling—and how you can do the same.