@next-bricks/presentational 1.21.9 → 1.21.11

package/dist/manifest.json

@@ -29,6 +29,7 @@
         {
           "name": "column",
           "description": "列数",
+          "default": "3",
           "attribute": true,
           "type": "number"
         },
@@ -51,7 +52,7 @@
         },
         {
           "name": "hideGroups",
-          "description": "隐藏的描述列表项",
+          "description": "需要隐藏的分组名称，匹配 list 项的 group 字段，支持字符串或字符串数组",
           "attribute": false,
           "type": "string | string[]"
         },
@@ -179,7 +180,6 @@
         {
           "name": "exportFileName",
           "description": "导出的文件名",
-          "default": "download.txt",
           "type": "string"
         }
       ],
@@ -195,7 +195,7 @@
       "properties": [
         {
           "name": "type",
-          "description": "",
+          "description": "分页模式：`page` 为页码模式，`token` 为令牌（游标）模式",
           "default": "\"page\"",
           "type": "\"page\" | \"token\""
         },
@@ -232,10 +232,12 @@
         },
         {
           "name": "nextToken",
+          "description": "令牌模式下的下一页令牌（nextToken），有值时\"下一页\"按钮可点击",
           "type": "string"
         },
         {
           "name": "previousToken",
+          "description": "令牌模式下的上一页令牌（previousToken），有值时\"上一页\"按钮可点击",
           "type": "string"
         }
       ],
@@ -259,7 +261,7 @@
       "properties": [
         {
           "name": "hasHeader",
-          "description": "是否有顶部小标题",
+          "description": "是否有顶部小标题区域，开启后会显示 `auxiliaryText` 辅助文字",
           "type": "boolean"
         },
         {
@@ -279,7 +281,7 @@
         },
         {
           "name": "avatar",
-          "description": "图标",
+          "description": "图标或图片，支持图标头像（IconAvatar）和图片头像（ImgAvatar）两种形式",
           "attribute": false,
           "type": "IconAvatar | ImgAvatar"
         },
@@ -307,7 +309,7 @@
         },
         {
           "name": "showActions",
-          "description": "展示操作按钮组",
+          "description": "操作按钮组的展示时机，`always` 始终展示，`hover` 悬停时展示",
           "default": "\"always\"",
           "type": "\"always\" | \"hover\""
         },
@@ -346,7 +348,7 @@
         },
         {
           "name": "avatarPosition",
-          "description": "图标是否放置在卡片封面",
+          "description": "头像的放置位置，设为 `cover` 时头像显示在封面区域，否则显示在内容区域",
           "type": "\"content\" | \"cover\""
         },
         {
@@ -357,6 +359,7 @@
         },
         {
           "name": "tagConfig",
+          "description": "徽标配置，可设置文本、图标、背景色和字体颜色",
           "attribute": false,
           "type": "TagConfig"
         },
@@ -415,6 +418,10 @@
           "name": null,
           "description": "内容区域，通常放置卡片自定义内容"
         },
