Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrivasperez/navi
A simple react routing library.
https://github.com/mrivasperez/navi
npm-package react react-router typescript
Last synced: 27 days ago
JSON representation
A simple react routing library.
- Host: GitHub
- URL: https://github.com/mrivasperez/navi
- Owner: mrivasperez
- License: mit
- Created: 2024-09-29T20:34:02.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-29T23:20:59.000Z (about 2 months ago)
- Last Synced: 2024-10-14T20:40:59.956Z (about 1 month ago)
- Topics: npm-package, react, react-router, typescript
- Language: TypeScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# navi: A simple react routing library.
## Overview
`navi` is a lightweight and flexible routing library designed specifically for React applications. It provides the core functionality you need to manage navigation within your application without the overhead of a large, complex library.
## Key Features
- **Simple API:** `navi` offers a clean and intuitive API, making it easy to set up and use.
- **Customizable:** You have full control over how your routes are structured and how navigation is handled, allowing you to create a routing system that perfectly fits your application's needs.
- **Lightweight:** `navi` is a small and efficient library, minimizing the impact on your application's performance.
## Installation
```bash
npm install @mrivasperez/navi
```
## Usage
```jsx
import { NavigationProvider, Route, Link, useNavigation } from "navi";
function App() {
return (
Home
About
About Us
Go back to Home
);
}
```
## Contributing
Contributions to navi are welcome! Please submit a PR if you encounter any issues, or help with resolving existing ones.
## Feedback
Please feel free to open an issue!
## License
`navi` is licensed under the MIT License.