React Keycloak

React bindings for Keycloak

---

Table of Contents

• Install
• Getting Started
  • Setup Keycloak instance
  • Setup KeycloakProvider
  • Hook Usage
  • External Usage (Advanced)
• Examples
• Guides and Articles
• Contributing
• License

---

Install

React Keycloak requires:

• React 16.8 or later
• keycloak-js 9.0.2 or later

1yarn add @react-keycloak/web

or

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

Getting Started

Setup Keycloak instance

Create a keycloak.js file in the src folder of your project (where App.js is located) with the following content

1import Keycloak from 'keycloak-js'
2
3// Setup Keycloak instance as needed
4// Pass initialization options as required or leave blank to load from 'keycloak.json'
5const keycloak = new Keycloak()
6
7export default keycloak

Setup KeycloakProvider

Wrap your App inside ReactKeycloakProvider and pass the keycloak instance as prop

1import { ReactKeycloakProvider } from '@react-keycloak/web'
2
3import keycloak from './keycloak'
4
5// Wrap everything inside KeycloakProvider
6const App = () => {
7  return <ReactKeycloakProvider authClient={keycloak}>...</ReactKeycloakProvider>
8}

N.B. If your using other providers (such as react-redux) it is recommended to place them inside ReactKeycloakProvider.

ReactKeycloakProvider automatically invokes keycloak.init() method when needed and supports the following props:

• initOptions, contains the object to be passed to keycloak.init() method, by default the following is used

  {
    onLoad: 'check-sso',
  }
  

  for more options see Keycloak docs.

• LoadingComponent, a component to be displayed while keycloak is being initialized, if not provided child components will be rendered immediately. Defaults to null

• isLoadingCheck, an optional loading check function to customize LoadingComponent display condition. Return true to display LoadingComponent, false to hide it.

  Can be implemented as follow

  1;(keycloak) => !keycloak.authenticated

• onEvent, an handler function that receives events launched by keycloak, defaults to null.

  It can be implemented as follow

  1;(event, error) => {
  2  console.log('onKeycloakEvent', event, error)
  3}

  Published events are:

  • onReady
  • onInitError
  • onAuthSuccess
  • onAuthError
  • onAuthRefreshSuccess
  • onAuthRefreshError
  • onTokenExpired
  • onAuthLogout

• onTokens, an handler function that receives keycloak tokens as an object every time they change, defaults to null.

  Keycloak tokens are returned as follow

  1{
  2  "idToken": string,
  3  "refreshToken": string,
  4  "token": string
  5}

Hook Usage

When a component requires access to Keycloak, you can use the useKeycloak Hook.

1import { useKeycloak } from '@react-keycloak/web'
2
3export default () => {
4  // Using Object destructuring
5  const { keycloak, initialized } = useKeycloak()
6
7  // Here you can access all of keycloak methods and variables.
8  // See https://www.keycloak.org/docs/latest/securing_apps/index.html#javascript-adapter-reference
9
10  return (
11    <div>
12      <div>{`User is ${
13        !keycloak.authenticated ? 'NOT ' : ''
14      }authenticated`}</div>
15
16      {!!keycloak.authenticated && (
17        <button type="button" onClick={() => keycloak.logout()}>
18          Logout
19        </button>
20      )}
21    </div>
22  )
23}

External Usage (Advanced)

If you need to access keycloak instance from non-React files (such as sagas, utils, providers ...), you can import the instance directly from the keycloak.js file.

The instance will be initialized by react-keycloak but you'll need to be carefull when using the instance and avoid setting/overriding any props, you can however freely access the exposed methods (such as refreshToken, login, etc...).

Examples

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

Guides and Articles

• Migration guide for @react-keycloak/web v2.x to v3.x can be found here MIGRATION.md.

• Secure React Routes & Component with Keycloak, a (slightly outdated) guide on how to setup Keycloak and create secured contents in a React app, thanks to @cagline for the detailed article.

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.