+        {
+          "name": "title-suffix",
+          "description": "标题后缀区域，通常放置状态标签等内容"
+        },
         {
           "name": "expanded-area-1",
           "description": "扩展区域 1，通常放置标签信息"
@@ -476,12 +483,12 @@
       "properties": [
         {
           "name": "cardTitle",
-          "description": "title",
+          "description": "卡片标题",
           "type": "string"
         },
         {
           "name": "description",
-          "description": "description",
+          "description": "卡片描述信息",
           "type": "string"
         },
         {
@@ -491,13 +498,13 @@
         },
         {
           "name": "cardIcon",
-          "description": "图标",
+          "description": "图标配置，支持设置图标、颜色、尺寸、形状和背景色",
           "attribute": false,
           "type": "IconAvatar"
         },
         {
           "name": "detailList",
-          "description": "详细列表",
+          "description": "详细列表，每项可设置标题、描述文字或自定义构件",
           "attribute": false,
           "type": "InfoCardDetail[]"
         },
@@ -511,7 +518,7 @@
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "信息卡片",
+      "description": "信息类卡片 —— 横向布局信息卡片",
       "category": "card-info"
     },
     {
@@ -522,19 +529,19 @@
       "properties": [
         {
           "name": "value",
-          "description": "时间截，或字符串，当为字符串时，应提供时间格式 `inputFormat`",
+          "description": "时间戳（秒或毫秒，由 `isMillisecond` 决定），或时间字符串（字符串类型时应提供 `inputFormat`）",
           "required": true,
           "attribute": false,
           "type": "number | string"
         },
         {
           "name": "inputFormat",
-          "description": "字符串的时间格式，如 \"YYYY-MM-DD\", [时间格式参照表](https://day.js.org/docs/en/parse/string-format)",
+          "description": "字符串类型 `value` 的解析格式，如 \"YYYY-MM-DD\"，[时间格式参照表](https://momentjs.com/docs/#/parsing/string-format/)",
           "type": "string"
         },
         {
           "name": "outputFormat",
-          "description": "展示时间格式，如 \"YYYY-MM-DD\"，当设置该属性时，属性 `formatter` 无效 [时间格式参照表](https://day.js.org/docs/en/display/format)",
+          "description": "自定义输出格式，如 \"YYYY-MM-DD HH:mm:ss\"，设置后 `formatter` 属性无效，[时间格式参照表](https://momentjs.com/docs/#/displaying/format/)",
           "type": "string"
         },
         {
@@ -550,25 +557,25 @@
         },
         {
           "name": "formatter",
-          "description": "格式类型",
-          "default": "\"default\"",
+          "description": "格式类型，可选值：`\"full\"`（完整时间）、`\"default\"`（自动相对/完整）、`\"relative\"`（相对时间，支持过去和未来）、`\"past\"`（仅过去相对时间）、`\"future\"`（仅未来相对时间）、`\"accurate\"`（精确耗时）、`\"auto\"`",
+          "default": "\"auto\"",
           "attribute": false,
           "type": "HumanizeTimeFormat"
         },
         {
           "name": "isMicrosecond",
-          "description": "value 值的单位是否为毫秒（此处属性 id 写错，实际表达意义为 isMillisecond）",
+          "description": "已废弃：`value` 值的单位是否为毫秒（属性名拼写有误，请改用 `isMillisecond`）",
           "deprecated": "请使用 `isMillisecond`",
           "type": "boolean"
         },
         {
           "name": "isMillisecond",
-          "description": "value 值的单位是否为毫秒",
+          "description": "`value` 值的单位是否为毫秒，默认将 `value` 视为秒级时间戳",
           "type": "boolean"
         },
         {
           "name": "link",
-          "description": "跳转链接，默认为空",
+          "description": "将时间显示为可点击链接",
           "attribute": false,
           "type": "LinkInfo"
         }
@@ -599,7 +606,7 @@
         },
         {
           "name": "icon",
-          "description": "图标",
+          "description": "图标，支持 GeneralIconProps 的所有字段，额外支持 `color`（图标颜色）和 `bgColor`（背景色）",
           "attribute": false,
           "type": "EoStatisticsCardProps[\"icon\"]"
         },
@@ -646,7 +653,7 @@
         },
         {
           "name": "titleSuffix",
-          "description": "标题前缀，放置辅助信息"
+          "description": "标题后缀，放置辅助信息"
         },
         {
           "name": "description",
@@ -674,42 +681,42 @@
       "properties": [
         {
           "name": "visible",
-          "description": "是否可见",
+          "description": "",
           "type": "boolean"
         },
         {
           "name": "width",
-          "description": "宽度",
+          "description": "",
           "type": "string"
         },
         {
           "name": "stepTitle",
-          "description": "步骤标题",
+          "description": "",
           "type": "string"
         },
         {
           "name": "stepList",
-          "description": "步骤列表",
+          "description": "",
           "attribute": false,
           "type": "StepItem[]"
         },
         {
           "name": "curStep",
-          "description": "当前步骤",
+          "description": "",
           "type": "string"
         }
       ],
       "events": [
         {
           "name": "open",
-          "description": "打开事件",
+          "description": "",
           "detail": {
             "type": "void"
           }
         },
         {
           "name": "close",
-          "description": "关闭事件",
+          "description": "",
           "detail": {
             "type": "void"
           }
@@ -720,18 +727,18 @@
         {
           "name": "open",
           "params": [],
-          "description": "打开",
+          "description": "",
           "returns": {}
         },
         {
           "name": "close",
           "params": [],
-          "description": "关闭",
+          "description": "",
           "returns": {}
         }
       ],
       "parts": [],
-      "description": "加载步骤框"
+      "description": ""
     },
     {
       "name": "eo-current-time",
@@ -753,7 +760,7 @@
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "构件 `eo-current-time`"
+      "description": "实时当前时间展示构件，每秒自动刷新，支持自定义时间格式和前置图标。"
     },
     {
       "name": "eo-carousel-text",
@@ -793,7 +800,7 @@
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "构件 `eo-carousel-text`"
+      "description": "文字跑马灯构件，文本内容从右向左循环滚动展示，支持自定义速度、字体大小和字体颜色。"
     },
     {
       "name": "eo-code-block",
@@ -803,21 +810,23 @@
       "properties": [
         {
           "name": "language",
+          "description": "代码语言，用于语法高亮，例如 `javascript`、`python`、`yaml` 等",
           "type": "string"
         },
         {
           "name": "source",
+          "description": "代码内容字符串",
           "type": "string"
         },
         {
           "name": "theme",
-          "description": "",
+          "description": "代码高亮主题。`auto` 跟随系统主题自动切换亮色/暗色",
           "default": "\"auto\"",
           "type": "\"auto\" | \"light-plus\" | \"dark-plus\""
         },
         {
           "name": "themeVariant",
-          "description": "主题变体",
+          "description": "主题变体，影响代码块的整体样式风格",
           "type": "\"default\" | \"elevo\""
         },
         {
@@ -848,13 +857,14 @@
           "description": "code-wrapper 构件"
         }
       ],
-      "description": "构件 `eo-code-block`"
+      "description": "代码块展示构件，基于 Shiki 进行语法高亮，支持多种编程语言、亮色/暗色主题自动切换及复制功能。"
     },
     {
       "name": "presentational.code-wrapper",
       "properties": [
         {
           "name": "preProps",
+          "description": "传递给 `<pre>` 元素的额外属性，例如 `className`、`style` 等",
           "attribute": false,
           "type": "React.PropsWithChildren<JSX.IntrinsicElements[\"pre\"]>"
         },
@@ -866,7 +876,7 @@
         },
         {
           "name": "themeVariant",
-          "description": "主题变体",
+          "description": "主题变体，影响复制按钮等内部元素的样式风格。`elevo` 为 Elevo 风格",
           "type": "\"default\" | \"elevo\""
         }
       ],
@@ -883,7 +893,7 @@
           "description": "复制按钮"
         }
       ],
