@bitspur/react-keycloak-core

react-keycloak

This is a continuation of the react-keycloak project

• https://github.com/react-keycloak/react-keycloak

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 9.0.2 or later

yarn add @bitspur/react-keycloak-web

or

npm install --save @bitspur/react-keycloak-web

or as a UMD package through unpkg

• one for development: https://unpkg.com/@bitspur/react-keycloak-web@latest/dist/umd/react-keycloak-web.js

• one for production: https://unpkg.com/@bitspur/react-keycloak-web@latest/dist/umd/react-keycloak-web.min.js

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

or

npm install --save @bitspur/react-keycloak-ssr

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

Support

version	keycloak-js version
v2.0.0+	9.0.2+
v1.x	>=8.0.2 <9.0.2

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