React Keycloak

React bindings for Keycloak

Table of Contents

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

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

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 Native

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.

Support

Examples

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

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.

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.2.0 (2020-10-18)

Features

• core: re-render ReactKeycloakProvider if authentication state changes (3ffa66d)

3.1.0 (2020-10-18)

Features

• core: remove 'token' from 'AuthProviderState' to avoid re-render on token refresh (11f1024), closes #106

3.0.0 (2020-10-04)

Note: Version bump only for package @react-keycloak/core

2.2.1 (2020-08-21)

Note: Version bump only for package @react-keycloak/core

2.2.0 (2020-07-21)

Features

• core: Add 'onInitError' event notification when 'init' call to 'keycloak' fails (1ae1ea0), closes #80
• core: Update TS typings (f5c43f1)

2.1.2 (2020-07-20)

Note: Version bump only for package @react-keycloak/core

2.1.1 (2020-04-09)

Note: Version bump only for package @react-keycloak/core

2.1.0 (2020-04-08)

Features

• core: Update TS typings (8a240f2)

2.0.0 (2020-03-30)

chore

• core: Remove support for 'keycloak-js' pre-9.0.2 (94f2d5f)

Features

• core: Improve TS typings (59d3553)

BREAKING CHANGES

• core: Drop support for older KeycloakJS versions

1.2.1 (2020-03-30)

Note: Version bump only for package @react-keycloak/core

1.2.0 (2020-03-19)

Features

• core: Update 'react-fast-compare' dependency (45471a8)

1.1.1 (2020-02-22)

Note: Version bump only for package @react-keycloak/core

1.1.0 (2020-02-19)

Features

• core: Add 'autoRefreshToken' prop to 'KeycloakProvider' (e1fe4c6)

1.0.1 (2020-01-23)

Note: Version bump only for package @react-keycloak/core

1.0.0-alpha.6 (2019-12-23)

Note: Version bump only for package @react-keycloak/core

1.0.0-alpha.5 (2019-12-16)

Note: Version bump only for package @react-keycloak/core

1.0.0-alpha.4 (2019-12-16)

Note: Version bump only for package @react-keycloak/core

1.0.0-alpha.3 (2019-12-16)

Note: Version bump only for package @react-keycloak/core

1.0.0-alpha.2 (2019-12-16)

Note: Version bump only for package @react-keycloak/core