Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atlassian-labs/react-resource-router
Configuration driven routing solution for React SPAs that manages route matching, data fetching and progressive rendering
https://github.com/atlassian-labs/react-resource-router
react router spa
Last synced: 2 days ago
JSON representation
Configuration driven routing solution for React SPAs that manages route matching, data fetching and progressive rendering
- Host: GitHub
- URL: https://github.com/atlassian-labs/react-resource-router
- Owner: atlassian-labs
- License: apache-2.0
- Created: 2020-05-25T00:58:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-26T05:48:00.000Z (10 months ago)
- Last Synced: 2024-05-03T16:31:43.446Z (9 months ago)
- Topics: react, router, spa
- Language: TypeScript
- Homepage: https://atlassian-labs.github.io/react-resource-router
- Size: 2.85 MB
- Stars: 195
- Watchers: 15
- Forks: 23
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: security-assistant.yml
Awesome Lists containing this project
README
react-resource-router
React Resource Router (RRR) is a configuration driven routing solution for React that manages single page application route matching, data fetching and progressive rendering.
## Why?
React Resource Router was developed by Atlassian for [Jira](https://www.atlassian.com/software/jira) primarily to improve **performance** and prepare for **compatibility** with React's forthcoming [Concurrent Mode](https://reactjs.org/docs/concurrent-mode-intro.html) on both client and server. You can read more about its development and impact [here](https://www.atlassian.com/engineering/react-resource-router-deep-dive).
### Features
- Fully driven by a static configuration of route objects
- Each route object contains the following core properties
- `path` - the path to match
- `component` - the component to render
- `resources` - an array of objects containing fetch functions that request the route component's data
- Data for a route is requested **asynchronously** and **as early as possible**, with the page progressively rendering as the requests resolve. This results in quicker meaningful render times
- Works on both client and server without having to traverse the React tree
## Usage
### Create your resources
Resources describe and provide the data required for your route. This data is safely stored and accessed via the `useResource` hook or `ResourceSubscriber` component.
```js
import { createResource } from 'react-resource-router/resources';
import { fetch } from '../common/utils';
export const homeResource = createResource({
type: 'HOME',
getKey: () => 'home-resource-key',
getData: () => fetch('https://my-api.com/home'),
});
export const aboutResource = createResource({
type: 'ABOUT',
getKey: () => 'about-resource-key',
getData: () => fetch('https://my-api.com/about'),
});
```
### Create your components
These are the React components that get rendered for your routes. As mentioned, they can be wired into the state of your resources via the `useResource` hook or `ResourceSubscriber` component.
```js
import { useResource } from 'react-resource-router/resources';
import { aboutResource, homeResource } from '../routes/resources';
import { Loading, Error } from './common';
export const Home = () => {
const { data, loading, error } = useResource(homeResource);
if (error) {
return ;
}
if (loading) {
return ;
}
return
{data.home.content};
};
export const About = () => {
const { data, loading, error } = useResource(aboutResource);
if (error) {
return ;
}
if (loading) {
return ;
}
return
{data.about.content};
};
```
### Create your routes
Your route configuration is the single source of truth for your application's routing concerns.
```js
import { Home, About } from '../components';
import { homeResource, aboutResource } from './resources';
export const appRoutes = [
{
name: 'home',
path: '/',
exact: true,
component: Home,
resources: [homeResource],
},
{
name: 'about',
path: '/about',
exact: true,
component: About,
resources: [aboutResource],
},
];
```
### Use the Router
Now that you've set up your resources, components and configuration correctly, all you need to do is mount the Router in your react tree with a `RouteComponent` as a child. It will do the rest!
```js
import {
Router,
RouteComponent,
createBrowserHistory,
} from 'react-resource-router';
import { createResourcesPlugin } from 'react-resource-router/resources';
import { appRoutes } from './routing/routes';
const history = createBrowserHistory();
const resourcesPlugin = createResourcesPlugin({});
const App = () => (
);
```
## Installation
```bash
npm install react-resource-router
# or
yarn add react-resource-router
```
## Documentation
Check the [docs website](https://atlassian-labs.github.io/react-resource-router/) or the [docs folder](https://github.com/atlassian-labs/react-resource-router/tree/master/docs).
## Examples
You can checkout the repo and play around with the examples we have setup to demonstrate how the API can be used for various use cases.
1. Clone the repo and install dependencies
2. Run `npm start`
3. Local dev site will launch with all the examples
## Thanks
Big thanks to [Thinkmill](https://www.thinkmill.com.au/) for their involvement in this project.
## License
Copyright (c) 2020 Atlassian and others.
Apache 2.0 licensed, see [LICENSE](LICENSE) file.
[](https://www.atlassian.com)