1.0.1 • Published 3 years ago

react-usepopstate v1.0.1

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

Installation

Using npm:

$ npm install --save react-usepopstate

Using yarn:

$ yarn add react-usepopstate

Quick Start

import React from 'react';
import usePopstate from 'react-usepopstate';

const render = () => {
  	const { isBackButtonClicked } = usePopstate({
    isPrompt: true,
		alertDescription: 'Confirm back',
		callback: () => {
			alert('BACK')
		},
	})
 
  return (
    <>
      <div>Hello React!</div>
    </>
  );
}

Documentation

const { isBackButtonClicked } = usePopstate({ isPrompt, alertDescription, callback })

Parameters object

  • alertDescription {String} Confirm prompt description
  • callback {Function} Callback function
  • isPrompt {Booleen} Use confirm propmt default : false

Return value

  • isBackButtonClicked {Booleen} Back status

Contributing

Feel free to submit any issues or pull requests.

License

MIT