# with-react-login

> React hoc component for rendering page only on user log success.

Latest version **1.13.9** (published 2020-06-02) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install with-react-login
pnpm add with-react-login
yarn add with-react-login
bun add with-react-login
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.13.9 |
| Published | 2020-06-02 |
| First published | 2019-04-12 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 45.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 1 |
| Maintainers | ledoux |
| Keywords | react, hoc, login |

## Links

- npm: https://www.npmjs.com/package/with-react-login
- Repository: https://github.com/betagouv/with-react-login
- npm.io page: https://npm.io/package/with-react-login

## Dependencies (7)

- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [react](https://npm.io/package/react.md) ^16.10.1
- [reselect](https://npm.io/package/reselect.md) ^3.0.1
- [classnames](https://npm.io/package/classnames.md) 2.2.5
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [lodash.uniq](https://npm.io/package/lodash.uniq.md) ^4.5.0
- [fetch-normalize-data](https://npm.io/package/fetch-normalize-data.md) 1.10.6

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.13.9 (latest) — 2020-06-02
- 1.13.8 — 2020-06-02
- 1.13.7 — 2020-06-02
- 1.13.6 — 2020-06-02
- 1.13.4 — 2020-06-02
- 1.13.3 — 2020-06-02
- 1.13.2 — 2020-05-17
- 1.13.1 — 2020-05-17
- 1.13.0 — 2020-05-13
- 1.12.0-rc5 — 2020-03-21
- 1.12.0-rc4 — 2020-03-15
- 1.12.0-rc2 — 2020-03-15
- 1.12.0-rc1 — 2020-03-09
- 1.11.4 — 2020-03-09
- 1.11.3 — 2020-03-09
- … 23 more at https://npm.io/package/with-react-login/versions

## README

# with-react-login

React hoc component for rendering page only on user log success.

[![CircleCI](https://circleci.com/gh/betagouv/with-react-login/tree/master.svg?style=svg)](https://circleci.com/gh/betagouv/with-react-login/tree/master)
[![npm version](https://img.shields.io/npm/v/with-react-login.svg?style=flat-square)](https://npmjs.org/package/with-react-login)

## Basic Usage

### Using redux-saga-data

See first the store install process in [redux-thunk-data](https://github.com/betagouv/redux-saga-data).

Then you can declare a login component like this:

```javascript

import { connect } from 'react-redux'
import { withRouter } from 'react-router-dom'
import { compose } from 'redux'
import withLogin from 'with-react-login'

const withConnectedLogin = compose(
  withRouter,
  withLogin({
    currentUserApiPath: '/users/current',
    handleFail: (state, action, { history }) => history.push('/signin'),
    withDispatcher: connect(),
  })
)

const FooPage = () => {
  // withLogin passes a currentUser props
  const { currentUser } = this.props
  const { email } = currentUser || {}
  return (
    <div>
      I am connected with {email} !
    </div>
  )
}

export default withConnectedLogin(FooPage)
```

Depending on what returns GET 'https://myfoo.com/users/current':

  - if it is a 200 with { email: 'michel.momarx@youpi.fr' }, FooPage will be rendered,
  - if it is a 400, app will redirect to '/signin' page.

### Using redux-thunk-data

Like above, see the install process in [redux-thunk-data](https://github.com/betagouv/redux-thunk-data).

Then you need just to slightly change setup:

```javascript

import { connect } from 'react-redux'
import { requestData } from 'redux-thunk-data'
import { compose } from 'redux'
import withLogin from 'with-react-login'

const withConnectedLogin = compose(
  withRouter,
  withLogin({
    currentUserApiPath: '/users/current',
    handleFail: (state, action, { history }) => history.push('/signin'),
    requestData,
    withDispatcher: connect()
  })
)
...
```

### Using react-hook-data

See [redux-hook-data](https://github.com/betagouv/redux-hook-data), but this is the same principle.

```javascript
import { DataContext } from 'react-hook-data'
import withLogin from 'with-react-login'

const withConnectedLogin = withLogin({
  currentUserApiPath: '/users/current',
  handleFail: (state, action, { history }) => history.push('/signin'),
  withDispatcher: DataContext
})
```

## Usage with config

### withLogin

| name | type | example | isRequired | default | description |
| -- | -- | -- | -- | -- | -- |
| currentUserApiPath | `string` |  | no | '/users/current' | apiPath that will be joined with your rootUrl to get the authenticated user from your auth server |
| failRedirect | `function` | See test | no | 'undefined' | function triggered after fail of your auth currentUserApiPath request saying. It should return a redirect path towards which react-router will history push. |
| currentUser | `object` |  | no | 'null' | object saying if withLogin needs to be rendered already with a currentUser. Useful when we want to do redux-persist login |
| requestData | `function` | See test | yes | requestData from fetch-normalize-data | action creator which will trigger the action to request '/users/current' |
| successRedirect | `function` | See test | no | 'undefined' | function triggered after success of your auth currentUserApiPath request saying. It should return a redirect path towards which react-router will history push. |
| isRequired | `boolean` | See test | no | 'true' | Boolean saying if the React WrappedComponent will need to wait a success from the currentUserApiPath to be rendered. |

---
_Source: https://npm.io/package/with-react-login · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._