@selfdecode/sd-component-library 2.46.12 → 2.46.14

package/lib/components/utils/anchor/interfaces.d.ts

@@ -1,38 +1,38 @@
-/// <reference types="react" />
-import { BoxProps } from "rebass";
-/**
- * Type for the refsMap to be stored in reference manager.
- */
-export declare type refsMap = {
-    [key: string]: React.MutableRefObject<HTMLElement | undefined>;
-};
-/**
- * Interface for Anchor props.
- */
-export interface AnchorProps extends BoxProps {
-    /**
-     * Hash id of the component.
-     */
-    id: string;
-    /**
-     * This function (if present) will be called when the child component
-     * is scrolled to top of the screen.
-     */
-    onScrolledToTop?: () => void;
-    /**
-     * Scroll offset adjust to take fixed navbars into account when checking
-     * if element has reached to the top of window.
-     *
-     * e.g. when set to 100, the callback will be called when window offsetY PLUS adjustment
-     * is equal to or greater than the offset of element.
-     */
-    offsetYAdjustment?: number;
-    /**
-     * Children of Anchor component.
-     */
-    children: React.ReactNode;
-    /**
-     * Scroll behavior for the anchor.
-     */
-    scrollBehavior?: "auto" | "smooth";
-}
+/// <reference types="react" />
+import { BoxProps } from "rebass";
+/**
+ * Type for the refsMap to be stored in reference manager.
+ */
+export declare type refsMap = {
+    [key: string]: React.MutableRefObject<HTMLElement | undefined>;
+};
+/**
+ * Interface for Anchor props.
+ */
+export interface AnchorProps extends BoxProps {
+    /**
+     * Hash id of the component.
+     */
+    id: string;
+    /**
+     * This function (if present) will be called when the child component
+     * is scrolled to top of the screen.
+     */
+    onScrolledToTop?: () => void;
+    /**
+     * Scroll offset adjust to take fixed navbars into account when checking
+     * if element has reached to the top of window.
+     *
+     * e.g. when set to 100, the callback will be called when window offsetY PLUS adjustment
+     * is equal to or greater than the offset of element.
+     */
+    offsetYAdjustment?: number;
+    /**
+     * Children of Anchor component.
+     */
+    children: React.ReactNode;
+    /**
+     * Scroll behavior for the anchor.
+     */
+    scrollBehavior?: "auto" | "smooth";
+}

package/lib/components/utils/anchor/refs-manager.d.ts

@@ -1,35 +1,35 @@
-import React from "react";
-import { refsMap } from "./interfaces";
-/**
- * Refs Manager class to keep record of registered refs on the page.
- */
-declare class RefsManager {
-    refRegistry: refsMap;
-    /**
-     * Check if ref is registered for a component with provided ID.
-     * @param id ID for the component.
-     */
-    doesRefExist(id: string): boolean;
-    /**
-     * Register a ref.
-     *
-     * @param id ID for the component.
-     * @param ref React Ref object for the component. Used for scrolling.
-     */
-    addRef(id: string, ref: React.MutableRefObject<HTMLDivElement | undefined>): void;
-    /**
-     * Remove a ref from registry.
-     *
-     * @param id ID for the component.
-     */
-    removeRef(id: string): void;
-    /**
-     * Scroll the component with provided ID into the view.
-     *
-     * @param id ID for the component.
-     * @param behavior Scroll behavior.
-     */
-    scrollToRef(id: string, behavior?: "smooth" | "auto"): void;
-}
-export declare const refsManager: RefsManager;
-export {};
+import React from "react";
+import { refsMap } from "./interfaces";
+/**
+ * Refs Manager class to keep record of registered refs on the page.
+ */
+declare class RefsManager {
+    refRegistry: refsMap;
+    /**
+     * Check if ref is registered for a component with provided ID.
+     * @param id ID for the component.
+     */
+    doesRefExist(id: string): boolean;
+    /**
+     * Register a ref.
+     *
+     * @param id ID for the component.
+     * @param ref React Ref object for the component. Used for scrolling.
+     */
+    addRef(id: string, ref: React.MutableRefObject<HTMLDivElement | undefined>): void;
+    /**
+     * Remove a ref from registry.
+     *
+     * @param id ID for the component.
+     */
+    removeRef(id: string): void;
+    /**
+     * Scroll the component with provided ID into the view.
+     *
+     * @param id ID for the component.
+     * @param behavior Scroll behavior.
+     */
+    scrollToRef(id: string, behavior?: "smooth" | "auto"): void;
+}
+export declare const refsManager: RefsManager;
+export {};

