@vuu-ui/vuu-notifications 3.3.9 → 3.3.10

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.3.9",
+  "version": "3.3.10",
   "description": "VUU notifications - Toast, WorkspaceNotification etc",
   "main": "./src/index.js",
   "author": "heswell",
@@ -13,8 +13,8 @@
     "@salt-ds/core": "1.54.1",
     "@salt-ds/styles": "0.2.1",
     "@salt-ds/window": "0.1.1",
-    "@vuu-ui/vuu-ui-controls": "3.3.9",
-    "@vuu-ui/vuu-utils": "3.3.9"
+    "@vuu-ui/vuu-ui-controls": "3.3.10",
+    "@vuu-ui/vuu-utils": "3.3.10"
   },
   "peerDependencies": {
     "clsx": "^2.0.0",

package/types/src/NotificationsCenter.d.ts

@@ -0,0 +1,6 @@
+import { NotificationsContextProps, ToastNotificationDescriptor } from "./NotificationsContext";
+export interface NotificationsCenterProps {
+    notificationsContext: NotificationsContextProps;
+    startupToastNotification?: ToastNotificationDescriptor;
+}
+export declare const NotificationsCenter: ({ notificationsContext, startupToastNotification, }: NotificationsCenterProps) => import("react").JSX.Element;

package/types/src/NotificationsContext.d.ts

@@ -0,0 +1,47 @@
+import type { ValidationStatus } from "@salt-ds/core";
+import type { ValueOf } from "@vuu-ui/vuu-utils";
+import type { ReactNode } from "react";
+export type DispatchShowNotification = (notification: Notification) => string | undefined;
+export type DispatchHideNotification = (id?: string) => void;
+export declare const NotificationType: {
+    readonly Toast: "toast";
+    readonly Workspace: "workspace";
+};
+export type NotificationType = ValueOf<typeof NotificationType>;
+export type DismissalStyle = "automatic" | "manual";
+export type NotificationAnimationType = "slide-in" | "slide-out" | "slide-in,slide-out";
+interface NotificationDescriptorBase<T extends NotificationType> {
+    animationType?: NotificationAnimationType;
+    /**
+     * 'automatic' dismissal means the Notification will be removed after a configurable delay
+     * (6 seconds by default). 'manual' means a close button will be rendered and user must
+     * manually dismiss by clicking the close button.
+     */
+    dismissal?: DismissalStyle;
+    /**
+     * A custom icon can be provided or false can be used to suppress rendering of any icon.
+     * Default icons will be rendered for the different status values.
+     */
+    icon?: string | false;
+    renderPostRefresh?: boolean;
+    showCloseButton?: boolean;
+    status: ValidationStatus;
+    type: T;
+}
+export interface ToastNotificationDescriptor extends NotificationDescriptorBase<"toast"> {
+    className?: string;
+    content?: ReactNode;
+    header: string;
+}
+export interface WorkspaceNotificationDescriptor extends NotificationDescriptorBase<"workspace"> {
+    content: ReactNode;
+}
+export type Notification = ToastNotificationDescriptor | WorkspaceNotificationDescriptor;
+export declare const isToastNotification: (n: Notification) => n is ToastNotificationDescriptor;
+export declare const isWorkspaceNotification: (n: Notification) => n is WorkspaceNotificationDescriptor;
+export type NotificationsContextProps = {
+    hideNotification: DispatchHideNotification;
+    showNotification: DispatchShowNotification;
+    setNotify: (showNotificationDispatcher: DispatchShowNotification, hideNotificationDispatcher: DispatchHideNotification) => void;
+};
+export {};

package/types/src/NotificationsProvider.d.ts

@@ -0,0 +1,9 @@
+import React, { type ReactElement } from "react";
+import type { DispatchHideNotification, DispatchShowNotification } from "./NotificationsContext";
+export declare const NotificationsProvider: (props: {
+    children: ReactElement | ReactElement[];
+}) => React.JSX.Element;
+export declare const useNotifications: () => {
+    hideNotification: DispatchHideNotification;
+    showNotification: DispatchShowNotification;
+};

package/types/src/ToastNotification.d.ts

@@ -0,0 +1,15 @@
+import type { ToastNotificationDescriptor } from "./NotificationsContext";
+export type ToastHoverHandler = (id?: string) => void;
+export type ToastNotificationProps = {
+    hidden?: boolean;
+    id?: string;
+    left?: number;
+    notification: ToastNotificationDescriptor;
+    onMeasured?: (id: string, height: number, width: number) => void;
+    onDismiss?: (id?: string) => void;
+    onHoverEntry?: ToastHoverHandler;
+    onHoverExit?: ToastHoverHandler;
+    opacity?: number;
+    top?: number;
+};
+export declare const ToastNotification: ({ hidden, id, left, onDismiss, onMeasured, top, notification, onHoverEntry, onHoverExit, opacity, }: ToastNotificationProps) => import("react").JSX.Element;

package/types/src/WorkspaceNotification.d.ts

@@ -0,0 +1,5 @@
+import { HTMLAttributes, ReactNode } from "react";
+export interface WorkspaceNotificationProps extends HTMLAttributes<HTMLDivElement> {
+    children: ReactNode;
+}
+export declare const WorkspaceNotification: ({ children, className, style: styleProp, ...htmlAttributes }: WorkspaceNotificationProps) => import("react").JSX.Element;

package/types/src/index.d.ts

@@ -0,0 +1,3 @@
+export { NotificationType, type Notification, type NotificationAnimationType, } from "./NotificationsContext";
+export { NotificationsProvider, useNotifications, } from "./NotificationsProvider";
+export { ToastNotification, type ToastNotificationProps, } from "./ToastNotification";