keycloak-scim/js/apps/admin-ui
Jon Koops d60dee7622
Remove the UMD distribution of Keycloak JS (#33080)
Closes #32826

Signed-off-by: Jon Koops <jonkoops@gmail.com>
2024-09-30 14:05:18 +02:00
..
cypress Duplicating groups (#32454) 2024-09-27 13:25:09 +02:00
maven-resources Duplicating groups (#32454) 2024-09-27 13:25:09 +02:00
maven-resources-community/theme/keycloak.v2/admin/messages Update translation files (#33361) 2024-09-30 10:46:02 +02:00
public Upgrade admin and account console to PatternFly 5 (#28196) 2024-04-05 16:37:05 +02:00
src fixed banner wrap (#33388) 2024-09-30 11:13:14 +00:00
.gitignore Add lib directory of Admin Console to .gitignore (#31579) 2024-07-24 17:31:35 +02:00
CONTRIBUTING.md make admin-ui build as a library (#30268) 2024-07-05 12:48:10 -04:00
cypress.config.ts Update ESLint dependencies to latest version (#31831) 2024-08-06 08:02:18 -04:00
package.json Remove the UMD distribution of Keycloak JS (#33080) 2024-09-30 14:05:18 +02:00
pom.xml Fix typo of interface (#32636) 2024-09-04 10:01:00 +00:00
README.md make admin-ui build as a library (#30268) 2024-07-05 12:48:10 -04:00
tsconfig.json Move ESLint configuration to project root (#28639) 2024-04-12 08:34:18 +00:00
tsconfig.node.json Rework project structure so it matches the main repo 2023-03-07 11:55:19 +01:00
vite.config.ts make admin-ui build as a library (#30268) 2024-07-05 12:48:10 -04:00

Keycloak Admin UI

This project is the next generation of the Keycloak Admin UI. It is written with React and PatternFly 4 and uses Vite.

Features

Contains all the "pages" from the admin-ui as re-usable components, all the functions to save and the side menu to use in your own build of the admin-ui

Install

npm i @keycloak/keycloak-admin-ui

Usage

To use these pages you'll need to add KeycloakProvider in your component hierarchy to setup what client, realm and url to use.

import { KeycloakProvider } from "@keycloak/keycloak-ui-shared";

//...

<KeycloakProvider environment={{
      authServerUrl: "http://localhost:8080",
      realm: "master",
      clientId: "security-admin-console"
  }}>
  {/* rest of you application */}
</KeycloakProvider>

Translation

For the translation we use react-i18next you can set it up as described on their website. If you want to use the translations that are provided then you need to add i18next-http-backend to your project and add:


backend: {
  loadPath: `http://localhost:8180/resources/master/admin/{{lng}}`,
  parse: (data: string) => {
    const messages = JSON.parse(data);

    const result: Record<string, string> = {};
    messages.forEach((v) => (result[v.key] = v.value));
    return result;
  },
},

to the i18next config object.

Building

To build a library instead of an app you need to add the LIB=true environment variable.

LIB=true pnpm run build