!React Keycloak

React Keycloak (Keycloak >=v17 Fork)

> React bindings for Keycloak. Fork of https://github.com/react-keycloak/react-keycloak.git with updated packages for keycloak >=17 support.


 !npm


---

Table of Contents

- Integrations
- React
- SSR
- React Native
- Support
- Examples
- Alternatives
- Contributing
- License

---

Integrations

$3

React Keycloak for Web requires:

- React 16.0 or later
- keycloak-js 17.0.0 or later

``shell
yarn add @react-keycloak-fork/web
`

or

`shell
npm install --save @react-keycloak-fork/web
`

or as a UMD package through unpkg

See @react-keycloak-fork/web package README for complete documentation.

$3

React Keycloak for SSR frameworks requires:

- React 16.0 or later
- SSR Framework:
- NextJS 9 or later
- Razzle 3 or later
- keycloak-js 17.0.0 or later

`shell
yarn add @react-keycloak-fork/ssr
`

or

`shell
npm install --save @react-keycloak-fork/ssr
`

See @react-keycloak-fork/ssr package README for complete documentation.

$3

React Keycloak for React Native requires React Native 61.0 or later

To install run

`shell
yarn add @react-keycloak-fork/native
`

or

`shell
npm install --save @react-keycloak-fork/native
`

See @react-keycloak-fork/native package README for complete documentation.

Support

| version | keycloak-js version |
| ------- | ------------------- |
| v4.0.1+ | 17.0.0+ | (fork)
| v2.0.0+ | 9.0.2+ |
| v1.x | >=8.0.2 <9.0.2 |

Examples

See @react-keycloak-fork/react-keycloak-examples repository for various demo implementing this library main features.

Alternatives

If you need to connect using a more generic OIDC client instead of keycloak.js`, consider using one of the following libraries:

- bjerkio/oidc-react
- thchia/react-oidc
- @axa-fr/react-oidc

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

---

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