package/lib/components/utils/page-tracker/index.d.ts

@@ -1,3 +1,3 @@
-import { PageTrackerProps as Props } from "./interfaces";
-export { PageTracker } from "./page-tracker";
-export declare type PageTrackerProps = Props;
+import { PageTrackerProps as Props } from "./interfaces";
+export { PageTracker } from "./page-tracker";
+export declare type PageTrackerProps = Props;

package/lib/components/utils/page-tracker/interfaces.d.ts

@@ -1,7 +1,7 @@
-import { Location } from "history";
-export interface PageTrackerProps {
-    /**
-     * The function to call on page change
-     */
-    callback: (location: Location) => void;
-}
+import { Location } from "history";
+export interface PageTrackerProps {
+    /**
+     * The function to call on page change
+     */
+    callback: (location: Location) => void;
+}

package/lib/components/utils/page-tracker/page-tracker.d.ts

@@ -1,2 +1,2 @@
-import { PageTrackerProps } from "./interfaces";
-export declare const PageTracker: (props: PageTrackerProps) => null;
+import { PageTrackerProps } from "./interfaces";
+export declare const PageTracker: (props: PageTrackerProps) => null;

package/lib/components/utils/scroll-to-top/index.d.ts

@@ -1 +1 @@
-export { ScrollToTop } from "./scroll-to-top";
+export { ScrollToTop } from "./scroll-to-top";

package/lib/components/utils/scroll-to-top/interfaces.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="react" />
-export interface ScrollToTopProps {
-    /**
-     * The text of the badge.
-     */
-    children?: React.ReactNode;
-}
+/// <reference types="react" />
+export interface ScrollToTopProps {
+    /**
+     * The text of the badge.
+     */
+    children?: React.ReactNode;
+}

package/lib/components/utils/scroll-to-top/scroll-to-top.d.ts

@@ -1,2 +1,3 @@
-import { ScrollToTopProps } from "./interfaces";
-export declare const ScrollToTop: (props: ScrollToTopProps) => JSX.Element;
+/// <reference types="react" />
+import { ScrollToTopProps } from "./interfaces";
+export declare const ScrollToTop: (props: ScrollToTopProps) => JSX.Element;

package/lib/components/utils/scroll-to-top-on-mount/index.d.ts

@@ -1 +1 @@
-export { ScrollToTopOnMount } from "./scroll-to-top-on-mount";
+export { ScrollToTopOnMount } from "./scroll-to-top-on-mount";

package/lib/components/utils/scroll-to-top-on-mount/scroll-to-top-on-mount.d.ts

@@ -1 +1,2 @@
-export declare const ScrollToTopOnMount: () => JSX.Element;
+/// <reference types="react" />
+export declare const ScrollToTopOnMount: () => JSX.Element;

package/lib/components/wrapper/functions.d.ts

@@ -1,9 +1,9 @@
-import { Theme } from "./interfaces";
-/**
- *
- * @param baseTheme - our library's base theme with all the variants that we have established.
- * @param clientsTheme - the client's theme, which holds any other theming variants the client has ceated in their own project.
- *
- * @returns - a merged theme object, containing both our styling variants and the client's.
- */
-export declare const mergeThemes: (baseTheme: Theme, clientsTheme?: Theme) => Theme;
+import { Theme } from "./interfaces";
+/**
+ *
+ * @param baseTheme - our library's base theme with all the variants that we have established.
+ * @param clientsTheme - the client's theme, which holds any other theming variants the client has ceated in their own project.
+ *
+ * @returns - a merged theme object, containing both our styling variants and the client's.
+ */
+export declare const mergeThemes: (baseTheme: Theme, clientsTheme?: Theme) => Theme;

