keycloak-scim/js/apps/admin-ui
dependabot[bot] 2fa903e4ad
Bump react-hook-form from 7.52.2 to 7.53.0 (#32377)
Bumps [react-hook-form](https://github.com/react-hook-form/react-hook-form) from 7.52.2 to 7.53.0.
- [Release notes](https://github.com/react-hook-form/react-hook-form/releases)
- [Changelog](https://github.com/react-hook-form/react-hook-form/blob/master/CHANGELOG.md)
- [Commits](https://github.com/react-hook-form/react-hook-form/compare/v7.52.2...v7.53.0)

---
updated-dependencies:
- dependency-name: react-hook-form
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-08-26 14:18:55 +02:00
..
cypress Warnings for temporary admin user and service account (#31387) 2024-08-21 09:30:24 +02:00
maven-resources Warnings for temporary admin user and service account (#31387) 2024-08-21 09:30:24 +02:00
maven-resources-community/theme/keycloak.v2/admin/messages Update translation files (#32019) 2024-08-08 17:19:12 +00:00
public
src added organizations table to account (#32311) 2024-08-22 15:44:03 -03: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 Bump react-hook-form from 7.52.2 to 7.53.0 (#32377) 2024-08-26 14:18:55 +02:00
pom.xml added admin-ui to the distribution (#31404) 2024-07-19 10:36:16 +02: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
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