This library is deprecated and will no longer be maintained or updated.
Instead, it is recommended to use:
react-oidc-context
for React SPA projects instead of@react-keycloak/web
NextAuth.js
for Next.js projects instead of@react-keycloak/ssr
React bindings for Keycloak
React Keycloak for Web requires:
- React 16.0 or later
keycloak-js
9.0.2 or later
yarn add @react-keycloak/web
or
npm install --save @react-keycloak/web
or as a UMD
package through unpkg
-
one for development: https://unpkg.com/@react-keycloak/web@latest/dist/umd/react-keycloak-web.js
-
one for production: https://unpkg.com/@react-keycloak/web@latest/dist/umd/react-keycloak-web.min.js
See @react-keycloak/web
package README for complete documentation.
React Keycloak for SSR frameworks requires:
- React 16.0 or later
- SSR Framework:
- NextJS 9 or later
- Razzle 3 or later
keycloak-js
9.0.2 or later
yarn add @react-keycloak/ssr
or
npm install --save @react-keycloak/ssr
See @react-keycloak/ssr
package README for complete documentation.
React Keycloak for React Native requires React Native 61.0 or later
To install run
yarn add @react-keycloak/native
or
npm install --save @react-keycloak/native
See @react-keycloak/native
package README for complete documentation.
version | keycloak-js version |
---|---|
v2.0.0+ | 9.0.2+ |
v1.x | >=8.0.2 <9.0.2 |
See @react-keycloak/react-keycloak-examples
repository for various demo implementing this library main features.
If you need to connect using a more generic OIDC client instead of keycloak.js
, consider using one of the following libraries:
See the contributing guide to learn how to contribute to the repository and the development workflow.
MIT