Extend documentation with all available adapters

pbeshai / use-query-params

React Hook for managing state in URL query parameters with easy serialization.

https://pbeshai.github.io/use-query-params

ISC License

2.15k stars 96 forks source link

Extend documentation with all available adapters #228

Open RaphaelManke opened 2 years ago

RaphaelManke commented 2 years ago

Hi we have a simple react app that does't use react router. In Version 2 one has to specify the adapter that should be used. We tried to use one of the react routers but this failed because react router is not installed.

By checking the code implementation we found a window-adapter which worked. This adapter is never mentioned in the docs. Is it safe to use this adapter? Should the docs be extended by mentioning all possible adapters that can be use.

pbeshai commented 2 years ago

Should be fine to use those adapters, they're just lower priority for maintenance than the React Router ones. But they're pretty simple and shouldn't be too bad to adjust if you run into issues. PRs welcome to update the docs!