m1000/keycloakify-custom
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
garronej 2023-03-21 23:40:16 +01:00
parent cee8ea7ecb
commit e379043ed2
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -10,14 +10,15 @@
<a href="https://starter.keycloakify.dev/storybook">Keycloak theme Storybook</a> <a href="https://starter.keycloakify.dev/storybook">Keycloak theme Storybook</a>
</p> </p>
# Introduction # Introduction
This repo constitutes an easily reusable setup for a standalone Keycloak theme project OR for a SPA React App that generates a This repo constitutes an easily reusable setup for a standalone Keycloak theme project OR for a SPA React App that generates a
Keycloak theme that goes along with it. Keycloak theme that goes along with it.
If you are only looking to create a theme (and not a theme + an App) there are a lot of things that you can remove from this starter: [Please read this section of the README](#standalone-keycloak-theme). If you are only looking to create a theme (and not a theme + an App) there are a lot of things that you can remove from this starter: [Please read this section of the README](#standalone-keycloak-theme).
❗️ WARNING ❗️: Don't waste time trying to setup Keycloakify in a [Vite](https://vitejs.dev/) project.
Currently Keycloakify only works with Webpack. If you want Vite support [join the conversation](https://github.com/InseeFrLab/keycloakify/issues/271#issuecomment-1478242786).
# Quick start # Quick start
```bash ```bash

3
src/keycloak-theme/account/KcApp.tsx
View File

@ -1,6 +1,6 @@
import "./KcApp.css"; import "./KcApp.css";
import { lazy, Suspense } from "react"; import { lazy, Suspense } from "react";
import Fallback, { type PageProps } from "keycloakify/account"; import type { PageProps } from "keycloakify/account";
import type { KcContext } from "./kcContext"; import type { KcContext } from "./kcContext";
import { useI18n } from "./i18n"; import { useI18n } from "./i18n";
@ -10,6 +10,7 @@ const DefaultTemplate = lazy(() => import("keycloakify/account/Template"));
const Password = lazy(() => import("./pages/Password")); const Password = lazy(() => import("./pages/Password"));
const MyExtraPage1 = lazy(() => import("./pages/MyExtraPage1")); const MyExtraPage1 = lazy(() => import("./pages/MyExtraPage1"));
const MyExtraPage2 = lazy(() => import("./pages/MyExtraPage2")); const MyExtraPage2 = lazy(() => import("./pages/MyExtraPage2"));
const Fallback = lazy(()=> import("keycloakify/account"));
const classes: PageProps<any, any>["classes"] = { const classes: PageProps<any, any>["classes"] = {
"kcBodyClass": "my-root-class" "kcBodyClass": "my-root-class"