@next-bricks/presentational-bricks 1.338.1 → 1.339.1

package/dist/stories.json

@@ -5346,12 +5346,12 @@
       "id": "presentational-bricks.brick-result",
       "name": "presentational-bricks.brick-result",
       "dockind": "brick",
-      "description": "结果页面，可配置其状态，标题，次要标题和自定义图标",
+      "description": "结果页面，支持三种状态类型：基础结果状态（success/error/info/warning/404/403/500）、空结果状态（empty/no-data/search-empty 等）和自定义插画状态（illustrations），可配置主标题、次标题、自定义图标及插画",
       "author": "ice",
       "slots": [
         {
           "name": "content",
-          "description": " 提供 content 插槽"
+          "description": " 提供 content 插槽，用于在结果页面下方放置自定义内容（如操作按钮、链接等）"
         }
       ],
       "history": [
@@ -5367,7 +5367,7 @@
           "type": "BrickResultStatus | EmptyResultStatus | IllustrationsStatus",
           "required": "true",
           "default": "-",
-          "description": "结果的状态, 决定图标和颜色；设置的值必须符合类型要求，否则返回空元素",
+          "description": "结果的状态，决定图标和颜色。支持三类值：BrickResultStatus（success/error/info/warning/404/403/500）显示 Ant Design 内置结果图标；EmptyResultStatus（empty/no-data/search-empty 等）显示空状态插画；设为 \"illustrations\" 时使用 illustrationsConfig 配置自定义插画。设置的值不符合任何类型时返回空元素",
           "group": "basic"
         },
         {
@@ -5397,7 +5397,7 @@
           "type": "IllustrationsConfig",
           "required": "false",
           "default": "{}",
-          "description": "自定义插画配置，size默认为middle，推荐使用size控制插画尺寸，可通过imageStyle覆盖size实现自定义大小（不推荐）",
+          "description": "自定义插画配置，仅当 status 为 \"illustrations\" 时生效。可通过 name 和 category 指定插画库图片，size 控制尺寸（默认 middle），imageStyle 覆盖样式（不推荐）",
           "group": "other"
         },
         {
@@ -5405,14 +5405,14 @@
           "type": "boolean",
           "required": "false",
           "default": "true",
-          "description": "在插画库的default分类下，使用新版本的图标替换default分类下图标",
+          "description": "是否使用新版插画替换插画库 default 分类下的图标，需配合特性开关 support-new-illustrations 及应用配置 supportNewIllustrations 启用",
           "group": "other"
         },
         {
           "name": "emptyResultSize",
           "type": "IconSize",
           "required": "false",
-          "description": "status为EmptyResultStatus时，设置插画的尺寸",
+          "description": "空结果插画的尺寸，仅当 status 为 EmptyResultStatus 类型时生效，可选值：small/middle/large/xlarge/unset，默认 middle",
           "group": "other"
         }
       ],
@@ -9853,13 +9853,13 @@
       "id": "presentational-bricks.brick-user",
       "name": "presentational-bricks.brick-user",
       "dockind": "brick",
-      "description": "展示用户头像加用户名",
+      "description": "展示用户头像和用户名的构件，支持昵称显示、showKey 显示、自定义 Tooltip 及头像大小和形状配置",
       "author": "ice",
       "slots": null,
       "history": [
         {
           "version": "1.152.0",
-          "change": "新属性 `shwNickname`"
+          "change": "新属性 `showNickname`"
         },
         {
           "version": "1.62.0",
@@ -9932,7 +9932,7 @@
         },
         {
           "name": "showNickname",
-          "type": "\"boolean\"",
+          "type": "boolean",
           "required": "false",
           "default": "false",
           "deprecated": true,
@@ -9940,24 +9940,24 @@
         },
         {
           "name": "showNicknameOrUsername",
-          "type": "\"boolean\"",
+          "type": "boolean",
           "required": "false",
           "default": "false",
           "description": "当有昵称时显示昵称，无昵称时显示用户名"
         },
         {
           "name": "displayShowKey",
-          "type": "\"boolean\"",
+          "type": "boolean",
           "required": "false",
           "default": "false",
-          "description": "是否显示 `showKey` ，如果有则显示`alan(hero)` or `alan`"
+          "description": "是否显示 showKey，启用后当用户拥有 showKey 时显示为 `name(showKey)` 格式（如 `alan(hero)`），否则仅显示用户名"
         },
         {
           "name": "iconMargin",
-          "type": "\"number\" | \"string\"",
+          "type": "number | string",
           "required": "false",
           "default": "0",
-          "description": "icon间距",
+          "description": "头像与用户名之间的间距，支持数字（像素）或 CSS 字符串（如 `\"0 8px\"`）",
           "group": "ui"
         },
         {
@@ -9965,7 +9965,7 @@
           "type": "string",
           "required": "false",
           "default": "-",
-          "description": "自定义toolTip替换字符串 例如：\"发起人：#{name}\"",
+          "description": "自定义 Tooltip 替换字符串，支持 `#{name}` 和 `#{showKey}` 占位符，例如 `\"发起人：#{name}\"`",
           "group": "basic"
         }
       ],
