rike422/react-keycloak

React/NextJS/Razzle components for Keycloak javascript adapter

React Keycloak

React bindings for Keycloak

---

Table of Contents

• Integrations
  • React
  • SSR
  • NextJS
  • Razzle
• Support
• Examples
• Contributors

---

Integrations

React

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.

SSR

Experimental (based on NextJS and Razzle ones)

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.

NextJS

Deprecated (please use SSR one instead).

React Keycloak for NextJS requires:

• React 16.0 or later
• NextJS 9 or later
• keycloak-js 9.0.2 or later

yarn add @react-keycloak/nextjs

or

npm install --save @react-keycloak/nextjs

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

Razzle

Deprecated (please use SSR one instead).

React Keycloak for Razzle requires:

• React 16.0 or later
• Razzle 3 or later
• keycloak-js 9.0.2 or later

yarn add @react-keycloak/razzle

or

npm install --save @react-keycloak/razzle

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

Support

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

Examples

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

Contributors

Thanks goes to these wonderful people (emoji key):

Mattia Panzeri 🤔 💻 📖 🐛 🚧 📦 💬 👀 ⚠️ 💡

JannesD 🐛 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

---

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