-      "description": "构件 `presentational.code-wrapper`"
+      "description": "代码内容包裹容器，提供统一的代码展示结构并支持一键复制功能。"
     }
   ],
   "providers": []

package/dist/types.json

@@ -179,7 +179,7 @@
               "type": "reference",
               "typeName": {
                 "type": "identifier",
-                "name": "UseBrickConf"
+                "name": "UseBrickConfOrRenderFunction"
               }
             },
             "optional": true,
@@ -1094,7 +1094,7 @@
               "type": "reference",
               "typeName": {
                 "type": "identifier",
-                "name": "UseSingleBrickConf"
+                "name": "UseSingleBrickConfOrRenderFunction"
               }
             },
             "optional": true,

package/dist-types/card-item/index.d.ts

@@ -76,6 +76,7 @@ export interface EoCardItemEventsMapping {
 /**
  * 信息类卡片 —— 通用卡片
  * @slot - 内容区域，通常放置卡片自定义内容
+ * @slot title-suffix - 标题后缀区域，通常放置状态标签等内容
  * @slot expanded-area-1 - 扩展区域 1，通常放置标签信息
  * @slot expanded-area-2 - 扩展区域 2，通常放置操作和其他属性信息（图标/头像/小字描述/统计信息）
  * @category card-info
@@ -83,7 +84,7 @@ export interface EoCardItemEventsMapping {
 export declare class EoCardItem extends ReactNextElement implements EoCardItemProps {
     #private;
     /**
-     * 是否有顶部小标题
+     * 是否有顶部小标题区域，开启后会显示 `auxiliaryText` 辅助文字
      */
     accessor hasHeader: boolean | undefined;
     /**
@@ -99,7 +100,7 @@ export declare class EoCardItem extends ReactNextElement implements EoCardItemPr
      */
     accessor auxiliaryText: string | undefined;
     /**
-     * 图标
+     * 图标或图片，支持图标头像（IconAvatar）和图片头像（ImgAvatar）两种形式
      */
     accessor avatar: IconAvatar | ImgAvatar | undefined;
     /**
@@ -119,7 +120,7 @@ export declare class EoCardItem extends ReactNextElement implements EoCardItemPr
      */
     accessor actions: ActionType[] | undefined;
     /**
-     * 展示操作按钮组
+     * 操作按钮组的展示时机，`always` 始终展示，`hover` 悬停时展示
      */
     accessor showActions: "always" | "hover";
     /**
@@ -147,13 +148,16 @@ export declare class EoCardItem extends ReactNextElement implements EoCardItemPr
      */
     accessor coverImageSize: React.CSSProperties["backgroundSize"] | undefined;
     /**
-     * 图标是否放置在卡片封面
+     * 头像的放置位置，设为 `cover` 时头像显示在封面区域，否则显示在内容区域
      */
     accessor avatarPosition: "content" | "cover";
     /**
      * 图标位置，在 avatarPosition 不为 cover 时有效
      */
     accessor avatarPlacement: "left" | "title-left";
+    /**
+     * 徽标配置，可设置文本、图标、背景色和字体颜色
+     */
     accessor tagConfig: TagConfig | undefined;
     /**
      * 卡片边框颜色

package/dist-types/carousel-text/index.d.ts

@@ -2,7 +2,7 @@ import React, { CSSProperties } from "react";
 import { ReactNextElement } from "@next-core/react-element";
 import "@next-core/theme";
 /**
- * 构件 `eo-carousel-text`
+ * 文字跑马灯构件，文本内容从右向左循环滚动展示，支持自定义速度、字体大小和字体颜色。
  */
 export declare class EoCarouselText extends ReactNextElement {
     /**

package/dist-types/code-block/index.d.ts

@@ -11,7 +11,7 @@ export interface CodeBlockProps {
     showCopyButton?: boolean;
 }
 /**
- * 构件 `eo-code-block`
+ * 代码块展示构件，基于 Shiki 进行语法高亮，支持多种编程语言、亮色/暗色主题自动切换及复制功能。
  *
  * @part pre - 包裹代码内容的 `<pre>` 元素
  * @part copy - 复制按钮
@@ -19,12 +19,21 @@ export interface CodeBlockProps {
  * @part wrapper - code-wrapper 构件
  */
 export declare class CodeBlock extends ReactNextElement implements CodeBlockProps {
+    /**
+     * 代码语言，用于语法高亮，例如 `javascript`、`python`、`yaml` 等
+     */
     accessor language: string | undefined;
+    /**
+     * 代码内容字符串
+     */
     accessor source: string | undefined;
-    /** @default "auto" */
+    /**
+     * 代码高亮主题。`auto` 跟随系统主题自动切换亮色/暗色
+     * @default "auto"
+     */
     accessor theme: "auto" | "light-plus" | "dark-plus" | undefined;
     /**
-     * 主题变体
+     * 主题变体，影响代码块的整体样式风格
      */
     accessor themeVariant: "default" | "elevo" | undefined;
     /**

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

@@ -47,7 +47,6 @@ export declare class CodeDisplay extends ReactNextElement implements CodeDisplay
     accessor showExportButton: boolean | undefined;
     /**
      * 导出的文件名
-     * @default download.txt
      */
     accessor exportFileName: string | undefined;
     render(): React.JSX.Element;

package/dist-types/code-wrapper/index.d.ts

@@ -10,7 +10,9 @@ export interface CodeWrapperProps {
     themeVariant?: "default" | "elevo";
 }
 /**
- * 构件 `presentational.code-wrapper`
+ * 代码内容包裹容器，提供统一的代码展示结构并支持一键复制功能。
+ *
+ * @description 代码内容包裹容器，提供统一的代码展示结构并支持一键复制功能。
  *
  * @internal
  *
@@ -18,6 +20,9 @@ export interface CodeWrapperProps {
  * @part copy - 复制按钮
  */
 export declare class CodeWrapper extends ReactNextElement implements CodeWrapperProps {
+    /**
+     * 传递给 `<pre>` 元素的额外属性，例如 `className`、`style` 等
+     */
     accessor preProps: React.PropsWithChildren<JSX.IntrinsicElements["pre"]> | undefined;
     /**
      * 是否展示复制按钮
@@ -25,7 +30,7 @@ export declare class CodeWrapper extends ReactNextElement implements CodeWrapper
      */
     accessor showCopyButton: boolean | undefined;
     /**
-     * 主题变体
+     * 主题变体，影响复制按钮等内部元素的样式风格。`elevo` 为 Elevo 风格
      */
     accessor themeVariant: "default" | "elevo" | undefined;
     render(): React.JSX.Element;

package/dist-types/current-time/index.d.ts

@@ -7,7 +7,7 @@ export interface CurrentTimeProps {
     icon?: GeneralIconProps;
 }
 /**
- * 构件 `eo-current-time`
+ * 实时当前时间展示构件，每秒自动刷新，支持自定义时间格式和前置图标。
  */
 export declare class EoCurrentTime extends ReactNextElement {
     /**

package/dist-types/descriptions/index.d.ts

@@ -1,14 +1,14 @@
 import React from "react";
 import { ReactNextElement } from "@next-core/react-element";
 import "@next-core/theme";
-import type { UseBrickConf } from "@next-core/types";
+import type { UseBrickConfOrRenderFunction } from "@next-core/react-runtime";
 import "./host-context.css";
 export interface DescriptionItem {
     label: string;
     field?: string;
     group?: string;
     text?: string | number;
-    useBrick?: UseBrickConf;
+    useBrick?: UseBrickConfOrRenderFunction;
     gridColumn?: string;
 }
 type Layout = "horizontal" | "vertical";
@@ -45,6 +45,7 @@ declare class Descriptions extends ReactNextElement {
     accessor showCard: boolean | undefined;
     /**
      * 列数
+     * @default 3
      */
     accessor column: number | undefined;
     /**
@@ -62,7 +63,7 @@ declare class Descriptions extends ReactNextElement {
      */
     accessor bordered: boolean | undefined;
     /**
-     * 隐藏的描述列表项
+     * 需要隐藏的分组名称，匹配 list 项的 group 字段，支持字符串或字符串数组
      */
     accessor hideGroups: string | string[] | undefined;
     /**

package/dist-types/humanize-time/index.d.ts

@@ -22,16 +22,16 @@ export interface EoHumanizeTimeProps {
  */
 export declare class EoHumanizeTime extends ReactNextElement {
     /**
-     * 时间截，或字符串，当为字符串时，应提供时间格式 `inputFormat`
+     * 时间戳（秒或毫秒，由 `isMillisecond` 决定），或时间字符串（字符串类型时应提供 `inputFormat`）
      * @required
      */
     accessor value: number | string;
     /**
-     * 字符串的时间格式，如 "YYYY-MM-DD", [时间格式参照表](https://day.js.org/docs/en/parse/string-format)
+     * 字符串类型 `value` 的解析格式，如 "YYYY-MM-DD"，[时间格式参照表](https://momentjs.com/docs/#/parsing/string-format/)
      */
     accessor inputFormat: string;
     /**
-     * 展示时间格式，如 "YYYY-MM-DD"，当设置该属性时，属性 `formatter` 无效 [时间格式参照表](https://day.js.org/docs/en/display/format)
+     * 自定义输出格式，如 "YYYY-MM-DD HH:mm:ss"，设置后 `formatter` 属性无效，[时间格式参照表](https://momentjs.com/docs/#/displaying/format/)
      */
     accessor outputFormat: string;
     /**
@@ -44,23 +44,23 @@ export declare class EoHumanizeTime extends ReactNextElement {
      */
     accessor isCostTime: boolean;
     /**
-     * 格式类型
+     * 格式类型，可选值：`"full"`（完整时间）、`"default"`（自动相对/完整）、`"relative"`（相对时间，支持过去和未来）、`"past"`（仅过去相对时间）、`"future"`（仅未来相对时间）、`"accurate"`（精确耗时）、`"auto"`
      *
-     * @default "default"
+     * @default "auto"
      */
     accessor formatter: HumanizeTimeFormat;
     /**
-     * value 值的单位是否为毫秒（此处属性 id 写错，实际表达意义为 isMillisecond）
+     * 已废弃：`value` 值的单位是否为毫秒（属性名拼写有误，请改用 `isMillisecond`）
      *
      * @deprecated 请使用 `isMillisecond`
      */
     accessor isMicrosecond: boolean;
     /**
-     * value 值的单位是否为毫秒
+     * `value` 值的单位是否为毫秒，默认将 `value` 视为秒级时间戳
      */
     accessor isMillisecond: boolean;
     /**
-     * 跳转链接，默认为空
+     * 将时间显示为可点击链接
      */
     accessor link: LinkInfo;
     connectedCallback(): void;

package/dist-types/info-card-item/index.d.ts

@@ -1,36 +1,37 @@
 import React, { Ref } from "react";
 import { ReactNextElement } from "@next-core/react-element";
-import { UseSingleBrickConf } from "@next-core/types";
+import { UseSingleBrickConfOrRenderFunction } from "@next-core/react-runtime";
 import "@next-core/theme";
 import type { LinkProps } from "@next-bricks/basic/link";
 import type { GeneralIconProps } from "@next-bricks/icons/general-icon";
 /**
- * 信息卡片
+ * 信息类卡片 —— 横向布局信息卡片
+ * @description 展示带图标、标题、描述和详细列表的横向布局信息卡片，支持链接跳转、插槽图标、标题后缀及操作区。
  * @author dophijing
  * @category card-info
  */
 export declare class EoInfoCardItem extends ReactNextElement implements EoInfoCardItemProps {
     #private;
     /**
-     * title
+     * 卡片标题
      */
     accessor cardTitle: string;
     /**
-     * description
+     * 卡片描述信息
      */
-    accessor description: string;
+    accessor description: string | undefined;
     /**
      * 链接地址
      */
     accessor url: string | undefined;
     /**
-     * 图标
+     * 图标配置，支持设置图标、颜色、尺寸、形状和背景色
      */
     accessor cardIcon: IconAvatar | undefined;
     /**
-     * 详细列表
+     * 详细列表，每项可设置标题、描述文字或自定义构件
      */
-    accessor detailList: InfoCardDetail[];
+    accessor detailList: InfoCardDetail[] | undefined;
     /**
      * 链接跳转目标
      */
@@ -57,7 +58,7 @@ export interface IconAvatar {
 export interface InfoCardDetail {
     title?: string;
     desc?: string;
-    useBrick?: UseSingleBrickConf;
+    useBrick?: UseSingleBrickConfOrRenderFunction;
 }
 export interface EoInfoCardItemProps {
     url?: string;