@ldkj/web-ui 0.17.0 → 0.18.0

package/components/interact/notification/Notification.d.ts

@@ -1,6 +1,21 @@
+import type { NotificationOffset, NotificationOptions, NotificationPlacement } from "./types";
+export interface NotificationFacadeConfig {
+    placement?: NotificationPlacement;
+    duration?: number;
+    closable?: boolean;
+    offset?: NotificationOffset;
+}
+/**
+ * 全局 notification facade。请先挂载 NotificationProvider，再在任意业务模块调用。
+ */
 export declare const notification: {
-    info(message: string): string;
-    success(message: string): string;
-    warn(message: string): string;
-    error(message: string): string;
+    open(options: NotificationOptions): string;
+    info(options: NotificationOptions | string): string;
+    success(options: NotificationOptions | string): string;
+    warn(options: NotificationOptions | string): string;
+    error(options: NotificationOptions | string): string;
+    dismiss(id: string): void;
+    clear(): void;
+    config(config: NotificationFacadeConfig): void;
+    resetConfig(): void;
 };

package/components/interact/notification/NotificationProvider.d.ts

@@ -0,0 +1,27 @@
+import * as React from "react";
+import type { NotificationOffset, NotificationOptions, NotificationPlacement } from "./types";
+import "./notification.css";
+export interface NotificationProviderProps {
+    children?: React.ReactNode;
+    placement?: NotificationPlacement;
+    duration?: number;
+    queueLimit?: number;
+    offset?: NotificationOffset;
+    closable?: boolean;
+}
+export declare function NotificationProvider(props: NotificationProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare namespace NotificationProvider {
+    var displayName: string;
+}
+/**
+ * 获取当前 NotificationProvider 提供的通知 API。
+ */
+export declare function useNotification(): {
+    open: (options: NotificationOptions) => string;
+    info: (options: NotificationOptions | string) => string;
+    success: (options: NotificationOptions | string) => string;
+    warn: (options: NotificationOptions | string) => string;
+    error: (options: NotificationOptions | string) => string;
+    dismiss: (id: string) => void;
+    clear: () => void;
+};

package/components/interact/notification/bridge.d.ts

@@ -0,0 +1,3 @@
+import type { NotificationContextValue } from "./types";
+export declare function setNotificationBridge(next: NotificationContextValue | null): void;
+export declare function getNotificationBridge(): NotificationContextValue | null;

package/components/interact/notification/index.d.ts

@@ -1 +1,3 @@
-export * from './Notification';
+export * from "./Notification";
+export * from "./NotificationProvider";
+export * from "./types";

package/components/interact/notification/types.d.ts

@@ -0,0 +1,39 @@
+import type * as React from "react";
+export type NotificationType = "info" | "success" | "warn" | "error";
+export type NotificationPlacement = "rightTop" | "rightBottom" | "leftTop" | "leftBottom" | "center";
+export type NotificationOffset = number | {
+    top?: number;
+    right?: number;
+    bottom?: number;
+    left?: number;
+};
+export type NotificationCustomSvg = React.ComponentType<React.SVGProps<SVGSVGElement> & {
+    title?: string;
+}>;
+export type NotificationIconOption = string | {
+    svg?: NotificationCustomSvg;
+    src?: string;
+};
+export interface NotificationOptions {
+    id?: string;
+    message: React.ReactNode;
+    description?: React.ReactNode;
+    content?: React.ReactNode;
+    actions?: React.ReactNode;
+    duration?: number;
+    placement?: NotificationPlacement;
+    offset?: NotificationOffset;
+    closable?: boolean;
+    icon?: NotificationIconOption;
+    iconColor?: string;
+    onClose?: () => void;
+}
+export interface NotificationCreateInput extends NotificationOptions {
+    type?: NotificationType;
+}
+export type NotificationShortcutInput = string | NotificationOptions;
+export interface NotificationContextValue {
+    push: (input: NotificationCreateInput) => string;
+    dismiss: (id: string) => void;
+    clear: () => void;
+}