private-route-react

1.1.12 • Public • Published

private-route-react

private-route-react is a library to handle private routing of react-router-dom instead of creating it manually.


Installation

Use the package manager npm to install private-route-react

npm install private-route-react

Usage

import PrivateRoute from 'private-route-react';

<PrivateRoute path={routePath} component={Component} isAbleToAccessRoute={isAbleToAccessRouteFunction} redirectPath={redirectPath} />
property Description
path routing path you want to go to
component component you want to render in this path
isAbleToAccessRoute function which have to return boolean to check if he isa able to go to that path or not
redirectPath routing path to go to if he is not allowed to go to that path

Example

  • isLoggedIn.js

      const isLoggedIn = ()=> false;
      export default isLoggedIn;
    
  • app.js

      import PrivateRoute from 'private-route-react';
      import isLoggedIn from './isLoggedIn.js';
      import ComponentA from './Component';
    
    
      <PrivateRoute path={'/profile'} component={ComponentA} isAbleToAccessRoute=   {isLoggedIn} redirectPath={'/login'} />
    

Tests

made using Jest to check tests run

npm run test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.


License

MIT

Dependents (0)

Package Sidebar

Install

npm i private-route-react

Weekly Downloads

4

Version

1.1.12

License

MIT

Unpacked Size

34.4 kB

Total Files

5

Last publish

Collaborators

  • ahmedhemaz