@overmap-ai/blocks 1.0.26 → 1.0.27-alpha.0

package/README.md

@@ -1,3 +1,3 @@
-# overmap-ai blocks
-
-Contains basic components used by overmap-ai libraries.
+# overmap-ai blocks
+
+Contains basic components used by overmap-ai libraries.

package/dist/Buttons/typings.d.ts

@@ -6,11 +6,7 @@ export interface Shortcut {
     action: () => void;
     disabled?: boolean;
 }
-export type RadixButtonProps = React.ComponentProps<typeof RadixButton>;
-export type ButtonHoverEffect = "spin90Clockwise" | "spin180Clockwise" | "spin360Clockwise";
-export interface ButtonProps extends Omit<RadixButtonProps, "size" | "variant" | "loading" | keyof MarginProps> {
-    children: RadixButtonProps["children"];
-    /** @default false */
+export interface ButtonStyleProps {
     fluid?: boolean;
     /** @default solid */
     variant?: Variant;
@@ -18,6 +14,11 @@ export interface ButtonProps extends Omit<RadixButtonProps, "size" | "variant" |
     severity?: Severity;
     size?: Responsive<Size>;
     hoverEffects?: ButtonHoverEffect[];
+}
+export type RadixButtonProps = React.ComponentProps<typeof RadixButton>;
+export type ButtonHoverEffect = "spin90Clockwise" | "spin180Clockwise" | "spin360Clockwise";
+export interface ButtonProps extends Omit<RadixButtonProps, "size" | "variant" | "loading" | keyof MarginProps>, ButtonStyleProps {
+    children: RadixButtonProps["children"];
     shortcut?: Shortcut;
     loading?: boolean;
 }

package/dist/Dialogs/Dialog/typings.d.ts

@@ -1,11 +1,6 @@
+import React, { ReactNode } from "react";
 import { DialogContent } from "@radix-ui/themes";
-import { CloseDialog } from "../typings";
-import { ReactNode } from "react";
-export interface CloseDialogOptions {
-    /** Bypass the `onCloseInterrupt` and force the dialog to close */
-    force?: boolean;
-}
-export type CloseDialogWithOptions = (options?: CloseDialogOptions) => void;
+import { CloseDialog, CloseDialogWithOptions } from "../typings";
 type RadixDialogContentProps = React.ComponentProps<typeof DialogContent>;
 export interface DialogProps extends Omit<RadixDialogContentProps, "content" | "children"> {
     /** The content of the dialog, which is rendered below the description.

package/dist/Dialogs/Dialog/utils.d.ts

@@ -1,4 +1,4 @@
-import { CloseDialogOptions, CloseDialogWithOptions } from "./typings.ts";
+import { CloseDialogOptions, CloseDialogWithOptions } from "../typings";
 /** This custom hook is used as a utility for wrapping a general callback in callback that accepts a close function for the
  * Blocks dialog component. Sometimes a side effect callback needs to be run upon the closure of a Dialog. This provides
  * a hook to wrap a callback with the returned close function passed to the Dialog Content. This allows the closure of

package/dist/Dialogs/Overlay/Overlay.d.ts

@@ -0,0 +1,34 @@
+import { CSSProperties, ReactElement, ReactNode } from "react";
+import * as RadixDialogPrimitive from "@radix-ui/react-dialog";
+import { CloseDialog, CloseDialogWithOptions } from "../typings";
+export interface OverlayProps {
+    /** The content to be displayed within the Overlay. A prop pattern with a passed close function that can be used to
+     * close the Overlay from the components rendering the content. pass {force: true} to the close function to avoid
+     * the onInterruptClose process when using in an uncontrolled state. NOTE: when controlling the open state of the overlay,
+     * the close function will have no effect on the open state of the Overlay */
+    content: (close: CloseDialogWithOptions) => ReactNode;
+    /** the element that should act as a trigger for opening the Overlay */
+    children?: ReactElement;
+    /** the initial open state of the Overlay */
+    defaultOpen?: RadixDialogPrimitive.DialogProps["defaultOpen"];
+    /** callback that is fired upon closing of the Overlay calls the close function to continue the closing process.
+     * If the close function is not called, the Overlay will not be closed */
+    onInterruptClose?: (close: CloseDialog) => void;
+    /** callback fired when the Overlay is being closed, if onInterruptClose is specified, it fires if the closing process
+     * is continued by calling the close function within the callback passed to onInterruptClose.
+     * */
+    onClose?: () => void;
+    open?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    className?: string;
+    style?: CSSProperties;
+    /** when true, renders an unstyled overlay filling the Overlays parent container */
+    overlay?: boolean;
+    /** className to be applied to the overlay component */
+    overlayClass?: string;
+    /** style object to be applied to the overlay component */
+    overlayStyle?: CSSProperties;
+}
+/** The Overlay component is a versatile UI element designed to provide a layer above the existing content.
+ * It serves various purposes such as modals, popovers, tooltips, or any other temporary or context-based UI overlay.*/
+export declare const Overlay: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<OverlayProps & import("react").RefAttributes<HTMLDivElement>>>;

package/dist/Dialogs/Overlay/index.d.ts

@@ -0,0 +1 @@
+export * from "./Overlay";

package/dist/Dialogs/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./Dialog/";
 export * from "./AlertDialog/";
+export * from "./Overlay";
+export * from "./typings";

package/dist/Dialogs/typings.d.ts

@@ -1,2 +1,7 @@
 /** Triggers the dialog to close */
 export type CloseDialog = () => void;
+export interface CloseDialogOptions {
+    /** Bypass the `onCloseInterrupt` and force the dialog to close */
+    force?: boolean;
+}
+export type CloseDialogWithOptions = (options?: CloseDialogOptions) => void;

package/dist/DownloadButtonUtility/DownloadButtonUtility.d.ts

@@ -0,0 +1,7 @@
+import { ReactElement } from "react";
+interface DownloadButtonUtilityProps {
+    children: ReactElement;
+    file: File;
+}
+export declare const DownloadButtonUtility: import("react").MemoExoticComponent<(props: DownloadButtonUtilityProps) => import("react/jsx-runtime").JSX.Element>;
+export {};

package/dist/DownloadButtonUtility/index.d.ts

@@ -0,0 +1 @@
+export * from "./DownloadButtonUtility";

package/dist/Layout/SlideOutOverlay.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="react" />
 import { PropsWithClassNameAndStyle } from "../typings";
 import { SlideOutV3Props } from "../SlideOutV3";
-export interface OverlayProps extends PropsWithClassNameAndStyle {
+export interface LayoutOverlayProps extends PropsWithClassNameAndStyle {
     active?: boolean;
     side: SlideOutV3Props["side"];
     smallModeOnly?: boolean;
 }
-export declare const SlideOutOverlay: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<OverlayProps & import("react").RefAttributes<HTMLDivElement>>>;
+export declare const SlideOutOverlay: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<LayoutOverlayProps & import("react").RefAttributes<HTMLDivElement>>>;

package/dist/Layout/index.d.ts

@@ -2,7 +2,7 @@
 export declare const Layout: {
     Root: import("react").MemoExoticComponent<(props: import("./Root").RootProps) => import("react/jsx-runtime").JSX.Element>;
     Container: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Omit<import("./Container").ContainerProps, "ref"> & import("react").RefAttributes<HTMLDivElement>>>;
-    SlideOutOverlay: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<import("./SlideOutOverlay").OverlayProps & import("react").RefAttributes<HTMLDivElement>>>;
+    SlideOutOverlay: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<import("./SlideOutOverlay").LayoutOverlayProps & import("react").RefAttributes<HTMLDivElement>>>;
     LeftSlideOut: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<import("./SlideOut").LayoutSlideOutProps & import("react").RefAttributes<HTMLDivElement>>>;
     RightSlideOut: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<import("./SlideOut").LayoutSlideOutProps & import("react").RefAttributes<HTMLDivElement>>>;
     SlideOutTrigger: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<import("./SlideOutTrigger").SlideOutTriggerProps & import("react").RefAttributes<HTMLButtonElement>>>;

package/dist/OvermapItem/OvermapItem.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { OvermapItemProps } from "./typings";
+/** The OvermapItem component is supposed to be used as a Base Component to layout content in an item-like format. It
+ * supports responsive sizing and slot props to insert content to the left and right of its children. */
+export declare const OvermapItem: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<OvermapItemProps & import("react").RefAttributes<HTMLDivElement>>>;

package/dist/OvermapItem/constants.d.ts

@@ -0,0 +1,2 @@
+import { OvermapItemSizes, SizeDependableProps } from "./typings";
+export declare const OvermapItemSizeDependantProps: Record<OvermapItemSizes, SizeDependableProps>;

package/dist/OvermapItem/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./OvermapItem";
+export * from "./typings";

package/dist/OvermapItem/typings.d.ts

@@ -0,0 +1,20 @@
+import { HTMLProps, ReactNode, ComponentProps } from "react";
+import { Flex } from "@radix-ui/themes";
+import { OvermapResponsive } from "../typings";
+type FlexProps = ComponentProps<typeof Flex>;
+export interface SizeDependableProps {
+    gap: FlexProps["gap"];
+    px: FlexProps["px"];
+    height: FlexProps["height"];
+    fontSize: string;
+}
+export type OvermapItemSizes = "1" | "2" | "3" | "4" | "5";
+export interface OvermapItemProps extends Omit<HTMLProps<HTMLDivElement>, "ref" | "width" | "height" | "wrap" | "size"> {
+    /** content to be rendered on the left of any children */
+    leftSlot?: ReactNode;
+    /** content to be rendered on the right of any children */
+    rightSlot?: ReactNode;
+    /** supports five different sizes, changing the overall proportions of the OvermapItem including font size. */
+    size?: OvermapResponsive<OvermapItemSizes>;
+}
+export {};

package/dist/ToggleButton/ToggleButton.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import * as Toggle from "@radix-ui/react-toggle";
+import { ButtonStyleProps } from "../Buttons/typings";
+interface ToggleButtonProps extends Toggle.ToggleProps, ButtonStyleProps {
+    "aria-label": string;
+}
+export declare const ToggleButton: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<ToggleButtonProps & import("react").RefAttributes<HTMLButtonElement>>>;
+export {};

package/dist/ToggleButton/index.d.ts

@@ -0,0 +1 @@
+export * from "./ToggleButton";