react-url-query/src/urlQueryConfig.js

A library for managing state through query parameters in the URL in React. Works well with or without Redux and React Router.

// function to create the singleton options object that can be shared
// throughout an application
function createUrlQueryConfig() {
  // default options
  return {
    // add in generated URL change handlers based on a urlPropsQueryConfig if provided
    addUrlChangeHandlers: true,

    // add in `props.params` from react-router to the url object
    addRouterParams: true,

    // function to specify change handler name (onChange<PropName>)
    changeHandlerName: propName =>
      `onChange${propName[0].toUpperCase()}${propName.substring(1)}`,

    // use this history if no history is specified
    history: {
      push() {
        // eslint-disable-next-line
        console.error(
          'No history provided to react-url-query. Please provide one via configureUrlQuery.'
        );
      },
      replace() {
        // eslint-disable-next-line
        console.error(
          'No history provided to react-url-query. Please provide one via configureUrlQuery.'
        );
      },
    },

    // reads in location from react-router-redux if available and passes it
    // to the reducer in the urlQueryMiddleware
    readLocationFromStore(state) {
      if (state && state.routing) {
        return state.routing.locationBeforeTransitions;
      }

      return undefined;
    },
    /**
     * The separator between entries
     * @default {String} "_"
     */
    entrySeparator: '_',
    /**
     * The separator between keys and values
     * @default {String} "-"
     */
    keyValSeparator: '-',
  };
}

export default createUrlQueryConfig();