1.0.0-alpha.0 • Published 5 years ago

@history-navigation/history v1.0.0-alpha.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@history-navigation/history

Extension to history object to listen for user navigation on an SPA (e.g. clicking back and forward on the browser or history.goBack/history.goForward method calls);

Install

$ npm i @history-navigation/history
$ yarn add @history-navigation/history

API

Table of contents

function listenToNaviationBinder

listen to history navigation changes

ParameterTypeDescription
onForwardonForwardcallback on forward movement
onBackonBackcallback on back movement

Examples

history::listenToNavigation(onForward, onBack)

listenToNavigation.bind(history)(onForward, onBack)

function listenToNaviationWrapper

ParameterTypeDescription
historyobjecthistory object to use

Returns: function(onForward, onBack) — that listens to history navigation changes

Examples

listenToNavigation(history)(onForward, onBack)

function onBack

Callback to execute when history moves backwards.

ParameterTypeDescription
stepsnumbernumber of steps in history

function onForward

Callback to execute when history moves forward.

ParameterTypeDescription
stepsnumbernumber of steps in history
@everything-registry/sub-chunk-396@infinitebrahmanuniverse/nolb-_his@history-navigation/react-history
1.0.0-alpha.0

5 years ago