@sia.soul/sia-react-ui 0.1.18 → 0.1.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/Select-4hGJt3RJ.d.cts +142 -0
  2. package/dist/Select-BNSE67xn.d.ts +142 -0
  3. package/dist/chart.d.cts +2498 -0
  4. package/dist/chart.d.ts +2498 -0
  5. package/dist/{chunk-LPRFOSRZ.js → chunk-3TRRBMXY.js} +45 -10
  6. package/dist/{chunk-JX53ZBIW.js → chunk-7RNS52YG.js} +38 -5
  7. package/dist/{chunk-SUMXP2SF.js → chunk-KLI65JVD.js} +12 -4
  8. package/dist/{chunk-I3EF5SF2.js → chunk-RWGSZW32.js} +1 -1
  9. package/dist/{chunk-UCQZZ2YC.js → chunk-VN6PIPP7.js} +2 -2
  10. package/dist/core-C5OnrCi4.d.cts +2288 -0
  11. package/dist/core-DeZknKwc.d.ts +2288 -0
  12. package/dist/core.cjs +85 -15
  13. package/dist/core.css +18 -1
  14. package/dist/core.d.cts +3 -3
  15. package/dist/core.d.ts +3 -3
  16. package/dist/core.js +3 -3
  17. package/dist/index.cjs +1812 -1571
  18. package/dist/index.css +18 -1
  19. package/dist/index.d.cts +1715 -8
  20. package/dist/index.d.ts +1715 -8
  21. package/dist/index.js +402 -238
  22. package/dist/markdown-editor.d.cts +41 -1
  23. package/dist/markdown-editor.d.ts +41 -1
  24. package/dist/rich-text-editor.cjs +11 -3
  25. package/dist/rich-text-editor.d.cts +46 -1
  26. package/dist/rich-text-editor.d.ts +46 -1
  27. package/dist/rich-text-editor.js +2 -2
  28. package/dist/{select-date-range-Bdb-hi9c.d.ts → select-date-range-CGRb3-W8.d.ts} +116 -2
  29. package/dist/{select-date-range-shDQ5uJA.d.cts → select-date-range-DDmYGDD4.d.cts} +116 -2
  30. package/dist/select-date-range.cjs +44 -9
  31. package/dist/select-date-range.d.cts +3 -3
  32. package/dist/select-date-range.d.ts +3 -3
  33. package/dist/select-date-range.js +3 -3
  34. package/dist/{shared-DAYZvZVu.d.cts → shared-Bx4B28Wh.d.cts} +3 -0
  35. package/dist/{shared-DAYZvZVu.d.ts → shared-Bx4B28Wh.d.ts} +3 -0
  36. package/package.json +1 -1
  37. package/dist/Select-CVvF4mcy.d.cts +0 -57
  38. package/dist/Select-Ce2Irbpt.d.ts +0 -57
  39. package/dist/core-AeKYVPDZ.d.cts +0 -1082
  40. package/dist/core-DcSXqSRs.d.ts +0 -1082
package/dist/index.d.cts CHANGED
@@ -1,905 +1,2088 @@
1
1
  import * as react from 'react';
2
2
  import { HTMLAttributes, ReactNode, CSSProperties, ElementType, FormHTMLAttributes, InputHTMLAttributes, ChangeEvent, TextareaHTMLAttributes, MouseEvent, Key, PointerEvent, Ref, ReactElement, ButtonHTMLAttributes, RefObject } from 'react';
3
- import { O as OverlayContainer, a as OverlayApiHandle, B as ButtonProps, T as TagStatus, b as ButtonSize, c as BadgeProps } from './core-AeKYVPDZ.cjs';
4
- export { d as Badge, e as BadgeRibbonProps, f as BadgeStatus, g as Breadcrumb, h as BreadcrumbItem, i as BreadcrumbProps, j as Button, k as ButtonVariant, C as Calendar, l as CalendarProps, m as Card, n as CardAccent, o as CardProps, p as Carousel, q as CarouselProps, r as CarouselRef, s as Collapse, t as CollapseItem, u as CollapseKey, v as CollapseProps, D as Dropdown, w as DropdownButtonProps, x as DropdownMenuProps, y as DropdownOpenSource, z as DropdownPlacement, A as DropdownProps, E as DropdownTrigger, F as FILLED_ICON_NAMES, G as FilledIconName, H as FloatButton, I as FloatButtonBackTopProps, J as FloatButtonGroupProps, K as FloatButtonProps, L as FloatButtonShape, M as FloatingPlacement, N as FloatingTrigger, P as ICON_NAMES, Q as Icon, R as IconName, S as IconProps, U as IconVariant, V as Image, W as ImagePreview, X as ImagePreviewConfig, Y as ImagePreviewProps, Z as ImageProps, _ as Input, $ as InputProps, a0 as Menu, a1 as MenuClickInfo, a2 as MenuItem, a3 as MenuMode, a4 as MenuProps, a5 as MenuTheme, a6 as MessageConfig, a7 as MessageHandle, a8 as MessageKey, a9 as MessageType, aa as Modal, ab as ModalActionResult, ac as ModalOpenConfig, ad as ModalProps, ae as ModalType, af as NotificationConfig, ag as NotificationPlacement, ah as NotificationType, ai as Popconfirm, aj as PopconfirmProps, ak as Popover, al as PopoverProps, am as Progress, an as ProgressProps, ao as ProgressStatus, ap as Rate, aq as RateProps, ar as Segmented, as as SegmentedOption, at as SegmentedProps, au as SegmentedValue, av as Spin, aw as SpinProps, ax as StepItem, ay as StepStatus, az as Steps, aA as StepsProps, aB as TabItem, aC as Tabs, aD as TabsContextMenuClickInfo, aE as TabsOrientation, aF as TabsPosition, aG as TabsProps, aH as TabsType, aI as Tag, aJ as TagProps, aK as TagVariant, aL as Timeline, aM as TimelineItem, aN as TimelineProps, aO as Tooltip, aP as TooltipProps, aQ as Tour, aR as TourProps, aS as TourStep, aT as Tree, aU as TreeDropPosition, aV as TreeKey, aW as TreeNode, aX as TreeProps, aY as Typography, aZ as TypographyLinkProps, a_ as TypographyProps, a$ as TypographyTitleProps, b0 as TypographyType, b1 as Upload, b2 as UploadChangeInfo, b3 as UploadDraggerProps, b4 as UploadFile, b5 as UploadFileStatus, b6 as UploadProps, b7 as UploadRequestOptions, b8 as Watermark, b9 as WatermarkFont, ba as WatermarkProps, bb as message, bc as notification } from './core-AeKYVPDZ.cjs';
5
- import { C as ControlSize, I as InputPlaceholderMode, a as ControlStatus } from './shared-DAYZvZVu.cjs';
6
- export { D as DatePicker, a as DatePickerDisabledInfo, b as DatePickerPreset, c as DatePickerProps, d as DatePickerShowTime, e as DatePickerType, f as DatePickerValue, g as DateRangePickerPreset, h as DateRangePickerProps, S as SelectDateRange, i as SelectDateRangeProps, j as SelectDateRangeValue } from './select-date-range-shDQ5uJA.cjs';
3
+ import { O as OverlayContainer, a as OverlayApiHandle, M as ModalOpenConfig, b as ModalActionResult, B as ButtonProps, T as TagStatus, c as ButtonSize, d as BadgeProps } from './core-C5OnrCi4.cjs';
4
+ export { e as Badge, f as BadgeRibbonProps, g as BadgeStatus, h as Breadcrumb, i as BreadcrumbItem, j as BreadcrumbProps, k as Button, l as ButtonVariant, C as Calendar, m as CalendarProps, n as Card, o as CardAccent, p as CardProps, q as Carousel, r as CarouselProps, s as CarouselRef, t as Collapse, u as CollapseItem, v as CollapseKey, w as CollapseProps, D as Dropdown, x as DropdownButtonProps, y as DropdownMenuProps, z as DropdownOpenSource, A as DropdownPlacement, E as DropdownProps, F as DropdownTrigger, G as FILLED_ICON_NAMES, H as FilledIconName, I as FloatButton, J as FloatButtonBackTopProps, K as FloatButtonGroupProps, L as FloatButtonProps, N as FloatButtonShape, P as FloatingPlacement, Q as FloatingTrigger, R as ICON_NAMES, S as Icon, U as IconName, V as IconProps, W as IconVariant, X as Image, Y as ImagePreview, Z as ImagePreviewConfig, _ as ImagePreviewProps, $ as ImageProps, a0 as Input, a1 as InputProps, a2 as Menu, a3 as MenuClickInfo, a4 as MenuItem, a5 as MenuMode, a6 as MenuProps, a7 as MenuTheme, a8 as MessageConfig, a9 as MessageHandle, aa as MessageKey, ab as MessageType, ac as Modal, ad as ModalProps, ae as ModalType, af as NotificationConfig, ag as NotificationPlacement, ah as NotificationType, ai as Popconfirm, aj as PopconfirmProps, ak as Popover, al as PopoverProps, am as Progress, an as ProgressProps, ao as ProgressStatus, ap as Rate, aq as RateProps, ar as Segmented, as as SegmentedOption, at as SegmentedProps, au as SegmentedValue, av as Spin, aw as SpinProps, ax as StepItem, ay as StepStatus, az as Steps, aA as StepsProps, aB as TabItem, aC as Tabs, aD as TabsContextMenuClickInfo, aE as TabsOrientation, aF as TabsPosition, aG as TabsProps, aH as TabsType, aI as Tag, aJ as TagProps, aK as TagVariant, aL as Timeline, aM as TimelineItem, aN as TimelineProps, aO as Tooltip, aP as TooltipProps, aQ as Tour, aR as TourProps, aS as TourStep, aT as Tree, aU as TreeDropPosition, aV as TreeKey, aW as TreeNode, aX as TreeProps, aY as Typography, aZ as TypographyLinkProps, a_ as TypographyProps, a$ as TypographyTitleProps, b0 as TypographyType, b1 as Upload, b2 as UploadChangeInfo, b3 as UploadDraggerProps, b4 as UploadFile, b5 as UploadFileStatus, b6 as UploadProps, b7 as UploadRequestOptions, b8 as Watermark, b9 as WatermarkFont, ba as WatermarkProps, bb as message, bc as notification } from './core-C5OnrCi4.cjs';
5
+ import { C as ControlSize, I as InputPlaceholderMode, a as ControlStatus } from './shared-Bx4B28Wh.cjs';
6
+ export { D as DatePicker, a as DatePickerDisabledInfo, b as DatePickerPreset, c as DatePickerProps, d as DatePickerShowTime, e as DatePickerType, f as DatePickerValue, g as DateRangePickerPreset, h as DateRangePickerProps, S as SelectDateRange, i as SelectDateRangeProps, j as SelectDateRangeValue } from './select-date-range-DDmYGDD4.cjs';
7
7
  export { RichTextContent, RichTextContentFormat, RichTextContentProps, RichTextEditor, RichTextEditorProps, RichTextImagePasteHandler, RichTextToolbar } from './rich-text-editor.cjs';
8
8
  export { MarkdownEditor, MarkdownEditorMode, MarkdownEditorProps } from './markdown-editor.cjs';
9
9
  import * as Monaco from 'monaco-editor';
10
- export { S as Select, a as SelectChangeValue, b as SelectMode, c as SelectOption, d as SelectProps, e as SelectValue } from './Select-CVvF4mcy.cjs';
10
+ import { S as SelectOption, a as SelectChangeValue, b as SelectProps } from './Select-4hGJt3RJ.cjs';
11
+ export { c as Select, d as SelectMode, e as SelectValue } from './Select-4hGJt3RJ.cjs';
11
12
  export { BaiduMapHostOptions, BaiduMapInstance, BaiduMapNamespace, BaiduMapPoint, BarChart, BarChartProps, BarDatum, BarSeries, CHART_VIEWBOX_HEIGHT, CHART_VIEWBOX_WIDTH, CandlestickChart, CandlestickChartProps, CandlestickDatum, CartesianChartProps, ChartAxis, ChartAxisProps, ChartComposite, ChartCompositeLayer, ChartCompositeProps, ChartCompositeRef, ChartDataClickInfo, ChartDataEditor, ChartDataEditorProps, ChartDataZoom, ChartDataZoomProps, ChartLegend, ChartLegendItem, ChartLegendProps, ChartMapOverlay, ChartMapOverlayProps, ChartMark, ChartMarkProps, ChartRoamController, ChartRoamControllerProps, ChartSeries, ChartTimeline, ChartTimelineProps, ChartToolbox, ChartToolboxFeature, ChartToolboxOptions, ChartToolboxProps, ChartTooltip, ChartTooltipProps, ChartValueAddress, ChartValueChannel, ChartValueIsland, ChartValueIslandProps, ChartValueTransferHandler, ChartVisualMap, ChartVisualMapProps, ChartWhirlingLoading, ChartWhirlingLoadingProps, ChordChart, ChordChartProps, ChordLink, ChordNode, DEFAULT_CHART_PALETTE, EventRiverChart, EventRiverChartProps, EventRiverEvent, EventRiverEvolution, EventRiverSeries, ForceChart, ForceGraphChart, FunnelChart, FunnelChartProps, FunnelDatum, FunnelSeries, GaugeChart, GaugeChartProps, GaugeDatum, GeoJsonFeature, GeoJsonFeatureCollection, GeoJsonMultiPolygonGeometry, GeoJsonPolygonGeometry, GraphChart, GraphChartProps, GraphLink, GraphNode, HeatmapChart, HeatmapChartProps, HeatmapPoint, KLineChart, LineChart, LineChartProps, LinePoint, LineSeries, LineShareChart, LineShareChartProps, MapChart, MapChartProps, MapDatum, MapMarkLine, MapMarkPoint, MapOverlayEvent, MapOverlayHost, MapOverlaySnapshot, MixedChart, MixedChartProps, MixedSeries, PieChart, PieChartProps, PieDatum, PieSeries, RadarChart, RadarChartProps, RadarIndicator, RadarPanel, RadarSeries, ScatterChart, ScatterChartProps, ScatterDatum, ScatterVisualMap, SiaChart, SiaChartProps, SiaChartRef, SvgMapPlot, SvgMapPlotProps, ThemeRiverChart, ThemeRiverChartProps, ThemeRiverSeries, TreeChart, TreeChartProps, TreeDatum, TreemapChart, TreemapChartProps, TreemapDatum, TreemapItemStyle, VennChart, VennChartProps, VennIntersection, VennSet, WordCloudChart, WordCloudChartProps, WordCloudDatum, XYChart, XYChartProps, XYSeries, chartColor, chartTicks, createBaiduMapHost, formatChartNumber, getChartMap, linearScale, niceChartDomain, paddedValueExtent, registerChartMap, saveCompositeImage, serializeChartStack, smoothSvgPath, svgArcPath, transferCompositeValue } from './chart.cjs';
12
13
  import 'vditor';
13
14
 
15
+ /** 警告提示的状态类型。 */
14
16
  type AlertStatus = "info" | "success" | "warning" | "error";
17
+ /** 警告提示的属性配置。 */
15
18
  interface AlertProps extends Omit<HTMLAttributes<HTMLDivElement>, "title"> {
19
+ /** 当前状态,用于选择对应的状态样式。 */
16
20
  status?: AlertStatus;
21
+ /** 类型标识,用于选择对应的表现形式。 */
17
22
  type?: AlertStatus;
23
+ /** 标题内容,可传入文本或 React 节点。 */
18
24
  title?: ReactNode;
25
+ /** 提示或错误消息文本。 */
19
26
  message?: ReactNode;
27
+ /** 补充说明内容。 */
20
28
  description?: ReactNode;
29
+ /** 警告内容旁的业务操作节点。 */
21
30
  action?: ReactNode;
31
+ /**
32
+ * 是否显示状态图标。
33
+ * @defaultValue false
34
+ */
22
35
  showIcon?: boolean;
36
+ /**
37
+ * 是否显示关闭入口。
38
+ * @defaultValue false
39
+ */
23
40
  closable?: boolean;
41
+ /** 自定义关闭图标。 */
24
42
  closeIcon?: ReactNode;
43
+ /**
44
+ * 是否以通栏横幅形式显示。
45
+ * @defaultValue false
46
+ */
25
47
  banner?: boolean;
48
+ /** 请求关闭时触发的回调。 */
26
49
  onClose?: (event: React.MouseEvent<HTMLButtonElement>) => void;
50
+ /** 关闭完成后调用。 */
27
51
  afterClose?: () => void;
28
52
  }
53
+ /** 警告提示组件。 */
29
54
  declare function Alert({ status, type, title, message, description, action, showIcon, closable, closeIcon, banner, onClose, afterClose, className, ...props }: AlertProps): react.JSX.Element | null;
30
55
 
56
+ /** 分页器默认提供的每页记录数选项。 */
31
57
  declare const DEFAULT_PAGE_SIZE_OPTIONS: readonly [10, 25, 50, 100, 200, 500, 1000, 2000, 5000];
58
+ /** 分页的属性配置。 */
32
59
  interface PaginationProps extends Omit<HTMLAttributes<HTMLElement>, "onChange"> {
60
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
33
61
  size?: ControlSize;
62
+ /**
63
+ * 数据总数
64
+ * @defaultValue 0
65
+ */
34
66
  total?: number;
67
+ /** 当前页实际条数;未提供时根据总数、页码和每页条数计算。 */
68
+ currentPageCount?: number;
69
+ /** 当前页码,从 1 开始;传入后由外部控制。 */
35
70
  current?: number;
71
+ /**
72
+ * 非受控模式的初始页码或步骤位置。
73
+ * @defaultValue 1
74
+ */
36
75
  defaultCurrent?: number;
76
+ /** 每页显示的记录数。 */
37
77
  pageSize?: number;
78
+ /**
79
+ * 非受控模式下每页默认展示的记录数。
80
+ * @defaultValue 25
81
+ */
38
82
  defaultPageSize?: number;
83
+ /**
84
+ * 每页条数候选项
85
+ * @defaultValue DEFAULT_PAGE_SIZE_OPTIONS
86
+ */
39
87
  pageSizeOptions?: readonly number[];
88
+ /**
89
+ * 是否显示每页条数切换控件。
90
+ * @defaultValue true
91
+ */
40
92
  showSizeChanger?: boolean;
93
+ /**
94
+ * 是否显示总数,或自定义总数文本的函数。
95
+ * @defaultValue true
96
+ */
41
97
  showTotal?: boolean | ((total: number, range: [number, number]) => ReactNode);
98
+ /**
99
+ * 是否禁用交互。
100
+ * @defaultValue false
101
+ */
42
102
  disabled?: boolean;
103
+ /**
104
+ * 只有一页数据时是否隐藏分页器。
105
+ * @defaultValue false
106
+ */
43
107
  hideOnSinglePage?: boolean;
108
+ /** 是否正在刷新总数。 */
44
109
  refreshing?: boolean;
110
+ /** 请求刷新总数时调用。 */
45
111
  onRefreshTotal?: () => void | Promise<void>;
112
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
46
113
  onChange?: (page: number, pageSize: number) => void;
114
+ /** 每页条数变化时调用,参数为页码及新的每页条数。 */
47
115
  onShowSizeChange?: (current: number, pageSize: number) => void;
48
116
  }
49
- declare function Pagination({ size: sizeProp, total, current, defaultCurrent, pageSize, defaultPageSize, pageSizeOptions, showSizeChanger, showTotal, disabled, hideOnSinglePage, refreshing, onRefreshTotal, onChange, onShowSizeChange, className, ...props }: PaginationProps): react.JSX.Element | null;
117
+ /** 分页组件。 */
118
+ declare function Pagination({ size: sizeProp, total, currentPageCount, current, defaultCurrent, pageSize, defaultPageSize, pageSizeOptions, showSizeChanger, showTotal, disabled, hideOnSinglePage, refreshing, onRefreshTotal, onChange, onShowSizeChange, className, ...props }: PaginationProps): react.JSX.Element | null;
50
119
 
120
+ /** 级联选择的值类型。 */
51
121
  type CascaderValue = string | number;
122
+ /** 级联选择的候选项定义。 */
52
123
  interface CascaderOption {
124
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
53
125
  value: CascaderValue;
126
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
54
127
  label?: ReactNode;
128
+ /** 是否禁用交互。 */
55
129
  disabled?: boolean;
130
+ /** 是否为叶子节点;异步加载场景可用于标识无子项节点。 */
56
131
  isLeaf?: boolean;
132
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
57
133
  children?: readonly CascaderOption[];
58
134
  [key: string]: unknown;
59
135
  }
136
+ /** 级联数据中 label、value 和 children 的字段映射。 */
60
137
  interface CascaderFieldNames {
138
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
61
139
  label?: string;
140
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
62
141
  value?: string;
142
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
63
143
  children?: string;
64
144
  }
145
+ /** 级联选择的属性配置。 */
65
146
  interface CascaderProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "onChange"> {
147
+ /** small / medium / large 高度为 22 / 30 / 38px;默认继承 Form,组件自身 size 优先 */
66
148
  size?: ControlSize;
149
+ /** 级联选项树 */
67
150
  options: readonly CascaderOption[];
151
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
68
152
  value?: readonly CascaderValue[] | readonly (readonly CascaderValue[])[];
153
+ /** 非受控模式的初始值,仅在初始化时使用。 */
69
154
  defaultValue?: readonly CascaderValue[] | readonly (readonly CascaderValue[])[];
155
+ /**
156
+ 是否允许同时选择多个项目。
157
+ * @defaultValue false
158
+ */
70
159
  multiple?: boolean;
160
+ /**
161
+ 是否显示搜索输入框。
162
+ * @defaultValue false
163
+ */
71
164
  showSearch?: boolean;
165
+ /**
166
+ 是否允许清空当前选择或输入值。
167
+ * @defaultValue false
168
+ */
72
169
  allowClear?: boolean;
170
+ /**
171
+ * 是否在选中任意层级节点时立即提交值。
172
+ * @defaultValue false
173
+ */
73
174
  changeOnSelect?: boolean;
175
+ /**
176
+ * 子级面板的展开方式。
177
+ * @defaultValue "click"
178
+ */
74
179
  expandTrigger?: "click" | "hover";
180
+ /**
181
+ * 未填写或未选择时的提示内容。
182
+ * @defaultValue "请选择"
183
+ */
75
184
  placeholder?: ReactNode;
185
+ /** 占位提示的显示模式;floating 为浮动标签。 */
76
186
  placeholderMode?: InputPlaceholderMode;
187
+ /**
188
+ * 是否禁用交互。
189
+ * @defaultValue false
190
+ */
77
191
  disabled?: boolean;
192
+ /** 数据字段名映射,用于适配业务数据结构。 */
78
193
  fieldNames?: CascaderFieldNames;
194
+ /** 自定义已选结果的显示内容。 */
79
195
  displayRender?: (labels: ReactNode[], selectedOptions: CascaderOption[]) => ReactNode;
196
+ /** 按当前节点异步加载子节点的函数。 */
80
197
  loadData?: (selectedOptions: CascaderOption[]) => void | Promise<void>;
198
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
81
199
  onChange?: (value: readonly CascaderValue[] | readonly (readonly CascaderValue[])[] | undefined, selectedOptions: CascaderOption[] | CascaderOption[][]) => void;
82
200
  }
