@react-fabric/core 1.0.0-beta.8 → 1.0.1

package/src/hooks/useResizeObserver.ts

@@ -1,55 +1,80 @@
-/*
+/**
  * React Fabric
- * @version: 1.0.0
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
  *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  *
- * The MIT License (MIT)
- * Copyright (c) 2024 Adarsh Pastakia
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
  *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
- * and associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial
- * portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
- * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
- * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
-import { useEffect, useRef, useTransition, type RefObject } from "react";
+import { useRef, useTransition } from "react";
 import ResizeObserver from "resize-observer-polyfill";
-import { type SizeObject } from "../types";
-import { useDebounce } from "./useDebounce";
+import type { SizeObject } from "../types";
+import { useEffectDebugger } from "./useEffectDebugger";
 
-export const useResizeObserver = <T extends HTMLElement = HTMLDivElement>(
+/**
+ * Custom hook to observe size changes of an element using ResizeObserver.
+ * It returns a ref that can be attached to the element you want to observe.
+ * The hook will call the provided `onResize` callback with the new size of the element
+ * whenever it changes.
+ * * This is useful for responsive designs where you need to adjust the layout or styles
+ * based on the size of an element.
+ *
+ * @param {Function} onResize Callback function that receives the new size of the element.
+ * @returns A ref object to be attached to the element you want to observe.
+ *
+ * @example
+ * ```jsx
+ * const ref = useResizeObserver((size) => {
+ *   console.log("Element resized:", size);
+ * });
+ * <div ref={ref}>Resize me!</div>
+ * ```
+ */
+export function useResizeObserver<T extends HTMLElement = HTMLDivElement>(
   onResize?: (size: SizeObject) => void,
-): RefObject<T> => {
+): React.RefObject<T | null> {
   const ref = useRef<T>(null);
   const [, startTransition] = useTransition();
 
-  const callbackResize = useDebounce(() => {
+  const callbackResize = () => {
     startTransition(() => {
       if (onResize && ref.current != null) {
         const { offsetWidth: width, offsetHeight: height } = ref.current;
         onResize?.({ width, height });
       }
     });
-  }, [onResize]);
+  };
 
-  useEffect(() => {
-    if (ref.current != null) {
-      const ob = new ResizeObserver(callbackResize);
-      ob.observe(ref.current);
-      return () => {
-        ob.disconnect();
-      };
-    }
-  }, [callbackResize, ref]);
+  useEffectDebugger(
+    () => {
+      if (ref.current != null) {
+        const ob = new ResizeObserver(callbackResize);
+        ob.observe(ref.current);
+        return () => {
+          ob.disconnect();
+        };
+      }
+    },
+    [],
+    "useResizeObserver",
+  );
 
   return ref;
-};
+}

package/src/hooks/useStorage.ts

@@ -1,46 +1,43 @@
-/*
+/**
  * React Fabric
- * @version: 1.0.0
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
  *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  *
- * The MIT License (MIT)
- * Copyright (c) 2024 Adarsh Pastakia
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
  *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
- * and associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial
- * portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
- * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
- * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
-import { useState } from "react";
+import { useEffectEvent, useState } from "react";
 import { useClientService } from "./useClientService";
 import { useEffectDebugger } from "./useEffectDebugger";
 
-export const useLocalStorage = <T>(
-  key: string,
-  defaultValue: T,
-): [T, (value: T) => void] => {
+/**
+ * Hook to manage a value in localStorage with a default fallback. Returns [value, setValue].
+ */
+export function useLocalStorage<T>(key: string, defaultValue: T): [T, (value: T) => void] {
   const service = useClientService(localStorage);
-  const [value, setValue] = useState<T>(
-    JSON.parse(service?.getItem(key) ?? "null") ?? defaultValue,
-  );
+  const [value, setValue] = useState<T>(() => (JSON.parse(service?.getItem(key) ?? "null") as T) ?? defaultValue);
 
-  useEffectDebugger(
-    () => {
-      setValue(JSON.parse(service?.getItem(key) ?? "null") ?? defaultValue);
-    },
-    [],
-    "useStorage initial value",
-  );
+  const init = useEffectEvent(() => {
+    setValue((JSON.parse(service?.getItem(key) ?? "null") as T) ?? defaultValue);
+  });
+  useEffectDebugger(init, [], "useStorage initial value");
 
   const changeValue = (value: T) => {
     service?.setItem(key, JSON.stringify(value));
@@ -48,24 +45,19 @@ export const useLocalStorage = <T>(
   };
 
   return [value, changeValue];
-};
+}
 
