From 69755192ab55cafcc2b67cccaf6edec3d1c98c0d Mon Sep 17 00:00:00 2001 From: SutuSebastian Date: Sun, 5 Jan 2025 19:18:05 +0200 Subject: [PATCH] feat(types): enhance ThemingProps interface with additional theme management properties --- packages/ui/src/types/index.ts | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/packages/ui/src/types/index.ts b/packages/ui/src/types/index.ts index 280dbebd2..041368294 100644 --- a/packages/ui/src/types/index.ts +++ b/packages/ui/src/types/index.ts @@ -15,7 +15,29 @@ export type DeepPartialApplyTheme = DeepPartialOf; export type ApplyTheme = "merge" | "replace"; export interface ThemingProps { + /** + * Partial theme object to merge (or replace, see `applyTheme` prop) with default theme + * + * @link https://flowbite-react.com/docs/customize/theme + * @default undefined + */ theme?: DeepPartial; + /** + * Indicates which theme properties should be cleared + * + * `boolean` | partial `theme` structure of `boolean` + * + * @link https://flowbite-react.com/docs/customize/theme + * @default undefined + */ clearTheme?: DeepPartialBoolean; + /** + * Specifies how theme properties should be applied/merged + * + * `"merge"` | `"replace"` | partial `theme` structure of `"merge"` | `"replace"` + * + * @link https://flowbite-react.com/docs/customize/theme + * @default "merge" + */ applyTheme?: DeepPartialApplyTheme; }