201
+ /** 级联选择组件。 */
83
202
  declare function Cascader({ options, value, defaultValue, size: sizeProp, multiple, showSearch, allowClear, changeOnSelect, expandTrigger, placeholder, placeholderMode, disabled, fieldNames, displayRender, loadData, onChange, className, ...props }: CascaderProps): react.JSX.Element;
84
203
 
204
+ /** 布局间距,可使用预设等级或数值。 */
85
205
  type LayoutGap = "small" | "medium" | "large" | number | string;
206
+ /** 弹性布局交叉轴上的对齐方式。 */
86
207
  type FlexAlign = "normal" | "start" | "center" | "end" | "stretch" | "baseline";
208
+ /** 弹性布局主轴上的内容分布方式。 */
87
209
  type FlexJustify = "normal" | "start" | "center" | "end" | "space-between" | "space-around" | "space-evenly";
210
+ /** 弹性布局的属性配置。 */
88
211
  interface FlexProps extends HTMLAttributes<HTMLElement> {
212
+ /**
213
+ * 是否使用垂直布局。
214
+ * @defaultValue false
215
+ */
89
216
  vertical?: boolean;
217
+ /** 组件的水平或垂直排列方向。 */
90
218
  orientation?: "horizontal" | "vertical";
219
+ /**
220
+ * 是否允许换行
221
+ * @defaultValue false
222
+ */
91
223
  wrap?: boolean | CSSProperties["flexWrap"];
224
+ /** 主轴对齐 */
92
225
  justify?: FlexJustify;
226
+ /** 交叉轴对齐 */
93
227
  align?: FlexAlign;
228
+ /** 预设或自定义间距 */
94
229
  gap?: LayoutGap;
230
+ /** 弹性布局的伸缩权重或 CSS flex 配置。 */
95
231
  flex?: CSSProperties["flex"];
232
+ /**
233
+ * 用作容器的元素或组件类型。
234
+ * @defaultValue "div"
235
+ */
96
236
  component?: ElementType;
97
237
  }
238
+ /** 弹性布局组件。 */
98
239
  declare function Flex({ vertical, orientation, wrap, justify, align, gap, flex, component: Component, className, style, ...props }: FlexProps): react.JSX.Element;
240
+ /** 间距布局的属性配置。 */
99
241
  interface SpaceProps extends HTMLAttributes<HTMLDivElement> {
242
+ /**
243
+ 排列或展示方向。
244
+ * @defaultValue "horizontal"
245
+ */
100
246
  direction?: "horizontal" | "vertical";
247
+ /**
248
+ * 组件尺寸;用于调整控件高度、字号和间距。
249
+ * @defaultValue "medium"
250
+ */
101
251
  size?: LayoutGap | readonly [LayoutGap, LayoutGap];
252
+ /**
253
+ * 交叉轴对齐
254
+ * @defaultValue "center"
255
+ */
102
256
  align?: "start" | "center" | "end" | "baseline";
257
+ /**
258
+ * 是否允许换行
259
+ * @defaultValue false
260
+ */
103
261
  wrap?: boolean;
262
+ /** 相邻元素之间的分隔内容 */
104
263
  split?: ReactNode;
105
264
  }
265
+ /** SpaceCompact的属性配置。 */
106
266
  interface SpaceCompactProps extends HTMLAttributes<HTMLDivElement> {
267
+ /**
268
+ 排列或展示方向。
269
+ * @defaultValue "horizontal"
270
+ */
107
271
  direction?: "horizontal" | "vertical";
272
+ /**
273
+ * 宽度撑满父容器
274
+ * @defaultValue false
275
+ */
108
276
  block?: boolean;
109
277
  }
110
278
  declare function SpaceCompact({ direction, block, className, ...props }: SpaceCompactProps): react.JSX.Element;
111
279
  declare function SpaceRoot({ direction, size, align, wrap, split, className, style, children, ...props }: SpaceProps): react.JSX.Element;
280
+ /** 间距布局组件。 */
112
281
  declare const Space: typeof SpaceRoot & {
282
+ /** 紧凑布局容器,将相邻控件组合为连续的按钮或输入组。 */
113
283
  Compact: typeof SpaceCompact;
114
284
  };
285
+ /** 分隔线的属性配置。 */
115
286
  interface DividerProps extends HTMLAttributes<HTMLDivElement> {
287
+ /**
288
+ 组件的水平或垂直排列方向。
289
+ * @defaultValue "horizontal"
290
+ */
116
291
  orientation?: "horizontal" | "vertical";
292
+ /**
293
+ 组件的视觉样式。
294
+ * @defaultValue "solid"
295
+ */
117
296
  variant?: "solid" | "dashed" | "dotted";
297
+ /**
298
+ * 文字在横向分割线中的位置
299
+ * @defaultValue "center"
300
+ */
118
301
  textAlign?: "start" | "center" | "end";
302
+ /**
303
+ * 使用普通字重
304
+ * @defaultValue false
305
+ */
119
306
  plain?: boolean;
307
+ /** 分割线文字 */
120
308
  children?: ReactNode;
121
309
  }
310
+ /** 分隔线组件。 */
122
311
  declare function Divider({ orientation, variant, textAlign, plain, children, className, ...props }: DividerProps): react.JSX.Element;
312
+ /** 响应式栅格的断点名称。 */
123
313
  type GridBreakpoint = "xs" | "sm" | "md" | "lg" | "xl" | "xxl";
314
+ /** 按照屏幕断点分别提供的配置值。 */
124
315
  type GridResponsive<T> = T | Partial<Record<GridBreakpoint, T>>;
316
+ /** 栅格行的属性配置。 */
125
317
  interface RowProps extends HTMLAttributes<HTMLDivElement> {
318
+ /**
319
+ * 栅格行列间距。
320
+ * @defaultValue 0
321
+ */
126
322
  gutter?: LayoutGap | readonly [LayoutGap, LayoutGap];
323
+ /** 交叉轴对齐 */
127
324
  align?: GridResponsive<"top" | "middle" | "bottom" | "stretch">;
325
+ /** 主轴对齐 */
128
326
  justify?: GridResponsive<"start" | "end" | "center" | "space-around" | "space-between" | "space-evenly">;
327
+ /**
328
+ * 是否允许换行
329
+ * @defaultValue true
330
+ */
129
331
  wrap?: boolean;
130
332
  }
333
+ /** 栅格行组件。 */
131
334
  declare function Row({ gutter, align, justify, wrap, className, style, ...props }: RowProps): react.JSX.Element;
335
+ /** 一个断点下的栅格列宽、偏移和排序配置。 */
132
336
  interface ColSize {
337
+ /** 占据的网格列数。 */
133
338
  span?: number;
339
+ /** 相对于默认位置的偏移。 */
134
340
  offset?: number;
341
+ /** 排序位置或排序方向。 */
135
342
  order?: number;
343
+ /** 推移距离或栅格偏移配置。 */
136
344
  push?: number;
345
+ /** 栅格列向左移动的列数。 */
137
346
  pull?: number;
138
347
  }
348
+ /** 栅格列的属性配置。 */
139
349
  interface ColProps extends HTMLAttributes<HTMLDivElement>, ColSize {
350
+ /** 弹性布局的伸缩权重或 CSS flex 配置。 */
140
351
  flex?: number | string;
352
+ /** 超小屏断点下的布局配置。 */
141
353
  xs?: number | ColSize;
354
+ /** 小屏断点下的布局配置。 */
142
355
  sm?: number | ColSize;
356
+ /** 中屏断点下的布局配置。 */
143
357
  md?: number | ColSize;
358
+ /** 大屏断点下的布局配置。 */
144
359
  lg?: number | ColSize;
360
+ /** 超大屏断点下的布局配置。 */
145
361
  xl?: number | ColSize;
362
+ /** 特大屏断点下的布局配置。 */
146
363
  xxl?: number | ColSize;
147
364
  }
365
+ /** 栅格列组件。 */
148
366
  declare function Col({ span, offset, order, push, pull, flex, xs, sm, md, lg, xl, xxl, className, style, ...props }: ColProps): react.JSX.Element;
149
367
 
368
+ /** SplitterPanel的属性配置。 */
150
369
  interface SplitterPanelProps extends HTMLAttributes<HTMLDivElement> {
370
+ /** 非受控模式下的初始尺寸。 */
151
371
  defaultSize?: number;
372
+ /** 非受控模式的初始收起状态。 */
152
373
  defaultCollapsed?: boolean;
374
+ /** 允许的最小值。 */
153
375
  min?: number;
376
+ /** 允许的最大值。 */
154
377
  max?: number;
378
+ /** 允许收起内容区域 */
155
379
  collapsible?: boolean;
380
+ /** 面板收起后的尺寸。 */
156
381
  collapsedSize?: number;
382
+ /** 面板收起时显示的内容。 */
157
383
  collapsedContent?: ReactNode;
384
+ /** 收起状态操作按钮的无障碍名称。 */
158
385
  collapsedAriaLabel?: string;
386
+ /** 是否允许通过拖拽调整尺寸。 */
159
387
  resizable?: boolean;
388
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
160
389
  children?: ReactNode;
161
390
  }
391
+ /** 可拖拽分割面板的属性配置。 */
162
392
  interface SplitterProps extends Omit<HTMLAttributes<HTMLDivElement>, "onResize"> {
393
+ /**
394
+ 组件的水平或垂直排列方向。
395
+ * @defaultValue "horizontal"
396
+ */
163
397
  orientation?: "horizontal" | "vertical";
398
+ /** 拖拽调整过程中持续触发 */
164
399
  onResize?: (sizes: readonly number[]) => void;
400
+ /** 鼠标或键盘调整结束时触发 */
165
401
  onResizeEnd?: (sizes: readonly number[]) => void;
166
402
  }
167
403
  declare function SplitterPanel({ defaultSize: _defaultSize, defaultCollapsed: _defaultCollapsed, min: _min, max: _max, collapsible: _collapsible, collapsedSize: _collapsedSize, collapsedContent: _collapsedContent, collapsedAriaLabel: _collapsedAriaLabel, resizable: _resizable, className, ...props }: SplitterPanelProps): react.JSX.Element;
168
404
  declare function SplitterRoot({ orientation, onResize, onResizeEnd, className, children, ...props }: SplitterProps): react.JSX.Element;
405
+ /** 可拖拽分割面板组件。 */
169
406
  declare const Splitter: typeof SplitterRoot & {
407
+ /** Splitter 中的可调整大小面板。 */
170
408
  Panel: typeof SplitterPanel;
171
409
  };
172
410
 
411
+ /** 工具面板的位置类型。 */
173
412
  type ToolPanelPlacement = "left" | "right";
413
+ /** 工具面板的项目定义。 */
174
414
  interface ToolPanelItem {
415
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
175
416
  key: string;
417
+ /** 标题内容,可传入文本或 React 节点。 */
176
418
  title: ReactNode;
419
+ /** 显示在内容旁的图标节点,建议使用 Icon 组件。 */
177
420
  icon?: ReactNode;
421
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
178
422
  children: ReactNode;
423
+ /** 是否禁用交互。 */
179
424
  disabled?: boolean;
180
425
  }
426
+ /** 工具面板的属性配置。 */
181
427
  interface ToolPanelProps extends Omit<HTMLAttributes<HTMLDivElement>, "title" | "onResize"> {
428
+ /** 标题内容,可传入文本或 React 节点。 */
182
429
  title?: ReactNode;
430
+ /** 显示在内容旁的图标节点,建议使用 Icon 组件。 */
183
431
  icon?: ReactNode;
432
+ /** 多面板配置;提供后优先于 title、icon 和 children。切换保留内容状态,共享面板宽度 */
184
433
  items?: readonly ToolPanelItem[];
434
+ /** 当前激活项目的标识;传入后由外部控制。 */
185
435
  activeKey?: string;
436
+ /** 非受控模式下初始激活的项目标识。 */
186
437
  defaultActiveKey?: string;
438
+ /** 切换面板时触发;再次点击当前入口仅切换展开状态 */
187
439
  onActiveKeyChange?: (key: string) => void;
440
+ /**
441
+ * 工具面板位于工作区左侧或右侧
442
+ * @defaultValue "left"
443
+ */
188
444
  placement?: ToolPanelPlacement;
445
+ /** 是否打开;传入后由外部控制显示状态。 */
189
446
  open?: boolean;
447
+ /**
448
+ * 非受控模式下的初始打开状态。
449
+ * @defaultValue true
450
+ */
190
451
  defaultOpen?: boolean;
452
+ /**
453
+ 非受控模式下的初始尺寸。
454
+ * @defaultValue 320
455
+ */
191
456
  defaultSize?: number;
457
+ /**
458
+ * 允许的最小尺寸。
459
+ * @defaultValue 220
460
+ */
192
461
  minSize?: number;
462
+ /**
463
+ * 允许的最大尺寸。
464
+ * @defaultValue 640
465
+ */
193
466
  maxSize?: number;
467
+ /** 活动栏切换展开状态时触发 */
194
468
  onOpenChange?: (open: boolean) => void;
469
+ /** 拖拽调整过程中持续触发 */
195
470
  onResize?: (size: number) => void;
471
+ /** 鼠标或键盘调整结束时触发 */
196
472
  onResizeEnd?: (size: number) => void;
197
473
  }
474
+ /** 工具面板组件。 */
198
475
  declare function ToolPanel({ title, icon, items, activeKey, defaultActiveKey, onActiveKeyChange, placement, open, defaultOpen, defaultSize, minSize, maxSize, onOpenChange, onResize, onResizeEnd, className, style, children, ...props }: ToolPanelProps): react.JSX.Element;
199
476
 
477
+ /** 窗口控制操作名称。 */
200
478
  type WindowAction = "start-dragging" | "minimize" | "toggle-maximize" | "close";
479
+ /** 窗口控制按钮可执行的操作。 */
201
480
  type WindowControlAction = Exclude<WindowAction, "start-dragging">;
481
+ /** 执行窗口控制操作的回调函数。 */
202
482
  type WindowActionHandler = (action: WindowAction) => void | Promise<void>;
483
+ /** 标题栏操作区域的对齐方式。 */
203
484
  type WindowTitleBarActionsAlign = "left" | "right";
485
+ /** 窗口控制按钮的显示和无障碍文案。 */
204
486
  interface WindowControlLabels {
487
+ /** 最小化窗口。 */
205
488
  minimize: string;
489
+ /** 最大化窗口。 */
206
490
  maximize: string;
491
+ /** 还原窗口尺寸或还原初始状态。 */
207
492
  restore: string;
493
+ /** 关闭当前界面或实例。 */
208
494
  close: string;
209
495
  }
496
+ /** 窗口框架的属性配置。 */
210
497
  interface WindowFrameProps extends HTMLAttributes<HTMLDivElement> {
498
+ /** 标题栏内容或配置。 */
211
499
  titleBar?: ReactNode;
212
500
  }
501
+ /** 窗口控制按钮的属性配置。 */
213
502
  interface WindowControlsProps extends HTMLAttributes<HTMLDivElement> {
503
+ /**
504
+ * 当前窗口是否已最大化。
505
+ * @defaultValue false
506
+ */
214
507
  maximized?: boolean;
508
+ /**
509
+ * 是否显示最小化按钮。
510
+ * @defaultValue true
511
+ */
215
512
  showMinimize?: boolean;
513
+ /**
514
+ * 是否显示最大化或还原按钮。
515
+ * @defaultValue true
516
+ */
216
517
  showMaximize?: boolean;
518
+ /**
519
+ * 是否显示关闭按钮。
520
+ * @defaultValue true
521
+ */
217
522
  showClose?: boolean;
523
+ /**
524
+ * 不允许执行的窗口操作集合。
525
+ * @defaultValue []
526
+ */
218
527
  disabledActions?: readonly WindowControlAction[];
528
+ /** 各操作入口的显示或无障碍文案。 */
219
529
  labels?: Partial<WindowControlLabels>;
530
+ /** 操作按钮被触发时调用。 */
220
531
  onAction?: WindowActionHandler;
221
532
  }
533
+ /** 窗口标题栏的属性配置。 */
222
534
  interface WindowTitleBarProps extends HTMLAttributes<HTMLElement> {
535
+ /** 标题前的内容区域。 */
223
536
  leading?: ReactNode;
537
+ /** 附加的操作按钮区域。 */
224
538
  actions?: ReactNode;
539
+ /**
540
+ * 操作区域的对齐方式。
541
+ * @defaultValue "right"
542
+ */
225
543
  actionsAlign?: WindowTitleBarActionsAlign;
544
+ /**
545
+ 是否显示窗口控制按钮。
546
+ * @defaultValue true
547
+ */
226
548
  controls?: boolean | ReactNode;
549
+ /**
550
+ * 当前窗口是否已最大化。
551
+ * @defaultValue false
552
+ */
227
553
  maximized?: boolean;
554
+ /**
555
+ * 是否允许拖拽。
556
+ * @defaultValue true
557
+ */
228
558
  draggable?: boolean;
559
+ /** 不允许执行的窗口操作集合。 */
229
560
  disabledActions?: readonly WindowControlAction[];
561
+ /** 窗口控制按钮的文案。 */
230
562
  controlLabels?: Partial<WindowControlLabels>;
563
+ /** 窗口控制操作触发时调用。 */
231
564
  onWindowAction?: WindowActionHandler;
232
565
  }
566
+ /** 窗口框架组件。 */
233
567
  declare function WindowFrame({ titleBar, className, children, ...props }: WindowFrameProps): react.JSX.Element;
568
+ /** 窗口控制按钮组件。 */
234
569
  declare function WindowControls({ maximized, showMinimize, showMaximize, showClose, disabledActions, labels, onAction, className, ...props }: WindowControlsProps): react.JSX.Element;
570
+ /** 窗口标题栏组件。 */
235
571
  declare function WindowTitleBar({ leading, actions, actionsAlign, controls, maximized, draggable, disabledActions, controlLabels, onWindowAction, className, children, onMouseDown, ...props }: WindowTitleBarProps): react.JSX.Element;
236
572
 
573
+ /** 抽屉的位置类型。 */
237
574
  type DrawerPlacement = "left" | "right" | "top" | "bottom";
575
+ /** DrawerPush的配置。 */
238
576
  interface DrawerPushConfig {
577
+ /** 抽屉推开父级时的位移距离。 */
239
578
  distance?: number | string;
240
579
  }
580
+ /** 子抽屉打开时是否推开父抽屉,以及推开距离的配置。 */
241
581
  type DrawerPush = boolean | DrawerPushConfig;
582
+ /** 抽屉的属性配置。 */
242
583
  interface DrawerProps extends Omit<HTMLAttributes<HTMLDivElement>, "title"> {
584
+ /** 是否显示抽屉 */
243
585
  open: boolean;
586
+ /** 标题内容,可传入文本或 React 节点。 */
244
587
  title?: ReactNode;
588
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
245
589
  children?: ReactNode;
590
+ /** 主体之外的补充内容或操作区。 */
246
591
  extra?: ReactNode;
592
+ /** 自定义底部操作区,传 null 隐藏 */
247
593
  footer?: ReactNode;
594
+ /**
595
+ * 出现方向
596
+ * @defaultValue "right"
597
+ */
248
598
  placement?: DrawerPlacement;
599
+ /**
600
+ * 抽屉宽度或高度
601
+ * @defaultValue placement === "top" || placement === "bottom" ? 320 : 760
602
+ */
249
603
  size?: number | string;
604
+ /**
605
+ * 是否显示关闭入口。
606
+ * @defaultValue true
607
+ */
250
608
  closable?: boolean;
609
+ /**
610
+ * 点击遮罩时是否允许关闭。
611
+ * @defaultValue true
612
+ */
251
613
  maskClosable?: boolean;
614
+ /**
615
+ * 是否允许通过 Esc 等键盘操作关闭。
616
+ * @defaultValue true
617
+ */
252
618
  keyboard?: boolean;
619
+ /**
620
+ 组件或浮层的堆叠层级。
621
+ * @defaultValue 1000
622
+ */
253
623
  zIndex?: number;
254
624
  /** 子抽屉打开时是否推移当前抽屉,默认开启。 */
255
625
  push?: DrawerPush;
256
626
  /** 适用于同级 Portal 渲染的多层抽屉,按层数累计推移。 */
257
627
  pushDepth?: number;
628
+ /** 弹层挂载目标;可提供元素或返回元素的函数,默认挂载到页面容器。 */
258
629
  getContainer?: OverlayContainer;
630
+ /** 请求关闭时触发的回调。 */
259
631
  onClose?: () => void;
632
+ /** 打开状态改变时触发,参数为新的打开状态。 */
260
633
  onOpenChange?: (open: boolean) => void;
261
634
  /** 展开动画完成且面板已稳定后触发。 */
262
635
  afterOpen?: () => void;
263
636
  /** 关闭动画完成且面板已隐藏后触发。 */
264
637
  afterClose?: () => void;
265
638
  }
639
+ /** DrawerOpen的配置。 */
266
640
  interface DrawerOpenConfig extends Omit<DrawerProps, "open"> {
267
641
  }
268
642
  declare function openDrawer(config: DrawerOpenConfig): OverlayApiHandle<DrawerOpenConfig>;
643
+ /** 抽屉组件。 */
269
644
  declare const Drawer: react.ForwardRefExoticComponent<DrawerProps & react.RefAttributes<HTMLDivElement>> & {
645
+ /** 直接打开实例,返回可用于更新或关闭的操作句柄。 */
270
646
  open: typeof openDrawer;
647
+ /** 关闭由此 API 打开的所有弹层。 */
271
648
  destroyAll(): void;
272
649
  };
273
650
 
651
+ /** 开关的视觉样式。 */
274
652
  type SwitchVariant = "standard" | "segmented";
653
+ /** 开关的属性配置。 */
275
654
  interface SwitchProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "type" | "size"> {
655
+ /** 标准开关高度为 16 / 22 / 28px,分段开关为 22 / 30 / 38px;默认继承 Form */
276
656
  size?: ControlSize;
657
+ /** 开关右侧的可见标签 */
277
658
  label?: ReactNode;
659
+ /**
660
+ 组件的视觉样式。
661
+ * @defaultValue "standard"
662
+ */
278
663
  variant?: SwitchVariant;
664
+ /** 选中状态的文字、图标或自定义内容 */
279
665
  checkedContent?: ReactNode;
666
+ /** 未选中状态的文字、图标或自定义内容 */
280
667
  uncheckedContent?: ReactNode;
668
+ /** 状态变化时返回最新布尔值 */
281
669
  onCheckedChange?: (checked: boolean) => void;
282
670
  }
671
+ /** 开关组件。 */
283
672
  declare const Switch: react.ForwardRefExoticComponent<SwitchProps & react.RefAttributes<HTMLInputElement>>;
673
+ /** 表单字段路径;字符串表示顶层字段,数组表示嵌套字段。 */
284
674
  type NamePath = string | number | readonly (string | number)[];
675
+ /** 表单字段名到当前值的映射。 */
285
676
  type FormValues = Record<string, unknown>;
