Keycloak UIコンポーネントライブラリの新しいものを発表します!

2024年9月4日 Erik Jan de Wit 著

Keycloakのカスタマイズ作業を大幅に強化するために設計された2つの新しいnpmパッケージのリリースを発表できることを嬉しく思います。これらのReactコンポーネントライブラリは、PatternFly上に構築されており、Keycloakのアカウントコンソールと管理コンソールを作成するための不可欠な構成要素を提供します。このツールは、当社の「Composable UI」手法を使用してカスタムコンソールのサンプルコードを生成します。これは基本的に、将来のリリースでサポートする予定の、エクスポートされたKeycloakコンポーネントからコンソールを構築できることを意味します。

パッケージは以下のとおりです

@keycloak/keycloak-admin-ui

このパッケージは、Keycloak管理コンソールを作成するための構成要素を提供します。

@keycloak/keycloak-account-ui

このパッケージは、Keycloakアカウントコンソールを作成するための構成要素を提供します。

@keycloak/ui-shared

このパッケージは、Keycloak UIを構築するための共有コンポーネントとユーティリティを提供します。

クイックスタートツールで開発を加速

npm create keycloak-theme my-theme コマンドを使用してプロジェクトをすぐに開始できます。この効率化されたツールは、プロジェクト構造、必須の依存関係、および構成を生成し、貴重な時間を節約します。現時点では、このツールはアカウントコンソールでのみ使用可能ですが、管理コンソールのサポートを追加する作業を進めています。これは次のリリース(26.0.0)で利用可能になる予定です。

はじめに

  1. npm create keycloak-theme@latest my-theme を実行します。

  2. Keycloakサーバーは npm run start-keycloak で起動できます。

  3. 開発サーバーを npm run dev で起動します。

  4. srcディレクトリ内のファイルを編集してテーマをカスタマイズします。

Keycloakサーバーは開発サーバーに接続し、すべての変更がブラウザに反映されます。ブラウザを開いて https://127.0.0.1:8080/realms/master/account/personalInfo にアクセスし、admin/adminでログインしてください。これによりKeycloakアカウントコンソールが開きます。サンプルコードには追加のページと、各ページの上にいくつかの追加コンテンツがあることがわかります。

主な利点

  1. 迅速な開発:短時間で素晴らしいUIを作成。

  2. 一貫性:統一感のあるルックアンドフィールを実現するためにPatternFlyデザインシステムに準拠。

  3. 柔軟性:ブランドとユーザーの好みに合わせてコンポーネントをカスタマイズ。

  4. アップグレード可能:npmパッケージの依存関係を持つことで、テーマの更新が容易になります。

詳細については、README を参照してください。