Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/daltonmenezes/electron-router-dom

🧬 A react-router-dom adapter for Electron apps
https://github.com/daltonmenezes/electron-router-dom

adapter electron library react react-router-dom router

Last synced: 6 days ago
JSON representation

🧬 A react-router-dom adapter for Electron apps

Host: GitHub
URL: https://github.com/daltonmenezes/electron-router-dom
Owner: daltonmenezes
License: mit
Created: 2022-09-20T04:58:00.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-09-14T01:48:16.000Z (about 2 months ago)
Last Synced: 2024-10-12T22:55:00.747Z (25 days ago)
Topics: adapter, electron, library, react, react-router-dom, router
Language: TypeScript
Homepage: https://electron-router-dom.daltonmenezes.com
Size: 2.42 MB
Stars: 134
Watchers: 2
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

If you've ever tried using the `react-router-dom` library with `Electron`,
you've probably had trouble getting it to work properly,
both in development and production environments.

From this, the `Electron Router DOM` library was born,
which aims to facilitate the integration of `react-router-dom` with `Electron` and window routing,
where each window can have its own routing.

# Features

- 🚀 Ready for production and development environments
- 📱 Window routing support
- 🌐 Support for `query strings` sent from the main process to the renderer
- 🧬 Type-safe API designed to provide good DX

# Installation

> **Minimum required versions**
>
> - electron: >=17.0
> - react: >=18.0
> - react-router-dom: >=6.22.3

In your terminal and in the root folder of your application, run:

```bash
npm i electron-router-dom
```

**Router DOM is a peer dependency**, if you haven't installed it yet or your package manager won't handle it automatically for you, so run:

```bash
npm i react-router-dom
```

# Links
- [Documentation](https://electron-router-dom.daltonmenezes.com/docs)
- [Blog](https://electron-router-dom.daltonmenezes.com/blog)
- [Examples](https://github.com/daltonmenezes/electron-router-dom/tree/main/examples)

# Contributing
> **Note**: contributions are always welcome, but always **ask first**, — please — before work on a PR.

That said, there's a bunch of ways you can contribute to this project, like by:

- :beetle: Reporting a bug
- :page_facing_up: Improving documentation
- :rotating_light: Sharing this project and recommending it to your friends
- :dollar: Supporting this project on GitHub Sponsors or Patreon
- :star2: Giving a star on this repository

# License