677
+ /** 字段校验规则,支持必填、长度、正则和异步自定义校验。 */
286
678
  interface FormRule {
679
+ /** 是否为必填字段。 */
287
680
  required?: boolean;
681
+ /** 是否将仅含空白字符的文本判为无效。 */
288
682
  whitespace?: boolean;
683
+ /** 类型标识,用于选择对应的表现形式。 */
289
684
  type?: "string" | "number" | "boolean" | "array" | "email" | "url";
685
+ /** 允许的最小值。 */
290
686
  min?: number;
687
+ /** 允许的最大值。 */
291
688
  max?: number;
689
+ /** 要求的精确长度。 */
292
690
  len?: number;
691
+ /** 用于校验字段值的正则表达式。 */
293
692
  pattern?: RegExp;
693
+ /** 提示或错误消息文本。 */
294
694
  message?: ReactNode;
695
+ /** 校验前转换字段值的函数。 */
295
696
  transform?: (value: unknown) => unknown;
697
+ /** 自定义校验函数;可返回 Promise,失败时抛出错误。 */
296
698
  validator?: (rule: FormRule, value: unknown, values: FormValues) => void | Promise<void>;
297
699
  }
700
+ /** 校验失败的字段路径及其错误文本。 */
298
701
  interface FormErrorField {
702
+ /** 名称或字段标识。 */
299
703
  name: readonly (string | number)[];
704
+ /** 字段的校验错误信息列表。 */
300
705
  errors: readonly ReactNode[];
301
706
  }
707
+ /** 表单操作实例,提供读写字段值、校验、重置和提交方法。 */
302
708
  interface FormInstance {
709
+ /** 读取指定字段的当前值,支持嵌套字段路径。 */
303
710
  getFieldValue: (name: NamePath) => unknown;
711
+ /** 读取表单当前字段值集合。 */
304
712
  getFieldsValue: () => FormValues;
713
+ /** 读取指定字段的校验错误信息。 */
305
714
  getFieldError: (name: NamePath) => readonly ReactNode[];
715
+ /** 设置单个字段的值;name 可为嵌套字段路径。 */
306
716
  setFieldValue: (name: NamePath, value: unknown) => void;
717
+ /** 批量设置表单字段值。 */
307
718
  setFieldsValue: (values: FormValues) => void;
719
+ /** 将字段恢复到初始值,并清理相关校验状态。 */
308
720
  resetFields: (names?: readonly NamePath[]) => void;
721
+ /** 执行字段校验;成功返回字段值,失败抛出校验错误信息。 */
309
722
  validateFields: (names?: readonly NamePath[]) => Promise<FormValues>;
723
+ /** 提交表单并执行校验;校验通过触发 onFinish,失败触发 onFinishFailed。 */
310
724
  submit: () => void;
725
+ /** 将指定字段滚动到可见区域。 */
311
726
  scrollToField: (name: NamePath) => void;
312
727
  }
728
+ /** 创建或复用表单实例。返回单元素元组,可使用 const [form] = useForm() 获取实例并传给 Form 或 QueryForm。 */
313
729
  declare function useForm(form?: FormInstance): readonly [FormInstance];
730
+ /** 表单的属性配置。 */
314
731
  interface FormProps extends Omit<FormHTMLAttributes<HTMLFormElement>, "onSubmit"> {
732
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
315
733
  size?: ControlSize;
734
+ /** 表单实例;可由 Form.useForm() 或 useForm() 创建。 */
316
735
  form?: FormInstance;
736
+ /** 表单初始值 */
317
737
  initialValues?: FormValues;
738
+ /**
739
+ * 布局方式。
740
+ * @defaultValue "horizontal"
741
+ */
318
742
  layout?: "horizontal" | "vertical" | "inline";
743
+ /** 占位提示的显示模式;floating 为浮动标签。 */
319
744
  placeholderMode?: InputPlaceholderMode;
745
+ /**
746
+ * 是否禁用交互。
747
+ * @defaultValue false
748
+ */
320
749
  disabled?: boolean;
750
+ /**
751
+ * 是否显示必填标识。
752
+ * @defaultValue true
753
+ */
321
754
  requiredMark?: boolean | "optional";
755
+ /** 提交并且校验通过时调用,参数为完整的表单字段值。 */
322
756
  onFinish?: (values: FormValues) => void;
757
+ /** 表单提交校验失败时调用,参数包含字段值和错误列表。 */
323
758
  onFinishFailed?: (info: {
759
+ /** 字段值或选中值的集合。 */
324
760
  values: FormValues;
761
+ /** 校验失败的字段及其错误信息。 */
325
762
  errorFields: readonly FormErrorField[];
326
763
  }) => void;
764
+ /** 字段通过表单控件交互更新时调用,接收本次变化字段和完整值;用于联动查询条件等业务逻辑。 */
327
765
  onValuesChange?: (changedValues: FormValues, values: FormValues) => void;
328
766
  }
329
767
  declare function FormRoot({ form, initialValues, layout, size: sizeProp, placeholderMode, disabled, requiredMark, className, onFinish, onFinishFailed, onValuesChange, children, ...props }: FormProps): react.JSX.Element;
768
+ /** FormItem的属性配置。 */
330
769
  interface FormItemProps {
770
+ /** 绑定到表单值的字段名或嵌套路径,例如 ["user", "name"]。 */
331
771
  name?: NamePath;
772
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
332
773
  label?: ReactNode;
774
+ /**
775
+ * 字段的校验规则,按配置执行。
776
+ * @defaultValue []
777
+ */
333
778
  rules?: readonly FormRule[];
779
+ /** 是否为必填字段。 */
334
780
  required?: boolean;
781
+ /** 主体之外的补充内容或操作区。 */
335
782
  extra?: ReactNode;
783
+ /** 字段下方的辅助说明或校验提示。 */
336
784
  help?: ReactNode;
785
+ /** 手动指定字段校验状态。 */
337
786
  validateStatus?: "success" | "warning" | "error" | "validating";
787
+ /**
788
+ * 向子控件传递值时使用的属性名,如 value 或 checked。
789
+ * @defaultValue "value"
790
+ */
338
791
  valuePropName?: string;
792
+ /**
793
+ * 触发显示的交互方式。
794
+ * @defaultValue "onChange"
795
+ */
339
796
  trigger?: string;
797
+ /**
798
+ * 触发字段校验的事件名或事件名集合。
799
+ * @defaultValue "onChange"
800
+ */
340
801
  validateTrigger?: string | readonly string[];
802
+ /** 从子控件的事件参数中提取需要写入表单的值。 */
341
803
  getValueFromEvent?: (...args: unknown[]) => unknown;
804
+ /**
805
+ * 只提供字段绑定与校验,不渲染 Form.Item 的布局容器。
806
+ * @defaultValue false
807
+ */
342
808
  noStyle?: boolean;
809
+ /** 依赖的字段路径;依赖变化时更新当前字段。 */
343
810
  dependencies?: readonly NamePath[];
811
+ /** 控制表单值变化后是否重新渲染此项,可传比较函数。 */
344
812
  shouldUpdate?: boolean | ((previous: FormValues, next: FormValues) => boolean);
813
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
345
814
  children?: ReactNode | ((form: FormInstance) => ReactNode);
815
+ /**
816
+ * 附加到组件根节点的 CSS 类名。
817
+ * @defaultValue ""
818
+ */
346
819
  className?: string;
347
820
  }
348
821
  declare function FormItem({ name, label, rules, required, extra, help, validateStatus, valuePropName, trigger, validateTrigger, getValueFromEvent, noStyle, children, className, }: FormItemProps): react.JSX.Element;
822
+ /** 动态列表中一个字段的渲染标识和索引。 */
349
823
  interface FormListField {
824
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
350
825
  key: number;
826
+ /** 该字段在表单列表中的索引。 */
351
827
  name: number;
352
828
  }
829
+ /** 动态表单列表的新增、删除和移动操作。 */
353
830
  interface FormListOperation {
831
+ /** 新增列表项,可指定初始值和插入位置。 */
354
832
  add: (value?: unknown, index?: number) => void;
833
+ /** 删除指定索引的列表项。 */
355
834
  remove: (index: number | readonly number[]) => void;
835
+ /** 将列表项从源索引移动到目标索引。 */
356
836
  move: (from: number, to: number) => void;
357
837
  }
838
+ /** FormList的属性配置。 */
358
839
  interface FormListProps {
840
+ /** 名称或字段标识。 */
359
841
  name: NamePath;
842
+ /** 列表渲染函数,接收字段描述和 add、remove、move 操作。 */
360
843
  children: (fields: readonly FormListField[], operations: FormListOperation) => ReactNode;
361
844
  }
362
845
  declare function FormList({ name, children }: FormListProps): ReactNode;
363
846
  declare function FormErrorList({ errors }: {
847
+ /** 要显示的字段校验错误列表。 */
364
848
  errors?: readonly ReactNode[];
365
849
  }): react.JSX.Element | null;
850
+ /** 表单组件。 */
366
851
  declare const Form: typeof FormRoot & {
852
+ /** 表单字段,负责字段值绑定、校验和标签布局。 */
367
853
  Item: typeof FormItem;
854
+ /** 动态表单列表,提供字段索引以及新增、删除、移动操作。 */
368
855
  List: typeof FormList;
856
+ /** 显示表单错误文本集合。 */
369
857
  ErrorList: typeof FormErrorList;
858
+ /** 创建或复用表单实例,返回单元素元组 [form]。 */
370
859
  useForm: typeof useForm;
371
860
  };
372
861
 
862
+ /** 复选框的值类型。 */
373
863
  type CheckboxValue = string | number;
864
+ /** 复选框的属性配置。 */
374
865
  interface CheckboxProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "type" | "size" | "value" | "onChange"> {
866
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
375
867
  size?: ControlSize;
868
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
376
869
  value?: CheckboxValue;
870
+ /**
871
+ * 半选状态
872
+ * @defaultValue false
873
+ */
377
874
  indeterminate?: boolean;
875
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
378
876
  children?: ReactNode;
877
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
379
878
  onChange?: (checked: boolean, event: ChangeEvent<HTMLInputElement>) => void;
380
879
  }
880
+ /** 复选框的候选项定义。 */
381
881
  interface CheckboxOption {
882
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
382
883
  label: ReactNode;
884
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
383
885
  value: CheckboxValue;
886
+ /** 是否禁用交互。 */
384
887
  disabled?: boolean;
385
888
  }
889
+ /** CheckboxGroup的属性配置。 */
386
890
  interface CheckboxGroupProps {
891
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
387
892
  size?: ControlSize;
893
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
388
894
  value?: readonly CheckboxValue[];
895
+ /**
896
+ * 非受控模式的初始值,仅在初始化时使用。
897
+ * @defaultValue []
898
+ */
389
899
  defaultValue?: readonly CheckboxValue[];
900
+ /** 可供用户选择的候选项列表。 */
390
901
  options?: readonly (CheckboxOption | CheckboxValue)[];
902
+ /** 是否禁用交互。 */
391
903
  disabled?: boolean;
904
+ /** 名称或字段标识。 */
392
905
  name?: string;
906
+ /**
907
+ * 附加到组件根节点的 CSS 类名。
908
+ * @defaultValue ""
909
+ */
393
910
  className?: string;
911
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
394
912
  children?: ReactNode;
913
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
395
914
  onChange?: (values: readonly CheckboxValue[]) => void;
396
915
  }
397
916
  declare function CheckboxGroup({ size: sizeProp, value, defaultValue, options, disabled, name, className, children, onChange, }: CheckboxGroupProps): react.JSX.Element;
917
+ /** 复选框组件。 */
398
918
  declare const Checkbox: react.ForwardRefExoticComponent<CheckboxProps & react.RefAttributes<HTMLInputElement>> & {
919
+ /** 组合多个子项并统一管理布局或选择状态。 */
399
920
  Group: typeof CheckboxGroup;
400
921
  };
401
922
 
923
+ /** 单选框的值类型。 */
402
924
  type RadioValue = string | number;
925
+ /** 单选框的属性配置。 */
403
926
  interface RadioProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "type" | "size" | "value" | "onChange"> {
927
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
404
928
  size?: ControlSize;
929
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
405
930
  value: RadioValue;
931
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
406
932
  children?: ReactNode;
933
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
407
934
  onChange?: (checked: boolean, event: ChangeEvent<HTMLInputElement>) => void;
408
935
  }
936
+ /** 单选框的候选项定义。 */
409
937
  interface RadioOption {
938
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
410
939
  label: ReactNode;
940
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
411
941
  value: RadioValue;
942
+ /** 是否禁用交互。 */
412
943
  disabled?: boolean;
413
944
  }
945
+ /** RadioGroup的属性配置。 */
414
946
  interface RadioGroupProps {
947
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
415
948
  size?: ControlSize;
949
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
416
950
  value?: RadioValue;
951
+ /** 非受控模式的初始值,仅在初始化时使用。 */
417
952
  defaultValue?: RadioValue;
953
+ /** 可供用户选择的候选项列表。 */
418
954
  options?: readonly (RadioOption | RadioValue)[];
955
+ /**
956
+ * 普通或按钮形态
957
+ * @defaultValue "default"
958
+ */
419
959
  optionType?: "default" | "button";
960
+ /**
961
+ * 按钮选中样式
962
+ * @defaultValue "outline"
963
+ */
420
964
  buttonStyle?: "outline" | "solid";
965
+ /** 是否禁用交互。 */
421
966
  disabled?: boolean;
967
+ /** 名称或字段标识。 */
422
968
  name?: string;
969
+ /**
970
+ * 附加到组件根节点的 CSS 类名。
971
+ * @defaultValue ""
972
+ */
423
973
  className?: string;
974
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
424
975
  children?: ReactNode;
976
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
425
977
  onChange?: (value: RadioValue) => void;
426
978
  }
427
979
  declare function RadioButton(props: RadioProps): react.JSX.Element;
428
980
  declare function RadioGroup({ size: sizeProp, value, defaultValue, options, optionType, buttonStyle, disabled, name, className, children, onChange, }: RadioGroupProps): react.JSX.Element;
981
+ /** 单选框组件。 */
429
982
  declare const Radio: react.ForwardRefExoticComponent<RadioProps & {
430
983
  button?: boolean;
431
984
  } & react.RefAttributes<HTMLInputElement>> & {
985
+ /** 组合主操作按钮与下拉菜单的按钮组件。 */
432
986
  Button: typeof RadioButton;
987
+ /** 组合多个子项并统一管理布局或选择状态。 */
433
988
  Group: typeof RadioGroup;
434
989
  };
435
990
 
991
+ /** 滑块的值类型。 */
436
992
  type SliderValue = number | readonly [number, number];
993
+ /** 滑块上的刻度标签定义。 */
437
994
  interface SliderMark {
995
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
438
996
  label: ReactNode;
997
+ /** 组件根节点的内联样式。 */
439
998
  style?: CSSProperties;
440
999
  }
1000
+ /** 滑块的属性配置。 */
441
1001
  interface SliderProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "onChange"> {
1002
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
442
1003
  value?: SliderValue;
1004
+ /** 非受控模式的初始值,仅在初始化时使用。 */
443
1005
  defaultValue?: SliderValue;
1006
+ /**
1007
+ * 允许的最小值。
1008
+ * @defaultValue 0
1009
+ */
444
1010
  min?: number;
1011
+ /**
1012
+ * 允许的最大值。
1013
+ * @defaultValue 100
1014
+ */
445
1015
  max?: number;
1016
+ /**
1017
+ * 每次改变的步长
1018
+ * @defaultValue 1
1019
+ */
446
1020
  step?: number;
1021
+ /**
1022
+ * 是否启用范围选择,或指定选择范围。
1023
+ * @defaultValue false
1024
+ */
447
1025
  range?: boolean;
1026
+ /**
1027
+ * 是否禁用交互。
1028
+ * @defaultValue false
1029
+ */
448
1030
  disabled?: boolean;
1031
+ /**
1032
+ * 反转节点顺序
1033
+ * @defaultValue false
1034
+ */
449
1035
  reverse?: boolean;
1036
+ /**
1037
+ * 是否使用垂直布局。
1038
+ * @defaultValue false
1039
+ */
450
1040
  vertical?: boolean;
1041
+ /** 刻度标记 */
451
1042
  marks?: Readonly<Record<number, ReactNode | SliderMark>>;
1043
+ /** 提示内容或提示框配置。 */
452
1044
  tooltip?: {
1045
+ /** 是否打开;传入后由外部控制显示状态。 */
453
1046
  open?: boolean;
1047
+ /** 将原始值转换为展示文本的函数。 */
454
1048
  formatter?: (value: number) => ReactNode;
455
1049
  };
1050
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
456
1051
  onChange?: (value: SliderValue) => void;
1052
+ /** 拖动完成回调 */
457
1053
  onChangeComplete?: (value: SliderValue) => void;
458
1054
  }
1055
+ /** 滑块组件。 */
459
1056
  declare function Slider({ value, defaultValue, min, max, step, range, disabled, reverse, vertical, marks, tooltip, className, onChange, onChangeComplete, ...props }: SliderProps): react.JSX.Element;
460
1057
 
1058
+ /** 颜色选择的模式类型。 */
461
1059
  type ColorPickerMode = "solid" | "gradient";
1060
+ /** 预设颜色分组定义。 */
462
1061
  interface ColorPickerPreset {
1062
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
463
1063
  label?: ReactNode;
1064
+ /** 可选颜色或颜色序列。 */
464
1065
  colors: readonly string[];
465
1066
  }
1067
+ /** 颜色选择的属性配置。 */
466
1068
  interface ColorPickerProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "onChange"> {
1069
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
467
1070
  size?: ControlSize;
1071
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
468
1072
  value?: string;
1073
+ /**
1074
+ * 非受控模式的初始值,仅在初始化时使用。
1075
+ * @defaultValue "#1677FF"
1076
+ */
469
1077
  defaultValue?: string;
1078
+ /** 展示或交互模式;可选值见类型定义。 */
470
1079
  mode?: ColorPickerMode;
1080
+ /**
1081
+ * 初始化时使用的模式。
1082
+ * @defaultValue "solid"
1083
+ */
471
1084
  defaultMode?: ColorPickerMode;
1085
+ /**
1086
+ 允许切换的模式集合。
1087
+ * @defaultValue DEFAULT_MODES
1088
+ */
472
1089
  modes?: readonly ColorPickerMode[];
1090
+ /**
1091
+ * 是否禁用交互。
1092
+ * @defaultValue false
1093
+ */
473
1094
  disabled?: boolean;
1095
+ /**
1096
+ 是否允许清空当前选择或输入值。
1097
+ * @defaultValue false
1098
+ */
474
1099
  allowClear?: boolean;
1100
+ /**
1101
+ * 是否显示文字内容。
1102
+ * @defaultValue false
1103
+ */
475
1104
  showText?: boolean | ((color: string) => ReactNode);
1105
+ /**
1106
+ * 是否显示透明度调节控件。
1107
+ * @defaultValue false
1108
+ */
476
1109
  showAlpha?: boolean;
1110
+ /** 预设候选值或快捷选项集合。 */
477
1111
  presets?: readonly ColorPickerPreset[];
1112
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
478
1113
  onChange?: (color: string) => void;
1114
+ /** 拖动完成回调 */
479
1115
  onChangeComplete?: (color: string) => void;
1116
+ /** 模式切换后调用。 */
480
1117
  onModeChange?: (mode: ColorPickerMode) => void;
1118
+ /** 清空当前值时调用。 */
481
1119
  onClear?: () => void;
482
1120
  }
1121
+ /** 颜色选择组件。 */
483
1122
  declare function ColorPicker({ size: sizeProp, value, defaultValue, mode, defaultMode, modes, disabled, allowClear, showText, showAlpha, presets, className, onChange, onChangeComplete, onModeChange, onClear, ...props }: ColorPickerProps): react.JSX.Element;
484
1123
 
1124
+ /** 时间选择的属性配置。 */
485
1125
  interface TimePickerProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "type" | "size" | "value" | "defaultValue" | "onChange"> {
1126
+ /** 占位提示的显示模式;floating 为浮动标签。 */
486
1127
  placeholderMode?: InputPlaceholderMode;
1128
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
487
1129
  value?: string;
1130
+ /**
1131
+ * 非受控模式的初始值,仅在初始化时使用。
1132
+ * @defaultValue ""
1133
+ */
488
1134
  defaultValue?: string;
1135
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
489
1136
  size?: ControlSize;
1137
+ /**
1138
+ * 当前状态,用于选择对应的状态样式。
1139
+ * @defaultValue "default"
1140
+ */
490
1141
  status?: ControlStatus;
1142
+ /**
1143
+ 是否允许清空当前选择或输入值。
1144
+ * @defaultValue true
1145
+ */
491
1146
  allowClear?: boolean;
1147
+ /**
1148
+ * 是否使用 12 小时制。
1149
+ * @defaultValue false
1150
+ */
492
1151
  use12Hours?: boolean;
1152
+ /**
1153
+ * 是否显示秒选择。
1154
+ * @defaultValue false
1155
+ */
493
1156
  showSecond?: boolean;
1157
+ /** 显示在控件末尾的图标。 */
494
1158
  suffixIcon?: ReactNode;
1159
+ /** 禁用时间判断 */
495
1160
  disabledTime?: (value: string) => boolean;
1161
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
496
1162
  onChange?: (value: string) => void;
1163
+ /** 打开状态改变时触发,参数为新的打开状态。 */
497
1164
  onOpenChange?: (open: boolean) => void;
498
1165
  }
1166
+ /** 时间区间选择的属性配置。 */
499
1167
  interface TimeRangePickerProps extends Omit<TimePickerProps, "value" | "defaultValue" | "onChange" | "placeholder"> {
1168
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
500
1169
  value?: readonly [string, string];
1170
+ /**
1171
+ * 非受控模式的初始值,仅在初始化时使用。
1172
+ * @defaultValue ["", ""]
1173
+ */
501
1174
  defaultValue?: readonly [string, string];
1175
+ /**
1176
+ * 未填写或未选择时的提示内容。
1177
+ * @defaultValue ["开始时间", "结束时间"]
1178
+ */
502
1179
  placeholder?: readonly [string, string];
1180
+ /**
1181
+ * 全局分隔符,可传入图标或文字
1182
+ * @defaultValue "→"
1183
+ */
503
1184
  separator?: ReactNode;
1185
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
504
1186
  onChange?: (value: readonly [string, string]) => void;
505
1187
  }
506
1188
  declare function TimeRangePicker({ value, defaultValue, placeholder, separator, onChange, className, style, ...props }: TimeRangePickerProps): react.JSX.Element;
1189
+ /** 时间选择组件。 */
507
1190
  declare function TimePicker({ value, defaultValue, size: sizeProp, status, allowClear, use12Hours, showSecond, suffixIcon, disabledTime, disabled, readOnly, className, style, onChange, onOpenChange, placeholder, placeholderMode, min, max, step, ...props }: TimePickerProps): react.JSX.Element;
508
1191
  declare namespace TimePicker {
1192
+ /** 时间区间选择器。 */
509
1193
  const RangePicker: typeof TimeRangePicker;
510
1194
  }
511
1195
 
1196
+ /** 树选择的值类型。 */
512
1197
  type TreeSelectValue = string | number;
