@opengovsg/oui 0.0.0-snapshot-20250311073924

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

@@ -0,0 +1,66 @@
+import type { SlotsToClasses, SpinnerSlots, SpinnerVariantProps } from "@opengovsg/oui-theme";
+import type { Ref } from "react";
+import type { HtmlUiProps, PropGetter } from "../system/types";
+export interface UseSpinnerProps extends Omit<HtmlUiProps, "children">, SpinnerVariantProps {
+    /**
+     * Ref to the DOM node.
+     */
+    ref?: Ref<HTMLElement | null>;
+    /**
+     * Classname or List of classes to change the classNames of the element.
+     * if `className` is passed, it will be added to the base slot.
+     *
+     * @example
+     * ```ts
+     * <Spinner classNames={{
+     *    base:"base-classes",
+     *    wrapper: "wrapper-classes",
+     *    circle1: "circle1-classes",
+     *    circle2: "circle2-classes",
+     *    label: "label-classes"
+     * }} />
+     * ```
+     */
+    classNames?: SlotsToClasses<SpinnerSlots>;
+}
+export declare const useSpinner: (originalProps: UseSpinnerProps) => {
+    slots: {
+        base: (slotProps?: ({
+            size?: "lg" | "md" | "sm" | undefined;
+            color?: "current" | "white" | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-variants").ClassValue>) | undefined) => string;
+        wrapper: (slotProps?: ({
+            size?: "lg" | "md" | "sm" | undefined;
+            color?: "current" | "white" | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-variants").ClassValue>) | undefined) => string;
+        circle1: (slotProps?: ({
+            size?: "lg" | "md" | "sm" | undefined;
+            color?: "current" | "white" | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-variants").ClassValue>) | undefined) => string;
+        circle2: (slotProps?: ({
+            size?: "lg" | "md" | "sm" | undefined;
+            color?: "current" | "white" | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-variants").ClassValue>) | undefined) => string;
+    } & {
+        base: (slotProps?: ({
+            size?: "lg" | "md" | "sm" | undefined;
+            color?: "current" | "white" | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-variants").ClassValue>) | undefined) => string;
+        wrapper: (slotProps?: ({
+            size?: "lg" | "md" | "sm" | undefined;
+            color?: "current" | "white" | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-variants").ClassValue>) | undefined) => string;
+        circle1: (slotProps?: ({
+            size?: "lg" | "md" | "sm" | undefined;
+            color?: "current" | "white" | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-variants").ClassValue>) | undefined) => string;
+        circle2: (slotProps?: ({
+            size?: "lg" | "md" | "sm" | undefined;
+            color?: "current" | "white" | undefined;
+        } & import("tailwind-variants").ClassProp<import("tailwind-variants").ClassValue>) | undefined) => string;
+    } & {};
+    classNames: SlotsToClasses<"base" | "wrapper" | "circle1" | "circle2"> | undefined;
+    getSpinnerProps: PropGetter;
+};
+export type UseSpinnerReturn = ReturnType<typeof useSpinner>;
+//# sourceMappingURL=use-spinner.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-spinner.d.ts","sourceRoot":"","sources":["../../../src/spinner/use-spinner.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,mBAAmB,EACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAKhC,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAG9D,MAAM,WAAW,eACf,SAAQ,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,EACnC,mBAAmB;IACrB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IAC7B;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,YAAY,CAAC,CAAA;CAC1C;AAED,eAAO,MAAM,UAAU,kBAAmB,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCxD,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA"}

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

@@ -0,0 +1,27 @@
+export interface CreateContextOptions {
+    /**
+     * If `true`, React will throw if context is `null` or `undefined`
+     * In some cases, you might want to support nested context, so you can set it to `false`
+     */
+    strict?: boolean;
+    /**
+     * Error message to throw if the context is `undefined`
+     */
+    errorMessage?: string;
+    /**
+     * The display name of the context
+     */
+    name?: string;
+}
+export type CreateContextReturn<T> = [
+    React.Provider<T>,
+    () => T,
+    React.Context<T>
+];
+/**
+ * Creates a named context, provider, and hook.
+ *
+ * @param options - create context options
+ */
+export declare function createContext<ContextType>(options?: CreateContextOptions): CreateContextReturn<ContextType>;
+//# sourceMappingURL=context.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../../src/system/react-utils/context.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI;IACnC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjB,MAAM,CAAC;IACP,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;CACjB,CAAA;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,WAAW,EACvC,OAAO,GAAE,oBAAyB,GACjC,mBAAmB,CAAC,WAAW,CAAC,CA8BlC"}

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

@@ -0,0 +1,2 @@
+export * from "./context";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/system/react-utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}

package/dist/types/system/types.d.ts

@@ -0,0 +1,63 @@
+import type * as CSS from "csstype";
+import type { JSX, ReactNode } from "react";
+import { AriaLabelingProps, DOMProps as SharedDOMProps } from "@react-types/shared";
+/**
+ * Explicit re-export to fix error:
+ * The inferred type of useRenderProps cannot be named without a reference to .pnpm/csstype@3.1.3/node_modules/csstype . This is likely not portable. A type annotation is necessary.
+ */
+interface CSSProperties extends CSS.Properties<string | number> {
+}
+export type As<Props = any> = React.ElementType<Props>;
+/**
+ * Extract the props of a React element or component
+ */
+export type PropsOf<T extends As> = React.ComponentPropsWithoutRef<T> & {
+    as?: As;
+};
+export type Merge<M, N> = N extends Record<string, unknown> ? M : Omit<M, keyof N> & N;
+export type MergeWithAs<ComponentProps extends object, AsProps extends object, AdditionalProps extends object = {}, AsComponent extends As = As> = (RightJoinProps<ComponentProps, AdditionalProps> | RightJoinProps<AsProps, AdditionalProps>) & {
+    as?: AsComponent;
+};
+export type OmitCommonProps<Target, OmitAdditionalProps extends keyof any = never> = Omit<Target, "transition" | "as" | "color" | OmitAdditionalProps>;
+export type RightJoinProps<SourceProps extends object = {}, OverrideProps extends object = {}> = OmitCommonProps<SourceProps, keyof OverrideProps> & OverrideProps;
+/**
+ * Type that omits default React HTML props that conflicts with RAC and theming UI props.
+ */
+export type HtmlUiProps<T extends As = "div", OmitKeys extends keyof any = never> = Omit<PropsOf<T>, "ref" | "color" | "slot" | "size" | "defaultChecked" | "defaultValue" | OmitKeys> & {
+    as?: As;
+};
+export type DOMElements = keyof JSX.IntrinsicElements;
+export interface DOMElement extends Element, HTMLOrSVGElement {
+}
+type DataAttributes = Record<string, any>;
+export type DOMAttributes<T = DOMElement> = React.AriaAttributes & React.DOMAttributes<T> & DataAttributes & {
+    id?: string;
+    role?: React.AriaRole;
+    tabIndex?: number;
+    style?: React.CSSProperties;
+};
+export type PropGetter<P = Record<string, unknown>, R = DOMAttributes> = (props?: Merge<DOMAttributes, P>, ref?: React.Ref<any>) => R & React.RefAttributes<any>;
+export interface StyleRenderProps<T> {
+    /** The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. */
+    className?: string | ((values: T & {
+        defaultClassName: string | undefined;
+    }) => string);
+    /** The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. */
+    style?: CSSProperties | ((values: T & {
+        defaultStyle: CSSProperties;
+    }) => CSSProperties | undefined);
+}
+export interface RenderProps<T> extends StyleRenderProps<T> {
+    /** The children of the component. A function may be provided to alter the children based on component state. */
+    children?: ReactNode | ((values: T & {
+        defaultChildren: ReactNode | undefined;
+    }) => ReactNode);
+}
+export interface RenderPropsHookOptions<T> extends RenderProps<T>, SharedDOMProps, AriaLabelingProps {
+    values: T;
+    defaultChildren?: ReactNode;
+    defaultClassName?: string;
+    defaultStyle?: CSSProperties;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/system/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,SAAS,CAAA;AACnC,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAC3C,OAAO,EACL,iBAAiB,EACjB,QAAQ,IAAI,cAAc,EAC3B,MAAM,qBAAqB,CAAA;AAE5B;;;GAGG;AAGH,UAAU,aAAc,SAAQ,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC;CAS9D;AAGD,MAAM,MAAM,EAAE,CAAC,KAAK,GAAG,GAAG,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,EAAE,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC,GAAG;IACtE,EAAE,CAAC,EAAE,EAAE,CAAA;CACR,CAAA;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,IACpB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAA;AAE9D,MAAM,MAAM,WAAW,CACrB,cAAc,SAAS,MAAM,EAC7B,OAAO,SAAS,MAAM,EAEtB,eAAe,SAAS,MAAM,GAAG,EAAE,EACnC,WAAW,SAAS,EAAE,GAAG,EAAE,IACzB,CACA,cAAc,CAAC,cAAc,EAAE,eAAe,CAAC,GAC/C,cAAc,CAAC,OAAO,EAAE,eAAe,CAAC,CAC3C,GAAG;IACF,EAAE,CAAC,EAAE,WAAW,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,eAAe,CACzB,MAAM,EAEN,mBAAmB,SAAS,MAAM,GAAG,GAAG,KAAK,IAC3C,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,GAAG,mBAAmB,CAAC,CAAA;AAErE,MAAM,MAAM,cAAc,CAExB,WAAW,SAAS,MAAM,GAAG,EAAE,EAE/B,aAAa,SAAS,MAAM,GAAG,EAAE,IAC/B,eAAe,CAAC,WAAW,EAAE,MAAM,aAAa,CAAC,GAAG,aAAa,CAAA;AAErE;;GAEG;AACH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,EAAE,GAAG,KAAK,EAEpB,QAAQ,SAAS,MAAM,GAAG,GAAG,KAAK,IAChC,IAAI,CACN,OAAO,CAAC,CAAC,CAAC,EACR,KAAK,GACL,OAAO,GACP,MAAM,GACN,MAAM,GACN,gBAAgB,GAChB,cAAc,GACd,QAAQ,CACX,GAAG;IACF,EAAE,CAAC,EAAE,EAAE,CAAA;CACR,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,iBAAiB,CAAA;AAErD,MAAM,WAAW,UAAW,SAAQ,OAAO,EAAE,gBAAgB;CAAG;AAGhE,KAAK,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAEzC,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,UAAU,IAAI,KAAK,CAAC,cAAc,GAC9D,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,GACtB,cAAc,GAAG;IACf,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAA;CAC5B,CAAA;AAEH,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,aAAa,IAAI,CACvE,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,EAE/B,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,KAEjB,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;AAEjC,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,yLAAyL;IACzL,SAAS,CAAC,EACN,MAAM,GACN,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG;QAAE,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,KAAK,MAAM,CAAC,CAAA;IACtE,wLAAwL;IACxL,KAAK,CAAC,EACF,aAAa,GACb,CAAC,CACC,MAAM,EAAE,CAAC,GAAG;QAAE,YAAY,EAAE,aAAa,CAAA;KAAE,KACxC,aAAa,GAAG,SAAS,CAAC,CAAA;CACpC;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IACzD,gHAAgH;IAChH,QAAQ,CAAC,EACL,SAAS,GACT,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG;QAAE,eAAe,EAAE,SAAS,GAAG,SAAS,CAAA;KAAE,KAAK,SAAS,CAAC,CAAA;CAC5E;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC,CACvC,SAAQ,WAAW,CAAC,CAAC,CAAC,EACpB,cAAc,EACd,iBAAiB;IACnB,MAAM,EAAE,CAAC,CAAA;IACT,eAAe,CAAC,EAAE,SAAS,CAAA;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,YAAY,CAAC,EAAE,aAAa,CAAA;CAC7B"}