Better naming convention for i18n API

This commit is contained in:
garronej
2023-03-19 13:54:39 +01:00
parent ad7bcf4669
commit 0608adde89
5 changed files with 12 additions and 5 deletions

View File

@ -69,7 +69,7 @@ export type GenericI18n<MessageKey extends string> = {
export type I18n = GenericI18n<MessageKeyBase>; export type I18n = GenericI18n<MessageKeyBase>;
export function useI18n<ExtraMessageKey extends string = never>(params: { export function useGenericI18n<ExtraMessageKey extends string = never>(params: {
kcContext: KcContextLike; kcContext: KcContextLike;
extraMessages: { [languageTag: string]: { [key in ExtraMessageKey]: string } }; extraMessages: { [languageTag: string]: { [key in ExtraMessageKey]: string } };
}): GenericI18n<MessageKeyBase | ExtraMessageKey> | null { }): GenericI18n<MessageKeyBase | ExtraMessageKey> | null {

View File

@ -1,3 +1,10 @@
import Fallback from "./Fallback"; import Fallback from "keycloakify/Fallback";
export default Fallback; export default Fallback;
export { createKeycloakAdapter } from "keycloakify/lib/keycloakJsAdapter";
export { useDownloadTerms } from "keycloakify/lib/useDownloadTerms";
export { getKcContext } from "keycloakify/kcContext/getKcContext";
export { useGenericI18n } from "keycloakify/i18n";
export type { PageProps } from "keycloakify/pages/PageProps";

View File

@ -43,7 +43,7 @@ export declare namespace keycloak_js {
*/ */
export function createKeycloakAdapter(params: { export function createKeycloakAdapter(params: {
keycloakInstance: keycloak_js.KeycloakInstance; keycloakInstance: keycloak_js.KeycloakInstance;
transformUrlBeforeRedirect(url: string): string; transformUrlBeforeRedirect: (url: string) => string;
getRedirectMethod?: () => "overwrite location.href" | "location.replace"; getRedirectMethod?: () => "overwrite location.href" | "location.replace";
}): keycloak_js.KeycloakAdapter { }): keycloak_js.KeycloakAdapter {
const { keycloakInstance, transformUrlBeforeRedirect, getRedirectMethod = () => "overwrite location.href" } = params; const { keycloakInstance, transformUrlBeforeRedirect, getRedirectMethod = () => "overwrite location.href" } = params;

View File

@ -1,6 +1,6 @@
import { useState, type FormEventHandler } from "react"; import { useState, type FormEventHandler } from "react";
import { clsx } from "keycloakify/tools/clsx"; import { clsx } from "keycloakify/tools/clsx";
import { useConstCallback } from "../tools/useConstCallback"; import { useConstCallback } from "keycloakify/tools/useConstCallback";
import { type PageProps, defaultClasses } from "keycloakify/pages/PageProps"; import { type PageProps, defaultClasses } from "keycloakify/pages/PageProps";
import { useGetClassName } from "keycloakify/lib/useGetClassName"; import { useGetClassName } from "keycloakify/lib/useGetClassName";
import type { KcContext } from "../kcContext"; import type { KcContext } from "../kcContext";

View File

@ -1,6 +1,6 @@
import { clsx } from "keycloakify/tools/clsx"; import { clsx } from "keycloakify/tools/clsx";
import { useRerenderOnStateChange } from "evt/hooks"; import { useRerenderOnStateChange } from "evt/hooks";
import { Markdown } from "../tools/Markdown"; import { Markdown } from "keycloakify/tools/Markdown";
import { type PageProps, defaultClasses } from "keycloakify/pages/PageProps"; import { type PageProps, defaultClasses } from "keycloakify/pages/PageProps";
import { useGetClassName } from "keycloakify/lib/useGetClassName"; import { useGetClassName } from "keycloakify/lib/useGetClassName";
import { evtTermMarkdown } from "keycloakify/lib/useDownloadTerms"; import { evtTermMarkdown } from "keycloakify/lib/useDownloadTerms";