https://github.com/ilikepizza2/react-savestate
A minimal routing solution for routing in react which saves the state across route changes and prevents hard refreshes
https://github.com/ilikepizza2/react-savestate
react react-routing routing state-management
Last synced: about 2 months ago
JSON representation
A minimal routing solution for routing in react which saves the state across route changes and prevents hard refreshes
- Host: GitHub
- URL: https://github.com/ilikepizza2/react-savestate
- Owner: Ilikepizza2
- Created: 2024-02-28T09:53:03.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-28T17:07:58.000Z (about 1 year ago)
- Last Synced: 2025-03-19T19:03:17.107Z (about 2 months ago)
- Topics: react, react-routing, routing, state-management
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/react-savestate
- Size: 11.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
**REACT-SAVESTATE**
**Description:** react-savestate is a lightweight npm package designed as a router for React applications which preserves states between route changes. It provides alternative routing functionalities and components to streamline navigation within React-based web applications.
**Installation:** You can install react-savestate via npm by running the following command:
```bash
npm install react-savestate
```
**Usage:**
```javascript
// import the functions
import { Route, getState, Link } from 'react-savestate';
```
```javascript
// Define routes using the Route component
```
```javascript
// Use the Link component for navigation without page refresh
Go to contact
```
```javascript
// Retrieve saved state using getState function
console.log(getState());
```
**Components:**
- **Route:** An alternative route element for routing between pages in a React application. No need to wrap them in any parent wrapper.
- **Link:** A replacement for `` tag which facilitates navigation without triggering a page refresh. It also supports passing a state object to preserve data across routes without using URL parameters.
- **getState:** Function to retrieve the saved state, if any, within the application.
**Note:**
- Ensure that the state passed to Link is serializable to avoid any issues with preservation and retrieval.
- Utilize Route and Link components as replacements for traditional routing and navigation elements within your React application for improved performance and user experience.
**Contributing:** Contributions to react-savestate are welcome! Feel free to submit issues or pull requests on the GitHub repository: react-savestate GitHub Repository
**License:** This project is licensed under the MIT License - see the LICENSE file for details.