From 9fc3998cf7e712649b240d181b3b70b929a3479b Mon Sep 17 00:00:00 2001 From: garronej Date: Mon, 17 Apr 2023 01:41:30 +0200 Subject: [PATCH] Avoid deprecating getKcContext #274 --- README.md | 4 ++++ src/account/kcContext/getKcContext.ts | 4 +++- src/login/kcContext/getKcContext.ts | 4 +++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e6e57594..335e2432 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d ## Changelog highlights +## 7.7 + +- Better storybook support, see [the starter project](https://github.com/keycloakify/keycloakify-starter). + ## 7.0 🍾 - Account theme support 🚀 diff --git a/src/account/kcContext/getKcContext.ts b/src/account/kcContext/getKcContext.ts index 00d0717d..e64429ab 100644 --- a/src/account/kcContext/getKcContext.ts +++ b/src/account/kcContext/getKcContext.ts @@ -2,7 +2,9 @@ import type { DeepPartial } from "keycloakify/tools/DeepPartial"; import type { ExtendKcContext } from "./getKcContextFromWindow"; import { createGetKcContext } from "./createGetKcContext"; -/** @deprecated: Use createGetKcContext instead */ +/** NOTE: We now recommend using createGetKcContext instead of this function to make storybook integration easier + * See: https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/account/kcContext.ts + */ export function getKcContext(params?: { mockPageId?: ExtendKcContext["pageId"]; mockData?: readonly DeepPartial>[]; diff --git a/src/login/kcContext/getKcContext.ts b/src/login/kcContext/getKcContext.ts index 3058721c..5d22035f 100644 --- a/src/login/kcContext/getKcContext.ts +++ b/src/login/kcContext/getKcContext.ts @@ -2,7 +2,9 @@ import type { DeepPartial } from "keycloakify/tools/DeepPartial"; import type { ExtendKcContext } from "./getKcContextFromWindow"; import { createGetKcContext } from "./createGetKcContext"; -/** @deprecated: Use createGetKcContext instead */ +/** NOTE: We now recommend using createGetKcContext instead of this function to make storybook integration easier + * See: https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/account/kcContext.ts + */ export function getKcContext(params?: { mockPageId?: ExtendKcContext["pageId"]; mockData?: readonly DeepPartial>[];