npm:react-router-navigation-confirm

README

React Router Navigation Confirm

Table of Contents
Installation
Demo
General Usage
- Basic example
- Custom dialog
API
License

Installation

To install this component you can use npm or yarn:

$ npm install --save react-router-navigation-confirm
$ yarn add react-router-navigation-confirm

Demo

You can see demo and docs on this site.

General Usage

Basic example

To show confirmation dialog on every navigation you only need to include <HistoryListener/> provider-component to the root router of your app and <NavigationConfirmModal/> to any Route (inside <HistoryListener>) in which you want to display confirmation dialog:

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter } from 'react-router-dom';
import { NavigationConfirmModal, HistoryListener } from 'react-router-navigation-confirm';

import App from './App';


ReactDOM.render(
    <BrowserRouter>
        <div>
            <HistoryListener>
                <NavigationConfirmModal/>
            <HistoryListener/>
            <App />
        </div>
    </BrowserRouter>
    , document.getElementById('root')
);

HistoryListener - the component-provider which start to listen all changes of history and help to understand when you go forward and when you go back in the navigation(NavigationConfirmModal and NavigationConfirm will not work without HistoryListener).
NavigationConfirmModal - the component that displays confirmation dialog with to buttons (Confirm and Cancel) when you try to navigate to other page or Route.

Custom dialog

If you want to create custom dialog you can use NavigationConfirm confirm component:

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter } from 'react-router-dom';
import { NavigationConfirm, HistoryListener } from 'react-router-navigation-confirm';

import App from './App';

const children = ({ onConfirm, onCancel }) => (
    <div>
        <button onClick={ onConfirm }>Confirm</button>
        <button onClick={ onCancel }>Cancel</button>
    </div>
)


ReactDOM.render(
    <BrowserRouter>
        <div>
            <HistoryListener>
                <NavigationConfirm>
                    { children }
                </NavigationConfirm>
            </HistoryListener>
            <App />
        </div>
    </BrowserRouter>
    , document.getElementById('root')
);

NavigationConfirm is the component that displays custom children, you should provide function that takes object with onConfirm and onCancel and return some React element. You can use onConfirm to approve navigation ot onCancel function to reject it and stay on the same page / Route.

API

1. `<HistoryListener/>`

Property	Description	Default	Type	Required
`children`	React element / node to render into the `HistoryListener` component	`undefined`	`React.ReactNode`	false

2. `<NavigationConfirm/>`

Property	Description	Default	Type	Required
`children`	function that takes object with `onConfirm` and `onCancel` fields-functions and returns React node to render when user navigate to other page / Route	no default	`({ onConfirm: function, onCancel: function }) => React.ReactNode;`	true
`unloadMsg`	message to show in the confirmation dialog on page unload event (in new versions in browser message alwase takes default messges according browser)	`'msg'`	`string`	false
`when`	condition to render confirmation, you can hide or show dialog by pass `true` or `false`, or create custom behaviour using function	`true`	`boolean \| ((location: Location, routeProps: RouteComponentProps) => boolean)`	false

3. `<NavigationConfirmModal/>`

Property	Description	Default	Type	Required
`children`	React element / node to render into the `NavigationConfirmModal` component	`'Are you sure you want to leave this page?'`	`React.ReactNode`	false
`when`	condition to render confirmation, you can hide or show dialog by pass `true` or `false`, or create custom behaviour using function	`true`	`boolean \| ((location: Location, routeProps: RouteComponentProps) => boolean)`	false
`onCancel`	function to call when user click on cancel button	`undefined`	`() => void`	false
`onConfirm`	function to call when user click on confirm button	`undefined`	`() => void`	false
`confirmText`	Text for confirm button	`'Confirm'`	`string`	false
`cancelText`	Text for cancel button	`'Cancel'`	`string`	false
`modalClassName`	modal class name	`'nc-modal'`	`string`	false
`backdropClassName`	class name for modal backdrop	`'nc-modal__backdrop'`	`string`	false
`contentClassName`	content class name	`'nc-modal__content'`	`string`	false
`bodyClassName`	class name for body container	`'nc-modal__body'`	`string`	false
`footerClassName`	class name for modal footer	`'nc-modal__footer'`	`string`	false
`buttonClassName`	class name for all modal buttons (applyed for confirm and cancel)	`'nc-modal__button'`	`string`	false
`buttonConfirmClassName`	confirm button aditional style	`'confirm'`	`string`	false

License

MIT

Usage no npm install needed!