@cloudtower/eagle 490.0.11 → 490.0.12

package/dist/src/core/Alert/__test__/Alert.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/core/Alert/alert.style.d.ts

@@ -0,0 +1,2 @@
+export declare const MessageWrapperStyle: import("@linaria/core").LinariaClassName;
+export declare const AlertStyle: import("@linaria/core").LinariaClassName;

package/dist/src/core/Alert/alert.type.d.ts

@@ -1,8 +1,57 @@
 /// <reference types="react" />
 import { AlertProps as AntdAlertProps } from "antd/lib/alert";
+export interface ExpandableConfig {
+    /** 默认展开状态（非受控模式） */
+    defaultExpanded?: boolean;
+    /** 展开状态（受控模式），传入后组件变为受控 */
+    expanded?: boolean;
+    /** 展开/收起状态变化回调 */
+    onExpandChange?: (expanded: boolean) => void;
+}
+/**
+ * 提示框组件 Props，基于 antd Alert 封装。
+ *
+ * @description
+ * 用于页面内的警告或提示信息展示，支持 info / error / warning / success / normal 五种类型。
+ * 扩展了 action 操作区、展开/收起等功能。
+ *
+ * @example
+ * ```tsx
+ * import React from "react";
+ * import Alert from "@cloudtower/eagle/Alert";
+ *
+ * // 基本用法
+ * <Alert type="info" message="集群升级已完成。" />
+ * ```
+ *
+ * @example
+ * ```tsx
+ * import React from "react";
+ * import Alert from "@cloudtower/eagle/Alert";
+ *
+ * // 带展开/收起
+ * <Alert
+ *   type="info"
+ *   message="以下服务版本不兼容："
+ *   description={<ul><li>服务 A 需升级至 1.4.5</li></ul>}
+ *   expandConfig={{}}
+ * />
+ * ```
+ *
+ * @see Banner 全局横幅通知，固定在页面顶部
+ * @see message 全局提示，自动消失
+ */
 export type AlertProps = Omit<AntdAlertProps, "type"> & {
+    /** 提示类型，"normal" 为无色信息提示 */
     type?: AntdAlertProps["type"] | "normal";
+    /** 右侧操作区域，渲染在 message 右侧 */
     action?: React.ReactNode;
+    /** 测试标识，透传到根元素 */
     "data-testid"?: string;
+    /**
+     * 启用展开/收起功能。启用后 description 内容在收起状态下隐藏，
+     * 展开后在 message 下方内联展示，不会触发 antd 的 with-description 布局。
+     */
+    expandConfig?: ExpandableConfig;
 };
 export type AlertComponentType = React.FunctionComponent<AlertProps>;

package/dist/src/core/Alert/index.d.ts

@@ -1,4 +1,5 @@
 import { AlertComponentType } from "./alert.type";
 declare const Alert: AlertComponentType;
 export default Alert;
+export * from "./alert.style";
 export * from "./alert.type";

package/dist/stories/docs/core/Alert.stories.d.ts

@@ -1,12 +1,121 @@
 import Alert from "../../../src/core/Alert";
-import { ComponentStory } from "@storybook/react";
-import React from "react";
-declare const _default: import("@storybook/types").ComponentAnnotations<import("@storybook/react/dist/types-0fc72a6d").R, Omit<import("antd/lib/alert").AlertProps, "type"> & {
-    type?: "normal" | "success" | "info" | "warning" | "error" | undefined;
-    action?: React.ReactNode;
-    "data-testid"?: string | undefined;
-} & {
-    children?: React.ReactNode;
-}>;
-export default _default;
-export declare const Basic: ComponentStory<typeof Alert>;
+import type { StoryObj } from "@storybook/react";
+/**
+ * 提示框组件，基于 antd Alert 封装。
+ *
+ * * 支持 info / error / warning / success / normal 五种类型
+ * * 支持 action、closable、expandConfig 等功能
+ * * 更多 props 请参考：https://ant.design/components/alert-cn#api
+ */
+declare const meta: {
+    component: import("../../../src/core/Alert").AlertComponentType;
+    title: "Core/Alert | 提示框";
+    argTypes: {
+        type: {
+            control: string;
+            options: string[];
+            description: string;
+            table: {
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        message: {
+            control: string;
+            description: string;
+        };
+        description: {
+            control: string;
+            description: string;
+        };
+        showIcon: {
+            control: string;
+            description: string;
+            table: {
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        closable: {
+            control: string;
+            description: string;
+            table: {
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        expandConfig: {
+            control: boolean;
+            description: string;
+        };
+        action: {
+            control: boolean;
+            description: string;
+        };
+        "data-testid": {
+            control: string;
+            description: string;
+        };
+    };
+    args: {
+        type: "info";
+        message: string;
+        showIcon: true;
+        closable: false;
+    };
+    parameters: {
+        design: {
+            type: string;
+            url: string;
+        };
+    };
+};
+export default meta;
+type Story = StoryObj<typeof Alert>;
+/**
+ * 通过下方 Controls 面板调整各 Props 查看效果。
+ */
+export declare const Playground: Story;
+/**
+ * 五种类型：info、error、warning、success、normal。
+ */
+export declare const Basic: Story;
+/**
+ * 通过 `action` 属性在右侧添加操作区域。
+ */
+export declare const WithAction: Story;
+/**
+ * 通过 `closable` 或 `onClose` 启用关闭按钮。
+ */
+export declare const Closable: Story;
+/**
+ * 同时使用 `closable` 和 `action`。
+ */
+export declare const ClosableWithAction: Story;
+/**
+ * `message` 支持传入 ReactNode，可自定义复杂内容。
+ */
+export declare const CustomMessage: Story;
+/**
+ * 通过 `expandConfig` 启用展开/收起功能，`description` 内容会被折叠。
+ *
+ * * `expandConfig={{}}` — 非受控模式，默认收起
+ * * `expandConfig={{ defaultExpanded: true }}` — 非受控模式，默认展开
+ * * `expandConfig={{ expanded, onExpandChange }}` — 受控模式
+ */
+export declare const Expandable: Story;
+/**
+ * 设置 `defaultExpanded: true` 使组件初始即为展开状态。
+ */
+export declare const ExpandableDefaultExpanded: Story;
+/**
+ * 通过 `expanded` 和 `onExpandChange` 实现受控模式。
+ */
+export declare const ExpandableControlled: Story;
+/**
+ * `expandConfig` 与 `action` 可同时使用。
+ */
+export declare const ExpandableWithAction: Story;