@scherer.adi/react-keycloak-core v3.2.3

React Keycloak

React bindings for Keycloak

Table of Contents

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

Integrations

React

React Keycloak for Web requires:

• React 16.0 or later
• keycloak-js 18.0.0 or later

yarn add @scherer.adi/react-keycloak-web

or

npm install --save @scherer.adi/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.

SSR

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 @scherer.adi/react-keycloak-ssr

or

npm install --save @scherer.adi/react-keycloak-ssr

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

React Native

React Keycloak for React Native requires React Native 61.0 or later

To install run

yarn add @scherer.adi/react-keycloak-native

or

npm install --save @scherer.adi/react-keycloak-native

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

Support

Examples

See @react-keycloak/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.