🔏 Create Keycloak themes using React 🔏

Home
-
Documentation

Ultimately this build tool generates a Keycloak theme Learn more

> The official websites of the project are temporarily down. While it is being addressed, you can access the doc here.

Changelog highlights

5.8.0

- React.lazy() support 🎉. #141

5.7.0

- Feat logout-confirm.ftl. PR

5.6.4

Fix login-verify-email.ftl page. Before - After

v5.6.0

Add support for login-config-totp.ftl page #127.

v5.3.0

Rename keycloak_theme_email to keycloak_email.
If you already had a keycloak_theme_email you should rename it keycloak_email.

v5.0.0

Migration guide
New i18n system.
Import of terms and services have changed. See example.

v4.10.0

Add login-idp-link-email.ftl page See PR.

v4.8.0

Email template customization.

v4.7.4

M1 Mac support (for testing locally with a dockerized Keycloak).

v4.7.2

> WARNING: This is broken.
> Testing with local Keycloak container working with M1 Mac. Thanks to @eduardosanzb.
> Be aware: When running M1s you are testing with Keycloak v15 else the local container spun will be a Keycloak v16.1.0.

v4.7.0

Register with user profile enabled: Out of the box options validator support.
Example

v4.6.0

tss-react and powerhooks are no longer peer dependencies of keycloakify.
After updating Keycloakify you can remove tss-react and powerhooks from your dependencies if you don't use them explicitly.

v4.5.3

There is a new recommended way to setup highly customized theme. See here.
Unlike with the previous recommended method,
with this new method your theme wont break on minor Keycloakify update.

v4.3.0

Feature login-update-password.ftl.
Every time a page is added it's a breaking change for non CSS-only theme.
Change this and this to update.

v4

- Out of the box frontend form validation 🥳
- Improvements (and breaking changes in import { useKcMessage } from "keycloakify".

v3

No breaking changes except that @emotion/react, tss-react and powerhooks are now peerDependencies instead of being just dependencies.
It's important to avoid problem when using keycloakify alongside mui and
when passing params from the app to the login page.

v2.5

- Feature Use advanced message
and messagesPerFields (implementation here)
- Test container now uses Keycloak version 15.0.2.

v2

- It's now possible to implement custom .ftl pages.
- Support for Keycloak plugins that introduce non standard ftl values.
(Like for example this plugin that define authorizedMailDomains in register.ftl).