Skip to content

offlegacy/nuqs-hash-router

Repository files navigation

nuqs-hash-router · NPM Version MIT License unofficial

Important

This package is not an official adapter of nuqs, and caution is advised when using it in production (especially in enterprise environments). (Although it's unofficial, I am actually using it successfully in a company project. Thanks to our team.)

This is a dedicated nuqs adapter for React Router's HashRouter. Currently, nuqs officially supports BrowserRouter, and support for HashRouter is still under discussion.

This package was created to enable the use of nuqs in applications that use React Router's HashRouter.

Usage

Installation

npm install @offlegacy/nuqs-hash-router

React Router v7

import { NuqsAdapter } from '@offlegacy/nuqs-hash-router';
import { Outlet } from 'react-router';

// ...

export default function App() {
  return (
    <NuqsAdapter>
      <Outlet />
    </NuqsAdapter>
  );
}

Related Links

Credits

This package is an unofficial adapter created specifically to support the hash router in nuqs. Until official support is provided, this package may be used for experimental purposes and maintenance may be discontinued at any time. For more details, please refer to the official nuqs documentation or this issue.

  • nuqs - Type-safe search params state manager for React frameworks - Like useState, but stored in the URL query string.

Contributing

We welcome contribution from everyone in the community. Read below for detailed contribution guide.

CONTRIBUTING.md

Contributors

contributors

License

See LICENSE for more information.

MIT © OffLegacy

About

nuqs adaptor for hash router (unofficial)

Resources

License

Stars

Watchers

Forks

Releases

No releases published