https://github.com/software-mansion-labs/react-native-url-router

A new way to create navigation in react-native
https://github.com/software-mansion-labs/react-native-url-router

Last synced: about 2 months ago
JSON representation

A new way to create navigation in react-native

• Host: GitHub
• URL: https://github.com/software-mansion-labs/react-native-url-router
• Owner: software-mansion-labs
• Archived: true
• Created: 2022-01-18T12:53:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-04T16:09:37.000Z (over 1 year ago)
• Last Synced: 2024-07-05T11:27:18.915Z (3 months ago)
• Language: TypeScript
• Size: 1.83 MB
• Stars: 129
• Watchers: 8
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# React Native Url Router

## [Documentation page](https://software-mansion-labs.github.io/react-native-url-router/docs/overview)

## Motivation

React Native Url Router aims to simplify native navigation patterns.

It allows for native navigation UI that feels natural on mobile together with easy navigation by opening URLs.

It exports Stack and Tab Navigators same as react-navigation, but they are usually closely mapped with an app-wide URL structure.

Being designed to work seamlessly with react-router and it should feel immidiately intuitive to people who used react-router on web.

React Router provides the routing logic, route ranking, matching, params support and more.

React Native Url Router provides a powerful new abstraction over a regular web history stack.

It also integrates with react-native-screens providing a fully native stack behavior, and relies on react-native-pager-view for swipeable Tabs.

## Usage

```tsx

    }}

    />

    

            {loggedIn && }

             setLoggedIn(true)} title="Login" />

            >

        }

    />

    

            {!loggedIn && }

             setLoggedIn(false)} title="Logout" />

            >

        }

    />

```

## Installation

For expo:

```

expo install react-native-url-router react-native-pager-view react-native-screens react-router history

```

For regular react native >=0.60:

```

yarn add react-native-url-router react-native-pager-view react-native-screens react-router history

```

Also follow https://github.com/software-mansion/react-native-screens#installation for android

## Documentation

https://software-mansion-labs.github.io/react-native-url-router/docs/overview

## Examples

Check out `examples/` for a quick start into using react-native-url-router in your own project.

## License

React Native Url Router library is licensed under The MIT License.