1198
+ /** 树选择器的节点,包含值、标签、子节点和禁用状态。 */
513
1199
  interface TreeSelectNode {
1200
+ /** 标题内容,可传入文本或 React 节点。 */
514
1201
  title: ReactNode;
1202
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
515
1203
  value: TreeSelectValue;
1204
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
516
1205
  key?: string | number;
1206
+ /** 是否禁用交互。 */
517
1207
  disabled?: boolean;
1208
+ /** 是否允许选中项目。 */
518
1209
  selectable?: boolean;
1210
+ /** 是否仅禁用该节点的勾选框。 */
519
1211
  disableCheckbox?: boolean;
1212
+ /** 是否显示勾选框或允许勾选。 */
520
1213
  checkable?: boolean;
1214
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
521
1215
  children?: readonly TreeSelectNode[];
522
1216
  }
1217
+ /** 树选择的属性配置。 */
523
1218
  interface TreeSelectProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "onChange" | "onSelect"> {
1219
+ /** 树形节点数据 */
524
1220
  treeData: readonly TreeSelectNode[];
1221
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
525
1222
  value?: TreeSelectValue | readonly TreeSelectValue[] | null;
1223
+ /** 非受控模式的初始值,仅在初始化时使用。 */
526
1224
  defaultValue?: TreeSelectValue | readonly TreeSelectValue[];
1225
+ /**
1226
+ 是否允许同时选择多个项目。
1227
+ * @defaultValue false
1228
+ */
527
1229
  multiple?: boolean;
1230
+ /**
1231
+ * 是否显示树节点复选框。
1232
+ * @defaultValue false
1233
+ */
528
1234
  treeCheckable?: boolean;
1235
+ /**
1236
+ 是否显示搜索输入框。
1237
+ * @defaultValue false
1238
+ */
529
1239
  showSearch?: boolean;
1240
+ /**
1241
+ 是否允许清空当前选择或输入值。
1242
+ * @defaultValue false
1243
+ */
530
1244
  allowClear?: boolean;
1245
+ /**
1246
+ * 默认展开全部节点
1247
+ * @defaultValue false
1248
+ */
531
1249
  treeDefaultExpandAll?: boolean;
1250
+ /**
1251
+ * 未填写或未选择时的提示内容。
1252
+ * @defaultValue "请选择"
1253
+ */
532
1254
  placeholder?: ReactNode;
1255
+ /** 占位提示的显示模式;floating 为浮动标签。 */
533
1256
  placeholderMode?: InputPlaceholderMode;
1257
+ /**
1258
+ * 搜索框的占位提示文字。
1259
+ * @defaultValue "搜索节点"
1260
+ */
534
1261
  searchPlaceholder?: string;
535
1262
  /** 最多显示的标签数;空间不足时会继续折叠,并为 +N 预留宽度。 */
536
1263
  maxTagCount?: number;
1264
+ /**
1265
+ * 是否禁用交互。
1266
+ * @defaultValue false
1267
+ */
537
1268
  disabled?: boolean;
1269
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
538
1270
  size?: ControlSize;
1271
+ /**
1272
+ * 当前状态,用于选择对应的状态样式。
1273
+ * @defaultValue "default"
1274
+ */
539
1275
  status?: ControlStatus;
1276
+ /** 是否打开;传入后由外部控制显示状态。 */
540
1277
  open?: boolean;
1278
+ /**
1279
+ * 非受控模式下的初始打开状态。
1280
+ * @defaultValue false
1281
+ */
541
1282
  defaultOpen?: boolean;
1283
+ /** 受控的搜索文本。 */
542
1284
  searchValue?: string;
1285
+ /** 受控的树节点展开标识集合。 */
543
1286
  treeExpandedKeys?: readonly TreeSelectValue[];
1287
+ /**
1288
+ * 初始展开的树节点标识集合。
1289
+ * @defaultValue []
1290
+ */
544
1291
  treeDefaultExpandedKeys?: readonly TreeSelectValue[];
1292
+ /** 树节点展开状态改变时调用。 */
545
1293
  onTreeExpand?: (keys: TreeSelectValue[]) => void;
1294
+ /** 自定义树节点的搜索匹配规则。 */
546
1295
  filterTreeNode?: false | ((search: string, node: TreeSelectNode) => boolean);
547
1296
  /** 默认独立勾选;关闭后父子节点联动,禁用节点作为边界。 */
548
1297
  treeCheckStrictly?: boolean;
1298
+ /**
1299
+ * 勾选结果的展示策略,控制父子节点如何显示。
1300
+ * @defaultValue "all"
1301
+ */
549
1302
  showCheckedStrategy?: "all" | "parent" | "child";
1303
+ /**
1304
+ * 是否处于加载状态。
1305
+ * @defaultValue false
1306
+ */
550
1307
  loading?: boolean;
1308
+ /**
1309
+ * 选项列表的最大可视高度,单位为像素。
1310
+ * @defaultValue 300
1311
+ */
551
1312
  listHeight?: number;
1313
+ /**
1314
+ * 弹出面板的附加 CSS 类名。
1315
+ * @defaultValue ""
1316
+ */
552
1317
  popupClassName?: string;
1318
+ /** 弹出面板的内联样式。 */
553
1319
  popupStyle?: React.CSSProperties;
1320
+ /** 下拉面板底部扩展内容。 */
554
1321
  dropdownFooter?: ReactNode;
1322
+ /** 自定义已选结果的显示内容。 */
555
1323
  displayRender?: (nodes: readonly TreeSelectNode[]) => ReactNode;
1324
+ /** 自定义触发控件的渲染函数。 */
556
1325
  renderTrigger?: (state: {
1326
+ /** 是否打开;传入后由外部控制显示状态。 */
557
1327
  open: boolean;
1328
+ /** 切换当前打开或选中状态。 */
558
1329
  toggle: () => void;
1330
+ /** 清空当前值或内容。 */
559
1331
  clear: () => void;
560
1332
  }) => ReactNode;
1333
+ /** 清空当前值时调用。 */
561
1334
  onClear?: () => void;
1335
+ /** 选中项目时调用,参数包含选中项目及关联状态。 */
562
1336
  onSelect?: (value: TreeSelectValue, node: TreeSelectNode) => void;
1337
+ /** 取消选中项目时调用。 */
563
1338
  onDeselect?: (value: TreeSelectValue, node: TreeSelectNode) => void;
1339
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
564
1340
  onChange?: (value: TreeSelectValue | readonly TreeSelectValue[] | undefined, nodes: readonly TreeSelectNode[]) => void;
1341
+ /** 搜索条件变化或提交搜索时调用,具体参数见签名。 */
565
1342
  onSearch?: (value: string) => void;
1343
+ /** 下拉面板显示状态变化时调用。 */
566
1344
  onDropdownVisibleChange?: (open: boolean) => void;
567
1345
  }
1346
+ /** 树选择组件。 */
568
1347
  declare function TreeSelect({ treeData, value, defaultValue, multiple, treeCheckable, showSearch, allowClear, treeDefaultExpandAll, placeholder, placeholderMode, searchPlaceholder, maxTagCount, disabled, size: sizeProp, status, className, onChange, onSearch, onDropdownVisibleChange, open: controlledOpen, defaultOpen, searchValue, treeExpandedKeys, treeDefaultExpandedKeys, onTreeExpand, filterTreeNode, treeCheckStrictly, showCheckedStrategy, loading, listHeight, popupClassName, popupStyle, dropdownFooter, displayRender, renderTrigger, onClear, onSelect, onDeselect, ...props }: TreeSelectProps): react.JSX.Element;
569
1348
 
1349
+ /** FlatTree的配置选项。 */
570
1350
  interface FlatTreeOptions {
1351
+ /** 扁平数据中用作节点唯一标识的字段名。 */
571
1352
  idField?: string;
1353
+ /** 扁平数据中用作父节点标识的字段名。 */
572
1354
  parentIdField?: string;
1355
+ /** 用来判断根节点的父标识值。 */
573
1356
  rootParentId?: unknown;
574
1357
  }
1358
+ /** 保留原始字段并补充 children 的树节点。 */
575
1359
  type FlatTreeNode<T> = T & {
1360
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
576
1361
  children: FlatTreeNode<T>[];
577
1362
  };
578
1363
  /** 平级列表转树;容忍孤儿节点,并切断自引用和循环关系,防止递归溢出。 */
579
1364
  declare function buildFlatTree<T extends Record<string, any>>(items: readonly T[], options?: FlatTreeOptions): FlatTreeNode<T>[];
580
1365
 
1366
+ /** 多行输入的属性配置。 */
581
1367
  interface TextAreaProps extends TextareaHTMLAttributes<HTMLTextAreaElement> {
1368
+ /** 调整字号和内边距;保留 rows 和内容决定的多行高度。默认继承 Form */
582
1369
  size?: ControlSize;
1370
+ /** 字段标签 */
583
1371
  label?: ReactNode;
1372
+ /** 帮助或校验信息 */
584
1373
  hint?: ReactNode;
1374
+ /**
1375
+ * 校验状态
1376
+ * @defaultValue "default"
1377
+ */
585
1378
  status?: ControlStatus;
1379
+ /**
1380
+ * 显示当前字符数
1381
+ * @defaultValue false
1382
+ */
586
1383
  showCount?: boolean;
1384
+ /** 占位提示的显示模式;floating 为浮动标签。 */
587
1385
  placeholderMode?: InputPlaceholderMode;
588
1386
  }
1387
+ /** 多行输入组件。 */
589
1388
  declare const TextArea: react.ForwardRefExoticComponent<TextAreaProps & react.RefAttributes<HTMLTextAreaElement>>;
590
1389
 
1390
+ /** 代码编辑器支持的 SQL 方言名称。 */
591
1391
  type SqlDialectLanguage = "sql-postgresql" | "sql-mysql" | "sql-sqlserver" | "sql-sqlite";
592
1392
 
1393
+ /** 代码编辑器的配色主题。 */
593
1394
  type EditorTheme = "light" | "dark";
1395
+ /** 代码编辑器支持的语言名称。 */
594
1396
  type EditorLanguage = SqlDialectLanguage | (string & {});
1397
+ /** 编辑器中的文本范围,行号和列号从 1 开始。 */
595
1398
  interface EditorRange {
1399
+ /** 起始行号,从 1 开始。 */
596
1400
  startLineNumber: number;
1401
+ /** 起始列号,从 1 开始。 */
597
1402
  startColumn: number;
1403
+ /** 结束行号,从 1 开始。 */
598
1404
  endLineNumber: number;
1405
+ /** 结束列号,从 1 开始。 */
599
1406
  endColumn: number;
600
1407
  }
1408
+ /** 编辑器中的诊断标记,包含范围、严重程度和提示信息。 */
601
1409
  interface EditorMarker extends EditorRange {
1410
+ /** 提示或错误消息文本。 */
602
1411
  message: string;
1412
+ /** 提示或问题的严重级别。 */
603
1413
  severity?: "error" | "warning" | "info";
1414
+ /** 触发来源,用于区分不同入口的操作。 */
604
1415
  source?: string;
605
1416
  }
1417
+ /** 编辑器选区变化时的范围和选中文本。 */
606
1418
  interface EditorSelectionChange {
1419
+ /** 是否启用范围选择,或指定选择范围。 */
607
1420
  range: EditorRange;
1421
+ /** 显示文本。 */
608
1422
  text: string;
1423
+ /** 插入内容后相对于插入起点的光标偏移。 */
609
1424
  cursorOffset: number;
610
1425
  }
1426
+ /** 编辑器键盘事件及控制默认行为的方法。 */
611
1427
  interface EditorKeyDownEvent {
1428
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
612
1429
  key: string;
1430
+ /** 代码内容或按键代码。 */
613
1431
  code: string;
1432
+ /** 事件发生时是否按下 Ctrl 键。 */
614
1433
  ctrlKey: boolean;
1434
+ /** 事件发生时是否按下 Command 或 Windows 键。 */
615
1435
  metaKey: boolean;
1436
+ /** 事件发生时是否按下 Shift 键。 */
616
1437
  shiftKey: boolean;
1438
+ /** 事件发生时是否按下 Alt 键。 */
617
1439
  altKey: boolean;
1440
+ /** 是否为按住按键产生的重复事件。 */
618
1441
  repeat: boolean;
1442
+ /** 阻止事件的浏览器默认行为。 */
619
1443
  preventDefault(): void;
1444
+ /** 阻止事件继续传播。 */
620
1445
  stopPropagation(): void;
621
1446
  }
1447
+ /** 补全候选项类别,用于显示对应图标。 */
622
1448
  type EditorCompletionItemKind = "text" | "keyword" | "snippet" | "database" | "schema" | "table" | "view" | "column" | "function" | "procedure" | "value";
1449
+ /** 请求补全时的文档、光标和触发字符上下文。 */
623
1450
  interface EditorCompletionContext {
1451
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
624
1452
  value: string;
1453
+ /** 文档起始位置到光标之前的文本。 */
625
1454
  textBeforeCursor: string;
1455
+ /** 当前行内光标之前的文本。 */
626
1456
  lineTextBeforeCursor: string;
1457
+ /** 光标所在位置的单词。 */
627
1458
  word: string;
1459
+ /** 显示位置或定位配置。 */
628
1460
  position: {
1461
+ /** 行号,从 1 开始。 */
629
1462
  lineNumber: number;
1463
+ /** 光标所在的列号,从 1 开始。 */
630
1464
  column: number;
1465
+ /** 相对于默认位置的偏移。 */
631
1466
  offset: number;
632
1467
  };
1468
+ /** 触发补全的字符。 */
633
1469
  triggerCharacter?: string;
634
1470
  }
1471
+ /** EditorCompletion的项目定义。 */
635
1472
  interface EditorCompletionItem {
1473
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
636
1474
  label: string;
1475
+ /** 接受补全项后插入的文本。 */
637
1476
  insertText?: string;
1477
+ /** 补全项或节点的类别。 */
638
1478
  kind?: EditorCompletionItemKind;
1479
+ /** 简短的补充说明。 */
639
1480
  detail?: string;
1481
+ /** 补全项的详细说明文档。 */
640
1482
  documentation?: string;
1483
+ /** 用于补全过滤匹配的文本。 */
641
1484
  filterText?: string;
1485
+ /** 用于补全排序的文本。 */
642
1486
  sortText?: string;
1487
+ /** 是否优先选中该补全项。 */
643
1488
  preselect?: boolean;
1489
+ /** 输入后可确认此补全项的字符集合。 */
644
1490
  commitCharacters?: readonly string[];
1491
+ /** 插入文本的格式,支持普通文本或代码片段。 */
645
1492
  insertTextFormat?: "plain" | "snippet";
1493
+ /** 是否启用范围选择,或指定选择范围。 */
646
1494
  range?: EditorRange;
647
1495
  }
1496
+ /** 根据编辑器上下文生成补全候选项的函数。 */
648
1497
  type EditorCompletionProvider = (context: EditorCompletionContext) => readonly EditorCompletionItem[] | Promise<readonly EditorCompletionItem[]>;
1498
+ /** 编辑器可执行的命令名称。 */
649
1499
  type EditorCommand = "cut" | "copy" | "paste" | "selectAll";
1500
+ /** EditorContextMenu的项目定义。 */
650
1501
  interface EditorContextMenuItem {
1502
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
651
1503
  key: string;
1504
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
652
1505
  label: string;
1506
+ /** 待执行的编辑命令。 */
653
1507
  command?: EditorCommand;
1508
+ /** 显示或绑定的快捷键。 */
654
1509
  shortcut?: string;
1510
+ /** 是否禁用交互。 */
655
1511
  disabled?: boolean | ((api: EditorHandle | null) => boolean);
1512
+ /** 点击时触发,参数为当前点击事件或项目上下文。 */
656
1513
  onClick?: (api: EditorHandle) => void;
657
1514
  }
1515
+ /** 代码编辑器的操作句柄。 */
658
1516
  interface EditorHandle {
1517
+ /** 将焦点移入控件。 */
659
1518
  focus(): void;
1519
+ /** 读取当前内容。 */
660
1520
  getValue(): string;
1521
+ /** 读取当前选区范围。 */
661
1522
  getSelection(): EditorRange | null;
1523
+ /** 读取当前选区的文本。 */
662
1524
  getSelectedText(): string;
1525
+ /** 在当前选区插入块内容。 */
663
1526
  insertBlock(content: string): void;
1527
+ /** 为选中行添加或移除行前缀。 */
664
1528
  prefixLines(prefix: string): void;
1529
+ /** 替换编辑器的全部内容。 */
665
1530
  replaceValue(content: string): void;
1531
+ /** 滚动到指定行并使其可见。 */
666
1532
  revealLine(line: number): void;
1533
+ /** 设置编辑器选区。 */
667
1534
  setSelection(range: EditorRange): void;
1535
+ /** 用指定前后文本包裹当前选区。 */
668
1536
  wrapSelection(prefix: string, suffix: string, placeholder?: string): void;
669
1537
  }
1538
+ /** 代码编辑器的属性配置。 */
670
1539
  interface EditorProps {
1540
+ /** 编辑器内容 */
671
1541
  value: string;
1542
+ /** 内容变化回调 */
672
1543
  onChange?: (value: string) => void;
1544
+ /** 实例初始化完成时调用,提供可用的实例或操作接口。 */
673
1545
  onReady?: (api: EditorHandle | null) => void;
1546
+ /** 编辑器选区变化时调用。 */
674
1547
  onSelectionChange?: (selection: EditorSelectionChange) => void;
1548
+ /** 键盘按下时调用,可用于处理快捷键。 */
675
1549
  onKeyDown?: (event: EditorKeyDownEvent) => void;
1550
+ /**
1551
+ * Monaco 语言标识
1552
+ * @defaultValue "plaintext"
1553
+ */
676
1554
  language?: EditorLanguage;
1555
+ /** 文件路径或文档标识,用于关联编辑器模型。 */
677
1556
  path?: string;
1557
+ /**
1558
+ 组件的配色主题。
1559
+ * @defaultValue "light"
1560
+ */
678
1561
  theme?: EditorTheme;
1562
+ /** Monaco 编辑器配置 */
679
1563
  options?: Monaco.editor.IStandaloneEditorConstructionOptions;
1564
+ /** 需要额外高亮的文档范围。 */
680
1565
  highlightRange?: EditorRange | null;
1566
+ /**
1567
+ * 在指定文本范围显示错误、警告或信息波浪线
1568
+ * @defaultValue []
1569
+ */
681
1570
  markers?: readonly EditorMarker[];
1571
+ /**
1572
+ * 右键菜单项目配置。
1573
+ * @defaultValue []
1574
+ */
682
1575
  contextMenuItems?: readonly EditorContextMenuItem[];
1576
+ /** 按当前文本和光标上下文异步提供智能提示 */
683
1577
  completionProvider?: EditorCompletionProvider;
1578
+ /**
1579
+ * 主动触发智能提示的字符
1580
+ * @defaultValue ["."]
1581
+ */
684
1582
  completionTriggerCharacters?: readonly string[];
1583
+ /**
1584
+ * 按空格时正常输入空格、关闭当前提示,并根据新的光标位置重新触发智能提示
1585
+ * @defaultValue false
1586
+ */
685
1587
  refreshSuggestionOnSpace?: boolean;
1588
+ /**
1589
+ * 附加到组件根节点的 CSS 类名。
1590
+ * @defaultValue ""
1591
+ */
686
1592
  className?: string;
1593
+ /**
1594
+ 控件的无障碍名称,供屏幕阅读器识别。
1595
+ * @defaultValue "代码编辑器"
1596
+ */
687
1597
  ariaLabel?: string;
1598
+ /**
1599
+ * 加载过程中的提示内容。
1600
+ * @defaultValue "正在加载编辑器…"
1601
+ */
688
1602
  loadingText?: string;
689
1603
  }
1604
+ /** 代码编辑器组件。 */
690
1605
  declare function Editor({ value, onChange, onReady, onSelectionChange, onKeyDown, language, path, theme, options, highlightRange, markers, contextMenuItems, completionProvider, completionTriggerCharacters, refreshSuggestionOnSpace, className, ariaLabel, loadingText, }: EditorProps): react.JSX.Element;
691
1606
 
1607
+ /** Markdown内容的属性配置。 */
692
1608
  interface MarkdownProps extends Omit<HTMLAttributes<HTMLElement>, "children"> {
1609
+ /** 需要渲染的 Markdown 源文本。 */
693
1610
  content: string;
1611
+ /**
1612
+ * 内容为空时显示的占位内容
1613
+ * @defaultValue "暂无 Markdown 内容"
1614
+ */
694
1615
  emptyText?: ReactNode;
1616
+ /** 图片加载失败时异步解析真实地址 */
695
1617
  resolveImageSrc?: (src: string) => string | Promise<string>;
1618
+ /**
1619
+ * 允许点击或键盘打开图片预览
1620
+ * @defaultValue true
1621
+ */
696
1622
  imagePreview?: boolean;
697
1623
  }
1624
+ /** Markdown内容组件。 */
698
1625
  declare function Markdown({ content, emptyText, resolveImageSrc, imagePreview, className, onClick, onKeyDown, ...props }: MarkdownProps): react.JSX.Element;
699
1626
 
1627
+ /** 数字输入的属性配置。 */
700
1628
  interface InputNumberProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "defaultValue" | "onChange" | "prefix" | "size" | "type" | "value"> {
1629
+ /** 当前数值(受控) */
701
1630
  value?: number | null;
1631
+ /**
1632
+ * 初始数值
1633
+ * @defaultValue null
1634
+ */
702
1635
  defaultValue?: number | null;
1636
+ /** 数值变化回调 */
703
1637
  onChange?: (value: number | null) => void;
1638
+ /** 允许的最小值。 */
704
1639
  min?: number;
1640
+ /** 允许的最大值。 */
705
1641
  max?: number;
1642
+ /**
1643
+ * 每次改变的步长
1644
+ * @defaultValue 1
1645
+ */
706
1646
  step?: number;
1647
+ /** 固定小数位数 */
707
1648
  precision?: number;
1649
+ /** small / medium / large 高度为 22 / 30 / 38px;默认继承 Form,组件自身 size 优先 */
708
1650
  size?: ControlSize;
1651
+ /**
1652
+ * 当前状态,用于选择对应的状态样式。
1653
+ * @defaultValue "default"
1654
+ */
709
1655
  status?: ControlStatus;
1656
+ /** 输入框前缀 */
710
1657
  prefix?: ReactNode;
1658
+ /** 输入框后缀 */
711
1659
  suffix?: ReactNode;
1660
+ /**
1661
+ 是否显示操作控件。
1662
+ * @defaultValue true
1663
+ */
712
1664
  controls?: boolean;
1665
+ /** 占位文案的显示模式 */
713
1666
  placeholderMode?: InputPlaceholderMode;
714
1667
  }
1668
+ /** 数字输入组件。 */
715
1669
  declare const InputNumber: react.ForwardRefExoticComponent<InputNumberProps & react.RefAttributes<HTMLInputElement>>;
716
1670
 
