@opengovsg/oui 0.0.0-snapshot-20251203100754 → 0.0.0-snapshot-20251216073051

package/dist/types/navbar/navbar-menu/menu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu.d.ts","sourceRoot":"","sources":["../../../../src/navbar/navbar-menu/menu.tsx"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAKrD,MAAM,WAAW,eAAgB,SAAQ,WAAW,CAAC,IAAI,CAAC;IACxD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,eAAO,MAAM,UAAU,6FAoDtB,CAAA"}

package/dist/types/navbar/navbar-menu/toggle.d.ts

@@ -0,0 +1,12 @@
+import type { ReactNode } from "react";
+import type { ToggleButtonProps } from "react-aria-components";
+import type { ButtonVariantProps, SlotsToClasses } from "@opengovsg/oui-theme";
+export interface NavbarMenuToggleProps extends ToggleButtonProps, Pick<ButtonVariantProps, "size" | "radius" | "isIconOnly"> {
+    /**
+     * The icon to display.
+     */
+    icon?: ReactNode | ((isOpen: boolean) => ReactNode) | null;
+    classNames?: SlotsToClasses<"toggle" | "toggleIcon">;
+}
+export declare const NavbarMenuToggle: ({ icon, className, onChange, classNames, size, radius, isIconOnly, ...props }: NavbarMenuToggleProps) => import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=toggle.d.ts.map

package/dist/types/navbar/navbar-menu/toggle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toggle.d.ts","sourceRoot":"","sources":["../../../../src/navbar/navbar-menu/toggle.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAK9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAM9E,MAAM,WAAW,qBACf,SAAQ,iBAAiB,EACvB,IAAI,CAAC,kBAAkB,EAAE,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAC;IAC5D;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,SAAS,CAAC,GAAG,IAAI,CAAA;IAC1D,UAAU,CAAC,EAAE,cAAc,CAAC,QAAQ,GAAG,YAAY,CAAC,CAAA;CACrD;AAED,eAAO,MAAM,gBAAgB,kFAS1B,qBAAqB,4CAkFvB,CAAA"}

package/dist/types/navbar/navbar.d.ts

@@ -0,0 +1,6 @@
+import type { UseNavbarProps } from "./use-navbar";
+export interface NavbarProps extends UseNavbarProps {
+    children?: React.ReactNode | React.ReactNode[];
+}
+export declare const Navbar: import("../system/utils").InternalForwardRefRenderFunction<"div", NavbarProps, never>;
+//# sourceMappingURL=navbar.d.ts.map

package/dist/types/navbar/navbar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navbar.d.ts","sourceRoot":"","sources":["../../../src/navbar/navbar.tsx"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAOlD,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;CAC/C;AAiBD,eAAO,MAAM,MAAM,uFAoCjB,CAAA"}

package/dist/types/navbar/use-navbar.d.ts