-export const useSessionStorage = <T>(
-  key: string,
-  defaultValue: T,
-): [T, (value: T) => void] => {
+/**
+ * Hook to manage a value in sessionStorage with a default fallback. Returns [value, setValue].
+ */
+export function useSessionStorage<T>(key: string, defaultValue: T): [T, (value: T) => void] {
   const service = useClientService(sessionStorage);
-  const [value, setValue] = useState<T>(
-    JSON.parse(service?.getItem(key) ?? "null") ?? defaultValue,
-  );
+  const [value, setValue] = useState<T>(() => (JSON.parse(service?.getItem(key) ?? "null") as T) ?? defaultValue);
 
-  useEffectDebugger(
-    () => {
-      setValue(JSON.parse(service?.getItem(key) ?? "null") ?? defaultValue);
-    },
-    [],
-    "useStorage initial value",
-  );
+  const init = useEffectEvent(() => {
+    setValue((JSON.parse(service?.getItem(key) ?? "null") as T) ?? defaultValue);
+  });
+  useEffectDebugger(init, [], "useStorage initial value");
 
   const changeValue = (value: T) => {
     service?.setItem(key, JSON.stringify(value));
@@ -73,4 +65,4 @@ export const useSessionStorage = <T>(
   };
 
   return [value, changeValue];
-};
+}

package/src/i18n/index.ts

@@ -1,40 +1,39 @@
-/*
+/**
  * React Fabric
- * @version: 1.0.0
- *
- *
- * The MIT License (MIT)
- * Copyright (c) 2024 Adarsh Pastakia
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
  *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
- * and associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  *
- * The above copyright notice and this permission notice shall be included in all copies or substantial
- * portions of the Software.
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
- * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
- * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 /* istanbul ignore file */
 
 import i18n from "i18next";
-import ar from "./ar.json";
-import en from "./en.json";
+import ar from "./ar/core.json";
+import en from "./en/core.json";
 
 /**
  * add language bundles using bundle keys as namespaces
- * @param key
- * @param languageBundles: {en: {}, ar: {}}
+ * @param {string} key
+ * @param {Record<string, Record<string, string>>} languageBundles: {en: {}, ar: {}}
  */
-export const addTranslationBundle = (
-  key: string,
-  languageBundles: KeyValue,
-) => {
+export const addTranslationBundle = (key: string, languageBundles: KeyValue<KeyValue>) => {
   const callback = () => {
     Object.keys(languageBundles).forEach((lang) => {
       const bundle = languageBundles[lang];

package/src/index.ts

@@ -1,51 +1,122 @@
-/*
+/**
  * React Fabric
- * @version: 1.0.0
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
  *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  *
- * The MIT License (MIT)
- * Copyright (c) 2024 Adarsh Pastakia
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
  *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
- * and associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial
- * portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
- * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
- * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
-export * from "./components";
-export * from "./core";
+/* istanbul ignore file */
+
+export const CORE_PACKAGE = "@react-fabric/core";
+export const CORE_VERSION = "1.0.1";
+
+export { useApplicationContext } from "./context/context";
+export { ApplicationProvider } from "./context/Global";
+
+export type { ModalProps } from "./types";
+
 export { addTranslationBundle } from "./i18n";
-export { Flyout, Modal, Tooltip } from "./overlays";
-export * from "./typography";
-
-export * from "./hooks/useClientService";
-export * from "./hooks/useDebounce";
-export * from "./hooks/useEffectDebugger";
-export * from "./hooks/useIsDark";
-export * from "./hooks/useIsRtl";
-export * from "./hooks/useNavigator";
-export * from "./hooks/useOverlayService";
-export * from "./hooks/useResize";
-export * from "./hooks/useResizeObserver";
-export * from "./hooks/useStorage";
-
-export { HotKey } from "./hotkeys/HotKey";
-export { HotKeyLabel } from "./hotkeys/HotKeyLabel";
-
-export { CoreIcons } from "./types/icons";
-
-export {
-  ApplicationProvider,
-  useApplicationContext,
-  useGlobals,
-  useNotificationService,
-} from "./context/Global";
+
+export { cloneChildren, getBadgeProps, getColor, getIconProps } from "./utils";
+
+// HOOKS
+export { useClientService } from "./hooks/useClientService";
+export { useContextMenu } from "./hooks/useContextMenu";
+export { useControlledValue } from "./hooks/useControlledValue";
+export { useDebounce } from "./hooks/useDebounce";
+export { useEffectDebugger, useLayoutEffectDebugger, useMemoDebugger } from "./hooks/useEffectDebugger";
+export { useIsDark } from "./hooks/useIsDark";
+export { useIsRtl } from "./hooks/useIsRtl";
+export { useNavigator } from "./hooks/useNavigator";
+export { useNotificationService } from "./hooks/useNotificationService";
+export { useOverlayService } from "./hooks/useOverlayService";
+export { usePropState, usePropWatcher } from "./hooks/usePropState";
+export { usePropToggle } from "./hooks/usePropToggle";
+export { useResize } from "./hooks/useResize";
+export { useResizeObserver } from "./hooks/useResizeObserver";
+export { useLocalStorage, useSessionStorage } from "./hooks/useStorage";
+
+// CORE
+export { AreaToggle } from "./core/areaToggle/AreaToggle";
+export { Aside } from "./core/aside/Aside";
+export { ErrorBoundary } from "./core/boundary/ErrorBoundary";
+export { Content } from "./core/content/Content";
+export { Footer, Header } from "./core/headfoot/HeadFoot";
+export { Layout } from "./core/layout/Layout";
+export { Col, Container, Row } from "./core/responsive/Responsive";
+export { ThemeProvider } from "./core/theme/ThemeProvider";
+export { Viewport } from "./core/viewport/Viewport";
+
+// TYPOGRAPHY
+export { Abbr } from "./typography/Abbr";
+export { Anchor } from "./typography/Anchor";
+export { Copy } from "./typography/Copy";
+export { Kbd } from "./typography/Kbd";
+export { Mark } from "./typography/Mark";
+export { Text } from "./typography/Text";
+export { Title } from "./typography/Title";
+
+// COMPONENTS
+export { ActionLabel } from "./components/actionLabel/ActionLabel";
+export { AnimationIndicator } from "./components/animations/Indicator";
+export { AnimationLoader } from "./components/animations/Loader";
+export { LoadingBars } from "./components/animations/LoadingBars";
+export { LoadingLine } from "./components/animations/LoadingLine";
+export { LoadingSpinner } from "./components/animations/LoadingSpinner";
+export { Skeleton } from "./components/animations/Skeleton";
+export { Avatar } from "./components/avatar/Avatar";
+export { AvatarGroup } from "./components/avatar/AvatarGroup";
+export { Badge } from "./components/badge/Badge";
+export { Button } from "./components/button/Button";
+export { ButtonGroup } from "./components/button/ButtonGroup";
+export { ConfirmButton } from "./components/button/ConfirmButton";
+export { ToggleButtonGroup } from "./components/button/ToggleButtonGroup";
+export { Callout } from "./components/callout/Callout";
+export { Card } from "./components/card/Card";
+export { CardCover } from "./components/card/CardCover";
+export { FlipContent, type FlipContentRef } from "./components/card/FlipContent";
+export { Chip } from "./components/chip/Chip";
+export { Collapsable } from "./components/collapsable/Collapsable";
+export { Divider } from "./components/divider/Divider";
+export { Dropdown, DropdownDismiss } from "./components/dropdown/Dropdown";
+export { DropdownTool } from "./components/dropdown/DropdownTool";
+export { StyleEffect } from "./components/effect/StyleEffect";
+export { EmptyContent } from "./components/empty/EmptyContent";
+export { Flyout } from "./components/flyout/Flyout";
+export { HotKey } from "./components/hotkey/HotKey";
+export { Icon } from "./components/icon/Icon";
+export { Image, Video } from "./components/media/Media";
+export { ContextMenu } from "./components/menu/ContextMenu";
+export { Menu } from "./components/menu/Menu";
+export { MenuItem } from "./components/menu/MenuItem";
+export { Meter } from "./components/meter/Meter";
+export { Modal } from "./components/modal/Modal";
+export { Navigator } from "./components/navigator/Navigator";
+export { Panel } from "./components/panel/Panel";
+export { PanelGroup } from "./components/panel/PanelGroup";
+export { PanelStack } from "./components/panel/PanelStack";
+export { Pillbox } from "./components/pillbox/Pillbox";
+export { ProgressBar } from "./components/progress/ProgressBar";
+export { ProgressCircle } from "./components/progress/ProgressCircle";
+export { Tab } from "./components/tabpanel/Tab";
+export { TabPanel } from "./components/tabpanel/TabPanel";
+export { Titlebar } from "./components/titlebar/Titlebar";
+export { Tooltip } from "./components/tooltip/Tooltip";

package/src/types/colors.ts

@@ -0,0 +1,49 @@
+/**
+ * React Fabric
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+export type ColorBase = "primary" | "secondary" | "info" | "danger" | "success" | "warning";
+
+export type ColorTints = "tint" | "silver" | "steel" | "olive" | "blush" | "slate";
+
+export type ColorPalette =
+  | "scarlet"
+  | "pumpkin"
+  | "marigold"
+  | "amber"
+  | "jade"
+  | "avocado"
+  | "teal"
+  | "azure"
+  | "denim"
+  | "iris"
+  | "lilac"
+  | "orchid"
+  | "coral"
+  | "wood"
+  | "terracotta";
+
+export type ColorUnion = ColorBase | ColorTints | ColorPalette;
+
+export type CustomColors<T = ColorUnion> = T | (string & {});

package/src/types/global.d.ts

@@ -1,27 +1,30 @@
-/*
+/**
  * React Fabric
- * @version: 1.0.0
+ * @version 1.0.0
+ * @license MIT
+ * @copyright 2024 Adarsh Pastakia
  *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  *
- * The MIT License (MIT)
- * Copyright (c) 2024 Adarsh Pastakia
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
  *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
- * and associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial
- * portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
- * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
- * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
 declare type Key = string | number | symbol;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any @typescript-eslint/no-unsafe-assignment
 declare type AnyObject = any;
 declare type KeyValue<T = AnyObject> = Record<Key, T>;
 
@@ -45,6 +48,18 @@ declare module "*.png" {
   const content: any;
   export default content;
 }
+declare module "*.jpg" {
+  const content: any;
+  export default content;
+}
+declare module "*.jpeg" {
+  const content: any;
+  export default content;
+}
+declare module "*.webp" {
+  const content: any;
+  export default content;
+}
 declare module "*.svg" {
   const content: any;
   export default content;
@@ -61,6 +76,14 @@ declare module "*.css" {
   const content: any;
   export default content;
 }
+declare module "*.txt" {
+  const content: any;
+  export default content;
+}
+declare module "*.vtt" {
+  const content: any;
+  export default content;
+}
 
 interface HDate extends Date {
   toGregorian: () => Date;