@bspk/ui 1.3.6 → 1.3.8

package/src/hooks/useDebounceState.ts

@@ -5,7 +5,6 @@ import { useTimeout } from './useTimeout';
 /**
  * A hook that debounces a state update, ensuring that the function is not called again until a specified delay
  *
- * @param defaultValue The initial value of the state
  * @param delay [1000] The delay (in ms) for the state to update
  * @returns A tuple containing the current state and a debounced setter function that updates the state after the
  *   specified delay

package/src/hooks/useOutsideClick.ts

@@ -24,16 +24,12 @@ import { useEffect } from 'react';
  *     </>
  *     );
  *     }
- *
- * @param elements - The elements to check if the click occurred outside of.
- * @param callback - The callback to call when a click occurs outside of the ref.
- * @param disabled - Whether the hook should be disabled. Defaults to false.
  */
 export function useOutsideClick({
-    elements,
-    callback,
-    disabled,
-    handleTabs = false,
+    elements, // The elements to check if the click occurred outside of.
+    callback, // The callback to call when a click occurs outside of the ref.
+    disabled, // Whether the hook should be disabled. Defaults to false.
+    handleTabs = false, // Whether to handle tab key presses as outside clicks.
 }: {
     elements: (HTMLElement | null)[] | null;
     callback: (event?: KeyboardEvent | MouseEvent) => void;

package/src/hooks/useTimeout.ts

@@ -1,6 +1,6 @@
 import { useRef, useEffect, useMemo } from 'react';
 
-type TimeoutHook = {
+export type TimeoutHook = {
     clear: () => void;
     set: (callback: () => void, ms?: number) => void;
     ref: React.MutableRefObject<ReturnType<typeof setTimeout> | null>;

package/src/types/common.ts

@@ -32,7 +32,7 @@ export type ElementConstructorProps<
     O extends string = '',
 > = Omit<ComponentPropsWithoutRef<E>, O>;
 
-type CSSVariables = `--${string}`;
+export type CSSVariables = `--${string}`;
 
 export type CSSWithVariables = CSSProperties | (CSSProperties & { [key in CSSVariables]: unknown });
 
@@ -119,14 +119,12 @@ export type CommonPropsLibrary = {
     /**
      * The aria-label for the element.
      *
-     * @required
-     */
-    'aria-label'?: string;
-    /**
-     * Identifies the parent component. Helps with styling, debugging, and/or testing purposes.
+     * This is used to provide an accessible name for the element when a visible label is not present.
      *
-     * @utility
+     * Ensure this is provided when using the element in isolation to maintain accessibility.
      */
+    'aria-label'?: string;
+    /** Identifies the parent component. Helps with styling, debugging, and/or testing purposes. */
     owner?: string;
     /**
      * The ARIA role of the element.

package/src/utils/countryCodes.ts

@@ -4,7 +4,7 @@ import { CountryCode } from 'libphonenumber-js';
 
 export type SupportedCountryCode = keyof CountryCodeData;
 
-type CountryCodeData = Omit<
+export type CountryCodeData = Omit<
     Record<CountryCode, { name: string; flagIconName: IconName }>,
     | 'AC'
     | 'CI'

package/src/utils/createExampleChildElement.tsx

@@ -11,7 +11,7 @@ import { Switch } from '-/components/Switch';
 import { Tag } from '-/components/Tag';
 import { Txt } from '-/components/Txt';
 
-type ExampleChildElementProps = {
+export type ExampleChildElementProps = {
     exampleState: Record<string, any>;
     name: string;
     setState: DemoSetState;

package/src/utils/demo.ts

@@ -55,7 +55,7 @@ export type ComponentExampleRender<Props = Record<string, unknown>> = (
     params: ComponentExampleRenderProps<Props>,
 ) => React.ReactNode;
 
-type ComponentVariantOverride<Props> = {
+export type ComponentVariantOverride<Props> = {
     [K in keyof Props]?: Props[K] | { options: Props[K][] };
 };
 

package/dist/components/Breadcrumb/BreadcumbDropdown.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"BreadcumbDropdown.js","sourceRoot":"","sources":["../../../src/components/Breadcrumb/BreadcumbDropdown.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAA6B,MAAM,8BAA8B,CAAC;AAC/F,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AA4BxC,MAAM,UAAU,kBAAkB,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAA2B;IAC7F,MAAM,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC;IAE5B,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;IAEpD,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,kBAAkB,CAAC;QAClF,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC9B,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEtC,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,WAAW,CAAC;QAC7C,IAAI,EAAE,CAAC,IAAI;QACX,aAAa,EAAE,CAAC;QAChB,QAAQ,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,eAAe,CAAC;QACZ,QAAQ,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC;QACjD,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE;QAC3B,QAAQ,EAAE,CAAC,IAAI;KAClB,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,GAAG,EAAE;QACpB,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,QAAQ,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC;YAC5B,OAAO;QACX,CAAC;QACD,IAAI,eAAe;YAAE,cAAc,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,CAAC;IAClE,CAAC,CAAC;IAEF,OAAO,CACH,yBACI,KAAC,MAAM,6BACoB,IAAI,CAAC,CAAC,CAAC,eAAe,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,mBACvD,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,mBACzB,IAAI,mBACL,SAAS,eACZ,MAAM,EACjB,IAAI,EAAE,KAAC,YAAY,KAAG,EACtB,QAAQ,QACR,QAAQ,EAAE,QAAQ,CAAC,YAAY,EAC/B,KAAK,EAAE,aAAa,KAAK,CAAC,MAAM,QAAQ,EACxC,IAAI,EAAE,GAAG,IAAI,eAAe,EAC5B,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;oBACf,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC;oBACvB,IAAI,QAAQ,EAAE,CAAC;wBACX,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,IAAI,CAAC,CAAC;oBAC7C,CAAC;yBAAM,CAAC;wBACJ,kBAAkB,CAAC,IAAI,CAAC,CAAC;oBAC7B,CAAC;oBACD,KAAK,CAAC,cAAc,EAAE,CAAC;gBAC3B,CAAC,EACD,SAAS,EAAE,aAAa,CACpB;oBACI,GAAG,iBAAiB;oBACpB,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;wBACjB,IAAI,CAAC,IAAI;4BAAE,UAAU,EAAE,CAAC;wBACxB,iBAAiB,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC;oBACzC,CAAC;oBACD,KAAK,EAAE,UAAU;oBACjB,KAAK,EAAE,UAAU;oBACjB,MAAM,EAAE,SAAS;oBACjB,mBAAmB,EAAE,UAAU;iBAClC,EACD,EAAE,cAAc,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,CAClD,EACD,IAAI,EAAC,UAAU,EACf,IAAI,EAAC,OAAO,EACZ,OAAO,EAAC,UAAU,GACpB,EACD,IAAI,IAAI,CACL,KAAC,IAAI,IACD,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,QAAQ,CAAC,WAAW,EAC9B,KAAK,EAAC,qBAAqB,EAC3B,KAAK,EAAC,YAAY,EAClB,IAAI,EAAC,MAAM,EACX,KAAK,EAAE;oBACH,GAAG,oBAAoB,CAAC,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;oBAClD,GAAG,cAAc;oBACjB,KAAK,EAAE,aAAa;oBACpB,QAAQ,EAAE,OAAO;oBACjB,QAAQ,EAAE,OAAO;iBACpB,YAEA,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CACjB,KAAC,QAAQ,OAAmB,IAAI,EAAE,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,IAApE,IAAI,CAAC,EAAE,CAAiE,CAC1F,CAAC,GACC,CACV,EACD,KAAC,eAAe,0BAAe,IAC9B,CACR,CAAC;AACN,CAAC"}

package/dist/hooks/useModalState.d.ts

@@ -1,22 +0,0 @@
-/**
- * A hook to manage the state of a modal.
- *
- * @example
- *     import { Modal } from '@bspk/ui/Modal';
- *     import { useModalState } from '@bspk/ui/hooks/useModalState';
- *
- *     function Example() {
- *     const modalProps = useModalState(false);
- *     return <Modal  {...modalProps}>...</Modal>
- *     }
- *
- * @param parentValue - The value of the parent state.
- * @param setParentState - A function to set the parent state.
- * @returns An object with the open state and the `onClose` and `onOpen` callbacks.
- */
-export declare function useModalState(parentValue?: boolean, setParentState?: (next: boolean) => void): {
-    open: boolean;
-    onClose: () => void;
-    onOpen: () => void;
-};
-/** Copyright 2025 Anywhere Real Estate - CC BY 4.0 */

package/dist/hooks/useModalState.js

@@ -1,34 +0,0 @@
-import { useEffect, useState } from 'react';
-/**
- * A hook to manage the state of a modal.
- *
- * @example
- *     import { Modal } from '@bspk/ui/Modal';
- *     import { useModalState } from '@bspk/ui/hooks/useModalState';
- *
- *     function Example() {
- *     const modalProps = useModalState(false);
- *     return <Modal  {...modalProps}>...</Modal>
- *     }
- *
- * @param parentValue - The value of the parent state.
- * @param setParentState - A function to set the parent state.
- * @returns An object with the open state and the `onClose` and `onOpen` callbacks.
- */
-export function useModalState(parentValue = false, setParentState) {
-    const [open, setOpen] = useState(parentValue);
-    useEffect(() => setOpen(parentValue), [parentValue]);
-    return {
-        open,
-        onClose: () => {
-            setOpen(false);
-            setParentState?.(false);
-        },
-        onOpen: () => {
-            setOpen(true);
-            setParentState?.(true);
-        },
-    };
-}
-/** Copyright 2025 Anywhere Real Estate - CC BY 4.0 */
-//# sourceMappingURL=useModalState.js.map

package/dist/hooks/useModalState.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useModalState.js","sourceRoot":"","sources":["../../src/hooks/useModalState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,aAAa,CAAC,cAAuB,KAAK,EAAE,cAAwC;IAChG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;IAE9C,SAAS,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAErD,OAAO;QACH,IAAI;QACJ,OAAO,EAAE,GAAG,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,CAAC;YACf,cAAc,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QACD,MAAM,EAAE,GAAG,EAAE;YACT,OAAO,CAAC,IAAI,CAAC,CAAC;YACd,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;KACJ,CAAC;AACN,CAAC;AAED,sDAAsD"}

package/src/hooks/useModalState.ts

@@ -1,37 +0,0 @@
-import { useEffect, useState } from 'react';
-
-/**
- * A hook to manage the state of a modal.
- *
- * @example
- *     import { Modal } from '@bspk/ui/Modal';
- *     import { useModalState } from '@bspk/ui/hooks/useModalState';
- *
- *     function Example() {
- *     const modalProps = useModalState(false);
- *     return <Modal  {...modalProps}>...</Modal>
- *     }
- *
- * @param parentValue - The value of the parent state.
- * @param setParentState - A function to set the parent state.
- * @returns An object with the open state and the `onClose` and `onOpen` callbacks.
- */
-export function useModalState(parentValue: boolean = false, setParentState?: (next: boolean) => void) {
-    const [open, setOpen] = useState(parentValue);
-
-    useEffect(() => setOpen(parentValue), [parentValue]);
-
-    return {
-        open,
-        onClose: () => {
-            setOpen(false);
-            setParentState?.(false);
-        },
-        onOpen: () => {
-            setOpen(true);
-            setParentState?.(true);
-        },
-    };
-}
-
-/** Copyright 2025 Anywhere Real Estate - CC BY 4.0 */