1671
+ /** 独立选择弹框的配置。 */
1672
+ interface SelectModalConfig extends Omit<ModalOpenConfig, "children" | "footer" | "onOk" | "type"> {
1673
+ /** 可供用户选择的候选项列表。 */
1674
+ options: readonly SelectOption[];
1675
+ /** 弹框打开时的初始选中值;通过返回句柄 update({ value }) 可替换当前草稿。 */
1676
+ value?: SelectChangeValue;
1677
+ /** 展示或交互模式;可选值见类型定义。 */
1678
+ mode?: SelectProps["mode"];
1679
+ /** 在选项名称下方显示 value,下拉与弹框模式均支持;不影响按 value 搜索 */
1680
+ showValue?: boolean;
1681
+ /** 弹框选项每行列数;长文本单行省略。 */
1682
+ columns?: number;
1683
+ /** 允许的最大高度。 */
1684
+ maxHeight?: number;
1685
+ /** 搜索框的占位提示文字。 */
1686
+ searchPlaceholder?: string;
1687
+ /** 自定义搜索匹配函数,返回 true 时保留该选项。 */
1688
+ filterOption?: SelectProps["filterOption"];
1689
+ /** 搜索条件变化或提交搜索时调用,具体参数见签名。 */
1690
+ onSearch?: SelectProps["onSearch"];
1691
+ /** 确认后接收选中的值和对应选项;单选为单值,多选为数组。支持异步处理;返回 false 或抛出异常时保留弹框,允许重试。 */
1692
+ onConfirm?: (value: SelectChangeValue, option: SelectOption | SelectOption[] | null) => ModalActionResult;
1693
+ }
1694
+ /** 无需渲染 Select,直接打开选择弹框。取消不提交,确认支持异步处理及返回 false 阻止关闭。 */
1695
+ declare function openSelectModal(config: SelectModalConfig): OverlayApiHandle<SelectModalConfig>;
1696
+
1697
+ /** 矩形树图节点的种类。 */
717
1698
  type TreemapNodeKind = "directory" | "file";
1699
+ /** 可下钻矩形树图的节点,包含权重、子节点和业务数据。 */
718
1700
  interface TreemapNode {
1701
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
719
1702
  key: string;
1703
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
720
1704
  label: string;
1705
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
721
1706
  value: number;
1707
+ /** 补全项或节点的类别。 */
722
1708
  kind?: TreemapNodeKind;
1709
+ /** 显示颜色,可使用 CSS 颜色值。 */
723
1710
  color?: string;
1711
+ /** 附加的业务元数据。 */
724
1712
  meta?: ReactNode;
1713
+ /** 用于布局计算的权重值。 */
725
1714
  layoutValue?: number;
1715
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
726
1716
  children?: readonly TreemapNode[];
1717
+ /** 是否包含子节点。 */
727
1718
  hasChildren?: boolean;
1719
+ /** 是否禁用交互。 */
728
1720
  disabled?: boolean;
729
1721
  }
1722
+ /** TreemapNode的点击事件上下文。 */
730
1723
  interface TreemapNodeClickInfo {
1724
+ /** 当前操作关联的节点数据。 */
731
1725
  node: TreemapNode;
1726
+ /** 是否处于展开状态。 */
732
1727
  expanded: boolean;
1728
+ /** 触发本次操作的原生事件。 */
733
1729
  nativeEvent: MouseEvent<HTMLElement>;
734
1730
  }
1731
+ /** 矩形树图的属性配置。 */
735
1732
  interface TreemapProps extends Omit<HTMLAttributes<HTMLDivElement>, "onChange"> {
1733
+ /** 用于渲染的数据集合。 */
736
1734
  data: readonly TreemapNode[];
1735
+ /**
1736
+ * 高亮节点键值
1737
+ * @defaultValue null
1738
+ */
737
1739
  activeKey?: string | null;
1740
+ /** 受控的展开节点标识集合。 */
738
1741
  expandedKeys?: readonly string[];
1742
+ /**
1743
+ * 初始化时展开的节点标识集合。
1744
+ * @defaultValue []
1745
+ */
739
1746
  defaultExpandedKeys?: readonly string[];
1747
+ /** 当前聚焦节点的唯一标识。 */
740
1748
  focusedKey?: string | null;
1749
+ /**
1750
+ * 初始化时聚焦的节点标识。
1751
+ * @defaultValue null
1752
+ */
741
1753
  defaultFocusedKey?: string | null;
1754
+ /**
1755
+ * 预设或自定义间距
1756
+ * @defaultValue 2
1757
+ */
742
1758
  gap?: number;
1759
+ /**
1760
+ * 标题区域高度。
1761
+ * @defaultValue 28
1762
+ */
743
1763
  headerHeight?: number;
1764
+ /**
1765
+ * 显示标签所需的最小宽度。
1766
+ * @defaultValue 26
1767
+ */
744
1768
  minLabelWidth?: number;
1769
+ /**
1770
+ * 显示标签所需的最小高度。
1771
+ * @defaultValue 18
1772
+ */
745
1773
  minLabelHeight?: number;
1774
+ /**
1775
+ * 矩形块的最小宽度。
1776
+ * @defaultValue 28
1777
+ */
746
1778
  minTileWidth?: number;
1779
+ /**
1780
+ * 矩形块的最小高度。
1781
+ * @defaultValue 18
1782
+ */
747
1783
  minTileHeight?: number;
1784
+ /**
1785
+ * 最大可见节点数,超出后合并为其他项
1786
+ * @defaultValue 180
1787
+ */
748
1788
  maxVisibleNodes?: number;
1789
+ /**
1790
+ * 没有数据时的显示内容。
1791
+ * @defaultValue "暂无数据"
1792
+ */
749
1793
  emptyContent?: ReactNode;
1794
+ /**
1795
+ 将数值格式化为显示文本的函数。
1796
+ * @defaultValue defaultValueFormatter
1797
+ */
750
1798
  valueFormatter?: (value: number, node: TreemapNode) => ReactNode;
1799
+ /** 自定义合并节点文案 */
751
1800
  overflowLabel?: (count: number) => string;
1801
+ /** 展开状态改变时调用。 */
752
1802
  onExpandedChange?: (keys: string[]) => void;
1803
+ /** 聚焦节点改变时调用。 */
753
1804
  onFocusedChange?: (key: string | null) => void;
1805
+ /** 节点点击回调 */
754
1806
  onNodeClick?: (info: TreemapNodeClickInfo) => void;
755
1807
  }
1808
+ /** 矩形树图组件。 */
756
1809
  declare function Treemap({ data, activeKey, expandedKeys, defaultExpandedKeys, focusedKey, defaultFocusedKey, gap, headerHeight, minLabelWidth, minLabelHeight, minTileWidth, minTileHeight, maxVisibleNodes, emptyContent, valueFormatter, overflowLabel, onExpandedChange, onFocusedChange, onNodeClick, className, style, ...props }: TreemapProps): react.JSX.Element;
757
1810
 
1811
+ /** 表格行或列的唯一标识类型。 */
758
1812
  type TableKey = Key;
1813
+ /** 表格列的固定方向。 */
759
1814
  type TableFixed = "left" | "right";
1815
+ /** 表格单元格的水平对齐方式。 */
760
1816
  type TableAlign = "left" | "center" | "right";
1817
+ /** 表格行高和字号的尺寸等级。 */
761
1818
  type TableSize = "small" | "medium" | "large";
1819
+ /** 经过表格插件处理的行数据及其层级和索引信息。 */
762
1820
  interface TableRow<T> {
1821
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
763
1822
  key: TableKey;
1823
+ /** 当前业务记录。 */
764
1824
  record: T;
1825
+ /** 记录在原始数据中的索引。 */
765
1826
  sourceIndex: number;
1827
+ /** 当前节点或行的嵌套深度。 */
766
1828
  depth: number;
1829
+ /** 附加的业务元数据。 */
767
1830
  meta: Record<string, unknown>;
768
1831
  }
1832
+ /** 单元格渲染和事件回调的上下文,包含行、列和索引。 */
769
1833
  interface TableCellRenderInfo<T> {
1834
+ /** 当前行记录。 */
770
1835
  row: TableRow<T>;
1836
+ /** 行索引,从 0 开始。 */
771
1837
  rowIndex: number;
1838
+ /** 当前单元格对应的完整列配置。 */
772
1839
  column: TableColumn<T>;
773
1840
  }
1841
+ /** TableMergeSticky的配置。 */
774
1842
  interface TableMergeStickyConfig<T> {
1843
+ /** 内容或选区与外边缘之间的内缩距离。 */
775
1844
  inset?: number;
1845
+ /** 组件或浮层的堆叠层级。 */
776
1846
  zIndex?: number;
1847
+ /** 附加到组件根节点的 CSS 类名。 */
777
1848
  className?: string;
1849
+ /** 组件根节点的内联样式。 */
778
1850
  style?: CSSProperties;
1851
+ /** 交叉轴对齐 */
779
1852
  align?: TableAlign;
1853
+ /** 读取当前内容。 */
780
1854
  getValue?: (record: T, index: number, rows: readonly T[]) => ReactNode;
781
1855
  }
1856
+ /** 表格的列定义,支持取值、渲染、固定、排序和分组表头。 */
782
1857
  interface TableColumn<T = Record<string, unknown>> {
1858
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
783
1859
  key: string;
1860
+ /** 代码内容或按键代码。 */
784
1861
  code?: string;
1862
+ /** 名称或字段标识。 */
785
1863
  name?: string;
1864
+ /** 标题内容,可传入文本或 React 节点。 */
786
1865
  title?: ReactNode;
1866
+ /** 补充说明内容。 */
787
1867
  description?: ReactNode;
1868
+ /** 读取单元格值的字段名或嵌套路径。 */
788
1869
  dataIndex?: keyof T | string | readonly string[];
1870
+ /** 列宽,单位为像素;拖拽调整后可由列设置插件持久化。 */
789
1871
  width?: number;
1872
+ /** 弹性布局的伸缩权重或 CSS flex 配置。 */
790
1873
  flex?: number;
1874
+ /** 是否根据单元格内容自动计算列宽。 */
791
1875
  autoWidth?: boolean;
1876
+ /** 允许的最小宽度。 */
792
1877
  minWidth?: number;
1878
+ /** 允许的最大宽度。 */
793
1879
  maxWidth?: number;
1880
+ /** 交叉轴对齐 */
794
1881
  align?: TableAlign;
1882
+ /** 固定列位置:left 固定在左侧,right 固定在右侧;未设置时随横向滚动。 */
795
1883
  fixed?: TableFixed | boolean;
1884
+ /** 是否隐藏此项。 */
796
1885
  hidden?: boolean;
797
1886
  /** 默认单行显示并省略溢出内容(含 Space 标签组);设为 false 允许多行。 */
798
1887
  ellipsis?: boolean;
1888
+ /** 是否使用 Sia Tooltip 显示完整文本;默认 false,不生成浏览器原生 title。 */
799
1889
  showTitle?: boolean;
1890
+ /** 是否允许该列排序。 */
800
1891
  sortable?: boolean;
1892
+ /** 是否允许该列筛选。 */
801
1893
  filterable?: boolean;
1894
+ /** 纯文本编辑;text 用于受控内容,onChange 在保存时触发 */
802
1895
  editable?: boolean | TableEditableCellConfig<T>;
1896
+ /** 是否将该列包含在导出结果中。 */
803
1897
  exportable?: boolean;
1898
+ /** 将单元格值转换为导出内容的函数。 */
804
1899
  exportRender?: (value: unknown, record: T, index: number, info: TableCellRenderInfo<T>) => ReactNode;
1900
+ /** 单元格跨越的行数,或按行计算跨行数量。 */
805
1901
  rowSpan?: boolean | keyof T | string | readonly string[] | ((record: T, index: number, rows: readonly T[]) => unknown);
1902
+ /** 合并单元格是否随滚动保持粘性定位。 */
806
1903
  mergeSticky?: boolean | TableMergeStickyConfig<T>;
1904
+ /** 合计行对此列的求和方式或求和值。 */
807
1905
  sum?: boolean;
1906
+ /** 子内容;组件嵌套内容或当前节点的子项。 */
808
1907
  children?: readonly TableColumn<T>[];
1908
+ /** 自定义数据单元格内容,接收该列的值、行数据和单元格上下文。 */
809
1909
  render?: (value: unknown, record: T, index: number, info: TableCellRenderInfo<T>) => ReactNode;
1910
+ /** 自定义列头内容。 */
810
1911
  renderHeader?: (column: TableColumn<T>, context: TablePluginContext<T, any>) => ReactNode;
1912
+ /** 数据单元格的 CSS 类名,也可按单元格计算。 */
811
1913
  cellClassName?: string | ((record: T, index: number) => string);
1914
+ /** 表头单元格的附加 CSS 类名。 */
812
1915
  headerClassName?: string;
1916
+ /** 附加的业务元数据。 */
813
1917
  meta?: Record<string, unknown>;
814
1918
  }
1919
+ /** TableEditableCell的类型标识。 */
815
1920
  type TableEditableCellType = "input" | "inputNumber" | "select" | "custom";
1921
+ /** TableEditableCell的配置。 */
816
1922
  interface TableEditableCellConfig<T> {
1923
+ /** 类型标识,用于选择对应的表现形式。 */
817
1924
  type?: TableEditableCellType;
1925
+ /** 可供用户选择的候选项列表。 */
818
1926
  options?: readonly {
1927
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
819
1928
  label: ReactNode;
1929
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
820
1930
  value: string | number;
821
1931
  }[];
1932
+ /** 自定义单元格编辑控件。 */
822
1933
  editRender?: (record: T, save: (value: unknown) => void, cancel: () => void) => ReactNode;
1934
+ /** 判断当前单元格是否允许编辑。 */
823
1935
  canEdit?: (record: T) => boolean;
824
1936
  }
1937
+ /** 表格插件执行时的上下文,提供数据、列、状态和事件操作。 */
825
1938
  interface TablePluginContext<T, S = unknown> {
1939
+ /** 插件唯一标识。 */
826
1940
  readonly pluginId: string;
1941
+ /** 未经插件处理的原始数据。 */
827
1942
  readonly sourceData: readonly T[];
1943
+ /** 未经插件转换的基础列配置。 */
828
1944
  readonly baseColumns: readonly TableColumn<T>[];
1945
+ /** 默认可见行数 */
829
1946
  readonly rows: readonly TableRow<T>[];
1947
+ /** 列配置或选项布局列数,具体类型见签名。 */
830
1948
  readonly columns: readonly TableColumn<T>[];
1949
+ /** 当前状态快照。 */
831
1950
  readonly state: S;
1951
+ /** 读取记录的唯一标识。 */
832
1952
  getRowKey: (record: T, index: number) => TableKey;
1953
+ /** 读取当前状态。 */
833
1954
  getState: <Value = unknown>(pluginId: string) => Value | undefined;
1955
+ /** 更新当前状态,可传入基于旧状态的更新函数。 */
834
1956
  setState: (next: S | ((previous: S) => S)) => void;
1957
+ /** 更新指定插件的状态。 */
835
1958
  setPluginState: <Value>(pluginId: string, next: Value | ((previous: Value) => Value)) => void;
1959
+ /** 按插件标识获取该插件暴露的 API。 */
836
1960
  getPluginApi: <Api = unknown>(pluginId: string) => Api | undefined;
1961
+ /** 发出事件,通知已注册的插件监听者。 */
837
1962
  emit: (event: TablePluginEvent) => void;
838
1963
  }
1964
+ /** 表格插件间传递的事件,包含类型、来源和负载。 */
839
1965
  interface TablePluginEvent {
1966
+ /** 类型标识,用于选择对应的表现形式。 */
840
1967
  type: string;
1968
+ /** 触发来源,用于区分不同入口的操作。 */
841
1969
  source: string;
1970
+ /** 事件携带的数据。 */
842
1971
  payload?: unknown;
843
1972
  }
1973
+ /** TablePluginCell的属性配置。 */
844
1974
  interface TablePluginCellProps {
1975
+ /** 单元格跨越的行数,或按行计算跨行数量。 */
845
1976
  rowSpan?: number;
1977
+ /** 单元格跨越的列数。 */
846
1978
  colSpan?: number;
1979
+ /** 是否隐藏此项。 */
847
1980
  hidden?: boolean;
1981
+ /** 附加到组件根节点的 CSS 类名。 */
848
1982
  className?: string;
1983
+ /** 组件根节点的内联样式。 */
849
1984
  style?: CSSProperties;
1985
+ /** 需要显示的内容,支持文本或 React 节点。 */
850
1986
  content?: ReactNode;
851
1987
  }
1988
+ /** TablePluginHeaderCell的属性配置。 */
852
1989
  interface TablePluginHeaderCellProps {
1990
+ /** 附加到组件根节点的 CSS 类名。 */
853
1991
  className?: string;
1992
+ /** 组件根节点的内联样式。 */
854
1993
  style?: CSSProperties;
855
1994
  }
1995
+ /** 表格插件契约,提供数据转换、渲染扩展、事件监听和对外 API。 */
856
1996
  interface TablePlugin<T, S = unknown, Api = unknown> {
1997
+ /** 唯一标识,用于关联实例或插件。 */
857
1998
  id: string;
1999
+ /** 排序位置或排序方向。 */
858
2000
  order?: number;
2001
+ /** 是否禁用虚拟渲染。 */
859
2002
  disableVirtual?: boolean;
2003
+ /** 插件或功能初始化时的状态。 */
860
2004
  initialState?: S | (() => S);
2005
+ /** 转换列配置;返回值传递给后续插件和表格渲染。 */
861
2006
  transformColumns?: (columns: readonly TableColumn<T>[], context: TablePluginContext<T, S>) => readonly TableColumn<T>[];
2007
+ /** 转换行数据;返回值传递给后续插件和表格渲染。 */
862
2008
  transformRows?: (rows: readonly TableRow<T>[], context: TablePluginContext<T, S>) => readonly TableRow<T>[];
2009
+ /** 渲染表格工具栏起始区域。 */
863
2010
  renderToolbarStart?: (context: TablePluginContext<T, S>) => ReactNode;
2011
+ /** 渲染表格工具栏末尾区域。 */
864
2012
  renderToolbarEnd?: (context: TablePluginContext<T, S>) => ReactNode;
2013
+ /** 渲染表格合计区域。 */
865
2014
  renderSummary?: (context: TablePluginContext<T, S>) => readonly TableSummaryRow[] | null;
2015
+ /** 渲染底部内容。 */
866
2016
  renderFooter?: (context: TablePluginContext<T, S>) => ReactNode;
2017
+ /** 渲染覆盖层或弹出面板。 */
867
2018
  renderOverlay?: (context: TablePluginContext<T, S>) => ReactNode;
2019
+ /** 根据行信息生成 CSS 类名。 */
868
2020
  getRowClassName?: (row: TableRow<T>, context: TablePluginContext<T, S>) => string;
2021
+ /** 根据单元格上下文生成附加属性。 */
869
2022
  getCellProps?: (row: TableRow<T>, column: TableColumn<T>, context: TablePluginContext<T, S>) => TablePluginCellProps | void;
2023
+ /** 根据列信息生成表头附加属性。 */
870
2024
  getHeaderCellProps?: (column: TableColumn<T>, context: TablePluginContext<T, S>) => TablePluginHeaderCellProps | void;
2025
+ /** 点击行时调用。 */
871
2026
  onRowClick?: (row: TableRow<T>, context: TablePluginContext<T, S>) => void;
2027
+ /** 鼠标进入行时调用。 */
872
2028
  onRowMouseEnter?: (row: TableRow<T>, context: TablePluginContext<T, S>) => void;
2029
+ /** 鼠标离开行时调用。 */
873
2030
  onRowMouseLeave?: (row: TableRow<T>, context: TablePluginContext<T, S>) => void;
2031
+ /** 鼠标进入单元格时调用。 */
874
2032
  onCellMouseEnter?: (row: TableRow<T>, column: TableColumn<T>, context: TablePluginContext<T, S>) => void;
2033
+ /** 鼠标离开单元格时调用。 */
875
2034
  onCellMouseLeave?: (row: TableRow<T>, column: TableColumn<T>, context: TablePluginContext<T, S>) => void;
2035
+ /** 点击单元格时调用。 */
876
2036
  onCellClick?: (row: TableRow<T>, column: TableColumn<T>, event: MouseEvent<HTMLTableCellElement>, context: TablePluginContext<T, S>) => void;
2037
+ /** 指针在单元格按下时调用。 */
877
2038
  onCellPointerDown?: (row: TableRow<T>, column: TableColumn<T>, event: PointerEvent<HTMLTableCellElement>, context: TablePluginContext<T, S>) => void;
2039
+ /** 指针在单元格移动时调用。 */
878
2040
  onCellPointerMove?: (row: TableRow<T>, column: TableColumn<T>, event: PointerEvent<HTMLTableCellElement>, context: TablePluginContext<T, S>) => void;
2041
+ /** 指针在表头按下时调用。 */
879
2042
  onHeaderPointerDown?: (column: TableColumn<T>, event: PointerEvent<HTMLTableCellElement>, context: TablePluginContext<T, S>) => void;
2043
+ /** 指针在表头移动时调用。 */
880
2044
  onHeaderPointerMove?: (column: TableColumn<T>, event: PointerEvent<HTMLTableCellElement>, context: TablePluginContext<T, S>) => void;
2045
+ /** 插件挂载时调用;可返回清理函数,在卸载时执行。 */
881
2046
  onMount?: (context: TablePluginContext<T, S>) => void | (() => void);
2047
+ /** 接收其他插件或表格发出的事件。 */
882
2048
  onEvent?: (event: TablePluginEvent, context: TablePluginContext<T, S>) => void;
2049
+ /** 创建插件对外暴露的操作 API。 */
883
2050
  getApi?: (context: TablePluginContext<T, S>) => Api;
884
2051
  }
2052
+ /** 可组合到 Table.plugins 中的表格插件类型。 */
885
2053
  type AnyTablePlugin<T> = TablePlugin<T, any, any>;
2054
+ /** 一条小计或总计行的标签和单元格内容。 */
886
2055
  interface TableSummaryRow {
2056
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
887
2057
  key: string;
2058
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
888
2059
  label?: ReactNode;
2060
+ /** 字段值或选中值的集合。 */
889
2061
  values: Record<string, ReactNode>;
2062
+ /** 附加到组件根节点的 CSS 类名。 */
890
2063
  className?: string;
891
2064
  }