@@ -10495,7 +10495,7 @@
           "type": "boolean",
           "required": false,
           "default": "false",
-          "description": "文案是否超出隐藏",
+          "description": "文案超出时是否隐藏溢出文本并在鼠标悬停时显示 Tooltip",
           "group": "other"
         },
         {
@@ -10517,8 +10517,8 @@
       "events": [
         {
           "type": "brick-value-mapping.click",
-          "detail": "{ data: any; value: string | number }",
-          "description": "点击事件"
+          "detail": "{ data: 通过 dataSource 传入的附加数据, value: 当前映射的原始值 }",
+          "description": "点击事件，需设置 `triggerClickEvent` 为 true 才会触发"
         }
       ],
       "interface": []
@@ -12663,7 +12663,7 @@
       "id": "presentational-bricks.cost-time",
       "name": "presentational-bricks.cost-time",
       "dockind": "brick",
-      "description": "如：15秒、1天",
+      "description": "耗时展示构件，将毫秒级时间自动转换为人类可读的时间文本（如\"15秒\"、\"1天\"），支持直接传入耗时或通过起止时间自动计算",
       "author": "lynette",
       "slots": null,
       "history": null,
@@ -12680,21 +12680,21 @@
           "name": "startTime",
           "type": "string | number",
           "required": "false",
-          "description": "起始时间",
+          "description": "起始时间，与 endTime 配合使用，当未传入 cost 时自动计算耗时",
           "group": "basic"
         },
         {
           "name": "endTime",
           "type": "string | number",
           "required": "false",
-          "description": "结束时间",
+          "description": "结束时间，与 startTime 配合使用，当未传入 cost 时自动计算耗时",
           "group": "basic"
         },
         {
           "name": "unitStyle",
           "type": "CSSProperties",
           "required": "false",
-          "description": "单位样式",
+          "description": "时间单位文本的自定义样式，设置后将使用自定义渲染逻辑而非默认的 costTime 函数",
           "group": "ui"
         },
         {
@@ -12969,9 +12969,9 @@
         },
         {
           "name": "format",
-          "type": "number",
+          "type": "string",
           "required": "false",
-          "description": "日期格式",
+          "description": "自定义日期显示格式，例如 \"YYYY-MM-DD HH:mm:ss\"",
           "group": "other"
         },
         {
@@ -14643,7 +14643,7 @@
           "name": "href",
           "type": "string",
           "required": "false",
-          "description": "是否使用原生 <a> 标签，通常用于外链的跳转",
+          "description": "外链地址，使用原生 `<a>` 标签跳转，通常用于外部链接",
           "group": "advanced"
         },
         {
@@ -14665,8 +14665,8 @@
       "events": [
         {
           "type": "label.click",
-          "detail": "any",
-          "description": "点击 label 触发的事件，详情为编排者输入的 dataSource"
+          "detail": "编排者通过 `dataSource` 属性传入的自定义数据（若未设置则回退到已废弃的 `data` 属性）",
+          "description": "点击 label 时触发"
         }
       ],
       "interface": []

package/dist-types/agent-status/index.d.ts

@@ -0,0 +1,24 @@
+export enum AgentStatusType {
+  NORMAL = "正常",
+  ABNORMAL = "异常",
+  NOT_INSTALLED = "未安装",
+  UNINSTALLED = "已卸载",
+  UNDER_MAINTENANCE = "维护中",
+  NORMAL_EN = "Normal",
+  ABNORMAL_EN = "Abnormal",
+  NOT_INSTALLED_EN = "Not Installed",
+  UNINSTALLED_EN = "Uninstalled",
+  UNDER_MAINTENANCE_EN = "Under Maintenance",
+}
+
+export interface AgentStatusProps {
+  dataSource?: any;
+  fields?: { value: string };
+  value?: AgentStatusType;
+}
+
+export declare class AgentStatusElement extends HTMLElement {
+  dataSource: any | undefined;
+  fields: { value: string } | undefined;
+  value: AgentStatusType | undefined;
+}

package/dist-types/avatar-upload/index.d.ts

@@ -0,0 +1,21 @@
+export interface AvatarUploadProps {
+  imgSrc?: string;
+  size?: number;
+  modalOkText?: string;
+  textStyle?: Record<string, any>;
+}
+
+export interface AvatarUploadEvents {
+  "avatar.upload.success": CustomEvent<any>;
+}
+
+export interface AvatarUploadEventsMap {
+  onAvatarUploadSuccess: "avatar.upload.success";
+}
+
+export declare class AvatarUploadElement extends HTMLElement {
+  imgSrc: string | undefined;
+  size: number | undefined;
+  modalOkText: string | undefined;
+  textStyle: Record<string, any> | undefined;
+}

package/dist-types/banner-display-card-list/index.d.ts

@@ -0,0 +1,16 @@
+import type { UseBrickConf } from "@next-core/brick-types";
+
+export interface CardItem {
+  title?: string;
+  content?: string;
+  optionConf?: { useBrick: UseBrickConf };
+  green?: boolean;
+}
+
+export interface BannerDisplayCardListProps {
+  cardList?: CardItem[];
+}
+
+export declare class BannerDisplayCardListElement extends HTMLElement {
+  cardList: CardItem[] | undefined;
+}

package/dist-types/basic-icon/index.d.ts

@@ -0,0 +1,37 @@
+import type { MenuIcon } from "@next-core/brick-types";
+import type React from "react";
+
+export type ImgIcon = {
+  imgSrc?: string;
+  imgStyle?: React.CSSProperties;
+};
+
+export interface BasicIconProps {
+  icon?: MenuIcon | ImgIcon;
+  size?: string;
+  renderBg?: boolean;
+  showWhenHover?: boolean;
+  bg?: string;
+  bgSize?: string;
+  bgBorderRadius?: string;
+  dataSource?: unknown;
+}
+
+export interface BasicIconEvents {
+  "icon.click": CustomEvent<any>;
+}
+
+export interface BasicIconEventsMap {
+  onIconClick: "icon.click";
+}
+
+export declare class BasicIconElement extends HTMLElement {
+  icon: MenuIcon | ImgIcon | undefined;
+  size: string | undefined;
+  renderBg: boolean | undefined;
+  showWhenHover: boolean | undefined;
+  bg: string | undefined;
+  bgSize: string | undefined;
+  bgBorderRadius: string | undefined;
+  dataSource: unknown | undefined;
+}

package/dist-types/basic-progress/index.d.ts

@@ -0,0 +1,55 @@
+export interface ColorObj {
+  /**
+   * 进度范围最大值，值（value）小于等于最大值则为该颜色
+   */
+  progress: string | number;
+  /**
+   * 颜色
+   */
+  color: Color;
+}
+
+export enum Color {
+  green = "green",
+  red = "red",
+  blue = "blue",
+  orange = "orange",
+  cyan = "cyan",
+  purple = "purple",
+  geekblue = "geekblue",
+  gray = "gray",
+  slategray = "slategray",
+  doderblue = "doderblue",
+  royalblue = "royalblue",
+  lightorange = "lightorange",
+  goldenrod = "goldenrod",
+  jewelryblue = "jewelryblue",
+  orangered = "orangered",
+  springgreen = "springgreen",
+  mediumpurple = "mediumpurple",
+  skyblue = "skyblue",
+  yellowgreen = "yellowgreen",
+  lightpurple = "lightpurple",
+}
+
+export interface BasicProgressProps {
+  value?: number;
+  type?: "line" | "circle" | "dashboard";
+  text?: string;
+  description?: string;
+  textColor?: string;
+  colorMap?: ColorObj[];
+  fontSize?: string;
+  configProps?: Record<string, any>;
+}
+
+export declare class BasicProgressElement extends HTMLElement {
+  value: number | undefined;
+  type: "line" | "circle" | "dashboard" | undefined;
+  text: string | undefined;
+  description: string | undefined;
+  textColor: string | undefined;
+  colorMap: ColorObj[] | undefined;
+  fontSize: string | undefined;
+  configProps: Record<string, any> | undefined;
+}

package/dist-types/bootstrap.d.ts

@@ -0,0 +1,78 @@
+import "./agent-status/index.js";
+import "./avatar-upload/index.js";
+import "./banner-display-card-list/index.js";
+import "./basic-icon/index.js";
+import "./basic-progress/index.js";
+import "./brick-alert/index.js";
+import "./brick-alert-level/index.js";
+import "./brick-alert-number/index.js";
+import "./brick-alert-status/index.js";
+import "./brick-alert-value/index.js";
+import "./brick-button/index.js";
+import "./brick-calendar/index.js";
+import "./brick-cluster-type/index.js";
+import "./brick-code-display/index.js";
+import "./brick-collapse-card/index.js";
+import "./brick-conditional-display/index.js";
+import "./brick-delete-confirm/index.js";
+import "./brick-descriptions/index.js";
+import "./brick-display-structs/index.js";
+import "./brick-divider/index.js";
+import "./brick-form/index.js";
+import "./brick-general-search/index.js";
+import "./brick-humanize-time/index.js";
+import "./brick-illustration/index.js";
+import "./brick-input/index.js";
+import "./brick-link/index.js";
+import "./brick-list/index.js";
+import "./brick-placeholder/index.js";
+import "./brick-quick-entries/index.js";
+import "./brick-rate/index.js";
+import "./brick-result/index.js";
+import "./brick-table/index.js";
+import "./brick-tag/index.js";
+import "./brick-timeline/index.js";
+import "./brick-tree/index.js";
+import "./brick-user/index.js";
+import "./brick-user-group/index.js";
+import "./brick-utils/index.js";
+import "./brick-value-mapping/index.js";
+import "./button-wrapper/index.js";
+import "./card-item/index.js";
+import "./code-editor/index.js";
+import "./collapse-info-list/index.js";
+import "./collapsible-card-item/index.js";
+import "./copyable-text/index.js";
+import "./cost-time/index.js";
+import "./crontab-display/index.js";
+import "./datetime-selector/index.js";
+import "./digital-number/index.js";
+import "./dropdown-button/index.js";
+import "./dropdown-select/index.js";
+import "./dynamic-content/index.js";
+import "./dynamic-grid-container/index.js";
+import "./entry-card-item/index.js";
+import "./general-badge/index.js";
+import "./general-carousel/index.js";
+import "./general-image/index.js";
+import "./general-label/index.js";
+import "./general-list/index.js";
+import "./general-pagination/index.js";
+import "./general-preview-image/index.js";
+import "./general-slider/index.js";
+import "./general-tooltip/index.js";
+import "./general-transfer/index.js";
+import "./general-video/index.js";
+import "./info-display-card-list/index.js";
+import "./log-display/index.js";
+import "./markdown-display/index.js";
+import "./markdown-editor/index.js";
+import "./modal-confirm/index.js";
+import "./qrcode-download/index.js";
+import "./rank-table/index.js";
+import "./single-field-edit/index.js";
+import "./statistic-card/index.js";
+import "./table-transfer/index.js";
+import "./template-breadcrumb/index.js";
+import "./text-collapse/index.js";
+import "./tree-transfer/index.js";

package/dist-types/brick-alert/index.d.ts

@@ -0,0 +1,38 @@
+import type { CSSProperties } from "react";
+export type AlertType = "success" | "error" | "info" | "warning";
+
+export interface BrickAlertProps {
+  message?: string;
+  messageStyle?: CSSProperties;
+  description?: string;
+  type?: AlertType;
+  showIcon?: boolean;
+  closable?: boolean;
+  enableDescSlot?: boolean;
+  enableMessageSlot?: boolean;
+  enableActionSlot?: boolean;
+  localStorageKey?: string;
+  stripLocalStorageUrlSuffix?: boolean;
+  foldDesc?: boolean;
+  foldDescLabel?: string;
+  noBorderRadio?: boolean;
+  iconSize?: "big" | "small" | "default";
+}
+
+export declare class BrickAlertElement extends HTMLElement {
+  message: string | undefined;
+  messageStyle: CSSProperties | undefined;
+  description: string | undefined;
+  type: AlertType | undefined;
+  showIcon: boolean | undefined;
+  closable: boolean | undefined;
+  enableDescSlot: boolean | undefined;
+  enableMessageSlot: boolean | undefined;
+  enableActionSlot: boolean | undefined;
+  localStorageKey: string | undefined;
+  stripLocalStorageUrlSuffix: boolean | undefined;
+  foldDesc: boolean | undefined;
+  foldDescLabel: string | undefined;
+  noBorderRadio: boolean | undefined;
+  iconSize: "big" | "small" | "default" | undefined;
+}

package/dist-types/brick-alert-level/index.d.ts

@@ -0,0 +1,13 @@
+export type AlertLevel = 0 | 1 | 2 | "info" | "warning" | "critical";
+
+export interface BrickAlertLevelProps {
+  value?: AlertLevel;
+  dataSource?: Record<string, any>;
+  fields?: { value: string };
+}
+
+export declare class BrickAlertLevelElement extends HTMLElement {
+  value: AlertLevel | undefined;
+  dataSource: Record<string, any> | undefined;
+  fields: { value: string } | undefined;
+}

package/dist-types/brick-alert-number/index.d.ts

@@ -0,0 +1,7 @@
+export interface BrickAlertNumberProps {
+  value?: number;
+}
+
+export declare class BrickAlertNumberElement extends HTMLElement {
+  value: number | undefined;
+}

package/dist-types/brick-alert-status/index.d.ts

@@ -0,0 +1,17 @@
+export interface BrickAlertStatusProps {
+  status?: number;
+  recoverType?: string;
+  isRecover?: boolean;
+  dataSource?: any;
+  fields?: { status: string; recoverType: string; isRecover: string };
+}
+
+export declare class BrickAlertStatusElement extends HTMLElement {
+  status: number | undefined;
+  recoverType: string | undefined;
+  isRecover: boolean | undefined;
+  dataSource: any | undefined;
+  fields:
+    | { status: string; recoverType: string; isRecover: string }
+    | undefined;
+}

package/dist-types/brick-alert-value/index.d.ts

@@ -0,0 +1,9 @@
+import type { MonitorModels } from "@next-sdk/monitor-sdk";
+
+export interface BrickAlertValueProps {
+  dataSource?: MonitorModels.ModelAlertEvent;
+}
+
+export declare class BrickAlertValueElement extends HTMLElement {
+  dataSource: MonitorModels.ModelAlertEvent | undefined;
+}

package/dist-types/brick-button/index.d.ts

@@ -0,0 +1,11 @@
+import type { ButtonProps } from "antd/lib/button";
+
+export interface BrickButtonProps {
+  text?: string;
+  configProps?: ButtonProps & { icon?: string };
+}
+
+export declare class BrickButtonElement extends HTMLElement {
+  text: string | undefined;
+  configProps: (ButtonProps & { icon?: string }) | undefined;
+}

package/dist-types/brick-calendar/index.d.ts

@@ -0,0 +1,49 @@
+import type { CalendarMode } from "antd/lib/calendar/generateCalendar";
+import type { UseBrickConf } from "@next-core/brick-types";
+
+export interface PanelEvent {
+  /** 日期 */
+  date: moment.Moment;
+  /** 显示模式 month/year */
+  mode: CalendarMode;
+}
+
+export interface BrickCalendarProps {
+  value?: moment.Moment;
+  mode?: CalendarMode;
+  fullscreen?: boolean;
+  dateCell?: { useBrick: UseBrickConf };
+  monthCell?: { useBrick: UseBrickConf };
+  data?: any[];
+}
+
+export interface BrickCalendarEvents {
+  "presentational.calendar.onSelect": CustomEvent<moment.Moment>;
+  "presentational.calendar.onSelect-v2": CustomEvent<{
+    date: moment.Moment;
+    data: any;
+  }>;
+  "presentational.calendar.onChange": CustomEvent<moment.Moment>;
+  "presentational.calendar.onChange-v2": CustomEvent<{
+    date: moment.Moment;
+    data: any;
+  }>;
+  "presentational.calendar.onPanelChange": CustomEvent<PanelEvent>;
+}
+
+export interface BrickCalendarEventsMap {
+  onPresentationalCalendarOnSelect: "presentational.calendar.onSelect";
+  onPresentationalCalendarOnSelectV2: "presentational.calendar.onSelect-v2";
+  onPresentationalCalendarOnChange: "presentational.calendar.onChange";
+  onPresentationalCalendarOnChangeV2: "presentational.calendar.onChange-v2";
+  onPresentationalCalendarOnPanelChange: "presentational.calendar.onPanelChange";
+}
+
+export declare class BrickCalendarElement extends HTMLElement {
+  value: moment.Moment | undefined;
+  mode: CalendarMode | undefined;
+  fullscreen: boolean | undefined;
+  dateCell: { useBrick: UseBrickConf } | undefined;
+  monthCell: { useBrick: UseBrickConf } | undefined;
+  data: any[] | undefined;
+}

package/dist-types/brick-cluster-type/index.d.ts

@@ -0,0 +1,17 @@
+export type ClusterType = "-1" | "0" | "1" | "2" | "3";
+
+export interface BrickClusterTypeProps {
+  objectId?: string;
+  value?: ClusterType;
+  dataSource?: Record<string, any>;
+  fields?: { value: string };
+  showBg?: boolean;
+}
+
+export declare class BrickClusterTypeElement extends HTMLElement {
+  objectId: string | undefined;
+  value: ClusterType | undefined;
+  dataSource: Record<string, any> | undefined;
+  fields: { value: string } | undefined;
+  showBg: boolean | undefined;
+}

package/dist-types/brick-code-display/index.d.ts

@@ -0,0 +1,15 @@
+export interface BrickCodeDisplayProps {
+  language?: string;
+  showLineNumber?: boolean;
+  value?: string;
+  field?: string;
+  dataSource?: any;
+}
+
+export declare class BrickCodeDisplayElement extends HTMLElement {
+  language: string | undefined;
+  showLineNumber: boolean | undefined;
+  value: string | undefined;
+  field: string | undefined;
+  dataSource: any | undefined;
+}

package/dist-types/brick-collapse-card/index.d.ts

@@ -0,0 +1,46 @@
+import type { MenuIcon } from "@next-core/brick-types";
+
+export interface descriptionsItemProps {
+  label: string;
+  text: string;
+}
+
+export interface BrickCollapseCardProps {
+  cardTitle?: string;
+  descriptionList?: descriptionsItemProps[];
+  expandInactiveText?: any;
+  expandActiveText?: any;
+  expandActiveIcon?: string;
+  expandInactiveIcon?: string;
+  titleIcon?: MenuIcon | string;
+  titleWithIconAndDesc?: boolean | "compact";
+  isActive?: boolean;
+  hasHeaderSlot?: boolean;
+  containerStyle?: any;
+  headerStyle?: any;
+  contentStyle?: any;
+  verticalCenter?: boolean;
+  title?: string;
+  fields?: { dataSource?: string; title: string };
+  dataSource?: Record<string, any>;
+}
+
+export declare class BrickCollapseCardElement extends HTMLElement {
+  cardTitle: string | undefined;
+  descriptionList: descriptionsItemProps[] | undefined;
+  expandInactiveText: any | undefined;
+  expandActiveText: any | undefined;
+  expandActiveIcon: string | undefined;
+  expandInactiveIcon: string | undefined;
+  titleIcon: MenuIcon | string | undefined;
+  titleWithIconAndDesc: boolean | "compact" | undefined;
+  isActive: boolean | undefined;
+  hasHeaderSlot: boolean | undefined;
+  containerStyle: any | undefined;
+  headerStyle: any | undefined;
+  contentStyle: any | undefined;
+  verticalCenter: boolean | undefined;
+  title: string;
+  fields: { dataSource?: string; title: string } | undefined;
+  dataSource: Record<string, any> | undefined;
+}