package/lib/components/wrapper/index.d.ts

@@ -1,2 +1,2 @@
-import { Wrapper } from "./wrapper";
-export default Wrapper;
+import { Wrapper } from "./wrapper";
+export default Wrapper;

package/lib/components/wrapper/interfaces.d.ts

@@ -1,17 +1,17 @@
-/// <reference types="react" />
-export interface KeyValue {
-    [key: string]: number | string | number[] | string[] | KeyValue;
-}
-export interface Theme {
-    [key: string]: KeyValue | number[] | string[];
-}
-export interface WrapperProps {
-    /**
-     * The custom theme we expect to receive from our client, containing their own theme definitions
-     */
-    clientsTheme: Theme;
-    /**
-     * The children that will be contained within our wrapper
-     */
-    children?: React.ReactNode;
-}
+/// <reference types="react" />
+export interface KeyValue {
+    [key: string]: number | string | number[] | string[] | KeyValue;
+}
+export interface Theme {
+    [key: string]: KeyValue | number[] | string[];
+}
+export interface WrapperProps {
+    /**
+     * The custom theme we expect to receive from our client, containing their own theme definitions
+     */
+    clientsTheme: Theme;
+    /**
+     * The children that will be contained within our wrapper
+     */
+    children?: React.ReactNode;
+}

package/lib/components/wrapper/wrapper.d.ts

@@ -1,6 +1,6 @@
-import React from "react";
-import { WrapperProps } from "./interfaces";
-/**
- * Wrapper for the whole react application.
- */
-export declare const Wrapper: React.FC<WrapperProps>;
+import React from "react";
+import { WrapperProps } from "./interfaces";
+/**
+ * Wrapper for the whole react application.
+ */
+export declare const Wrapper: React.FC<WrapperProps>;

package/lib/core/custom-hooks.d.ts