2065
+ /** 表格的属性配置。 */
892
2066
  interface TableProps<T extends Record<string, unknown> = Record<string, unknown>> extends Omit<HTMLAttributes<HTMLDivElement>, "children"> {
2067
+ /** 表格或列表的原始数据集合。 */
893
2068
  dataSource?: readonly T[];
2069
+ /** 表格列定义;支持 children 构建分组表头。 */
894
2070
  columns?: readonly TableColumn<T>[];
2071
+ /** 行唯一键字段或计算函数 */
895
2072
  rowKey?: keyof T | string | ((record: T, index: number) => TableKey);
896
2073
  /** 默认启用行悬停高亮;传入 createHighlightPlugin({ row: false }) 可关闭。 */
897
2074
  plugins?: readonly AnyTablePlugin<T>[];
2075
+ /** 是否处于加载状态。 */
898
2076
  loading?: boolean;
2077
+ /** 内容为空时显示的占位内容 */
899
2078
  emptyText?: ReactNode;
2079
+ /** 高度;数值按像素处理,字符串可使用 CSS 尺寸。 */
900
2080
  height?: number | string;
2081
+ /** 表格滚动区域的高度。 */
901
2082
  tableHeight?: number | string;
2083
+ /** 表格密度 */
902
2084
  size?: TableSize;
2085
+ /** 是否显示边框。 */
903
2086
  bordered?: boolean;
904
2087
  /** 是否显示行分隔线(含表头和汇总行),默认 true。 */
905
2088
  rowBordered?: boolean;
@@ -907,297 +2090,538 @@ interface TableProps<T extends Record<string, unknown> = Record<string, unknown>
907
2090
  columnBordered?: boolean;
908
2091
  /** 是否将工具栏纳入表格边框,默认 false;表格主体边框仍由 bordered 控制。 */
909
2092
  toolbarBordered?: boolean;
2093
+ /** 是否显示隔行背景。 */
910
2094
  striped?: boolean;
2095
+ /** 长列表启用窗口化渲染 */
911
2096
  virtual?: boolean;
2097
+ /** 启用虚拟滚动的选项数量 */
912
2098
  virtualThreshold?: number;
2099
+ /** 行高度,虚拟滚动用其计算行位置。 */
913
2100
  rowHeight?: number;
2101
+ /** 虚拟列表在可视区域前后额外渲染的数量。 */
914
2102
  overscan?: number;
2103
+ /** 滚动时是否固定表头。 */
915
2104
  stickyHeader?: boolean;
2105
+ /** 是否允许拖拽表头边界调整列宽;默认启用内置列宽调整插件。 */
916
2106
  resizable?: boolean;
2107
+ /** 点击行时调用。 */
917
2108
  onRowClick?: (record: T, index: number) => void;
2109
+ /** 双击行时调用。 */
918
2110
  onRowDoubleClick?: (record: T, index: number) => void;
2111
+ /** 单元格右键事件,可用于业务上下文菜单 */
919
2112
  onCellContextMenu?: (record: T, column: TableColumn<T>, index: number, event: MouseEvent<HTMLTableCellElement>) => void;
2113
+ /** 行的 CSS 类名或计算函数。 */
920
2114
  rowClassName?: string | ((record: T, index: number) => string);
2115
+ /** 表格元素的内联样式。 */
921
2116
  tableStyle?: CSSProperties;
922
2117
  }
2118
+ /** 表格的实例引用接口。 */
923
2119
  interface TableRef<T> {
2120
+ /** 读取插件当前处理的行数据。 */
924
2121
  getRows: () => readonly T[];
2122
+ /** 读取当前表格列配置。 */
925
2123
  getColumns: () => readonly TableColumn<T>[];
2124
+ /** 按插件标识获取该插件暴露的 API。 */
926
2125
  getPluginApi: <Api = unknown>(pluginId: string) => Api | undefined;
2126
+ /** 滚动到指定位置。 */
927
2127
  scrollTo: (options: ScrollToOptions) => void;
2128
+ /** 切换加载状态。 */
928
2129
  setLoading: (loading: boolean) => void;
2130
+ /** 读取当前分页状态。 */
929
2131
  getPage: () => {
2132
+ /** 当前页码、步骤或播放位置,具体取值见组件类型。 */
930
2133
  current: number;
2134
+ /** 每页显示的记录数。 */
931
2135
  pageSize: number;
932
2136
  };
2137
+ /** 设置当前页码与分页参数。 */
933
2138
  setPage: (page: Partial<{
2139
+ /** 当前页码、步骤或播放位置,具体取值见组件类型。 */
934
2140
  current: number;
2141
+ /** 每页显示的记录数。 */
935
2142
  pageSize: number;
936
2143
  }>) => void;
2144
+ /** 清空当前选择。 */
937
2145
  clearSelection: () => void;
2146
+ /** 设置选中行标识集合。 */
938
2147
  setSelectedKeys: (keys: readonly TableKey[]) => void;
2148
+ /** 读取当前选中的行数据。 */
939
2149
  getSelectedRows: () => readonly T[];
2150
+ /** 读取当前排序列及方向。 */
940
2151
  getSortInfo: () => TableSortInfo | null;
2152
+ /** 读取当前列设置。 */
941
2153
  getColumnSettings: () => readonly TableColumnSettingItem[];
2154
+ /** 打开列设置面板。 */
942
2155
  openColumnSetting: () => void;
2156
+ /** 将分页状态转换为业务请求需要的参数。 */
943
2157
  generatePageParams: <Model extends Record<string, unknown>>(model: Model) => Model & TablePageParams;
2158
+ /** 请求记录总数的函数。 */
944
2159
  requestCount: (model?: unknown) => Promise<void>;
945
2160
  }
2161
+ /** 当前排序列和排序方向。 */
946
2162
  interface TableSortInfo {
2163
+ /** 字段名或字段路径。 */
947
2164
  field: string;
2165
+ /** 排序位置或排序方向。 */
948
2166
  order: "ascend" | "descend" | null;
2167
+ /** 配置存储的作用域,用于隔离不同模块和业务表格。 */
949
2168
  scope?: "page" | "all";
950
2169
  }
2170
+ /** 传递给业务数据请求的分页参数。 */
951
2171
  interface TablePageParams {
2172
+ /** 当前页码、步骤或播放位置,具体取值见组件类型。 */
952
2173
  current: number;
2174
+ /** 当前页索引。 */
953
2175
  pageIndex: number;
2176
+ /** 每页显示的记录数。 */
954
2177
  pageSize: number;
2178
+ /** 请求数据时跳过的记录数。 */
955
2179
  skipCount: number;
2180
+ /** 请求数据时最多返回的记录数。 */
956
2181
  maxResultCount: number;
957
2182
  }
2183
+ /** TableColumnSetting的项目定义。 */
958
2184
  interface TableColumnSettingItem {
2185
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
959
2186
  key: string;
2187
+ /** 宽度;数值按像素处理,字符串可使用 CSS 尺寸。 */
960
2188
  width?: number;
2189
+ /** 列固定位置,left 固定左侧,right 固定右侧。 */
961
2190
  fixed?: TableFixed;
2191
+ /** 是否可见。 */
962
2192
  visible: boolean;
2193
+ /** 排序位置或排序方向。 */
963
2194
  order: number;
964
2195
  }
2196
+ /** 可持久化的表格列设置和分页大小快照。 */
965
2197
  interface TableSettingsSnapshot {
2198
+ /** 列配置或选项布局列数,具体类型见签名。 */
966
2199
  columns?: readonly TableColumnSettingItem[];
2200
+ /** 每页显示的记录数。 */
967
2201
  pageSize?: number;
2202
+ /** 配置格式版本号,用于兼容历史数据。 */
968
2203
  version?: number;
969
2204
  }
2205
+ /** 读取与保存表格设置的适配器契约。 */
970
2206
  interface TableSettingsAdapter {
2207
+ /** 按 scope 读取表格配置;首次挂载及打开列设置时调用。无已保存配置时返回 null 或 undefined。 */
971
2208
  load: (scope: {
2209
+ /** 所属业务模块名称。 */
972
2210
  moduleName: string;
2211
+ /** 同一模块内用于区分表格配置的业务标识。 */
973
2212
  businessKey: string;
974
2213
  }) => Promise<TableSettingsSnapshot | null>;
2214
+ /** 按 scope 保存完整的列设置快照。用于列设置应用、拖拽列宽结束或分页大小变化后的持久化,可返回 Promise。 */
975
2215
  save: (scope: {
2216
+ /** 所属业务模块名称。 */
976
2217
  moduleName: string;
2218
+ /** 同一模块内用于区分表格配置的业务标识。 */
977
2219
  businessKey: string;
978
2220
  }, settings: TableSettingsSnapshot) => Promise<void>;
979
2221
  }
980
2222
 
2223
+ /** 表格组件。 */
981
2224
  declare const Table: <T extends Record<string, unknown> = Record<string, unknown>>(props: TableProps<T> & {
982
2225
  ref?: Ref<TableRef<T>>;
983
2226
  }) => ReactElement | null;
984
2227
 
2228
+ /** TableColumnTransform的插件配置。 */
985
2229
  interface TableColumnTransformPluginOptions<T> {
2230
+ /** 插入在原有列之前的列配置。 */
986
2231
  prepend?: readonly TableColumn<T>[];
2232
+ /** 追加在原有列之后的列配置。 */
987
2233
  append?: readonly TableColumn<T>[];
2234
+ /** 转换表格列配置,返回用于后续处理和渲染的新列集合。 */
988
2235
  transform?: (columns: readonly TableColumn<T>[]) => readonly TableColumn<T>[];
989
2236
  }
2237
+ /** 创建表格列转换插件。将返回值加入 Table 的 plugins 后生效。 */
990
2238
  declare function createColumnTransformPlugin<T extends Record<string, unknown>>(options: TableColumnTransformPluginOptions<T>): TablePlugin<T, undefined>;
2239
+ /** TableHighlight的值类型。 */
991
2240
  type TableHighlightValue = boolean | CSSProperties;
2241
+ /** TableHighlight的插件配置。 */
992
2242
  interface TableHighlightPluginOptions {
2243
+ /** 当前行记录。 */
993
2244
  row?: TableHighlightValue;
2245
+ /** 列号或当前列配置,具体含义由所在类型决定。 */
994
2246
  column?: TableHighlightValue;
2247
+ /** 当前单元格的配置或状态。 */
995
2248
  cell?: TableHighlightValue;
996
2249
  }
2250
+ /** 当前高亮的行和列。 */
997
2251
  interface HighlightState {
2252
+ /** 当前高亮行的标识。 */
998
2253
  rowKey?: TableKey;
2254
+ /** 当前高亮列的标识。 */
999
2255
  columnKey?: string;
1000
2256
  }
2257
+ /** 创建表格行和单元格高亮插件。将返回值加入 Table 的 plugins 后生效。 */
1001
2258
  declare function createHighlightPlugin<T extends Record<string, unknown>>(options?: TableHighlightPluginOptions): TablePlugin<T, HighlightState>;
2259
+ /** 通过行标识和列标识定位一个单元格。 */
1002
2260
  interface TableCellAddress {
2261
+ /** 行唯一键字段或计算函数 */
1003
2262
  rowKey: TableKey;
2263
+ /** 列的唯一标识,对应 TableColumn.key。 */
1004
2264
  columnKey: string;
1005
2265
  }
2266
+ /** 通过起止单元格定义的选区。 */
1006
2267
  interface TableCellRange {
2268
+ /** 单元格选区的起始锚点。 */
1007
2269
  anchor: TableCellAddress;
2270
+ /** 将焦点移入控件。 */
1008
2271
  focus: TableCellAddress;
1009
2272
  }
2273
+ /** 选区内一个单元格的值和行列上下文。 */
1010
2274
  interface TableSelectedCell<T> {
2275
+ /** 行唯一键字段或计算函数 */
1011
2276
  rowKey: TableKey;
2277
+ /** 列的唯一标识,对应 TableColumn.key。 */
1012
2278
  columnKey: string;
2279
+ /** 当前业务记录。 */
1013
2280
  record: T;
2281
+ /** 列号或当前列配置,具体含义由所在类型决定。 */
1014
2282
  column: TableColumn<T>;
2283
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
1015
2284
  value: unknown;
2285
+ /** 行索引,从 0 开始。 */
1016
2286
  rowIndex: number;
2287
+ /** 列索引,从 0 开始。 */
1017
2288
  columnIndex: number;
1018
2289
  }
2290
+ /** TableCellSelection的插件配置。 */
1019
2291
  interface TableCellSelectionPluginOptions<T> {
2292
+ /** 初始化时的单元格选区。 */
1020
2293
  defaultRange?: TableCellRange | null;
2294
+ /** 是否包含勾选、序号等工具列。 */
1021
2295
  includeUtilityColumns?: boolean;
2296
+ /** 复制完整文本,可指定复制内容和成功回调 */
1022
2297
  copyable?: boolean;
2298
+ /** 判断指定单元格是否允许加入选区。 */
1023
2299
  isCellSelectable?: (record: T, column: TableColumn<T>, rowIndex: number, columnIndex: number) => boolean;
2300
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
1024
2301
  onChange?: (range: TableCellRange | null, cells: readonly TableSelectedCell<T>[]) => void;
2302
+ /** 复制操作触发后的回调。 */
1025
2303
  onCopy?: (text: string, cells: readonly TableSelectedCell<T>[]) => void;
1026
2304
  }
2305
+ /** 表格单元格选区状态。 */
1027
2306
  interface CellSelectionState {
2307
+ /** 当前单元格选区,null 表示无选区。 */
1028
2308
  range: TableCellRange | null;
2309
+ /** 复制选区时是否包含表头。 */
1029
2310
  includeHeaders: boolean;
2311
+ /** 通过表头选择的列标识。 */
1030
2312
  selectedHeaderKey: string | null;
1031
2313
  }
2314
+ /** TableCellSelection的操作接口。 */
1032
2315
  interface TableCellSelectionApi<T> {
2316
+ /** 读取当前单元格选区。 */
1033
2317
  getRange: () => TableCellRange | null;
2318
+ /** 设置单元格选区,传入空值可清除选区。 */
1034
2319
  setRange: (range: TableCellRange | null) => void;
2320
+ /** 清空当前值或内容。 */
1035
2321
  clear: () => void;
2322
+ /** 读取当前选区中的单元格信息。 */
1036
2323
  getSelectedCells: () => readonly TableSelectedCell<T>[];
2324
+ /** 将当前选区转换为可复制文本。 */
1037
2325
  getCopyText: () => string;
1038
2326
  }
2327
+ /** 创建表格单元格区域选择插件。将返回值加入 Table 的 plugins 后生效。 */
1039
2328
  declare function createCellSelectionPlugin<T extends Record<string, unknown>>(options?: TableCellSelectionPluginOptions<T>): TablePlugin<T, CellSelectionState, TableCellSelectionApi<T>>;
2329
+ /** TableRowSpan的插件配置。 */
1040
2330
  interface TableRowSpanPluginOptions<T> {
2331
+ /** 列配置或选项布局列数,具体类型见签名。 */
1041
2332
  columns?: readonly string[];
2333
+ /** 自定义两个值的相等性判断。 */
1042
2334
  equals?: (left: unknown, right: unknown, column: TableColumn<T>) => boolean;
2335
+ /** 是否禁用虚拟渲染。 */
1043
2336
  disableVirtual?: boolean;
1044
2337
  }
2338
+ /** 创建表格跨行合并插件。将返回值加入 Table 的 plugins 后生效。 */
1045
2339
  declare function createRowSpanPlugin<T extends Record<string, unknown>>(options?: TableRowSpanPluginOptions<T>): TablePlugin<T, undefined>;
2340
+ /** TableSelection的模式类型。 */
1046
2341
  type TableSelectionMode = "single" | "multiple" | "row";
2342
+ /** TableSelection的插件配置。 */
1047
2343
  interface TableSelectionPluginOptions<T> {
2344
+ /** 展示或交互模式;可选值见类型定义。 */
1048
2345
  mode?: TableSelectionMode;
2346
+ /** 当前选中项目的标识集合;传入后由外部控制。 */
1049
2347
  selectedKeys?: readonly TableKey[];
2348
+ /** 非受控模式下初始选中的项目标识集合。 */
1050
2349
  defaultSelectedKeys?: readonly TableKey[];
2350
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
1051
2351
  onChange?: (keys: readonly TableKey[], rows: readonly T[]) => void;
2352
+ /** 按行判断其勾选框是否禁用。 */
1052
2353
  getCheckboxDisabled?: (record: T) => boolean;
2354
+ /** 是否展示已选记录数。 */
1053
2355
  showSelectedCount?: boolean;
2356
+ /** 切换页面或数据源时是否保留已选行标识。 */
1054
2357
  preserveSelectedRowKeys?: boolean;
2358
+ /** 是否显示跨页保留勾选的开关。 */
1055
2359
  showPreserveSelectedRowKeys?: boolean;
2360
+ /** 已选记录面板的列数。 */
1056
2361
  selectionPanelColumnCount?: number;
2362
+ /** 已选记录面板最多展示的条数。 */
1057
2363
  selectionPanelMaxCount?: number;
2364
+ /** 跨页保留勾选开关变化时调用。 */
1058
2365
  onPreserveSelectedRowKeysChange?: (preserve: boolean) => void;
2366
+ /** 行数据中存放子行的字段名。 */
1059
2367
  childrenColumnName?: string;
1060
2368
  }
2369
+ /** 行勾选和已选面板状态。 */
1061
2370
  interface SelectionState {
2371
+ /** 当前选中的行标识。 */
1062
2372
  selectedKeys: readonly TableKey[];
2373
+ /** 是否跨页保留选中行。 */
1063
2374
  preserveSelectedRowKeys: boolean;
2375
+ /** 已选记录面板是否打开。 */
1064
2376
  panelOpen: boolean;
1065
2377
  }
2378
+ /** TableSelection的操作接口。 */
1066
2379
  interface TableSelectionApi<T> {
2380
+ /** 读取当前选中行的标识。 */
1067
2381
  getSelectedKeys: () => readonly TableKey[];
2382
+ /** 设置选中行标识集合。 */
1068
2383
  setSelectedKeys: (keys: readonly TableKey[]) => void;
2384
+ /** 清空当前值或内容。 */
1069
2385
  clear: () => void;
2386
+ /** 切换指定行的选中状态。 */
1070
2387
  toggle: (key: TableKey, checked?: boolean) => void;
2388
+ /** 读取当前选中的行数据。 */
1071
2389
  getSelectedRows: () => readonly T[];
2390
+ /** 读取是否跨页保留选中行。 */
1072
2391
  getPreserveSelectedRowKeys: () => boolean;
2392
+ /** 设置是否跨页保留选中行。 */
1073
2393
  setPreserveSelectedRowKeys: (preserve: boolean) => void;
1074
2394
  }
2395
+ /** 创建表格行勾选插件。将返回值加入 Table 的 plugins 后生效。 */
1075
2396
  declare function createSelectionPlugin<T extends Record<string, unknown>>(options?: TableSelectionPluginOptions<T>): TablePlugin<T, SelectionState, TableSelectionApi<T>>;
2397
+ /** TableSort的插件配置。 */
1076
2398
  interface TableSortPluginOptions {
2399
+ /** 展示或交互模式;可选值见类型定义。 */
1077
2400
  mode?: "local" | "remote";
2401
+ /** 配置存储的作用域,用于隔离不同模块和业务表格。 */
1078
2402
  scope?: "page" | "all";
2403
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
1079
2404
  value?: TableSortInfo | null;
2405
+ /** 非受控模式的初始值,仅在初始化时使用。 */
1080
2406
  defaultValue?: TableSortInfo | null;
2407
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
1081
2408
  onChange?: (sort: TableSortInfo) => void;
2409
+ /** 比较两条记录的排序函数;负数表示前者排在前面。 */
1082
2410
  compare?: (a: unknown, b: unknown, field: string) => number;
1083
2411
  }
2412
+ /** 表格排序状态。 */
1084
2413
  interface SortState {
2414
+ /** 当前排序配置。 */
1085
2415
  sort: TableSortInfo | null;
1086
2416
  }
2417
+ /** TableSort的操作接口。 */
1087
2418
  interface TableSortApi {
2419
+ /** 读取当前排序列及方向。 */
1088
2420
  getSortInfo: () => TableSortInfo | null;
2421
+ /** 设置当前排序信息。 */
1089
2422
  setSortInfo: (sort: TableSortInfo | null) => void;
2423
+ /** 清空当前值或内容。 */
1090
2424
  clear: () => void;
1091
2425
  }
2426
+ /** 创建表格列排序插件。将返回值加入 Table 的 plugins 后生效。 */
1092
2427
  declare function createSortPlugin<T extends Record<string, unknown>>(options?: TableSortPluginOptions): TablePlugin<T, SortState, TableSortApi>;
2428
+ /** 列标识到筛选条件的映射。 */
1093
2429
  type TableFilterValues = Readonly<Record<string, string>>;
2430
+ /** TableFilter的插件配置。 */
1094
2431
  interface TableFilterPluginOptions<T> {
2432
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
1095
2433
  value?: TableFilterValues;
2434
+ /** 非受控模式的初始值,仅在初始化时使用。 */
1096
2435
  defaultValue?: TableFilterValues;
2436
+ /** 未填写或未选择时的提示内容。 */
1097
2437
  placeholder?: string | ((column: TableColumn<T>) => string);
2438
+ /** 用于判断记录是否满足条件的函数。 */
1098
2439
  predicate?: (value: unknown, filterValue: string, record: T, column: TableColumn<T>) => boolean;
2440
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
1099
2441
  onChange?: (filters: TableFilterValues) => void;
1100
2442
  }
2443
+ /** 表格筛选条件状态。 */
1101
2444
  interface FilterState {
2445
+ /** 按列保存的筛选条件。 */
1102
2446
  filters: Record<string, string>;
1103
2447
  }
2448
+ /** TableFilter的操作接口。 */
1104
2449
  interface TableFilterApi<T> {
2450
+ /** 读取当前筛选条件。 */
1105
2451
  getFilters: () => TableFilterValues;
2452
+ /** 设置指定列的筛选条件。 */
1106
2453
  setFilter: (columnKey: string, value: string) => void;
2454
+ /** 清空当前值或内容。 */
1107
2455
  clear: (columnKey?: string) => void;
2456
+ /** 读取应用筛选后的行数据。 */
1108
2457
  getFilteredRows: () => readonly T[];
1109
2458
  }
2459
+ /** 创建表格数据筛选插件。将返回值加入 Table 的 plugins 后生效。 */
1110
2460
  declare function createFilterPlugin<T extends Record<string, unknown>>(options?: TableFilterPluginOptions<T>): TablePlugin<T, FilterState, TableFilterApi<T>>;
2461
+ /** TablePagination的插件配置。 */
1111
2462
  interface TablePaginationPluginOptions {
2463
+ /** 展示或交互模式;可选值见类型定义。 */
1112
2464
  mode?: "local" | "server" | "auto";
2465
+ /** 记录总条数。 */
1113
2466
  totalCount?: number;
2467
+ /** 当前页码、步骤或播放位置,具体取值见组件类型。 */
1114
2468
  current?: number;
2469
+ /** 每页显示的记录数。 */
1115
2470
  pageSize?: number;
2471
+ /** 非受控模式的初始页码或步骤位置。 */
1116
2472
  defaultCurrent?: number;
2473
+ /** 非受控模式下每页默认展示的记录数。 */
1117
2474
  defaultPageSize?: number;
2475
+ /** 每页条数候选项 */
1118
2476
  pageSizeOptions?: readonly number[];
2477
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
1119
2478
  onChange?: (current: number, pageSize: number, isFirstLoad?: boolean) => void;
2479
+ /** 按分页上下文异步请求总记录数。 */
1120
2480
  requestTotal?: (model?: unknown) => Promise<void>;
2481
+ /** 是否为首次加载。 */
1121
2482
  isFirstLoad?: boolean;
1122
2483
  }
