react-qparams v0.4.0

react-qparams

One of the hardest parts of working with a SPA is keeping the applications internal state in sync with the URL bar. Conceptually, React follows this formula:

f(state) := view

But for SPA's it's closer to:

f(state, url) := view

However, it's difficult to keep the URL bar in sync with your internal state. There ends up being a lot of calls to history.push and withRouter in order to get the history instance. That is, at the core, what this module is for.

Installation

$ yarn add react-qparams query-string@5

Additionally, you need react, react-dom, prop-types, and react-router-dom, but you probably already have those.

QueryParams

import { QueryParams } from "react-qparams";

function RenderView(props) {
  return (
    <QueryParams>
      {query => (
        <button onClick={() => query.setQuery({ tab: "other" })}>
          {query.tab || "default"}
        </button>
      )}
    </QueryParams>
  );
}

You can also add a replace option if you want setQuery to replace the last location in the history.

import { QueryParams } from "react-qparams";

function RenderView(props) {
  return (
    <QueryParams>
      {query => (
        <button
          onClick={() => query.setQuery({ tab: "other" }, { replace: true })}
        >
          {query.tab || "default"}
        </button>
      )}
    </QueryParams>
  );
}

Props

children or render

A render prop. Both children and render receive the same arguments:

• An object with all the query params in the url bar, along with
• A setQuery function that mutates the URL bar, and takes an object like setState

QueryLink

import { QueryLink } from "react-qparams";

function RenderView(props) {
  return <QueryLink query={{ name: "value" }}>Go Here!</QueryLink>;
}

Props

All react-router-dom Link props are supported, as well as:

query

An object that will be merged with the current query string when the link is clicked.