# react-keycloak-js

> Keycloak React for javascript adapter

Latest version **1.0.10** (published 2024-08-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-keycloak-js
pnpm add react-keycloak-js
yarn add react-keycloak-js
bun add react-keycloak-js
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2024-08-01 |
| First published | 2023-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16.15.0 |
| Dependencies | 0 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Lucas Canavesio |
| Maintainers | luxer066 |
| Keywords | react, keycloak, keycloak-js |

## Links

- npm: https://www.npmjs.com/package/react-keycloak-js
- Repository: https://github.com/lcanavesio/react-keycloak-js
- Homepage: https://github.com/lcanavesio/react-keycloak-js#readme
- Issues: https://github.com/lcanavesio/react-keycloak-js/issues
- npm.io page: https://npm.io/package/react-keycloak-js

## 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.0.10 (latest) — 2024-08-01
- 1.0.9 — 2024-08-01
- 1.0.8 — 2024-06-21
- 1.0.7 — 2023-09-16
- 1.0.6 — 2023-07-31
- 1.0.5 — 2023-07-29
- 1.0.4 — 2023-07-29
- 1.0.3 — 2023-02-06
- 1.0.2 — 2023-02-06
- 1.0.1 — 2023-02-06
- 1.0.0 — 2023-02-03

## README

# Keycloak login for React

This package use [keycloak-js](https://github.com/keycloak/keycloak).

It lets you login against a keycloak instance from an React.

## Install

```
npm install react-keycloak-js
```

## How to use

```js

import { KeycloakProvider } from 'react-keycloak-js';

const configKeycloak = {
    url: process.env.REACT_APP_AUTH_APP,
    realm: process.env.REACT_APP_PUBLIC_REALM,
    clientId: process.env.REACT_APP_CLIENT_ID
};

const App = () => (
 <KeycloakProvider keycloakConfig={configKeycloak} initOptions={{ onLoad: 'login-required' }}>
        <AppRoute />
  </KeycloakProvider>
);

# You can use hook useKeycloak()

const { keycloak, authenticated, error, isTokenExpired } = useKeycloak();

```

## Contributing

Feel free to open issues and pull requests. Help from the community is always welcome.

## License

MIT

---

If you found this project to be helpful, please consider buying me a coffee.

[![buy me a coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/lcanavesio)

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