2484
+ /** 表格分页和总数请求状态。 */
1123
2485
  interface PaginationState {
2486
+ /** 当前页码。 */
1124
2487
  current: number;
2488
+ /** 每页记录数。 */
1125
2489
  pageSize: number;
2490
+ /** 是否正在请求记录总数。 */
1126
2491
  requestLoading: boolean;
1127
2492
  }
2493
+ /** TablePagination的操作接口。 */
1128
2494
  interface TablePaginationApi {
2495
+ /** 读取当前分页状态。 */
1129
2496
  getPage: () => {
2497
+ /** 当前页码、步骤或播放位置,具体取值见组件类型。 */
1130
2498
  current: number;
2499
+ /** 每页显示的记录数。 */
1131
2500
  pageSize: number;
1132
2501
  };
2502
+ /** 设置当前页码与分页参数。 */
1133
2503
  setPage: (page: Partial<{
2504
+ /** 当前页码、步骤或播放位置,具体取值见组件类型。 */
1134
2505
  current: number;
2506
+ /** 每页显示的记录数。 */
1135
2507
  pageSize: number;
1136
2508
  }>) => void;
2509
+ /** 将分页状态转换为业务请求需要的参数。 */
1137
2510
  generatePageParams: <Model extends Record<string, unknown>>(model: Model) => Model & TablePageParams;
2511
+ /** 请求记录总数的函数。 */
1138
2512
  requestCount: (model?: unknown) => Promise<void>;
1139
2513
  }
2514
+ /** 创建表格分页插件。将返回值加入 Table 的 plugins 后生效。 */
1140
2515
  declare function createPaginationPlugin<T extends Record<string, unknown>>(options?: TablePaginationPluginOptions): TablePlugin<T, PaginationState, TablePaginationApi>;
2516
+ /** TableIndex的插件配置。 */
1141
2517
  interface TableIndexPluginOptions {
2518
+ /** 标题内容,可传入文本或 React 节点。 */
1142
2519
  title?: ReactNode;
2520
+ /** 宽度;数值按像素处理,字符串可使用 CSS 尺寸。 */
1143
2521
  width?: number;
2522
+ /** 序号列的起始编号。 */
1144
2523
  startIndex?: number;
1145
2524
  }
2525
+ /** 创建表格序号列插件。将返回值加入 Table 的 plugins 后生效。 */
1146
2526
  declare function createIndexPlugin<T extends Record<string, unknown>>(options?: TableIndexPluginOptions): TablePlugin<T, undefined>;
2527
+ /** TableTree的插件配置。 */
1147
2528
  interface TableTreePluginOptions<T> {
2529
+ /** 行数据中存放子行的字段名。 */
1148
2530
  childrenColumnName?: string;
2531
+ /** 是否忽略数据内的子行字段。 */
1149
2532
  ignoreChildrenColumn?: boolean;
2533
+ /** 受控的展开行标识集合。 */
1150
2534
  expandedRowKeys?: readonly TableKey[];
2535
+ /** 初始化时展开的行标识集合。 */
1151
2536
  defaultExpandedRowKeys?: readonly TableKey[];
2537
+ /** 是否在初始化时展开全部行。 */
1152
2538
  defaultExpandAllRows?: boolean;
2539
+ /** 展开行集合变化时调用。 */
1153
2540
  onExpandedRowsChange?: (keys: readonly TableKey[]) => void;
2541
+ /** 按记录判断是否允许展开该行。 */
1154
2542
  canExpand?: (record: T) => boolean;
1155
2543
  }
2544
+ /** 树形行的展开状态。 */
1156
2545
  interface TreeState {
2546
+ /** 已展开的行标识集合。 */
1157
2547
  expandedKeys: readonly TableKey[];
1158
2548
  }
2549
+ /** TableTree的操作接口。 */
1159
2550
  interface TableTreeApi {
2551
+ /** 读取展开行或节点的标识集合。 */
1160
2552
  getExpandedKeys: () => readonly TableKey[];
2553
+ /** 设置展开行或节点的标识集合。 */
1161
2554
  setExpandedKeys: (keys: readonly TableKey[]) => void;
2555
+ /** 展开全部可展开行或节点。 */
1162
2556
  expandAll: () => void;
2557
+ /** 收起全部已展开行或节点。 */
1163
2558
  collapseAll: () => void;
1164
2559
  }
2560
+ /** 创建表格树形行展开插件。将返回值加入 Table 的 plugins 后生效。 */
1165
2561
  declare function createTreePlugin<T extends Record<string, unknown>>(options?: TableTreePluginOptions<T>): TablePlugin<T, TreeState, TableTreeApi>;
2562
+ /** TableSummary的插件配置。 */
1166
2563
  interface TableSummaryPluginOptions<T> {
2564
+ /** 当前数据范围的小计配置。 */
1167
2565
  subTotal?: Record<string, ReactNode> | ((pageData: readonly T[]) => Record<string, ReactNode>);
2566
+ /** 数据总数 */
1168
2567
  total?: Record<string, ReactNode>;
2568
+ /** 小计行的标题文案。 */
1169
2569
  subTotalLabel?: ReactNode;
2570
+ /** 总计行的标题文案。 */
1170
2571
  totalLabel?: ReactNode;
1171
2572
  }
2573
+ /** 创建表格小计与总计插件。将返回值加入 Table 的 plugins 后生效。 */
1172
2574
  declare function createSummaryPlugin<T extends Record<string, unknown>>(options: TableSummaryPluginOptions<T>): TablePlugin<T, undefined>;
2575
+ /** 表格当前编辑单元格的状态。 */
1173
2576
  interface EditableState {
2577
+ /** 是否处于编辑状态。 */
1174
2578
  editing: {
2579
+ /** 行唯一键字段或计算函数 */
1175
2580
  rowKey: TableKey;
2581
+ /** 列的唯一标识,对应 TableColumn.key。 */
1176
2582
  columnKey: string;
1177
2583
  } | null;
1178
2584
  }
2585
+ /** TableEditable的插件配置。 */
1179
2586
  interface TableEditablePluginOptions<T> {
2587
+ /** 单元格编辑值变化时调用,接收行、列及新旧值等上下文。 */
1180
2588
  onCellChange?: (columnKey: string, record: T, newValue: unknown) => boolean | Promise<boolean>;
2589
+ /** 触发显示的交互方式。 */
1181
2590
  trigger?: "click" | "doubleClick";
1182
2591
  }
2592
+ /** TableEditable的操作接口。 */
1183
2593
  interface TableEditableApi {
2594
+ /** 取消当前编辑或操作。 */
1184
2595
  cancel: () => void;
2596
+ /** 读取当前正在编辑的单元格。 */
1185
2597
  getEditingCell: () => EditableState["editing"];
1186
2598
  }
2599
+ /** 创建表格单元格编辑插件。将返回值加入 Table 的 plugins 后生效。 */
1187
2600
  declare function createEditablePlugin<T extends Record<string, unknown>>(options?: TableEditablePluginOptions<T>): TablePlugin<T, EditableState, TableEditableApi>;
2601
+ /** 已调整列宽和手动布局状态。 */
1188
2602
  interface ResizeState {
2603
+ /** 列标识到已调整宽度的映射。 */
1189
2604
  widths: Record<string, number>;
2605
+ /** 是否已启用手动列宽布局。 */
1190
2606
  manualLayout?: boolean;
1191
2607
  }
2608
+ /** TableResize的插件配置。 */
1192
2609
  interface TableResizePluginOptions {
2610
+ /** 是否启用该功能。 */
1193
2611
  enabled?: boolean;
2612
+ /** 拖拽调整列宽结束时调用,接收 columnKey 和最终宽度(px);拖动过程中不会逐帧触发。 */
1194
2613
  onResize?: (columnKey: string, width: number) => void;
1195
2614
  }
2615
+ /** TableResize的操作接口。 */
1196
2616
  interface TableResizeApi {
2617
+ /** 读取已调整的列宽映射,键为列标识。 */
1197
2618
  getWidths: () => Readonly<Record<string, number>>;
2619
+ /** 设置指定列的宽度,并通知列宽变更监听者。 */
1198
2620
  setWidth: (columnKey: string, width: number) => void;
1199
2621
  }
2622
+ /** 创建表格列宽拖拽调整插件。将返回值加入 Table 的 plugins 后生效。 */
1200
2623
  declare function createResizePlugin<T extends Record<string, unknown>>(options?: TableResizePluginOptions): TablePlugin<T, ResizeState, TableResizeApi>;
