4.1.0 • Published 6 years ago

react-router-lockin v4.1.0

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

react-router-lockin

React Router addon for locking user in current page. It also lets you display content depends whether user is locked on page or not. See last example.

Props

NameTypeDefaultRequireddescription
lockbooleanfalseNoWhether to lock user on current page
messagestringAre you sure you want to leave this page?NoMessage displayed to user before leaving the page
renderChildrenalways or locked or freealwaysNoWhen should render components children
childrennodenullNoChildren

Example

import * as React from 'react';
import Lockin from 'react-router-lockin';


const Page = () => (
    <div>
        <Lockin lock />
    </div>
);


const Page = () => (
    <div>
        <Lockin lock={false} message="Want to leave?" />
    </div>
);

const Page = () => (
    <div>
        <Lockin lock={true} message="Want to leave?" renderChildren="locked">
            This is rendered when lock is true
        </Lockin>
    </div>
);

const Page = () => (
    <div>
        <Lockin lock={true} message="Want to leave?" renderChildren="free">
            This is rendered when lock is false
        </Lockin>
    </div>
);


const Page = () => (
    <div>
        <Lockin lock={true} message="Want to leave?">
            <Lockin renderChildren="free">
                This is rendered when lock is false
            </Lockin>
            <Lockin renderChildren="locked">
                This is rendered when lock is true
            </Lockin>
        </Lockin>
    </div>
);

There is also fully working example in example/index.js

Run with webpack dev server at 8080: yarn start or npm start

4.1.0

6 years ago

4.0.2

6 years ago

4.0.1

6 years ago

4.0.0

6 years ago

1.0.0

6 years ago