Farce [![Travis][build-badge]][build] [![npm][npm-badge]][npm]

This is a fork of the original farce package with some changes:

• Fixed empty location.pathname bug in createBasenameMiddleware.js when using a basename.
• Fixed a bug in createNavigationListenerMiddleware.js when it didn't correctly clear navigation listeners on DISPOSE event.
• Replaced redux with a basic stub of it. The rationale is that the redux that was used under the hood by this package would conflict with the redux used by the application itself.
• Removed unused createHref() and createLocation() actions.
• Removed unused HashProtocol.
• Removed store.farce.addNavigationListener() function. As a replacement, it now exports a new function addNavigationListener().
• Removed createHistoryEnhancer() function. As a replacement, it now exports a new function createReduxMiddlewares().

This fork is exclusively used by react-pages package.

The source code is available at github.com or gitlab.com.

How farce works in general:

• It provides Redux actions that could be dispatched:
  • type: PUSH — navigates to a page.
  • type: REPLACE — redirects to a page: replaces the current page with the new one without the ability to go "Back" to the current one.
  • type: GO — goes "Back"/"Forward".
• Whenever one of the Redux actions above is dispatched, it emits a type: UPDATE_LOCATION Redux action. The action property of the Redux action will be:
  • "PUSH" when dispatching a type: PUSH action.
  • "REPLACE" when dispatching a type: REPLACE action.
  • "POP" when dispatching a type: GO action.
• It listens to "Back"/"Forward" navigation: whenever it happens, it emits a type: UPDATE_LOCATION Redux action. The action property of the Redux action will be "POP".
• The application could listen to type: UPDATE_LOCATION Redux action and read the location property from that action to always have the up-to-date location object.
• No type: UPDATE_LOCATION Redux action will be emitted in case of any changes that were made using History API directly, such as history.pushState(), history.replaceState(), etc. So those changes to the current URL will go unnoticed by this library.