@@ -1,83 +1,75 @@
-import { Dispatch, RefObject, SetStateAction } from "react";
-/**
- * A custom useState hook function, that automatically
- * updates the state whenever the dependency param changes
- *
- * Note that, for maximum performance, dependency should be
- * the result of calling useMemo or useCallback: otherwise,
- * the state would be reseted on each render of the component
- * @param dependency
- */
-export declare const useDependantState: <D>(dependency: D) => [D, Dispatch<SetStateAction<D>>];
-/**
- * The useCarousel hook
- */
-export declare const useCarousel: (itemWidth: number, amountOfItems: number, spacing: number) => {
-    ref: any;
-    leftIsDisabled: boolean;
-    rightIsDisabled: boolean;
-    swipe: (direction: 1 | -1) => void;
-};
-/**
- * Calculates height of specified element and carries out recalculation of height
- * on window resize with the delay of 0.2s.
- * @param refElement ref to an element height of which is going to be measured.
- * @returns current content state and height measuring status
- */
-export declare const useResize: (refElement: RefObject<HTMLDivElement | null>, contentHash?: string | undefined) => {
-    contentHeight: number;
-    isHeightMeasured: boolean;
-};
-/**
- * Executes handler function each time user clicks outside of ref object.
- */
-export declare function useOnClickOutside(ref: RefObject<HTMLElement>, handler: (event: MouseEvent | TouchEvent) => void): void;
-export declare function useMediaQuery(query: string): boolean;
-/**
- * Provides set of flags indicating what is the current screen size.
- */
-export declare function useBreakPoints(): {
-    isMobile: boolean;
-    isLargeMobile: boolean;
-    isTab: boolean;
-    isDesktop: boolean;
-    isWiderThanMobile: boolean;
-    isWiderThanLargeMobile: boolean;
-};
-/**
- * Provided intersection observer for the specified elements.
- *
- * @param rootRef Ref for the root element.
- * @param rootMargin Margin for the root element area.
- * @param callback Function to process intersection changes.
- */
-export declare function useIntersectionObserver(rootRef: RefObject<HTMLElement>, rootMargin: string, callback: IntersectionObserverCallback): IntersectionObserver | undefined;
-export declare function useHover(onHover?: (newState: boolean) => void): {
-    isHover: boolean;
-    hoverCallbacks: {
-        onMouseEnter: () => void;
-        onMouseLeave: () => void;
-    };
-};
-export declare function useContentSize<T extends Element = HTMLElement>(settings?: {
-    listenForResize?: boolean;
-    debounceDelay?: number;
-    checkEachRender?: boolean;
-}): {
-    ref: RefObject<T>;
-    contentWidth: number;
-    contentHeight: number;
-};
-export declare function useElementCoordinates<T extends Element = HTMLElement>(): {
-    ref: RefObject<T>;
-    x: number;
-    y: number;
-};
-export declare function useBoundingClientRect<T extends Element = HTMLElement>(settings?: {
-    listenForResize?: boolean;
-    debounceDelay?: number;
-    checkEachRender?: boolean;
-}): {
-    ref: RefObject<T>;
-    rect: DOMRect | undefined;
-};
+import { Dispatch, RefObject, SetStateAction } from "react";
+/**
+ * A custom useState hook function, that automatically
+ * updates the state whenever the dependency param changes
+ *
+ * Note that, for maximum performance, dependency should be
+ * the result of calling useMemo or useCallback: otherwise,
+ * the state would be reseted on each render of the component
+ * @param dependency
+ */
+export declare const useDependantState: <D>(dependency: D) => [D, Dispatch<SetStateAction<D>>];
+/**
+ * The useCarousel hook
+ */
+export declare const useCarousel: (itemWidth: number, amountOfItems: number, spacing: number) => {
+    ref: any;
+    leftIsDisabled: boolean;
+    rightIsDisabled: boolean;
+    swipe: (direction: 1 | -1) => void;
+};
+/**
+ * Calculates height of specified element and carries out recalculation of height
+ * on window resize with the delay of 0.2s.
+ * @param refElement ref to an element height of which is going to be measured.
+ * @returns current content state and height measuring status
+ */
+export declare const useResize: (refElement: RefObject<HTMLDivElement | null>, contentHash?: string | undefined) => {
+    contentHeight: number;
+    isHeightMeasured: boolean;
+};
+/**
+ * Executes handler function each time user clicks outside of ref object.
+ */
+export declare function useOnClickOutside(ref: RefObject<HTMLElement>, handler: (event: MouseEvent | TouchEvent) => void): void;
+export declare function useMediaQuery(query: string): boolean;
+/**
+ * Provides set of flags indicating what is the current screen size.
+ */
+export declare function useBreakPoints(): {
+    isMobile: boolean;
+    isLargeMobile: boolean;
+    isTab: boolean;
+    isDesktop: boolean;
+    isWiderThanMobile: boolean;
+    isWiderThanLargeMobile: boolean;
+};
+/**
+ * Provided intersection observer for the specified elements.
+ *
+ * @param rootRef Ref for the root element.
+ * @param rootMargin Margin for the root element area.
+ * @param callback Function to process intersection changes.
+ */
+export declare function useIntersectionObserver(rootRef: RefObject<HTMLElement>, rootMargin: string, callback: IntersectionObserverCallback): IntersectionObserver | undefined;
+export declare function useHover(onHover?: (newState: boolean) => void): {
+    isHover: boolean;
+    hoverCallbacks: {
+        onMouseEnter: () => void;
+        onMouseLeave: () => void;
+    };
+};
+export declare function useContentSize<T extends Element = HTMLElement>(settings?: {
+    listenForResize?: boolean;
+    debounceDelay?: number;
+    checkEachRender?: boolean;
+}): {
+    ref: RefObject<T>;
+    contentWidth: number;
+    contentHeight: number;
+};
+export declare function useElementCoordinates<T extends Element = HTMLElement>(): {
+    ref: RefObject<T>;
+    x: number;
+    y: number;
+};