2624
+ /** TableColumnSetting的插件配置。 */
1201
2625
  interface TableColumnSettingPluginOptions<T> {
1202
2626
  /** 设置按钮的完整 Button 属性;className 合并,disabled/loading 同时禁用菜单触发。 */
1203
2627
  buttonProps?: ButtonProps;
@@ -1205,218 +2629,501 @@ interface TableColumnSettingPluginOptions<T> {
1205
2629
  menuItems?: readonly TableToolbarItem<T>[];
1206
2630
  /** 是否显示设置菜单中的导出操作,默认 true。 */
1207
2631
  showExport?: boolean;
2632
+ /** 未读取到保存配置时默认显示的列标识。 */
1208
2633
  defaultVisibleKeys?: readonly string[];
2634
+ /** 是否在工具栏显示此插件的操作按钮。 */
1209
2635
  showButton?: boolean;
2636
+ /** 可见列集合变化时调用。 */
1210
2637
  onVisibleChange?: (columns: readonly TableColumn<T>[]) => void;
2638
+ /** 列顺序变化时调用。 */
1211
2639
  onOrderChange?: (columns: readonly TableColumn<T>[]) => void;
2640
+ /** 配置持久化适配器,提供 load 和 save 方法对接本地或云端存储。 */
1212
2641
  adapter?: TableSettingsAdapter;
2642
+ /** 配置存储的作用域,用于隔离不同模块和业务表格。 */
1213
2643
  scope?: {
2644
+ /** 所属业务模块名称。 */
1214
2645
  moduleName: string;
2646
+ /** 同一模块内用于区分表格配置的业务标识。 */
1215
2647
  businessKey: string;
1216
2648
  };
1217
2649
  }
2650
+ /** 列设置插件的加载、面板和持久化状态。 */
1218
2651
  interface ColumnSettingState {
2652
+ /** 列设置面板是否打开。 */
1219
2653
  open: boolean;
2654
+ /** 当前列设置集合。 */
1220
2655
  items: readonly TableColumnSettingItem[];
2656
+ /** 是否已完成一次配置读取。 */
1221
2657
  loaded: boolean;
2658
+ /** 是否正在读取配置。 */
1222
2659
  loading?: boolean;
2660
+ /** 最近一次配置读取是否失败。 */
1223
2661
  loadError?: boolean;
2662
+ /** 用于忽略过期读取响应的请求标记。 */
1224
2663
  loadToken?: symbol;
2664
+ /** 每页记录数。 */
1225
2665
  pageSize?: number;
1226
2666
  }
2667
+ /** TableColumnSetting的操作接口。 */
1227
2668
  interface TableColumnSettingApi {
2669
+ /** 打开列设置面板,并通过已配置的适配器重新读取保存配置。 */
1228
2670
  open: () => void;
2671
+ /** 关闭当前界面或实例。 */
1229
2672
  close: () => void;
2673
+ /** 读取当前列设置快照。 */
1230
2674
  getSettings: () => readonly TableColumnSettingItem[];
2675
+ /** 应用传入的配置;是否持久化由方法参数或插件选项控制。 */
1231
2676
  apply: (settings: readonly TableColumnSettingItem[]) => void;
1232
2677
  }
2678
+ /** 创建表格列设置和持久化插件。将返回值加入 Table 的 plugins 后生效。 */
1233
2679
  declare function createColumnSettingPlugin<T extends Record<string, unknown>>(options?: TableColumnSettingPluginOptions<T>): TablePlugin<T, ColumnSettingState, TableColumnSettingApi>;
2680
+ /** 创建使用 localStorage 持久化表格设置的适配器,按模块及业务标识隔离配置。 */
1234
2681
  declare function createLocalStorageTableSettingsAdapter(prefix?: string): TableSettingsAdapter;
2682
+ /** TableToolbar的项目定义。 */
1235
2683
  interface TableToolbarItem<T> {
2684
+ /** 唯一标识;同一集合内应保持唯一且稳定,用于定位、渲染和状态关联。 */
1236
2685
  key: string;
2686
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
1237
2687
  label: ReactNode;
2688
+ /** 显示在内容旁的图标节点,建议使用 Icon 组件。 */
1238
2689
  icon?: ReactNode;
2690
+ /** 显示位置或定位配置。 */
1239
2691
  position?: "start" | "end";
2692
+ /** 是否允许该列出现在列设置面板中。 */
1240
2693
  inSettings?: boolean;
2694
+ /** 危险操作样式 */
1241
2695
  danger?: boolean;
2696
+ /** 是否禁用交互。 */
1242
2697
  disabled?: boolean | ((context: TablePluginContext<T, any>) => boolean);
2698
+ /** 是否隐藏此项。 */
1243
2699
  hidden?: boolean | ((context: TablePluginContext<T, any>) => boolean);
2700
+ /** 点击时触发,参数为当前点击事件或项目上下文。 */
1244
2701
  onClick?: (context: TablePluginContext<T, any>) => void | Promise<void>;
1245
2702
  }
2703
+ /** TableToolbar的插件配置。 */
1246
2704
  interface TableToolbarPluginOptions<T> {
2705
+ /** 范围起点。 */
1247
2706
  start?: ReactNode;
2707
+ /** 范围终点。 */
1248
2708
  end?: ReactNode;
2709
+ /** 按展示顺序排列的项目配置。 */
1249
2710
  items?: readonly TableToolbarItem<T>[];
2711
+ /** 按业务权限判断是否允许访问或展示。 */
1250
2712
  canAccess?: (item: TableToolbarItem<T>) => boolean;
1251
2713
  }
2714
+ /** 创建表格工具栏操作插件。将返回值加入 Table 的 plugins 后生效。 */
1252
2715
  declare function createToolbarPlugin<T extends Record<string, unknown>>(options: TableToolbarPluginOptions<T>): TablePlugin<T, undefined>;
2716
+ /** 表格导出的数据范围。 */
1253
2717
  type TableExportScope = "visible" | "all" | "selected";
2718
+ /** TableExport的插件配置。 */
1254
2719
  interface TableExportPluginOptions<T> {
2720
+ /** 配置存储的作用域,用于隔离不同模块和业务表格。 */
1255
2721
  scope?: TableExportScope;
2722
+ /** 导出文件名。 */
1256
2723
  fileName?: string | ((context: TablePluginContext<T, undefined>) => string);
2724
+ /** CSV 字段分隔符。 */
1257
2725
  delimiter?: "," | "\t" | ";";
2726
+ /** 是否在导出文本前添加 UTF-8 BOM,便于表格软件识别中文。 */
1258
2727
  includeBom?: boolean;
2728
+ /** 是否处理可能被表格软件当作公式执行的单元格文本。 */
1259
2729
  sanitizeFormula?: boolean;
2730
+ /** 操作按钮的显示文案。 */
1260
2731
  buttonLabel?: ReactNode;
2732
+ /** 是否在工具栏显示此插件的操作按钮。 */
1261
2733
  showButton?: boolean;
2734
+ /** 执行导出时调用。 */
1262
2735
  onExport?: (csv: string, rows: readonly T[]) => void | Promise<void>;
1263
2736
  }
2737
+ /** TableExport的操作接口。 */
1264
2738
  interface TableExportApi<T> {
2739
+ /** 生成当前导出范围的 CSV 文本。 */
1265
2740
  getCsv: (scope?: TableExportScope) => string;
2741
+ /** 下载当前导出结果。 */
1266
2742
  download: (scope?: TableExportScope) => Promise<void>;
2743
+ /** 读取插件当前处理的行数据。 */
1267
2744
  getRows: (scope?: TableExportScope) => readonly T[];
1268
2745
  }
2746
+ /** 创建表格数据导出插件。将返回值加入 Table 的 plugins 后生效。 */
1269
2747
  declare function createExportPlugin<T extends Record<string, unknown>>(options?: TableExportPluginOptions<T>): TablePlugin<T, undefined, TableExportApi<T>>;
1270
2748
 
2749
+ /** 主题切换的属性配置。 */
1271
2750
  interface ThemeSwitchProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, "onChange"> {
2751
+ /** 当前是否勾选;作为受控属性时通过回调更新。 */
1272
2752
  checked: boolean;
2753
+ /** 状态变化时返回最新布尔值 */
1273
2754
  onCheckedChange?: (checked: boolean) => void;
2755
+ /**
2756
+ * 亮色主题的显示文案。
2757
+ * @defaultValue "亮色模式"
2758
+ */
1274
2759
  lightLabel?: string;
2760
+ /**
2761
+ * 暗色主题的显示文案。
2762
+ * @defaultValue "暗色模式"
2763
+ */
1275
2764
  darkLabel?: string;
1276
2765
  }
2766
+ /** 主题切换组件。 */
1277
2767
  declare const ThemeSwitch: react.ForwardRefExoticComponent<ThemeSwitchProps & react.RefAttributes<HTMLButtonElement>>;
1278
2768
 
2769
+ /** 浮动滚动条接入组件的属性配置。 */
1279
2770
  interface FloatingScrollbarProviderProps {
2771
+ /**
2772
+ * 是否禁用交互。
2773
+ * @defaultValue false
2774
+ */
1280
2775
  disabled?: boolean;
1281
2776
  /** 仅接管指定容器;不传时接管页面中的滚动容器。 */
1282
2777
  targetRef?: RefObject<HTMLElement | null>;
1283
2778
  }
2779
+ /** 浮动滚动条接入组件组件。 */
1284
2780
  declare function FloatingScrollbarProvider({ disabled, targetRef }: FloatingScrollbarProviderProps): null;
1285
2781
 
2782
+ /** SiaTheme的模式类型。 */
1286
2783
  type SiaThemeMode = "light" | "dark";
2784
+ /** 框架主题令牌集合。 */
1287
2785
  declare const SIA_THEME: {
2786
+ /** 主色。 */
1288
2787
  readonly colorPrimary: "#1677ff";
2788
+ /** 主色的悬停色。 */
1289
2789
  readonly colorPrimaryHover: "#4096ff";
2790
+ /** 主色的按下色。 */
1290
2791
  readonly colorPrimaryActive: "#0958d9";
2792
+ /** 主要文本颜色。 */
1291
2793
  readonly colorText: "#1f1f1f";
2794
+ /** 次要文本颜色。 */
1292
2795
  readonly colorTextSecondary: "#666666";
2796
+ /** 页面背景颜色。 */
1293
2797
  readonly colorBackground: "#f5f7fa";
2798
+ /** 组件表面颜色。 */
1294
2799
  readonly colorSurface: "#ffffff";
2800
+ /** 默认边框颜色。 */
1295
2801
  readonly colorBorder: "#d9d9d9";
2802
+ /** 默认圆角半径,单位为像素。 */
1296
2803
  readonly borderRadius: 6;
2804
+ /** 默认控件高度,单位为像素。 */
1297
2805
  readonly controlHeight: 32;
2806
+ /** 默认布局间距,单位为像素。 */
1298
2807
  readonly spacing: 16;
2808
+ /** 默认字号,单位为像素。 */
1299
2809
  readonly fontSize: 16;
2810
+ /** 小号文字尺寸,单位为像素。 */
1300
2811
  readonly fontSizeSmall: 14;
2812
+ /** 大号文字尺寸,单位为像素。 */
1301
2813
  readonly fontSizeLarge: 18;
1302
2814
  };
2815
+ /** 将亮色或暗色主题应用到指定元素;省略目标时应用到文档根节点。 */
1303
2816
  declare function applySiaTheme(mode: SiaThemeMode, target?: HTMLElement): void;
1304
2817
 
2818
+ /** Selection的值类型。 */
1305
2819
  type SelectionValue = string | number;
2820
+ /** Selection的候选项定义。 */
1306
2821
  interface SelectionOption {
2822
+ /** 该项目对应的数据值,用于标识、选择或计算。 */
1307
2823
  value: SelectionValue;
2824
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
1308
2825
  label: ReactNode;
2826
+ /** 是否禁用交互。 */
1309
2827
  disabled?: boolean;
2828
+ /** 禁用项悬停时显示的原因说明。 */
1310
2829
  disabledTip?: ReactNode;
2830
+ /** 选项所属分组名称。 */
1311
2831
  group?: string;
2832
+ /** 普通或按钮形态 */
1312
2833
  optionType?: "divider";
1313
2834
  }
2835
+ /** 分组选择面板的属性配置。 */
1314
2836
  interface SelectionPanelProps {
2837
+ /** 可供用户选择的候选项列表。 */
1315
2838
  options: readonly SelectionOption[];
2839
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
1316
2840
  value: readonly SelectionValue[];
2841
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
1317
2842
  onChange: (values: SelectionValue[]) => void;
2843
+ /**
2844
+ 是否允许同时选择多个项目。
2845
+ * @defaultValue false
2846
+ */
1318
2847
  multiple?: boolean;
2848
+ /** 单选时允许再次点击已选项以清空选择。 */
2849
+ allowDeselect?: boolean;
2850
+ /**
2851
+ * 是否禁用交互。
2852
+ * @defaultValue false
2853
+ */
1319
2854
  disabled?: boolean;
2855
+ /**
2856
+ * 是否处于加载状态。
2857
+ * @defaultValue false
2858
+ */
1320
2859
  loading?: boolean;
2860
+ /**
2861
+ 是否显示搜索输入框。
2862
+ * @defaultValue true
2863
+ */
1321
2864
  showSearch?: boolean;
2865
+ /**
2866
+ 是否显示全选、反选、清空及已选数量操作行。
2867
+ * @defaultValue true
2868
+ */
1322
2869
  showActions?: boolean;
2870
+ /**
2871
+ * 是否将不在 options 中的已选值作为自定义选项展示。
2872
+ * @defaultValue true
2873
+ */
1323
2874
  includeUnknownValues?: boolean;
2875
+ /** 受控的搜索文本。 */
1324
2876
  searchValue?: string;
2877
+ /** 搜索条件变化或提交搜索时调用,具体参数见签名。 */
1325
2878
  onSearch?: (value: string) => void;
2879
+ /**
2880
+ * 是否只显示已选中的选项。
2881
+ * @defaultValue false
2882
+ */
1326
2883
  selectedOnly?: boolean;
2884
+ /**
2885
+ * 在选项名称下方显示 value,下拉与弹框模式均支持;不影响按 value 搜索
2886
+ * @defaultValue false
2887
+ */
1327
2888
  showValue?: boolean;
2889
+ /**
2890
+ * 选项主文本显示 label 还是 value。
2891
+ * @defaultValue "label"
2892
+ */
1328
2893
  displayField?: "label" | "value";
2894
+ /**
2895
+ * 每行选项列数;长文本在格内单行省略。
2896
+ * @defaultValue 1
2897
+ */
1329
2898
  columns?: number;
2899
+ /**
2900
+ * 允许的最大高度。
2901
+ * @defaultValue 250
2902
+ */
1330
2903
  maxHeight?: number;
2904
+ /**
2905
+ * 面板挂载后是否自动聚焦搜索框。
2906
+ * @defaultValue false
2907
+ */
1331
2908
  autoFocusSearch?: boolean;
1332
2909
  }
1333
2910
  /** 可嵌入下拉或弹窗的分组选择面板,长列表按行虚拟化。 */
1334
- declare function SelectionPanel({ options, value, onChange, multiple, disabled, loading, showSearch, showActions, includeUnknownValues, searchValue, onSearch, selectedOnly, showValue, displayField, columns, maxHeight, autoFocusSearch }: SelectionPanelProps): react.JSX.Element;
2911
+ declare function SelectionPanel({ options, value, onChange, multiple, allowDeselect, disabled, loading, showSearch, showActions, includeUnknownValues, searchValue, onSearch, selectedOnly, showValue, displayField, columns, maxHeight, autoFocusSearch }: SelectionPanelProps): react.JSX.Element;
1335
2912
 
2913
+ /** 输入选择组合控件的属性配置。 */
1336
2914
  interface InputSelectProps {
2915
+ /** 可供用户选择的候选项列表。 */
1337
2916
  options: readonly SelectionOption[];
2917
+ /** 当前值;作为受控属性时,需要在变更回调中同步更新。 */
1338
2918
  value?: SelectionValue | readonly SelectionValue[] | null;
2919
+ /** 非受控模式的初始值,仅在初始化时使用。 */
1339
2920
  defaultValue?: SelectionValue | readonly SelectionValue[];
2921
+ /** 值发生变化时调用;参数为新值及类型声明中列出的关联信息。 */
1340
2922
  onChange?: (value: SelectionValue | SelectionValue[] | undefined) => void;
2923
+ /**
2924
+ 是否允许同时选择多个项目。
2925
+ * @defaultValue false
2926
+ */
1341
2927
  multiple?: boolean;
2928
+ /**
2929
+ * 选项主文本显示 label 还是 value。
2930
+ * @defaultValue "label"
2931
+ */
1342
2932
  displayField?: "label" | "value";
2933
+ /**
2934
+ * 在选项名称下方显示 value,下拉与弹框模式均支持;不影响按 value 搜索
2935
+ * @defaultValue false
2936
+ */
1343
2937
  showValue?: boolean;
2938
+ /**
2939
+ * 未填写或未选择时的提示内容。
2940
+ * @defaultValue "请选择"
2941
+ */
1344
2942
  placeholder?: string;
2943
+ /** 占位提示的显示模式;floating 为浮动标签。 */
1345
2944
  placeholderMode?: InputPlaceholderMode;
2945
+ /** 组件尺寸;用于调整控件高度、字号和间距。 */
1346
2946
  size?: ControlSize;
2947
+ /** 当前状态,用于选择对应的状态样式。 */
1347
2948
  status?: ControlStatus;
2949
+ /**
2950
+ * 是否禁用交互。
2951
+ * @defaultValue false
2952
+ */
1348
2953
  disabled?: boolean;
2954
+ /**
2955
+ * 是否处于加载状态。
2956
+ * @defaultValue false
2957
+ */
1349
2958
  loading?: boolean;
2959
+ /**
2960
+ 是否允许清空当前选择或输入值。
2961
+ * @defaultValue true
2962
+ */
1350
2963
  allowClear?: boolean;
2964
+ /** 是否隐藏搜索输入框。 */
1351
2965
  hideSearch?: boolean;
2966
+ /** 手动输入内容的最大长度 */
1352
2967
  inputMaxLength?: number;
2968
+ /** 将输入文本解析为选项值的函数。 */
1353
2969
  parseInput?: (text: string) => SelectionValue | SelectionValue[] | undefined;
2970
+ /** 是否显示通过弹框选择的入口。 */
1354
2971
  enableModal?: boolean | {
2972
+ /** 标题内容,可传入文本或 React 节点。 */
1355
2973
  title?: string;
2974
+ /** 宽度;数值按像素处理,字符串可使用 CSS 尺寸。 */
1356
2975
  width?: number | string;
2976
+ /** 列配置或选项布局列数,具体类型见签名。 */
1357
2977
  columns?: number;
2978
+ /** 允许的最大高度。 */
1358
2979
  maxHeight?: number;
1359
2980
  };
2981
+ /** 输入框后缀 */
1360
2982
  suffix?: ReactNode;
2983
+ /** 组件根节点的内联样式。 */
1361
2984
  style?: CSSProperties;
2985
+ /**
2986
+ * 附加到组件根节点的 CSS 类名。
2987
+ * @defaultValue ""
2988
+ */
1362
2989
  className?: string;
2990
+ /** 唯一标识,用于关联实例或插件。 */
1363
2991
  id?: string;
2992
+ /** 辅助技术读取的控件名称。 */
1364
2993
  "aria-label"?: string;
2994
+ /** 向辅助技术声明该控件是否必填。 */
1365
2995
  "aria-required"?: boolean | "true" | "false";
2996
+ /** 打开状态改变时触发,参数为新的打开状态。 */
1366
2997
  onOpenChange?: (open: boolean) => void;
1367
2998
  }
2999
+ /** 输入选择组合控件组件。 */
1368
3000
  declare const InputSelect: react.ForwardRefExoticComponent<InputSelectProps & react.RefAttributes<HTMLInputElement>>;
1369
3001
 
3002
+ /** 查询区中的一个字段,复用 Form.Item 绑定能力并增加布局宽度配置。 */
1370
3003
  interface QueryFormField extends FormItemProps {
3004
+ /** 字段布局的稳定唯一标识;用于 React 渲染,不替代 Form.Item 的 name 字段路径。 */
1371
3005
  key: string;
1372
3006
  /** 字段占用宽度,默认由 fieldWidth 控制;组合字段可指定更大的宽度。 */
1373
3007
  width?: number | string;
1374
3008
  }
3009
+ /** 预设或已保存的快捷查询,包含名称、条件、颜色和可选数量徽标。 */
1375
3010
  interface QueryFormShortcut<T extends FormValues = FormValues> {
3011
+ /** 快捷查询的稳定唯一标识,用于选中态和 onSearch 的 info.shortcutKey;建议使用后端主键,不使用可变排序索引。 */
1376
3012
  key: string;
3013
+ /** 展示给用户的名称,可传入文本或 React 节点。 */
1377
3014
  label: ReactNode;
3015
+ /** 该快捷查询保存的条件。点击时先恢复表单初始值,再用这些字段覆盖;支持与 Form 字段一致的嵌套数据结构。 */
1378
3016
  values: Partial<T>;
3017
+ /** 是否禁用交互。 */
1379
3018
  disabled?: boolean;
3019
+ /** 底部已保存快捷标签的颜色状态;未指定时使用组件分配的配色。 */
1380
3020
  status?: TagStatus;
1381
3021
  /** 顶部快捷查询按钮尺寸,优先于 quickQuerySize。 */
1382
3022
  size?: ButtonSize;
1383
3023
  /** 该快捷查询对应的数据总量,由业务接口提供。 */
1384
3024
  count?: number;
3025
+ /** 顶部数量徽标的附加属性,例如 overflowCount、showZero 和颜色;徽标数量由同一快捷项的 count 提供。 */
1385
3026
  badgeProps?: Omit<BadgeProps, "children" | "count">;
1386
3027
  }
3028
+ /** 本次查询的触发来源及关联快捷查询标识。 */
1387
3029
  interface QueryFormSearchInfo {
3030
+ /** 查询来源:submit 为查询按钮或表单提交,reset 为重置后查询,quick 为顶部预设,saved 为底部已保存条件。 */
1388
3031
  source: "submit" | "reset" | "quick" | "saved";
3032
+ /** 触发查询的快捷项标识;普通查询或重置时可能未提供。 */
1389
3033
  shortcutKey?: string;
1390
3034
  }
3035
+ /** 查询表单的属性配置。 */
1391
3036
  interface QueryFormProps<T extends FormValues = FormValues> extends Omit<FormProps, "onFinish" | "children" | "onError"> {
3037
+ /** 查询字段配置,每项包含稳定 key、可选宽度以及 Form.Item 属性;提供后优先于 children。 */
1392
3038
  fields?: readonly QueryFormField[];
1393
3039
  /** 也可直接放入 Form.Item 或 Space.Compact,每个直接子项视为一个查询字段。 */
1394
3040
  children?: ReactNode;
3041
+ /** 表单校验通过后执行查询。values 是完整条件;info.source 区分 submit(查询)、reset(重置)、quick(顶部预设)和 saved(已保存条件)。返回 Promise 时自动显示加载状态并阻止重复提交。 */
1395
3042
  onSearch: (values: T, info: QueryFormSearchInfo) => void | Promise<void>;
3043
+ /**
3044
+ * 是否处于加载状态。
3045
+ * @defaultValue false
3046
+ */
1396
3047
  loading?: boolean;
3048
+ /**
3049
+ * 查询字段的默认宽度,数值单位为像素,可传 CSS 尺寸字符串。
3050
+ * @defaultValue 220
3051
+ */
1397
3052
  fieldWidth?: number | string;
3053
+ /**
3054
+ 是否显示展开和收起入口;false 时始终展示全部字段。
3055
+ * @defaultValue true
3056
+ */
1398
3057
  collapsible?: boolean;
3058
+ /** 受控收起状态,需在 onCollapsedChange 中更新。收起时保留字段挂载和值,只隐藏放不下的字段和底部快捷标签。 */
1399
3059
  collapsed?: boolean;
3060
+ /**
3061
+ * 非受控模式的初始收起状态。
3062
+ * @defaultValue false
3063
+ */
1400
3064
  defaultCollapsed?: boolean;
3065
+ /**
3066
+ * 收起时最多保留的字段数;实际数量会根据可用宽度减少,以保持单行。
3067
+ * @defaultValue 3
3068
+ */
1401
3069
  collapsedCount?: number;
3070
+ /** 收起状态变化回调 */
1402
3071
  onCollapsedChange?: (collapsed: boolean) => void;
3072
+ /**
3073
+ * 顶部预设快捷查询按钮。点击后先恢复 initialValues,再覆盖该项 values,校验并自动触发 onSearch。
3074
+ * @defaultValue []
3075
+ */
1403
3076
  quickQueries?: readonly QueryFormShortcut<T>[];
3077
+ /**
3078
+ * 顶部快捷查询按钮的默认尺寸,单项 size 优先。
3079
+ * @defaultValue "small"
3080
+ */
1404
3081
  quickQuerySize?: ButtonSize;
3082
+ /**
3083
+ * 底部已保存快捷查询标签。点击回填该项条件并查询;收起时隐藏。业务方负责加载数据,并在保存或删除成功后更新此数组。
3084
+ * @defaultValue []
3085
+ */
1405
3086
  savedQueries?: readonly QueryFormShortcut<T>[];
3087
+ /**
3088
+ * 快捷查询正在加载或更新时设为 true,期间禁用快捷操作。
3089
+ * @defaultValue false
3090
+ */
1406
3091
  shortcutsLoading?: boolean;
3092
+ /** 点击“另存为快捷查询”并确认名称后调用。query.name 为去除首尾空格的名称,query.values 为打开保存弹框时的条件快照。业务方负责持久化并更新 savedQueries;返回 Promise 时显示等待状态,失败保留弹框供重试。 */
1407
3093
  onSaveQuery?: (query: {
3094
+ /** 用户输入的快捷查询名称,已经去除首尾空格。 */
1408
3095
  name: string;
3096
+ /** 打开保存弹框时的完整查询条件快照。 */
1409
3097
  values: T;
1410
3098
  }) => void | Promise<void>;
3099
+ /** 删除已保存快捷项时调用,query 为被删除的完整快捷项。业务方负责持久化并更新 savedQueries;失败保留该项,删除操作不会触发查询。 */
1411
3100
  onRemoveQuery?: (query: QueryFormShortcut<T>) => void | Promise<void>;
3101
+ /** 查询、保存或删除失败时调用。error 为原始异常,operation 为 search、save 或 remove;组件同时显示错误提示。 */
1412
3102
  onError?: (error: unknown, operation: "search" | "save" | "remove") => void;
3103
+ /**
3104
+ * 查询按钮文案。
3105
+ * @defaultValue "查询"
3106
+ */
1413
3107
  searchText?: ReactNode;
3108
+ /**
3109
+ * 重置按钮文案。
3110
+ * @defaultValue "重置"
3111
+ */
1414
3112
  resetText?: ReactNode;
3113
+ /**
3114
+ * 保存快捷查询按钮文案。
3115
+ * @defaultValue "另存为快捷查询"
3116
+ */
1415
3117
  saveText?: ReactNode;
3118
+ /**
3119
+ * 点击重置后是否自动提交查询;false 时只恢复 initialValues,不调用 onSearch。
3120
+ * @defaultValue true
3121
+ */
1416
3122
  resetSearch?: boolean;
3123
+ /** 查询按钮组旁的自定义操作内容。 */
1417
3124
  actionsExtra?: ReactNode;
1418
3125
  }
1419
3126
  /** 可复用的业务查询表单;快捷查询的存储和结果数据由业务方管理。 */
1420
3127
  declare function QueryForm<T extends FormValues = FormValues>({ fields, children, form: providedForm, onSearch, loading, fieldWidth, collapsible, collapsed: controlledCollapsed, defaultCollapsed, collapsedCount, onCollapsedChange, quickQueries, quickQuerySize, savedQueries, shortcutsLoading, onSaveQuery, onRemoveQuery, onError, searchText, resetText, saveText, resetSearch, actionsExtra, disabled, className, placeholderMode, onValuesChange, onFinishFailed, ...formProps }: QueryFormProps<T>): react.JSX.Element;
1421
3128
 
1422
- export { Alert, type AlertProps, type AlertStatus, type AnyTablePlugin, BadgeProps, ButtonProps, ButtonSize, Cascader, type CascaderFieldNames, type CascaderOption, type CascaderProps, type CascaderValue, Checkbox, type CheckboxGroupProps, type CheckboxOption, type CheckboxProps, type CheckboxValue, Col, type ColProps, type ColSize, ColorPicker, type ColorPickerMode, type ColorPickerPreset, type ColorPickerProps, ControlSize, ControlStatus, DEFAULT_PAGE_SIZE_OPTIONS, Divider, type DividerProps, Drawer, type DrawerOpenConfig, type DrawerPlacement, type DrawerProps, type DrawerPush, type DrawerPushConfig, Editor, type EditorCommand, type EditorCompletionContext, type EditorCompletionItem, type EditorCompletionItemKind, type EditorCompletionProvider, type EditorContextMenuItem, type EditorHandle, type EditorKeyDownEvent, type EditorLanguage, type EditorMarker, type EditorProps, type EditorRange, type EditorSelectionChange, type EditorTheme, type FlatTreeNode, type FlatTreeOptions, Flex, type FlexProps, FloatingScrollbarProvider, type FloatingScrollbarProviderProps, Form, type FormErrorField, type FormInstance, type FormItemProps, type FormListField, type FormListOperation, type FormListProps, type FormProps, type FormRule, type FormValues, type GridBreakpoint, InputNumber, type InputNumberProps, InputPlaceholderMode, InputSelect, type InputSelectProps, type LayoutGap, Markdown, type MarkdownProps, type NamePath, OverlayApiHandle, Pagination, type PaginationProps, QueryForm, type QueryFormField, type QueryFormProps, type QueryFormSearchInfo, type QueryFormShortcut, Radio, type RadioGroupProps, type RadioOption, type RadioProps, type RadioValue, Row, type RowProps, SIA_THEME, type SelectionOption, SelectionPanel, type SelectionPanelProps, type SelectionValue, type SiaThemeMode, Slider, type SliderMark, type SliderProps, type SliderValue, Space, type SpaceCompactProps, type SpaceProps, Splitter, type SplitterPanelProps, type SplitterProps, Switch, type SwitchProps, type SwitchVariant, Table, type TableAlign, type TableCellAddress, type TableCellRange, type TableCellRenderInfo, type TableCellSelectionApi, type TableCellSelectionPluginOptions, type TableColumn, type TableColumnSettingApi, type TableColumnSettingItem, type TableColumnSettingPluginOptions, type TableColumnTransformPluginOptions, type TableEditableApi, type TableEditableCellConfig, type TableEditableCellType, type TableEditablePluginOptions, type TableExportApi, type TableExportPluginOptions, type TableExportScope, type TableFilterApi, type TableFilterPluginOptions, type TableFilterValues, type TableFixed, type TableHighlightPluginOptions, type TableHighlightValue, type TableIndexPluginOptions, type TableKey, type TableMergeStickyConfig, type TablePageParams, type TablePaginationApi, type TablePaginationPluginOptions, type TablePlugin, type TablePluginCellProps, type TablePluginContext, type TablePluginEvent, type TableProps, type TableRef, type TableResizeApi, type TableResizePluginOptions, type TableRow, type TableRowSpanPluginOptions, type TableSelectedCell, type TableSelectionApi, type TableSelectionMode, type TableSelectionPluginOptions, type TableSettingsAdapter, type TableSettingsSnapshot, type TableSize, type TableSortApi, type TableSortInfo, type TableSortPluginOptions, type TableSummaryPluginOptions, type TableSummaryRow, type TableToolbarItem, type TableToolbarPluginOptions, type TableTreeApi, type TableTreePluginOptions, TagStatus, TextArea, type TextAreaProps, ThemeSwitch, type ThemeSwitchProps, TimePicker, type TimePickerProps, type TimeRangePickerProps, ToolPanel, type ToolPanelItem, type ToolPanelPlacement, type ToolPanelProps, TreeSelect, type TreeSelectNode, type TreeSelectProps, type TreeSelectValue, Treemap, type TreemapNode, type TreemapNodeClickInfo, type TreemapNodeKind, type TreemapProps, type WindowAction, type WindowActionHandler, type WindowControlAction, type WindowControlLabels, WindowControls, type WindowControlsProps, WindowFrame, type WindowFrameProps, WindowTitleBar, type WindowTitleBarActionsAlign, type WindowTitleBarProps, applySiaTheme, buildFlatTree, createCellSelectionPlugin, createColumnSettingPlugin, createColumnTransformPlugin, createEditablePlugin, createExportPlugin, createFilterPlugin, createHighlightPlugin, createIndexPlugin, createLocalStorageTableSettingsAdapter, createPaginationPlugin, createResizePlugin, createRowSpanPlugin, createSelectionPlugin, createSortPlugin, createSummaryPlugin, createToolbarPlugin, createTreePlugin, useForm };
3129
+ export { Alert, type AlertProps, type AlertStatus, type AnyTablePlugin, BadgeProps, ButtonProps, ButtonSize, Cascader, type CascaderFieldNames, type CascaderOption, type CascaderProps, type CascaderValue, Checkbox, type CheckboxGroupProps, type CheckboxOption, type CheckboxProps, type CheckboxValue, Col, type ColProps, type ColSize, ColorPicker, type ColorPickerMode, type ColorPickerPreset, type ColorPickerProps, ControlSize, ControlStatus, DEFAULT_PAGE_SIZE_OPTIONS, Divider, type DividerProps, Drawer, type DrawerOpenConfig, type DrawerPlacement, type DrawerProps, type DrawerPush, type DrawerPushConfig, Editor, type EditorCommand, type EditorCompletionContext, type EditorCompletionItem, type EditorCompletionItemKind, type EditorCompletionProvider, type EditorContextMenuItem, type EditorHandle, type EditorKeyDownEvent, type EditorLanguage, type EditorMarker, type EditorProps, type EditorRange, type EditorSelectionChange, type EditorTheme, type FlatTreeNode, type FlatTreeOptions, Flex, type FlexProps, FloatingScrollbarProvider, type FloatingScrollbarProviderProps, Form, type FormErrorField, type FormInstance, type FormItemProps, type FormListField, type FormListOperation, type FormListProps, type FormProps, type FormRule, type FormValues, type GridBreakpoint, InputNumber, type InputNumberProps, InputPlaceholderMode, InputSelect, type InputSelectProps, type LayoutGap, Markdown, type MarkdownProps, ModalActionResult, ModalOpenConfig, type NamePath, OverlayApiHandle, Pagination, type PaginationProps, QueryForm, type QueryFormField, type QueryFormProps, type QueryFormSearchInfo, type QueryFormShortcut, Radio, type RadioGroupProps, type RadioOption, type RadioProps, type RadioValue, Row, type RowProps, SIA_THEME, SelectChangeValue, type SelectModalConfig, SelectOption, SelectProps, type SelectionOption, SelectionPanel, type SelectionPanelProps, type SelectionValue, type SiaThemeMode, Slider, type SliderMark, type SliderProps, type SliderValue, Space, type SpaceCompactProps, type SpaceProps, Splitter, type SplitterPanelProps, type SplitterProps, Switch, type SwitchProps, type SwitchVariant, Table, type TableAlign, type TableCellAddress, type TableCellRange, type TableCellRenderInfo, type TableCellSelectionApi, type TableCellSelectionPluginOptions, type TableColumn, type TableColumnSettingApi, type TableColumnSettingItem, type TableColumnSettingPluginOptions, type TableColumnTransformPluginOptions, type TableEditableApi, type TableEditableCellConfig, type TableEditableCellType, type TableEditablePluginOptions, type TableExportApi, type TableExportPluginOptions, type TableExportScope, type TableFilterApi, type TableFilterPluginOptions, type TableFilterValues, type TableFixed, type TableHighlightPluginOptions, type TableHighlightValue, type TableIndexPluginOptions, type TableKey, type TableMergeStickyConfig, type TablePageParams, type TablePaginationApi, type TablePaginationPluginOptions, type TablePlugin, type TablePluginCellProps, type TablePluginContext, type TablePluginEvent, type TableProps, type TableRef, type TableResizeApi, type TableResizePluginOptions, type TableRow, type TableRowSpanPluginOptions, type TableSelectedCell, type TableSelectionApi, type TableSelectionMode, type TableSelectionPluginOptions, type TableSettingsAdapter, type TableSettingsSnapshot, type TableSize, type TableSortApi, type TableSortInfo, type TableSortPluginOptions, type TableSummaryPluginOptions, type TableSummaryRow, type TableToolbarItem, type TableToolbarPluginOptions, type TableTreeApi, type TableTreePluginOptions, TagStatus, TextArea, type TextAreaProps, ThemeSwitch, type ThemeSwitchProps, TimePicker, type TimePickerProps, type TimeRangePickerProps, ToolPanel, type ToolPanelItem, type ToolPanelPlacement, type ToolPanelProps, TreeSelect, type TreeSelectNode, type TreeSelectProps, type TreeSelectValue, Treemap, type TreemapNode, type TreemapNodeClickInfo, type TreemapNodeKind, type TreemapProps, type WindowAction, type WindowActionHandler, type WindowControlAction, type WindowControlLabels, WindowControls, type WindowControlsProps, WindowFrame, type WindowFrameProps, WindowTitleBar, type WindowTitleBarActionsAlign, type WindowTitleBarProps, applySiaTheme, buildFlatTree, createCellSelectionPlugin, createColumnSettingPlugin, createColumnTransformPlugin, createEditablePlugin, createExportPlugin, createFilterPlugin, createHighlightPlugin, createIndexPlugin, createLocalStorageTableSettingsAdapter, createPaginationPlugin, createResizePlugin, createRowSpanPlugin, createSelectionPlugin, createSortPlugin, createSummaryPlugin, createToolbarPlugin, createTreePlugin, openSelectModal, useForm };