@@ -0,0 +1,163 @@
+import type { HTMLMotionProps } from "motion/react";
+import type { NavbarSlots, NavbarVariantProps, SlotsToClasses } from "@opengovsg/oui-theme";
+import type { ReactRef } from "../system/react-utils";
+import type { HtmlUiProps, PropGetter } from "../system/types";
+interface Props extends HtmlUiProps<"nav"> {
+    /**
+     * Ref to the DOM node.
+     */
+    ref?: ReactRef<HTMLElement | null>;
+    /**
+     * The parent element where the navbar is placed within.
+     * This is used to determine the scroll position for `shouldShowOnScrollUp`.
+     * @default `window`
+     */
+    parentRef?: React.RefObject<HTMLElement>;
+    /**
+     * The height of the navbar.
+     * @default "4rem" (64px)
+     */
+    height?: number | string;
+    /**
+     * Whether the menu is open.
+     * @default false
+     */
+    isMenuOpen?: boolean;
+    /**
+     * Whether the menu should be open by default.
+     * @default false
+     */
+    isMenuDefaultOpen?: boolean;
+    /**
+     * Whether the navbar should show up when user is scrolling up or not.
+     * Will only take effect if the `position` of the navbar is set to `static`.
+     * @default false
+     */
+    shouldShowOnScrollUp?: boolean;
+    /**
+     * Whether the navbar parent scroll event should be listened to or not.
+     * @default false
+     */
+    disableScrollHandler?: boolean;
+    /**
+     * The scroll event handler for the navbar. The event fires when the navbar parent element is scrolled.
+     * it only works if `disableScrollHandler` is set to `false` or `shouldShowOnScrollUp` is set to `true`.
+     */
+    onScrollPositionChange?: (scrollPosition: number) => void;
+    /**
+     * Whether the navbar should block scroll when the menu is open or not.
+     * @default true
+     */
+    shouldBlockScroll?: boolean;
+    /**
+     * The props to modify motion animation. Use the `variants` API to create your own animation.
+     * This motion is only available if the `shouldShowOnScrollUp` prop is set to `true`.
+     */
+    motionProps?: Omit<HTMLMotionProps<"nav">, "ref">;
+    /**
+     * The event handler for the menu open state.
+     * @param isOpen boolean
+     * @returns void
+     */
+    onMenuOpenChange?: (isOpen: boolean) => void;
+    /**
+     * Classname or List of classes to change the classNames of the element.
+     * if `className` is passed, it will be added to the base slot.
+     */
+    classNames?: SlotsToClasses<NavbarSlots>;
+}
+export type UseNavbarProps = Props & NavbarVariantProps;
+export declare function useNavbar(originalProps: UseNavbarProps): {
+    Component: import("../system/types").As<any>;
+    slots: {
+        base: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        wrapper: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        toggle: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        toggleIcon: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        brand: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        content: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        item: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        menu: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        menuItem: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+    } & {
+        base: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        wrapper: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        toggle: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        toggleIcon: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        brand: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        content: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        item: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        menu: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+        menuItem: (slotProps?: ({
+            position?: "static" | "sticky" | undefined;
+            hasBorder?: boolean | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
+    } & {};
+    domRef: import("react").RefObject<HTMLElement | null>;
+    menuTopOffset: number;
+    menuTopOffsetPx: string;
+    isNavbarHidden: boolean;
+    shouldShowOnScrollUp: boolean;
+    isMenuOpen: boolean;
+    classNames: SlotsToClasses<"toggle" | "content" | "base" | "wrapper" | "item" | "brand" | "menu" | "menuItem" | "toggleIcon"> | undefined;
+    setIsMenuOpen: (value: boolean, ...args: any[]) => void;
+    menuRef: import("react").RefObject<HTMLButtonElement | null>;
+    getBaseProps: PropGetter;
+    getWrapperProps: PropGetter;
+    position: "static" | "sticky";
+    motionProps: Omit<HTMLMotionProps<"nav">, "ref"> | undefined;
+};
+export type UseNavbarReturn = ReturnType<typeof useNavbar>;
+export {};
+//# sourceMappingURL=use-navbar.d.ts.map

package/dist/types/navbar/use-navbar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-navbar.d.ts","sourceRoot":"","sources":["../../../src/navbar/use-navbar.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAMnD,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,cAAc,EACf,MAAM,sBAAsB,CAAA;AAG7B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAQ9D,UAAU,KAAM,SAAQ,WAAW,CAAC,KAAK,CAAC;IACxC;;OAEG;IACH,GAAG,CAAC,EAAE,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;IACxC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAA;IACzD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,WAAW,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAA;IACjD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;IAC5C;;;OAGG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC,CAAA;CACzC;AAED,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,kBAAkB,CAAA;AAEvD,wBAAgB,SAAS,CAAC,aAAa,EAAE,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8HtD;AAED,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,CAAA"}

package/dist/types/spinner/use-spinner.d.ts

@@ -26,36 +26,36 @@ export interface UseSpinnerProps extends Omit<HtmlUiProps, "children">, SpinnerV
 export declare const useSpinner: (originalProps: UseSpinnerProps) => {
     slots: {
         base: (slotProps?: ({
-            size?: "lg" | "md" | "sm" | undefined;
+            size?: "lg" | "md" | "sm" | "xs" | undefined;
             color?: "current" | "white" | undefined;
         } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
         wrapper: (slotProps?: ({
-            size?: "lg" | "md" | "sm" | undefined;
+            size?: "lg" | "md" | "sm" | "xs" | undefined;
             color?: "current" | "white" | undefined;
         } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
         circle1: (slotProps?: ({
-            size?: "lg" | "md" | "sm" | undefined;
+            size?: "lg" | "md" | "sm" | "xs" | undefined;
             color?: "current" | "white" | undefined;
         } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
         circle2: (slotProps?: ({
-            size?: "lg" | "md" | "sm" | undefined;
+            size?: "lg" | "md" | "sm" | "xs" | undefined;
             color?: "current" | "white" | undefined;
         } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
     } & {
         base: (slotProps?: ({
-            size?: "lg" | "md" | "sm" | undefined;
+            size?: "lg" | "md" | "sm" | "xs" | undefined;
             color?: "current" | "white" | undefined;
         } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
         wrapper: (slotProps?: ({
-            size?: "lg" | "md" | "sm" | undefined;
+            size?: "lg" | "md" | "sm" | "xs" | undefined;
             color?: "current" | "white" | undefined;
         } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
         circle1: (slotProps?: ({
-            size?: "lg" | "md" | "sm" | undefined;
+            size?: "lg" | "md" | "sm" | "xs" | undefined;
             color?: "current" | "white" | undefined;
         } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
         circle2: (slotProps?: ({
-            size?: "lg" | "md" | "sm" | undefined;
+            size?: "lg" | "md" | "sm" | "xs" | undefined;
             color?: "current" | "white" | undefined;
         } & import("tailwind-variants").ClassProp<import("tailwind-merge").ClassNameValue>) | undefined) => string;
     } & {};

package/dist/types/system/react-utils/children.d.ts

@@ -0,0 +1,10 @@
+import type { ReactNode } from "react";
+/**
+ * Gets only the valid children of a component,
+ * and ignores any nullish or falsy child.
+ *
+ * @param children the children
+ */
+export declare function getValidChildren(children: React.ReactNode): React.ReactElement[];
+export declare const pickChildren: <T = ReactNode>(children: T | undefined, targetChild: React.ElementType) => [T | undefined, T[] | undefined];
+//# sourceMappingURL=children.d.ts.map

package/dist/types/system/react-utils/children.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"children.d.ts","sourceRoot":"","sources":["../../../../src/system/react-utils/children.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAGtC;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,GAGnD,KAAK,CAAC,YAAY,EAAE,CAC1B;AAED,eAAO,MAAM,YAAY,GAAI,CAAC,wBAClB,CAAC,GAAG,SAAS,eACV,KAAK,CAAC,WAAW,KAC7B,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,GAAG,SAAS,CAiBjC,CAAA"}

package/dist/types/system/react-utils/index.d.ts

@@ -1,4 +1,6 @@
-export * from "./context";
-export * from "./refs";
-export * from "./filter-dom-props";
+export { createContext } from "./context";
+export { useDomRef } from "./refs";
+export { filterDOMProps } from "./filter-dom-props";
+export type { CreateContextOptions, CreateContextReturn } from "./context";
+export type { ReactRef } from "./refs";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/system/react-utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/system/react-utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,QAAQ,CAAA;AACtB,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/system/react-utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAEnD,YAAY,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAC1E,YAAY,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA"}