@overmap-ai/blocks 0.0.1-alpha.51 → 0.0.1

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/Toast/Toast.d.ts

@@ -1,6 +1,3 @@
 import { FC } from "react";
-import * as RadixToast from "@radix-ui/react-toast";
-import { ToastProps, ToastProviderProps } from "./typings.ts";
-export declare const ToastProvider: FC<ToastProviderProps>;
+import { ToastProps } from "./typings";
 export declare const Toast: FC<ToastProps>;
-export declare const ToastViewport: FC<RadixToast.ToastViewportProps>;

package/dist/Toast/ToastContext.d.ts

@@ -1,4 +1,4 @@
-import { FC } from "react";
-import { IToastContext, ToastContextProviderProps } from "./typings.ts";
+/// <reference types="react" />
+import { IToastContext } from "./typings";
 export declare const ToastContext: import("react").Context<IToastContext>;
-export declare const ToastContextProvider: FC<ToastContextProviderProps>;
+export declare const useToast: () => IToastContext;

package/dist/Toast/ToastProvider.d.ts

@@ -0,0 +1,4 @@
+import { FC } from "react";
+import { ToastContextProviderProps } from "./typings";
+/** Toasts will be displayed in the top-right handle corner of the screen */
+export declare const ToastProvider: FC<ToastContextProviderProps>;

package/dist/Toast/index.d.ts

@@ -1,3 +1,4 @@
-export * from "./Toast.tsx";
-export * from "./ToastContext.tsx";
-export * from "./typings.ts";
+export * from "./Toast";
+export * from "./ToastContext";
+export * from "./ToastProvider";
+export * from "./typings";

package/dist/Toast/typings.d.ts

@@ -1,45 +1,45 @@
 import { ComponentProps, ReactNode } from "react";
-import * as RadixToast from "@radix-ui/react-toast";
+import { ToastProps as RadixToastProps, ToastProviderProps, ToastViewportProps } from "@radix-ui/react-toast";
 import { Callout } from "@radix-ui/themes";
 import { Severity } from "../typings.ts";
-export interface ToastProviderProps {
-    /** a global duration that will be applied to each Toast rendered within the provider*/
-    duration?: RadixToast.ToastProviderProps["duration"];
-    /** label for each toast. Used to help screen reader users associate the interruption with a toast. */
-    label?: RadixToast.ToastProviderProps["label"];
-    children?: RadixToast.ToastProviderProps["children"];
-}
 export interface ToastProps {
     size?: ComponentProps<typeof Callout.Root>["size"];
-    /** to indicate the severity of each Toast*/
+    /**
+     * to indicate the severity of each Toast
+     * @default "primary"
+     */
     severity?: Severity;
     /** the title of the Toast*/
     title: string;
     /** description of the Toast located underneath the title*/
     description: string;
-    /** the icon located to the left of the Toast*/
+    /**
+     * the icon located to the left of the Toast
+     * @default "an 'i' in a circle"
+     */
     icon?: ReactNode;
-    /** if toast generated by user action, set type to foreground, otherwise set type to background*/
-    type?: RadixToast.ToastProps["type"];
-    /** duration that the specific instance of Toast is visible for*/
-    duration?: RadixToast.ToastProps["duration"];
+    /**
+     * duration that the specific instance of Toast is visible for (in milliseconds)
+     * @default 5000
+     */
+    duration?: RadixToastProps["duration"];
     /** a callback that will trigger when the Toast is closed */
     onClose?: () => void;
+    /**
+     * Control the sensitivity of the toast for screen readers.
+     * For toasts that are the result of a user action, choose `foreground`.
+     * Toasts generated from background tasks (ex: Update available) should use `background`.
+     * @default "foreground"
+     */
+    sensitivity?: RadixToastProps["type"];
 }
-export interface ToastContextProviderProps extends ToastProviderProps, Omit<RadixToast.ToastViewportProps, "label" | "asChild"> {
-    /** a class that will be applied to the ol element responsible for listing the Toasts */
-    viewportClass?: string;
-}
-export interface SimpleToastMessage {
-    title: string;
-    description: string;
-    type?: RadixToast.ToastProps["type"];
-    duration?: number;
+export interface ToastContextProviderProps extends ToastProviderProps, Omit<ToastViewportProps, "label" | "asChild"> {
 }
+export type SimpleToastProps = Omit<ToastProps, "severity">;
 export interface IToastContext {
     showToast: (toastMessage: ToastProps) => void;
-    showPrimary: (simpleMessage: SimpleToastMessage) => void;
-    showSuccess: (simpleMessage: SimpleToastMessage) => void;
-    showInfo: (simpleMessage: SimpleToastMessage) => void;
-    showError: (simpleMessage: SimpleToastMessage) => void;
+    showPrimary: (simpleMessage: SimpleToastProps) => void;
+    showSuccess: (simpleMessage: SimpleToastProps) => void;
+    showInfo: (simpleMessage: SimpleToastProps) => void;
+    showError: (simpleMessage: SimpleToastProps) => void;
 }