This is the documentation for v9, checkout the latest version
Keycloakify
HomeGitHubStartersStorybookDiscordKeycloak-js Alternative
v9
  • Keycloakify
  • Release Notes & Upgrade Instructions
  • FAQ
v9
  • 👨‍💻Quick start
  • 📥Importing your theme in Keycloak
  • 🔩Keycloakify in my App
  • 🖼️Importing assets and fonts
  • 📧Email customization
  • ✒️Terms and conditions
  • ✅Realtime input validation and custom registration fields
  • ⚠️Limitations
  • 🔧Environment Variables
  • 🌎i18n: msg(...)
  • 📖Build options
  • 💂Email domain acceptlist
  • 🛑Keycloak error in log
  • 🌉Passing values from the App to the theme
  • 💟Contributing
  • 🤔How it works
  • ⬆️Migration guides
    • ⬆️CRA -> Vite
    • ⬆️v8 -> v9
    • ⬆️v7 -> v8
    • ⬆️v6 -> v7
    • ⬆️v6.x -> v6.12
    • ⬆️v5 -> v6
Powered by GitBook
On this page

Was this helpful?

  1. Migration guides

v7 -> v8

Previousv8 -> v9Nextv6 -> v7

Last updated 27 days ago

Was this helpful?

  • Remove the public/keycloak-resources directory.

  • The it was a performance optimization that is no longer relevant now that we have lazy loading.

  • kcContext.usernameEditDisabled is now kcContext.usernameHidden, the type was lying, it has been updated to reflect what's actually on the kcContext at runtime. If you want to see in detail what should be updated , or you can search and replace usernameEditDisabled -> usernameHidden it'll do the trick.

  • The usePrepareTemplate prototype has been changed, you can search and replace:

src/keycloak-theme/login/Template.tsx

url,
"stylesCommon": [
    "node_modules/patternfly/dist/css/patternfly.min.css",
    "node_modules/patternfly/dist/css/patternfly-additions.min.css",
    "lib/zocial/zocial.css"
],
"styles": ["css/login.css"],

by

"styles": [
    `${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
    `${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
    `${url.resourcesCommonPath}/lib/zocial/zocial.css`,
    `${url.resourcesPath}/css/login.css`
],

and

src/keycloak-theme/account/Template.css

url,
"stylesCommon": ["node_modules/patternfly/dist/css/patternfly.min.css", "node_modules/patternfly/dist/css/patternfly-additions.min.css"],
"styles": ["css/account.css"],

by

"styles": [
    `${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
    `${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
    `${url.resourcesPath}/css/account.css`
],
⬆️
⬆️
--external-assets build option has been removed
see issue