# @flatbiz/antd LLMs.txt
> 这是 `packages/antd/src` 公开模块的完整单文件 LLM 文档。它内联每个公开模块的使用方式、Props、默认行为和源码位置,不依赖子模块 `LLMs.txt`。
## 包定位
`@flatbiz/antd` 是 FlatBiz 项目基于 antd v5 的 React 组件与工具封装库,包含表单、表格、弹窗、选择器、上传、拖拽、富文本、PDF 预览、布局和若干业务工具。
## 通用导入规则
```ts
import { ButtonWrapper, EasyTable } from '@flatbiz/antd';
import { ButtonWrapper } from '@flatbiz/antd/button-wrapper';
```
- 推荐从主入口或对应子路径导入公开导出。
- 不要从 `src/**` 或 `dist/**` 的内部实现文件直接导入。
- 大多数组件透传 antd 原组件 Props,并在本库 Props 中增加业务行为;遇到同名属性时以本库 Props 类型为准。
- Promise 型事件常用于自动 loading 或关闭弹窗,请保留返回值。
## 模块索引
### ace-editor-groovy
- 子路径:`@flatbiz/antd/ace-editor-groovy`
- 常用导出:`AceEditorGroovy`
- Props 类型:`AceEditorGroovyProps`
- 定位:groovy编辑器
### ace-editor-java
- 子路径:`@flatbiz/antd/ace-editor-java`
- 常用导出:`AceEditorJava`
- Props 类型:`AceEditorJavaProps`
- 定位:java编辑器
### ace-editor-json
- 子路径:`@flatbiz/antd/ace-editor-json`
- 常用导出:`AceEditorJson`
- Props 类型:`AceEditorJsonProps`
- 定位:Json编辑器
### ace-editor-mysql
- 子路径:`@flatbiz/antd/ace-editor-mysql`
- 常用导出:`AceEditorMysql`
- Props 类型:`AceEditorMysqlProps`
- 定位:编辑器高度,默认值:100%,可输入值例如 300px、100%
### ace-editor-xml
- 子路径:`@flatbiz/antd/ace-editor-xml`
- 常用导出:`AceEditorXml`、`validateXML`
- Props 类型:`AceEditorXmlProps`
- antd 依赖:`Space`
- 定位:xml编辑器
### alert-wrapper
- 子路径:`@flatbiz/antd/alert-wrapper`
- 常用导出:`AlertWrapper`
- Props 类型:`AlertWrapperProps`
- antd 依赖:`Alert`
- 定位:antd Alert 无法控制内边距,此组件扩展size属性
### amount-fen-input
- 子路径:`@flatbiz/antd/amount-fen-input`
- 常用导出:`AmountFenInput`
- Props 类型:`AmountFenInputProps`
- antd 依赖:`InputNumber`
- 定位:AmountFenInput:基于 antd 的 InputNumber 封装。
### amount-fen-input-form-item
- 子路径:`@flatbiz/antd/amount-fen-input-form-item`
- 常用导出:`AmountFenInputFormItem`
- Props 类型:`AmountFenInputFormItemProps`
- antd 依赖:`Form`、`FormItemProps`、`InputNumberProps`
- 定位:分金额输入组件(集成了FormItem),入参为分,返回为分,显示为元
### anchor-steps
- 子路径:`@flatbiz/antd/anchor-steps`
- 常用导出:`AnchorSteps`
- Props 类型:`AnchorStepsProps`
- antd 依赖:`Anchor`、`Steps`
- 定位:锚点步骤组件
### block-layout
- 子路径:`@flatbiz/antd/block-layout`
- 常用导出:`BlockLayout`
- Props 类型:`BlockLayoutProps`
- 定位:块布局(控制light/dark模式下,块背景色和字体颜色)
### bootstrap
- 子路径:`@flatbiz/antd/bootstrap`
- 常用导出:`Bootstrap`
- Props 类型:`BootstrapProps`
- antd 依赖:`App`、`theme`
- 定位:如果当前项目入口不使用@flatbiz/pro-layout,必须使用 Bootstrap 组件包装
### box-grid
- 子路径:`@flatbiz/antd/box-grid`
- 常用导出:`Col`、`PresetDefaultGrid`、`DefaultGutter`、`RowAligns`、`RowJustify`、`alignPropsMap`
- Props 类型:`BoxColProps`、`BoxRowProps`
- 定位:栅格占位格数 span 优先级最高:配置了span后,其他的响应式配置将失效; 范围 0 ~ 24 为 0 相当于隐藏 为 24 相当于独占一行
### button-operate
- 子路径:`@flatbiz/antd/button-operate`
- 常用导出:`ButtonOperateItemContent`、`ButtonOperate`
- Props 类型:`ButtonOperateProps`
- antd 依赖:`Button`、`Divider`、`Popconfirm`、`PopconfirmProps`、`Popover`、`Space`、`SpaceProps`、`Tooltip`
- 定位:按钮组合处理组件
### button-wrapper
- 子路径:`@flatbiz/antd/button-wrapper`
- 常用导出:`ButtonWrapper`
- Props 类型:`ButtonWrapperProps`
- antd 依赖:`Button`、`ButtonProps`
- 定位:antd Button包装组件 1. 添加按钮 onClick 返回 Promise自动loading效果 2. 内置 防抖 效果(在第一触发函数后,在指定时间内再次触发无效,即两次触发的时间间隙大于指定时间)
### card-layout
- 子路径:`@flatbiz/antd/card-layout`
- 常用导出:`CardLayout`
- Props 类型:`CardLayoutProps`
- antd 依赖:`Space`
- 定位:卡片结构布局,替代 SimpleLayout 组件
### card-wrapper
- 子路径:`@flatbiz/antd/card-wrapper`
- 常用导出:`CardWrapper`
- antd 依赖:`Card`、`CardProps`
- 定位:
### cascader-wrapper
- 子路径:`@flatbiz/antd/cascader-wrapper`
- 常用导出:`CascaderWrapper`、`getValues`
- Props 类型:`CascaderWrapperProps`
- antd 依赖:`Button`、`Cascader`、`CascaderProps`、`Flex`
- 定位:级联选择器包装组件
### check-list
- 子路径:`@flatbiz/antd/check-list`
- 常用导出:`CheckListItem`、`CheckListInner`、`CheckList`、`getValueList`
- Props 类型:`CheckListItemContentProps`、`CheckListItemProps`、`CheckListProps`
- 定位:CheckListItem:FlatBiz antd 扩展模块。
### checkbox-wrapper
- 子路径:`@flatbiz/antd/checkbox-wrapper`
- 常用导出:`CheckboxWrapper`
- Props 类型:`CheckboxWrapperProps`
- antd 依赖:`Checkbox`、`CheckboxProps`
- 定位:解决 Checkbox 只能接收boolean的限制,与Form.Item结合使用最佳
### code-render
- 子路径:`@flatbiz/antd/code-render`
- 常用导出:`CodeRender`
- Props 类型:`CodeRenderProps`
- 定位:代码、json格式化渲染
### color-picker-wrapper
- 子路径:`@flatbiz/antd/color-picker-wrapper`
- 常用导出:`ColorPickerWrapper`
- Props 类型:`ColorPickerWrapperProps`
- antd 依赖:`ColorPicker`
- 定位:转换成 hex 格式颜色字符串,返回格式如:#1677ff
### config-provider-wrapper
- 子路径:`@flatbiz/antd/config-provider-wrapper`
- 常用导出:`ConfigProviderWrapper`
- Props 类型:`ConfigProviderWrapperProps`
- antd 依赖:`ConfigProvider`
- 定位:antd ConfigProvider 扩展类
### copy-wrapper
- 子路径:`@flatbiz/antd/copy-wrapper`
- 常用导出:`CopyWrapper`
- Props 类型:`CopyWrapperProps`
- antd 依赖:`Flex`、`message`
- 定位:自定义文本,显示在复制图标前或后
### css-node-hover
- 子路径:`@flatbiz/antd/css-node-hover`
- 常用导出:`CssNodeHover`
- Props 类型:`CssHoverProps`
- 定位:css hover 效果
### data-render
- 子路径:`@flatbiz/antd/data-render`
- 常用导出:`DataRender`
- Props 类型:`DataRenderProps`
- antd 依赖:`Empty`
- 定位:数据渲染,内置处理数据为空渲染
### date-picker-wrapper
- 子路径:`@flatbiz/antd/date-picker-wrapper`
- 常用导出:`DatePickerWrapper`
- Props 类型:`DatePickerWrapperProps`
- antd 依赖:`DatePicker`、`GetProps`
- 定位:DatePicker包装组件
### date-range-picker-wrapper
- 子路径:`@flatbiz/antd/date-range-picker-wrapper`
- 常用导出:`DateRangePickerWrapper`
- Props 类型:`DateRangePickerWrapperProps`
- antd 依赖:`DatePicker`、`GetProps`
- 定位:DatePicker.RangePicker包装组件
### date-range-picker-wrapper-form-item
- 子路径:`@flatbiz/antd/date-range-picker-wrapper-form-item`
- 常用导出:`DateRangePickerWrapperFormItem`
- Props 类型:`DateRangePickerWrapperFormItemProps`
- antd 依赖:`Form`
- 定位:包含了Form.Item组件的时间区间选择组件,时间区间组件可以定义成两个字段操作,不用再通过数组处理
### delete-node
- 子路径:`@flatbiz/antd/delete-node`
- 常用导出:`DeleteNode`
- 定位:删除节点,点击后会显示二次确认点击
### dialog-alert
- 子路径:`@flatbiz/antd/dialog-alert`
- 常用导出:`dialogAlert`、`bodyAppendDivElement`、`removeBodyChild`
- Props 类型:`DialogAlertProps`、`BodyAppendDivElementProps`
- 定位:确认弹框
### dialog-confirm
- 子路径:`@flatbiz/antd/dialog-confirm`
- 常用导出:`dialogConfirm`
- 定位:确认弹框
### dialog-drag-modal
- 子路径:`@flatbiz/antd/dialog-drag-modal`
- 常用导出:`dialogDragModal`
- Props 类型:`DialogDragModalProps`
- antd 依赖:`Form`、`FormInstance`、`Space`
- 定位:可移动弹框
### dialog-drawer
- 子路径:`@flatbiz/antd/dialog-drawer`
- 常用导出:`dialogDrawer`
- Props 类型:`DialogDrawerProps`
- antd 依赖:`Drawer`、`DrawerProps`、`Form`、`FormInstance`、`Space`
- 定位:抽屉弹框
### dialog-drawer-content
- 子路径:`@flatbiz/antd/dialog-drawer-content`
- 常用导出:`DialogDrawerContent`
- Props 类型:`DialogDrawerContentProps`
- antd 依赖:`Space`
- 定位:当dialogDrawer底部操作按钮在业务content内部时,使用
### dialog-loading
- 子路径:`@flatbiz/antd/dialog-loading`
- 常用导出:`dialogLoading`
- Props 类型:`DialogLoadingProps`
- antd 依赖:`Modal`、`theme`
- 定位:Loading弹框
### dialog-modal
- 子路径:`@flatbiz/antd/dialog-modal`
- 常用导出:`dialogModal`
- Props 类型:`DialogModalProps`
- antd 依赖:`Form`、`FormInstance`、`Modal`、`ModalProps`
- 定位:居中弹框
### dialog-preview-image
- 子路径:`@flatbiz/antd/dialog-preview-image`
- 常用导出:`dialogPreviewImage`
- Props 类型:`DialogPreviewImageProps`
- antd 依赖:`Image`
- 定位:图片预览
### dialog-preview-image-list
- 子路径:`@flatbiz/antd/dialog-preview-image-list`
- 常用导出:`dialogPreviewImageList`
- Props 类型:`DialogPreviewImageListProps`
- antd 依赖:`Image`、`Space`
- 定位:图片列表预览
### drag-collapse
- 子路径:`@flatbiz/antd/drag-collapse`
- 常用导出:`DragCollapse`、`SortableItem`
- Props 类型:`SortableItemProps`、`DragCollapseProps`
- antd 依赖:`Collapse`、`CollapseProps`
- 定位:可拖拽 折叠面板
### drag-collapse-form-list
- 子路径:`@flatbiz/antd/drag-collapse-form-list`
- 常用导出:`DragCollapseFormList`、`SortableItem`
- Props 类型:`SortableItemProps`、`DragCollapseFormListContentProps`、`DragCollapseFormListHeaderProps`、`DragCollapseFormListProps`
- antd 依赖:`Collapse`、`CollapseProps`、`Form`、`FormListFieldData`、`FormListOperation`
- 定位:可拖拽 折叠面板+FormList
### drag-editable-card
- 子路径:`@flatbiz/antd/drag-editable-card`
- 常用导出:`DragEditableCard`、`Handle`、`Handle2`
- Props 类型:`DragEditableCardProps`、`HandleProps`、`Handle2Props`
- antd 依赖:`Form`、`FormListFieldData`、`FormListOperation`、`Space`
- 定位:可拖拽编辑卡片
### drag-editable-table
- 子路径:`@flatbiz/antd/drag-editable-table`
- 常用导出:`DragEditableTable`、`Row`、`TableTrHandle`
- Props 类型:`DragEditableTableProps`、`TableTrHandleProps`
- antd 依赖:`Form`
- 定位:可拖拽编辑表格 @deprecated 已过期,请使用 DragEditableTablePro组件
### drag-editable-table-pro
- 子路径:`@flatbiz/antd/drag-editable-table-pro`
- 常用导出:`DragEditableTablePro`、`Row`、`TableTrHandle`
- Props 类型:`DragEditableTableProProps`、`TableTrHandleProps`
- antd 依赖:`Form`
- 定位:可拖拽编辑表格
### drag-form-list
- 子路径:`@flatbiz/antd/drag-form-list`
- 常用导出:`DragFormList`、`SortableItem`
- Props 类型:`FormListChildrenWrapperProps`、`SortableItemProps`、`DragFormListContentProps`、`DragFormListProps`
- antd 依赖:`Empty`、`Form`
- 定位:可拖拽FormList
### drag-table
- 子路径:`@flatbiz/antd/drag-table`
- 常用导出:`DragTable`、`Row`、`TableTrHandle`、`TableTr`
- Props 类型:`DragTableProps`、`TableTrHandleProps`
- antd 依赖:`Table`
- 定位:可拖拽表格
### dropdown-menu-wrapper
- 子路径:`@flatbiz/antd/dropdown-menu-wrapper`
- 常用导出:`DropdownMenuWrapper`、`parentsHasSticky`
- Props 类型:`DropdownMenuWrapperProps`
- antd 依赖:`ButtonProps`、`Dropdown`、`DropdownProps`
- 定位:DropdownMenuWrapper 升级 antd 5.5.1 后,Dropdown 中 Popconfirm弹框使用存在问题,所以在 @flatbiz/antd@4.2.49版本修改为使用dialogConfirm组件实现二次弹框确认功能
### dynamic-node
- 子路径:`@flatbiz/antd/dynamic-node`
- 常用导出:`dynamicNode`
- Props 类型:`TDynamicNodeProps`
- 定位:动态添加 element 元素
### easy-form
- 子路径:`@flatbiz/antd/easy-form`
- 常用导出:`EasyForm`
- Props 类型:`EasyFormProps`
- antd 依赖:`Form`
- 定位:简单Form布局,可自定义网格布局
### easy-table
- 子路径:`@flatbiz/antd/easy-table`
- 常用导出:`filterCache`、`firstQueryCache`、`columnFoldCache`、`EasyTableContext`、`EasyTable`、`EasyTableFilter`
- Props 类型:`EasyTableFilterProps`、`FoldOperateProps`、`FoldOperateProps`、`EasyTableTableProps`
- antd 依赖:`Badge`、`Checkbox`、`Drawer`、`Empty`、`Form`、`FormInstance`、`message`、`Popover`
- 定位:对 查询条件+表格数据 进行深度封装,内置数据交互处理
### editable-card
- 子路径:`@flatbiz/antd/editable-card`
- 常用导出:`EditableCard`
- Props 类型:`EditableCardProps`
- antd 依赖:`ConfigProvider`、`Empty`、`Form`、`FormListFieldData`、`FormListOperation`
- 定位:使用FormList实现可编辑卡片
### editable-field
- 子路径:`@flatbiz/antd/editable-field`
- 常用导出:`EditableField`
- Props 类型:`EditableFieldProps`
- antd 依赖:`Space`
- 定位:可编辑字段组件
### editable-field-provider
- 子路径:`@flatbiz/antd/editable-field-provider`
- 常用导出:`EditableFieldContext`、`EditableFieldProvider`
- Props 类型:`EditableFieldProviderProps`
- 定位:EditableFieldProvider 控制内部使有的 EditableField 状态
### editable-table
- 子路径:`@flatbiz/antd/editable-table`
- 常用导出:`EditableTable`、`CheckboxGroupFormItem`、`DatePickerWrapperFormItem`、`DateRangePickerWrapperFormItem`、`FormItemAdapter`、`InputNumberFormItem`
- Props 类型:`EditableTableProps`、`FormItemContentProps`、`FormItemAdapterProps`、`FormItemContentProps`
- antd 依赖:`Button`、`Checkbox`、`Form`、`FormItemProps`、`FormListFieldData`、`FormListOperation`、`InputNumber`、`InputNumberProps`
- 定位:可编辑表格(通过FormList实现) @deprecated 已过期,请使用 EditableTablePro 组件 demo:https://fex.qa.tcshuke.com/docs/admin/main/table/row-editable1
### editable-table-pro
- 子路径:`@flatbiz/antd/editable-table-pro`
- 常用导出:`EditableTablePro`
- Props 类型:`EditableTableProProps`
- antd 依赖:`Form`、`message`、`Space`、`Table`
- 定位:使用FormList实现可编辑表格
### error-boundary-wrapper
- 子路径:`@flatbiz/antd/error-boundary-wrapper`
- 常用导出:`ErrorBoundaryWrapper`
- Props 类型:`ErrorBoundaryProps`
- antd 依赖:`Alert`、`Button`
- 定位:react 异常拦截
### fba-app
- 子路径:`@flatbiz/antd/fba-app`
- 常用导出:`FbaAppContext`、`FbaAppAlert`、`FbaAppConfirm`、`FbaAppDrawer`、`FbaAppLoading`、`FbaAppModal`
- Props 类型:`FbaAppAlertProps`、`FbaAppConfirmProps`、`FbaAppDrawerProps`、`FbaAppLoadingProps`
- antd 依赖:`Drawer`、`DrawerProps`、`Form`、`FormInstance`、`Modal`、`ModalProps`、`Space`、`theme`
- 定位:content只在第一次弹起时,执行一次
### fba-hooks
- 子路径:`@flatbiz/antd/fba-hooks`
- 常用导出:`createCtx`、`fbaHooks`、`useArrayChange`、`Demo`、`useCopyRemoveSpace`、`useEffectCustomAsync`
- Props 类型:`CopyRemoveSpaceProps`
- antd 依赖:`Grid`、`theme`
- 定位:A helper to create a Context and Provider with no upfront default value, and without having to check for undefined all the time.
### fba-utils
- 子路径:`@flatbiz/antd/fba-utils`
- 常用导出:`fbaUtils`
- antd 依赖:`FormInstance`
- 定位:手动触发Antd Form 的 onValuesChange
### file-export
- 子路径:`@flatbiz/antd/file-export`
- 常用导出:`FileExport`
- Props 类型:`FileExportProps`
- antd 依赖:`message`
- 定位:文件导出
### file-import
- 子路径:`@flatbiz/antd/file-import`
- 常用导出:`FileImport`
- Props 类型:`FileImportProps`
- antd 依赖:`Button`、`message`、`Upload`、`UploadProps`
- 定位:文件导入
### file-select
- 子路径:`@flatbiz/antd/file-select`
- 常用导出:`FileSelect`
- Props 类型:`FileSelectProps`
- antd 依赖:`Button`、`Upload`
- 定位:文件选择,内部不调用服务上传
### flex-layout
- 子路径:`@flatbiz/antd/flex-layout`
- 常用导出:`FlexLayout`
- Props 类型:`FlexLayoutProps`
- 定位:flex布局,主要用于Flex结构性布局
### form-grid
- 子路径:`@flatbiz/antd/form-grid`
- 常用导出:`FormCol`、`FormOperateCol`、`FormRow`、`FormGrid`、`calculateOperateGrid`
- Props 类型:`FormColProps`、`FormOperateColProps`、`FormRowProps`
- antd 依赖:`Col`、`Form`、`Row`、`RowProps`、`Space`、`SpaceProps`
- 定位:网格响应式布局,默认值:{ xs: 24, sm: 12, md: 12, lg: 8, xl: 8, xxl: 6 }
### form-item-group
- 子路径:`@flatbiz/antd/form-item-group`
- 常用导出:`FormItemCard`、`FormItemHorizontalUnion`、`FormItemGroup`
- Props 类型:`FormItemCardProps`、`FormItemHorizontalUnionProps`
- antd 依赖:`Form`
- 定位:FormItem 水平布局
### form-item-hidden
- 子路径:`@flatbiz/antd/form-item-hidden`
- 常用导出:`FormItemHidden`
- Props 类型:`FormItemHiddenProps`
- antd 依赖:`Form`、`FormItemProps`
- 定位:FormItemHidden:基于 antd 的 Form、FormItemProps 封装。
### form-item-span
- 子路径:`@flatbiz/antd/form-item-span`
- 常用导出:`FormItemSpan`
- Props 类型:`FormItemSpanProps`
- 定位:包裹EasyForm children item元素, 设置自定义栅格占位格数(使用在EasyForm一级子节点下生效)
### form-item-text
- 子路径:`@flatbiz/antd/form-item-text`
- 常用导出:`FormItemTextContent`、`FormItemText`、`RequestText`、`useRequestFormItemText`
- Props 类型:`FormItemTextProps`
- antd 依赖:`Form`、`Spin`、`Tooltip`
- 定位:FormItem 文本显示,默认不换行,超出省略(鼠标悬浮可显示)
### form-item-wrapper
- 子路径:`@flatbiz/antd/form-item-wrapper`
- 常用导出:`FormItemWrapper`
- Props 类型:`FormItemWrapperProps`、`FormItemWrapperChildrenProps`
- antd 依赖:`Form`、`FormItemProps`
- 定位:对 Form.Item 包装处理
### form-item-wrapper-dependencies
- 子路径:`@flatbiz/antd/form-item-wrapper-dependencies`
- 常用导出:`FormItemWrapperDependencies`
- Props 类型:`FormItemWrapperDependenciesProps`
- antd 依赖:`Form`
- 定位:FormItem依赖写法包装,当处在EasyForm内部时,不支持
此写法,使用 代替
### form-list-wrapper
- 子路径:`@flatbiz/antd/form-list-wrapper`
- 常用导出:`FormListWrapper`
- Props 类型:`FormListChildrenWrapperProps`、`FormListWrapperContentProps`、`FormListWrapperProps`
- antd 依赖:`Empty`、`Form`
- 定位:Form.List 包装组件,使用更简单
### form-wrapper
- 子路径:`@flatbiz/antd/form-wrapper`
- 常用导出:`FormWrapper`
- Props 类型:`FormWrapperProps`
- antd 依赖:`Form`、`FormProps`
- 定位:Form 包装组件,添加对formItem的布局控制
### full-screen
- 子路径:`@flatbiz/antd/full-screen`
- 常用导出:`FullScreenInner`、`useFullScreenHandleInner`、`FullScreen`
- Props 类型:`FullScreenHandleProps`、`FullScreenProps`
- 定位:全屏显示(点击键盘ESC可关闭全屏显示)
### gap
- 子路径:`@flatbiz/antd/gap`
- 常用导出:`Gap`
- Props 类型:`GapProps`
- 定位:间隙组件
### icon-wrapper
- 子路径:`@flatbiz/antd/icon-wrapper`
- 常用导出:`IconWrapper`
- Props 类型:`IconWrapperProps`
- antd 依赖:`Popover`、`Tooltip`
- 定位:提示类型 @default 'tooltip'
### input-search-wrapper
- 子路径:`@flatbiz/antd/input-search-wrapper`
- 常用导出:`InputSearchWrapper`
- Props 类型:`InputSearchWrapperProps`
- antd 依赖:`Input`
- 定位:
### input-text-area-wrapper
- 子路径:`@flatbiz/antd/input-text-area-wrapper`
- 常用导出:`InputTextAreaWrapper`
- Props 类型:`InputTextAreaWrapperProps`
- antd 依赖:`Input`
- 定位:
### input-wrapper
- 子路径:`@flatbiz/antd/input-wrapper`
- 常用导出:`InputWrapper`
- Props 类型:`InputWrapperProps`
- antd 依赖:`Input`、`InputProps`
- 定位:
### label-value-render
- 子路径:`@flatbiz/antd/label-value-render`
- 常用导出:`LabelValueRender`、`getRenderGrid`
- Props 类型:`LabelValueRenderProps`
- 定位:label+value 列表布局
### local-loading
- 子路径:`@flatbiz/antd/local-loading`
- 常用导出:`LocalLoading`、`LocalLoadingInner`
- Props 类型:`LocalLoadingProps`
- antd 依赖:`Button`、`Result`、`Spin`
- 定位:局部加载,包含接口数据处理逻辑
### markdown-editor
- 子路径:`@flatbiz/antd/markdown-editor`
- 常用导出:`MarkdownEditor`、`ReactMdEditor`、`MermaidViewBtn`、`PluginMermaidCode`、`UploadImageContent`、`UploadImageBtn`
- Props 类型:`MarkdownEditorProps`
- antd 依赖:`Button`、`FormInstance`、`InputNumber`、`message`、`Spin`
- 定位:markdown编辑器
### mention-editor
- 子路径:`@flatbiz/antd/mention-editor`
- 常用导出:`MentionEditor`
- Props 类型:`OperationPresetProps`、`MentionEditorProps`
- antd 依赖:`Button`、`Flex`
- 定位:基于MentionWrapper封装的模版字符串配置组件 1. 提供变量,数字,链接等可选的模版参数 2. 不同类型模版参数可配置多个 3. mention 会根据 传入的params自动推断出关键字 4. 模版参数建议都以${_xxx}为格式 5. Demo: https://fex.qa.tcshuke.com/docs/admin/main/widg…
### mentions-wrapper
- 子路径:`@flatbiz/antd/mentions-wrapper`
- 常用导出:`MentionsWrapper`、`getOverallKeyWordsPosition`、`judgmentCursorInKeyWordsPosition`
- Props 类型:`MentionsWrapperProps`
- antd 依赖:`Mentions`
- 定位:基于Antd Mentions进行二次封装,可实现输入内关键字整体控制,包括光标移动、关键词删除等
### modal-action
- 子路径:`@flatbiz/antd/modal-action`
- 常用导出:`ModalAction`
- Props 类型:`ModalActionProps`
- 定位:弹框 触发器
### number-range-form-item
- 子路径:`@flatbiz/antd/number-range-form-item`
- 常用导出:`NumberRangeFormItem`
- Props 类型:`InputNumberProps`、`NumberRangeFormItemProps`
- antd 依赖:`InputNumber`
- 定位:数字输入范围组件
### page-fixed-footer
- 子路径:`@flatbiz/antd/page-fixed-footer`
- 常用导出:`PageFixedFooter`
- Props 类型:`PageFixedFooterProps`
- 定位:PageFixedFooter:FlatBiz antd 扩展模块。
### page404
- 子路径:`@flatbiz/antd/page404`
- 常用导出:`Page404`
- Props 类型:`Page404Props`
- antd 依赖:`Result`
- 定位:Page404:基于 antd 的 Result 封装。
### pagination-wrapper
- 子路径:`@flatbiz/antd/pagination-wrapper`
- 常用导出:`PaginationWrapper`、`SmallSelect`、`LargeSelect`、`MiddleSelect`
- antd 依赖:`Pagination`、`PaginationProps`、`Select`、`SelectProps`
- 定位:由于 antd 5.3.x 分页Pagination组件,存在点击分页选择框时,一直朝下 issues:https://github.com/ant-design/ant-design/issues/36866 为了兼容,在 Pagination 中添加了 selectComponentClass 属性,后期antd 官方优化了bug,可取消 配置sele…
### pdf
- 子路径:`@flatbiz/antd/pdf`
- 常用导出:`PdfDocument`、`Pdf`、`PdfPage`
- Props 类型:`CtxProps`、`PdfProps`、`PdfProps`
- antd 依赖:`Result`、`Spin`
- 定位:pdf预览
### pdf-preview
- 子路径:`@flatbiz/antd/pdf-preview`
- 常用导出:`Navigation`、`PdfPreview`
- Props 类型:`NavigationProps`、`PdfPreviewProps`
- antd 依赖:`Result`
- 定位:pdf预览方式1
### pdf-preview2
- 子路径:`@flatbiz/antd/pdf-preview2`
- 常用导出:`PdfPreview2`
- Props 类型:`PdfPreview2Props`
- 定位:PDF预览方式2
### permission
- 子路径:`@flatbiz/antd/permission`
- 常用导出:`Permission`
- Props 类型:`PermissionProps`
- 定位:Permission:FlatBiz antd 扩展模块。
### pre-defined-class-name
- 子路径:`@flatbiz/antd/pre-defined-class-name`
- 常用导出:`formClassName`、`formItemClassName`、`getFormLayoutClassName`、`getFormItemLayoutClassName`、`preDefinedClassName`
- Props 类型:`TFormLayoutPreClassNameProps`、`TFormItemLayoutPreClassNameProps`
- 定位:预定义className
### preview-file-list
- 子路径:`@flatbiz/antd/preview-file-list`
- 常用导出:`PreviewCard`、`PreviewCompact`、`PreviewFileList`、`PreviewThumbnail`、`isImageUrl`、`downloadByUrl`
- Props 类型:`FileImageThumbProps`、`PreviewCardProps`、`PreviewCompactProps`、`FileListPreviewProps`
- antd 依赖:`Image`、`Tag`、`Tooltip`、`Typography`
- 定位:正常列表:左侧缩略(图片可预览,非图片为文件图标);非图片整行点击下载。
### radio-group-wrapper
- 子路径:`@flatbiz/antd/radio-group-wrapper`
- 常用导出:`RadioGroupWrapper`
- Props 类型:`CustomRadioGroupProps`
- antd 依赖:`Radio`、`Space`
- 定位:RadioGroupWrapper 为了解决 RadioGroup 组件不能取消选中问题
### relation-tree
- 子路径:`@flatbiz/antd/relation-tree`
- 常用导出:`RelationGroupList`、`RelationItem`、`Relation`、`RelationTree`、`deleteLoop`、`filterSurplusData`
- Props 类型:`RelationGroupListProps`、`RelationItemProps`、`RelationItemRenderProps`、`RelationProps`
- antd 依赖:`Empty`、`Form`、`Tag`
- 定位:左侧Tag+线占用宽度
### request-status
- 子路径:`@flatbiz/antd/request-status`
- 常用导出:`RequestStatus`
- Props 类型:`TRequestStatusProps`
- antd 依赖:`Empty`、`Spin`
- 定位:RequestStatus:基于 antd 的 Empty、Spin 封装。
### resizable-drawer
- 子路径:`@flatbiz/antd/resizable-drawer`
- 常用导出:`ResizableDrawer`、`ResizeHandle`、`getZindex`
- Props 类型:`ResizableDrawerProps`
- antd 依赖:`Button`、`Space`
- 定位:最小宽度,默认值:400
### rich-text-editor
- 子路径:`@flatbiz/antd/rich-text-editor`
- 常用导出:`Preview`、`RichTextEditor`、`editorTemplates`、`defaultVarStyle`
- Props 类型:`RichTextEditorProps`
- antd 依赖:`Image`、`message`
- 定位:富文本编辑器,配置参考tinymce https://www.tiny.cloud/docs/tinymce/6
### rich-text-viewer
- 子路径:`@flatbiz/antd/rich-text-viewer`
- 常用导出:`RichTextViewer`
- Props 类型:`RichTextViewerProps`
- 定位:预览 RichTextEditor 生成的富文本数据
### roll-location-center
- 子路径:`@flatbiz/antd/roll-location-center`
- 常用导出:`RollLocationCenter`
- Props 类型:`RollLocationCenterProps`
- 定位:RollLocationCenter:FlatBiz antd 扩展模块。
### roll-location-in-view
- 子路径:`@flatbiz/antd/roll-location-in-view`
- 常用导出:`RollLocationInView`
- Props 类型:`RollLocationInViewProps`
- 定位:RollLocationInView:FlatBiz antd 扩展模块。
### rule-describe
- 子路径:`@flatbiz/antd/rule-describe`
- 常用导出:`RuleDescribe`
- Props 类型:`RuleDescribeProps`
- 定位:RuleDescribe:FlatBiz antd 扩展模块。
### search-menu
- 子路径:`@flatbiz/antd/search-menu`
- 常用导出:`ListView`、`SearchMenu`
- Props 类型:`IListViewProps`、`ISearchMenuProps`
- antd 依赖:`Empty`
- 定位:列表搜索
### selector-wrapper
- 子路径:`@flatbiz/antd/selector-wrapper`
- 常用导出:`RefreshIcon`、`SelectorWrapper`、`useRequest`、`getVauleList`
- Props 类型:`SelectorWrapperProps`
- antd 依赖:`Button`、`Select`、`SelectProps`
- 定位:选择器包装组件
### selector-wrapper-search
- 子路径:`@flatbiz/antd/selector-wrapper-search`
- 常用导出:`SelectorWrapperSearch`
- Props 类型:`SelectorWrapperSearchProps`
- antd 依赖:`Button`、`Select`、`SelectProps`
- 定位:选择器简单包装组件
### selector-wrapper-simple
- 子路径:`@flatbiz/antd/selector-wrapper-simple`
- 常用导出:`SelectorWrapperSimple`
- Props 类型:`SelectorWrapperSimpleProps`
- antd 依赖:`Button`、`Select`、`SelectProps`
- 定位:选择器简单包装组件
### sms-count-down
- 子路径:`@flatbiz/antd/sms-count-down`
- 常用导出:`SmsCountDown`
- Props 类型:`SmsCountDownProps`
- 定位:短信验证码倒计时组件
### split-wrapper
- 子路径:`@flatbiz/antd/split-wrapper`
- 常用导出:`SplitWrapper`
- Props 类型:`SplitWrapperProps`
- 定位:分屏可拖动组件
### styles
- 子路径:`@flatbiz/antd/styles`
- 常用导出:`styles`
- 定位:Styles:FlatBiz antd 扩展模块。
### svg-http-view
- 子路径:`@flatbiz/antd/svg-http-view`
- 常用导出:`SvgHttpView`
- Props 类型:`SvgHttpViewProps`
- 定位:http svg地址解析,可自定义颜色
### switch-confirm-wrapper
- 子路径:`@flatbiz/antd/switch-confirm-wrapper`
- 常用导出:`SwitchConfirmWrapper`
- Props 类型:`SwitchConfirmWrapperProps`
- antd 依赖:`message`、`Popconfirm`、`PopconfirmProps`、`Switch`、`SwitchProps`
- 定位:@description switch 切换时做二次pop提醒, 非可控组件【内部控制】 close:switch 由开启转换成关闭时pop弹出 open:switch 由开启转换成开启时pop弹出 all:switch 一直pop none:switch 不弹出 @field onRequest 请求函数 @field message message配置…
### switch-wrapper
- 子路径:`@flatbiz/antd/switch-wrapper`
- 常用导出:`SwitchWrapper`
- Props 类型:`SwitchWrapperProps`
- antd 依赖:`message`、`Switch`、`SwitchProps`、`Tooltip`、`TooltipProps`
- 定位:解决Switch只能接收boolean的限制,与Form.Item结合使用最佳
### table-cell-render
- 子路径:`@flatbiz/antd/table-cell-render`
- 常用导出:`tableCellRender`
- Props 类型:`TableColumnIconRenderProps`
- antd 依赖:`Badge`、`Space`、`Tooltip`
- 定位:table 索引展示,如果存在pageSize、pageNo参数可分页展示索引,否则每页都从1开始 @param pageSize @param pageNo @returns
### table-scrollbar
- 子路径:`@flatbiz/antd/table-scrollbar`
- 常用导出:`TableScrollbar`
- Props 类型:`TableScrollProps`、`ScrollbarSummaryProps`
- antd 依赖:`Affix`
- 定位:表格x轴浮动滚动条
### tabs-sticky
- 子路径:`@flatbiz/antd/tabs-sticky`
- 常用导出:`TabsSticky`
- Props 类型:`TabsStickyProps`
- antd 依赖:`Affix`、`Tabs`
- 定位:Tabs吸顶组件
### tabs-wrapper
- 子路径:`@flatbiz/antd/tabs-wrapper`
- 常用导出:`TabsWrapper`
- Props 类型:`TabsWrapperProps`
- antd 依赖:`Tabs`、`TabsProps`
- 定位:Tabs 包装组件
### tag-group
- 子路径:`@flatbiz/antd/tag-group`
- 常用导出:`TagGroup`
- Props 类型:`TagGroupProps`
- antd 依赖:`Space`、`SpaceProps`、`Tag`
- 定位:Tag 列表显示
### tag-list-render
- 子路径:`@flatbiz/antd/tag-list-render`
- 常用导出:`TagListRender`
- Props 类型:`TagListRenderProps`
- antd 依赖:`Popover`、`Tag`
- 定位:在列表数据dataList中通过value匹配数据,以Tag形式展示
### tag-wrapper
- 子路径:`@flatbiz/antd/tag-wrapper`
- 常用导出:`TagWrapper`
- Props 类型:`TagWrapperProps`
- antd 依赖:`Tag`、`TagProps`
- 定位:为 Tag 添加 loading 效果
### text-overflow
- 子路径:`@flatbiz/antd/text-overflow`
- 常用导出:`OverflowAuto`、`OverflowLength`、`OverflowWidth`、`TextOverflow`
- Props 类型:`TextOverflowProps`
- antd 依赖:`Tooltip`
- 定位:内容溢出截取,并在尾部添加...,被截取的添加Tooltip显示完整数据
### text-symbol-wrapper
- 子路径:`@flatbiz/antd/text-symbol-wrapper`
- 常用导出:`TextSymbolWrapper`
- Props 类型:`TextSymbolWrapperProps`
- 定位:为文字添加符号,例如:必填符号
### time-picker-wrapper
- 子路径:`@flatbiz/antd/time-picker-wrapper`
- 常用导出:`TimePickerWrapper`
- Props 类型:`TimePickerWrapperProps`
- antd 依赖:`TimePicker`、`TimePickerProps`
- 定位:TimePicker组件包装
### time-range-picker-wrapper
- 子路径:`@flatbiz/antd/time-range-picker-wrapper`
- 常用导出:`TimeRangePickerWrapper`
- Props 类型:`TimeRangePickerWrapperProps`
- antd 依赖:`TimePicker`、`TimeRangePickerProps`
- 定位:TimePicker组件包装
### time-range-picker-wrapper-form-item
- 子路径:`@flatbiz/antd/time-range-picker-wrapper-form-item`
- 常用导出:`TimeRangePickerWrapperFormItem`
- Props 类型:`TimeRangePickerWrapperFormItemProps`
- antd 依赖:`Form`
- 定位:包含了Form.Item组件的时间区间选择组件,时间区间组件可以定义成两个字段操作,不用再通过数组处理
### tips-title
- 子路径:`@flatbiz/antd/tips-title`
- 常用导出:`TipsTitle`
- Props 类型:`TipsTitleProps`
- antd 依赖:`Flex`
- 定位:TipsTitle:基于 antd 的 Flex 封装。
### tips-wrapper
- 子路径:`@flatbiz/antd/tips-wrapper`
- 常用导出:`TipsWrapper`
- Props 类型:`TipsWrapperProps`
- antd 依赖:`Popover`、`PopoverProps`、`Tooltip`、`TooltipProps`
- 定位:为目标元素右侧添加Icon
### tree-modal
- 子路径:`@flatbiz/antd/tree-modal`
- 常用导出:`HorizontalLayout`、`TreeModal`、`SelectItemList`、`TreeModalContent`、`TreeModal`、`SelectContent`
- Props 类型:`TreeModalContentProps`、`TreeModalProps`
- antd 依赖:`Modal`
- 定位:树节点数据选择,一般用于选择员工等
### tree-modal-selector
- 子路径:`@flatbiz/antd/tree-modal-selector`
- 常用导出:`TreeModalSelector`
- Props 类型:`TreeModalSelectorProps`
- antd 依赖:`message`、`Select`
- 定位:树弹框选择器
### tree-selector-wrapper
- 子路径:`@flatbiz/antd/tree-selector-wrapper`
- 常用导出:`treeSelectorWrapperModel`、`TreeSelectorWrapper`、`getExpandedKeysByValue`、`getExpandedKeysByValues`
- Props 类型:`TreeSelectorWrapperProps`
- antd 依赖:`Button`、`TreeSelect`、`TreeSelectProps`
- 定位:树选择器包装组件,由于过度封装,部分antd TreeSelect原始功能不支持,不满足情况的请使用antd TreeSelect实现
### tree-wrapper
- 子路径:`@flatbiz/antd/tree-wrapper`
- 常用导出:`getTreeDataList`、`TreeWrapper`、`treeWrapperModel`、`TreeWrapper`、`getDefaultExpandAllKeys`、`getExpandedKeys`
- Props 类型:`TreeWrapperProps`
- antd 依赖:`Button`、`message`、`Spin`、`Tree`
- 定位:Tree包装组件,默认返回父节点,可配置不返回
### types
- 子路径:`@flatbiz/antd/types`
- 常用导出:`types`
- 定位:图片预览项
### upload-multi-type
- 子路径:`@flatbiz/antd/upload-multi-type`
- 常用导出:`UploadMultiType`、`FileListView`
- Props 类型:`UploadMultiTypeProps`
- antd 依赖:`Button`、`message`、`Spin`、`Tabs`
- 定位:上传组件,同时支持多种上传方式,支持【点击&拖拽上传】、【粘贴上传】
### upload-wrapper
- 子路径:`@flatbiz/antd/upload-wrapper`
- 常用导出:`UploadWrapper`、`getBase64`
- Props 类型:`UploadWrapperProps`
- antd 依赖:`Button`、`Image`、`message`、`Upload`、`UploadFile`、`UploadProps`
- 定位:文件上传,支持拖拽上传
### x-mind-preview
- 子路径:`@flatbiz/antd/x-mind-preview`
- 常用导出:`useCallbackRef`、`XMindPreview`
- Props 类型:`IXMindPreviewProps`
- 定位:额外的数据,用于使用时自定义渲染
## 完整模块文档
### ace-editor-groovy LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/ace-editor-groovy` 的使用方式。
#### 模块定位
groovy编辑器
#### 导入方式
```ts
import { AceEditorGroovy } from '@flatbiz/antd/ace-editor-groovy';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `AceEditorGroovy` - groovy编辑器
- `AceEditorGroovyProps`
- `* from ./editor.jsx`
#### Props / 配置要点
##### AceEditorGroovyProps
- `height`(可选):: string;编辑器高度,默认值:100%,可输入值例如 300px、100%
- `value`(可选):: string | TPlainObject | TPlainObject[]
- `onChange`(可选):: (value?: string | TPlainObject | TPlainObject[]) => void
- `autoCompleterList`(可选):: { name: string; desc?: string }[];配置输入自动提示关键字
- `theme`(可选):: string;编辑器主题配置,例如:github、terminal、xcode
- `hiddenFormatterBtn`(可选):: boolean;隐藏【美化】按钮
#### 使用规则与行为
- 编辑器高度,默认值:100%,可输入值例如 300px、100%
- 配置输入自动提示关键字
- 编辑器主题配置,例如:github、terminal、xcode
- 隐藏【美化】按钮
- groovy编辑器
- 向编辑器中添加自动补全列表
#### 默认值线索
- `height => '100%'`
#### 基础示例
```tsx
import { AceEditorGroovy, type AceEditorGroovyProps } from '@flatbiz/antd/ace-editor-groovy';
const props: AceEditorGroovyProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/ace-editor-groovy/editor.tsx`
- `src/ace-editor-groovy/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/ace-editor-groovy` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### ace-editor-java LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/ace-editor-java` 的使用方式。
#### 模块定位
java编辑器
#### 导入方式
```ts
import { AceEditorJava } from '@flatbiz/antd/ace-editor-java';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `AceEditorJava` - java编辑器
- `AceEditorJavaProps`
- `* from ./editor.jsx`
#### Props / 配置要点
##### AceEditorJavaProps
- `height`(可选):: string;编辑器高度,默认值:100%,可输入值例如 300px、100%
- `value`(可选):: string | TPlainObject | TPlainObject[]
- `onChange`(可选):: (value?: string | TPlainObject | TPlainObject[]) => void
- `autoCompleterList`(可选):: { name: string; desc?: string }[];配置输入自动提示关键字
- `theme`(可选):: string;编辑器主题配置,例如:github、terminal、xcode
#### 使用规则与行为
- 编辑器高度,默认值:100%,可输入值例如 300px、100%
- 配置输入自动提示关键字
- 编辑器主题配置,例如:github、terminal、xcode
- java编辑器
- 向编辑器中添加自动补全列表
#### 默认值线索
- `height => '100%'`
#### 基础示例
```tsx
import { AceEditorJava, type AceEditorJavaProps } from '@flatbiz/antd/ace-editor-java';
const props: AceEditorJavaProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/ace-editor-java/editor.tsx`
- `src/ace-editor-java/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/ace-editor-java` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### ace-editor-json LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/ace-editor-json` 的使用方式。
#### 模块定位
Json编辑器
#### 导入方式
```ts
import { AceEditorJson } from '@flatbiz/antd/ace-editor-json';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `AceEditorJson` - Json编辑器
- `AceEditorJsonProps`
- `* from ./editor.jsx`
#### Props / 配置要点
##### AceEditorJsonProps
- `height`(可选):: string;编辑器高度,默认值:100%,可输入值例如 300px、100%
- `value`(可选):: string | TPlainObject | TPlainObject[]
- `onChange`(可选):: (value?: string | TPlainObject | TPlainObject[]) => void
- `autoCompleterList`(可选):: { name: string; desc?: string }[];配置输入自动提示关键字
- `hiddenVerifyBtn`(可选):: boolean;是否隐藏【验证数据】按钮
- `hiddenErrorMsg`(可选):: boolean;是否隐藏内部验证异常文案
- `theme`(可选):: string;编辑器主题配置,例如:github、terminal、xcode
- `footerExtraRender`(可选):: (children: ReactElement) => ReactElement;底部额外布局
- `footerStyle`(可选):: CSSProperties
#### 使用规则与行为
- 编辑器高度,默认值:100%,可输入值例如 300px、100%
- 配置输入自动提示关键字
- 是否隐藏【验证数据】按钮
- 是否隐藏内部验证异常文案
- 编辑器主题配置,例如:github、terminal、xcode
- 底部额外布局
- Json编辑器
- 向编辑器中添加自动补全列表
#### 默认值线索
- `height => '100%'`
#### 基础示例
```tsx
import { AceEditorJson, type AceEditorJsonProps } from '@flatbiz/antd/ace-editor-json';
const props: AceEditorJsonProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/ace-editor-json/editor.tsx`
- `src/ace-editor-json/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/ace-editor-json` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### ace-editor-mysql LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/ace-editor-mysql` 的使用方式。
#### 模块定位
编辑器高度,默认值:100%,可输入值例如 300px、100%
#### 导入方式
```ts
import { AceEditorMysql } from '@flatbiz/antd/ace-editor-mysql';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `AceEditorMysql`
- `AceEditorMysqlProps`
- `* from ./editor.jsx`
#### Props / 配置要点
##### AceEditorMysqlProps
- `height`(可选):: string;编辑器高度,默认值:100%,可输入值例如 300px、100%
- `value`(可选):: string
- `onChange`(可选):: (value?: string) => void
- `autoCompleterList`(可选):: { name: string; desc?: string }[];配置输入自动提示关键字
- `hiddenFormatterBtn`(可选):: boolean;隐藏【美化】按钮
- `theme`(可选):: string;编辑器主题配置,例如:github、terminal、xcode
- `footerExtraRender`(可选):: (children: ReactElement) => ReactElement;底部额外布局
- `footerStyle`(可选):: CSSProperties
#### 使用规则与行为
- 编辑器高度,默认值:100%,可输入值例如 300px、100%
- 配置输入自动提示关键字
- 隐藏【美化】按钮
- 编辑器主题配置,例如:github、terminal、xcode
- 底部额外布局
- 向编辑器中添加自动补全列表
#### 基础示例
```tsx
import { AceEditorMysql, type AceEditorMysqlProps } from '@flatbiz/antd/ace-editor-mysql';
const props: AceEditorMysqlProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/ace-editor-mysql/editor.tsx`
- `src/ace-editor-mysql/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/ace-editor-mysql` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### ace-editor-xml LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/ace-editor-xml` 的使用方式。
#### 模块定位
xml编辑器
#### 导入方式
```ts
import { AceEditorXml } from '@flatbiz/antd/ace-editor-xml';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `AceEditorXml` - xml编辑器
- `AceEditorXmlProps`
- `* from ./editor.jsx`
- `validateXML` - 验证xml格式的正确性
#### 依赖的 antd 能力
`Space`
#### Props / 配置要点
##### AceEditorXmlProps
- `height`(可选):: string;编辑器高度,默认值:100%,可输入值例如 300px、100%
- `value`(可选):: string | TPlainObject | TPlainObject[]
- `onChange`(可选):: (value?: string | TPlainObject | TPlainObject[]) => void
- `autoCompleterList`(可选):: { name: string; desc?: string }[];配置输入自动提示关键字
- `hiddenVerifyBtn`(可选):: boolean;隐藏【验证数据】按钮
- `hiddenErrorMsg`(可选):: boolean;是否隐藏内部验证异常文案
- `hiddenFormatterBtn`(可选):: boolean;隐藏【美化】按钮
- `theme`(可选):: string;编辑器主题配置,例如:github、terminal、xcode
- `footerExtraRender`(可选):: (children: ReactElement) => ReactElement;底部额外布局
- `footerStyle`(可选):: CSSProperties
#### 使用规则与行为
- 编辑器高度,默认值:100%,可输入值例如 300px、100%
- 配置输入自动提示关键字
- 隐藏【验证数据】按钮
- 是否隐藏内部验证异常文案
- 隐藏【美化】按钮
- 编辑器主题配置,例如:github、terminal、xcode
- 底部额外布局
- xml编辑器
- 向编辑器中添加自动补全列表
- 验证xml格式的正确性
#### 默认值线索
- `height => '100%'`
#### 基础示例
```tsx
import { AceEditorXml, type AceEditorXmlProps } from '@flatbiz/antd/ace-editor-xml';
const props: AceEditorXmlProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/ace-editor-xml/editor.tsx`
- `src/ace-editor-xml/index.ts`
- `src/ace-editor-xml/validate-xml.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/ace-editor-xml` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### alert-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/alert-wrapper` 的使用方式。
#### 模块定位
antd Alert 无法控制内边距,此组件扩展size属性
#### 导入方式
```ts
import { AlertWrapper } from '@flatbiz/antd/alert-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `AlertWrapper` - antd Alert 无法控制内边距,此组件扩展size属性
- `AlertWrapperProps`
- `* from ./alert.jsx`
#### 依赖的 antd 能力
`Alert`
#### Props / 配置要点
##### AlertWrapperProps
- `size`(可选):: 'small' | 'default' | 'large'
#### 使用规则与行为
- antd Alert 无法控制内边距,此组件扩展size属性
#### 默认值线索
- `size => 'default'`
#### 基础示例
```tsx
import { AlertWrapper, type AlertWrapperProps } from '@flatbiz/antd/alert-wrapper';
const props: AlertWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/alert-wrapper/alert.tsx`
- `src/alert-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/alert-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### amount-fen-input LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/amount-fen-input` 的使用方式。
#### 模块定位
AmountFenInput:基于 antd 的 InputNumber 封装。
#### 导入方式
```ts
import { AmountFenInput } from '@flatbiz/antd/amount-fen-input';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `AmountFenInput`
- `AmountFenInputProps`
- `* from ./amount-fen-input.jsx`
#### 依赖的 antd 能力
`InputNumber`
#### Props / 配置要点
##### AmountFenInputProps
- `value`(可选):: number
- `onChange`(可选):: (value?: number) => void
#### 默认值线索
- `value => undefined`
#### 基础示例
```tsx
import { AmountFenInput, type AmountFenInputProps } from '@flatbiz/antd/amount-fen-input';
const props: AmountFenInputProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/amount-fen-input/amount-fen-input.tsx`
- `src/amount-fen-input/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/amount-fen-input` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### amount-fen-input-form-item LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/amount-fen-input-form-item` 的使用方式。
#### 模块定位
分金额输入组件(集成了FormItem),入参为分,返回为分,显示为元
#### 导入方式
```ts
import { AmountFenInputFormItem } from '@flatbiz/antd/amount-fen-input-form-item';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `AmountFenInputFormItem` - 分金额输入组件(集成了FormItem),入参为分,返回为分,显示为元
- `AmountFenInputFormItemProps`
- `* from ./amount-fen-input.jsx`
#### 依赖的 antd 能力
`Form`、`FormItemProps`、`InputNumberProps`
#### Props / 配置要点
##### AmountFenInputFormItemProps
- `inputNumberProps`(可选):: Omit< InputNumberProps, 'value' | 'onChange' | 'defaultValue' >
#### 使用规则与行为
- 分金额输入组件(集成了FormItem),入参为分,返回为分,显示为元
#### 基础示例
```tsx
import { AmountFenInputFormItem, type AmountFenInputFormItemProps } from '@flatbiz/antd/amount-fen-input-form-item';
const props: AmountFenInputFormItemProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/amount-fen-input-form-item/amount-fen-input.tsx`
- `src/amount-fen-input-form-item/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/amount-fen-input-form-item` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### anchor-steps LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/anchor-steps` 的使用方式。
#### 模块定位
锚点步骤组件
#### 导入方式
```ts
import { AnchorSteps } from '@flatbiz/antd/anchor-steps';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `AnchorSteps` - 锚点步骤组件
- `AnchorStepsProps`
- `* from ./anchor-steps.jsx`
#### 依赖的 antd 能力
`Anchor`、`Steps`
#### Props / 配置要点
##### AnchorStepsProps
- `steps`(必填):: { id: string; title: string; content: ReactElement; }[]
- `className`(可选):: string
#### 使用规则与行为
- 锚点步骤组件 @param props @returns
#### 基础示例
```tsx
import { AnchorSteps, type AnchorStepsProps } from '@flatbiz/antd/anchor-steps';
const props: AnchorStepsProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/anchor-steps/anchor-steps.tsx`
- `src/anchor-steps/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/anchor-steps` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### block-layout LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/block-layout` 的使用方式。
#### 模块定位
块布局(控制light/dark模式下,块背景色和字体颜色)
#### 导入方式
```ts
import { BlockLayout } from '@flatbiz/antd/block-layout';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./layout.jsx`
- `BlockLayout` - 块布局(控制light/dark模式下,块背景色和字体颜色)
#### Props / 配置要点
##### BlockLayoutProps
- 声明:`type BlockLayoutProps = DetailedHTMLProps<`
#### 使用规则与行为
- 块布局(控制light/dark模式下,块背景色和字体颜色) @param props @returns
#### 基础示例
```tsx
import { BlockLayout, type BlockLayoutProps } from '@flatbiz/antd/block-layout';
const props: BlockLayoutProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/block-layout/index.ts`
- `src/block-layout/layout.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/block-layout` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### bootstrap LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/bootstrap` 的使用方式。
#### 模块定位
如果当前项目入口不使用@flatbiz/pro-layout,必须使用 Bootstrap 组件包装
#### 导入方式
```ts
import { Bootstrap } from '@flatbiz/antd/bootstrap';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `Bootstrap` - 如果当前项目入口不使用@flatbiz/pro-layout,必须使用 Bootstrap 组件包装
- `BootstrapProps`
- `* from ./bootstrap.jsx`
#### 依赖的 antd 能力
`App`、`theme`
#### Props / 配置要点
##### BootstrapProps
- `compact`(可选):: boolean;是否紧凑模式
- `dark`(可选):: boolean;是否drak模式
- `children`(必填):: ReactNode
- `configProviderProps`(可选):: ConfigProviderWrapperProps
- `locale`(可选):: 'en' | 'zh-cn';@default zhCN
- `bgColorConfig`(可选):: { dark?: { bgColor?: string; blockBgColor?: string; }; light?: { bgColor?: string; blockBgColor?: string; }; };背景颜色配置
#### 使用规则与行为
- 是否紧凑模式
- 是否drak模式
- 背景颜色配置
- 如果当前项目入口不使用@flatbiz/pro-layout,必须使用 Bootstrap 组件包装
#### 基础示例
```tsx
import { Bootstrap, type BootstrapProps } from '@flatbiz/antd/bootstrap';
const props: BootstrapProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/bootstrap/bootstrap.tsx`
- `src/bootstrap/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/bootstrap` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### box-grid LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/box-grid` 的使用方式。
#### 模块定位
栅格占位格数 span 优先级最高:配置了span后,其他的响应式配置将失效; 范围 0 ~ 24 为 0 相当于隐藏 为 24 相当于独占一行
#### 导入方式
```ts
import { BoxGrid } from '@flatbiz/antd/box-grid';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `Col`
- `BoxColProps`
- `PresetDefaultGrid`
- `DefaultGutter`
- `RowAligns`
- `RowJustify`
- `alignPropsMap`
- `justifyPropsMap`
- `defaultCtx`
- `BoxGridProviderCtx`
- `BoxGridProviderContextType`
- `useBoxBreakpoint` - 监听盒子大小变化,返回当前的断点
- `useGutter` - 处理间距
- `BoxGrid`
- `Row`
- `BoxRowProps`
- `TBoxBreakpoint`
- `ICommonReact`
- `Gutter`
- `GutterParams`
- `getGridMapByRange` - 获取栅格响应式布局的配置
#### Props / 配置要点
##### BoxColProps
- `span`(可选):: number;栅格占位格数 span 优先级最高:配置了span后,其他的响应式配置将失效; 范围 0 ~ 24 为 0 相当于隐藏 为 24 相当于独占一行
- `xs`(可选):: number; sm?: number; md?: number; lg?: number; xl?: number; xxl?: number; removeWrapper?: boolean;;屏幕 < 576px
##### BoxGridProviderContextType
- `horizontalGap`(必填):: number
- `verticalGap`(必填):: number
- `boxBreakpoint`(必填):: TBoxBreakpoint
- `defaultGrid`(必填):: { xs: number; sm: number; md: number; lg: number; xl: number; xxl: number; }
##### BoxRowProps
- `defaultGrid`(可选):: Partial;在不同响应尺寸下的元素占位格数 应用到所有Col子元素上
- `gutter`(可选):: GutterParams;间距
- `align`(可选):: 'top' | 'middle' | 'bottom' | 'stretch';flex 布局的垂直对齐方式
- `justify`(可选):: | 'start' | 'end' | 'center' | 'space-around' | 'space-between' | 'space-evenly';flex 布局的水平排列方式
- `onBoxBreakpointChange`(可选):: (breakpoint: TBoxBreakpoint) => void;尺寸变化回调
#### 使用规则与行为
- 栅格占位格数 span 优先级最高:配置了span后,其他的响应式配置将失效; 范围 0 ~ 24 为 0 相当于隐藏 为 24 相当于独占一行
- 屏幕 < 576px
- 屏幕 ≥ 576px
- 屏幕 ≥ 768px
- 屏幕 ≥ 992px
- 屏幕 ≥ 1200px
- 屏幕 ≥ 1600px
- 是否移除 外部包装div
- 监听盒子大小变化,返回当前的断点 @param dom @returns
- width为0,或者不存在
#### 基础示例
```tsx
import { BoxGrid, type BoxColProps } from '@flatbiz/antd/box-grid';
const props: BoxColProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/box-grid/col.tsx`
- `src/box-grid/constant.ts`
- `src/box-grid/ctx.ts`
- `src/box-grid/hooks.ts`
- `src/box-grid/index.ts`
- `src/box-grid/row.tsx`
- `src/box-grid/type.ts`
- `src/box-grid/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/box-grid` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### button-operate LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/button-operate` 的使用方式。
#### 模块定位
按钮组合处理组件
#### 导入方式
```ts
import { ButtonOperate } from '@flatbiz/antd/button-operate';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `ButtonOperateItemContent`
- `ButtonOperate` - 按钮组合处理组件
- `ButtonOperateItem`
- `ButtonOperateProps`
- `* from ./button-operate.jsx`
#### 依赖的 antd 能力
`Button`、`Divider`、`Popconfirm`、`PopconfirmProps`、`Popover`、`Space`、`SpaceProps`、`Tooltip`
#### Props / 配置要点
##### ButtonOperateItem
- `hoverTips`(可选):: string | ReactElement;hover 提示文字,isFold=true无效
- `tipsType`(可选):: 'popover' | 'tooltip';hover 提示类型 默认:'tooltip'
- `text`(可选):: string | ReactElement;按钮文案
- `color`(可选):: string;自定义按钮颜色
- `needConfirm`(可选):: boolean;是否需要二次弹框确认
- `confirmMessage`(可选):: ReactNode;二次弹框确认文案
- `isFold`(可选):: boolean;是否折叠合拢
- `show`(可选):: boolean;是否显示按钮,优先级高于 hidden
##### ButtonOperateProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `operateList`(必填):: Array;如果数组中元素为ReactElement类型 1. 一般为antd Button组件,如果组件存在属性hidden=true、v-hidden=true,则会隐藏 2. 可配置 v-permission 权限值,例如 v-permission="add" 3. 任何confirm、disabled等状态在外部控制 3. 不支持fold效果
- `wrap`(可选):: boolean;是否换行,默认true
- `foldIcon`(可选):: ReactElement;隐藏图标Icon
- `split`(可选):: boolean;按钮之间是否添加分隔符
- `spaceProps`(可选):: SpaceProps;多个按钮的包装组件Space属性
- `gap`(可选):: number;间距,默认:10;split=true配置下无效(可通过spaceProps设置间距)
- `dropdownMenuProps`(可选):: Omit;折叠合拢属性
- `size`(可选):: 'small' | 'default';按钮布局尺寸
#### 使用规则与行为
- hover 提示文字,isFold=true无效
- hover 提示类型 默认:'tooltip'
- 按钮文案
- 自定义按钮颜色
- 是否需要二次弹框确认
- 二次弹框确认文案
- 是否折叠合拢
- 是否显示按钮,优先级高于 hidden
- 如果数组中元素为ReactElement类型 1. 一般为antd Button组件,如果组件存在属性hidden=true、v-hidden=true,则会隐藏 2. 可配置 v-permission 权限值,例如 v-permission="add" 3. 任何confirm、disabled等状态在外部控制 3. 不支持fold效果
- 是否换行,默认true
#### 默认值线索
- `gap => 10`
#### 基础示例
```tsx
import { ButtonOperate, type ButtonOperateProps } from '@flatbiz/antd/button-operate';
const props: ButtonOperateProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/button-operate/button-operate.tsx`
- `src/button-operate/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/button-operate` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### button-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/button-wrapper` 的使用方式。
#### 模块定位
antd Button包装组件 1. 添加按钮 onClick 返回 Promise自动loading效果 2. 内置 防抖 效果(在第一触发函数后,在指定时间内再次触发无效,即两次触发的时间间隙大于指定时间)
#### 导入方式
```ts
import { ButtonWrapper } from '@flatbiz/antd/button-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `ButtonWrapper` - antd Button包装组件 1. 添加按钮 onClick 返回 Promise自动loading效果 2. 内置 防抖 效果(在第一触发函数后,在指定时间内再次触发无效,即两次触发的时间间隙大于指定时间)
- `ButtonWrapperProps`
- `* from ./button-wrapper.jsx`
#### 依赖的 antd 能力
`Button`、`ButtonProps`
#### Props / 配置要点
##### ButtonWrapperProps
- `onClick`(可选):: (e: React.MouseEvent) => Promise | void;当返回 Promise 时,按钮自动loading
- `debounceDuration`(可选):: number;重复点击间隙,单位毫秒 默认值:500
- `permission`(可选):: string;基于GLOBAL中elemAclLimits按钮权限列表,控制按钮显示、隐藏
- `hidden`(可选):: boolean;是否隐藏按钮
- `loadingPosition`(可选):: 'left' | 'center';loading 显示位置,默认值:left
- `removeGap`(可选):: boolean;移除按钮内边距,一般用于 type=link 类型下
- `color`(可选):: string
#### 使用规则与行为
- 当返回 Promise 时,按钮自动loading
- 重复点击间隙,单位毫秒 默认值:500
- 基于GLOBAL中elemAclLimits按钮权限列表,控制按钮显示、隐藏
- 是否隐藏按钮
- loading 显示位置,默认值:left
- 移除按钮内边距,一般用于 type=link 类型下
- antd Button包装组件 1. 添加按钮 onClick 返回 Promise自动loading效果 2. 内置 防抖 效果(在第一触发函数后,在指定时间内再次触发无效,即两次触发的时间间隙大于指定时间) @param props @returns
#### 默认值线索
- `loadingPosition => 'left'`
- `debounceDuration => 500`
#### 基础示例
```tsx
import { ButtonWrapper, type ButtonWrapperProps } from '@flatbiz/antd/button-wrapper';
const props: ButtonWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/button-wrapper/button-wrapper.tsx`
- `src/button-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/button-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### card-layout LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/card-layout` 的使用方式。
#### 模块定位
卡片结构布局,替代 SimpleLayout 组件
#### 导入方式
```ts
import { CardLayout } from '@flatbiz/antd/card-layout';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `CardLayout` - 卡片结构布局,替代 SimpleLayout 组件
- `CardLayoutProps`
- `* from ./card-layout.jsx`
#### 依赖的 antd 能力
`Space`
#### Props / 配置要点
##### CardLayoutProps
- `desc`(可选):: string | string[] | ReactElement | ReactElement[];描述
- `title`(可选):: string | ReactElement;标题
- `subTitle`(可选):: string | ReactElement;子标题,在标题右侧
- `layoutType`(可选):: 'layer' | 'tight';layoutType 布局类型
- `titleLeftLine`(可选):: boolean;隐藏标题左侧符号
- `titleStyle`(可选):: CSSProperties
- `titleContentStyle`(可选):: CSSProperties
- `subTitleStyle`(可选):: CSSProperties
- `titleExtraStyle`(可选):: CSSProperties
- `contentStyle`(可选):: CSSProperties
- `padding`(可选):: CSSProperties['padding'];优先级大于 style padding
- `width`(可选):: CSSProperties['width'];优先级大于 style width
- `height`(可选):: CSSProperties['height'];优先级大于 style height
- `titleExtra`(可选):: string | ReactElement;标题右侧布局
- `titleFixed`(可选):: boolean;当存在滚动条时,标题固定,滚动区域为内部部分
- `size`(可选):: 'default' | 'small';间距尺寸 1. default = 15 2. small = 8
- `onClick`(可选):: (event) => void
- `hidden`(可选):: boolean
- `children`(可选):: ReactNode
- `className`(可选):: string
- `style`(可选):: CSSProperties
#### 使用规则与行为
- 描述
- 标题
- 子标题,在标题右侧
- layoutType 布局类型
- 隐藏标题左侧符号
- 优先级大于 style padding
- 优先级大于 style width
- 优先级大于 style height
- 标题右侧布局
- 当存在滚动条时,标题固定,滚动区域为内部部分
#### 基础示例
```tsx
import { CardLayout, type CardLayoutProps } from '@flatbiz/antd/card-layout';
const props: CardLayoutProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/card-layout/card-layout.tsx`
- `src/card-layout/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/card-layout` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### card-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/card-wrapper` 的使用方式。
#### 模块定位
#### 导入方式
```ts
import { CardWrapper } from '@flatbiz/antd/card-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `CardWrapper` -
- `* from ./card-wrapper.jsx`
#### 依赖的 antd 能力
`Card`、`CardProps`
#### 使用规则与行为
- @param props @returns
#### 基础示例
```tsx
import { CardWrapper } from '@flatbiz/antd/card-wrapper';
;
```
#### 源码索引
- `src/card-wrapper/card-wrapper.tsx`
- `src/card-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/card-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### cascader-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/cascader-wrapper` 的使用方式。
#### 模块定位
级联选择器包装组件
#### 导入方式
```ts
import { CascaderWrapper } from '@flatbiz/antd/cascader-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `CascaderWrapper` - 级联选择器包装组件
- `CascaderWrapperProps`
- `CascaderWrapperRefApi`
- `* from ./cascader-wrapper.jsx`
- `getValues`
#### 依赖的 antd 能力
`Button`、`Cascader`、`CascaderProps`、`Flex`
#### Props / 配置要点
##### CascaderWrapperServiceConfig
- `params`(可选):: TPlainObject
- `onRequest`(可选):: (params?: TAny) => TAny
- `onRequestResultAdapter`(可选):: (respData: TAny) => TPlainObject[];响应数据适配器
- `requiredParamsKeys`(可选):: string[];必填字段设置
##### CascaderWrapperProps
- `fieldNames`(可选):: { list?: string; label?: string; value?: string; children?: string; };参数Key映射
- `serviceConfig`(可选):: CascaderWrapperServiceConfig;请求服务需求的数据,当设置selectorList后无效果
- `onSelectorListChange`(可选):: (dataList: TPlainObject[]) => void
- `isDynamicLoad`(可选):: boolean;是否动态加载选项
- `value`(可选):: | string | number | Array | LabelValueItem | LabelValueItem[]
- `onChange`(可选):: ( value?: string | number | Array, selectedList?: TPlainObject[] ) => void
- `requestMessageConfig`(可选):: TRequestStatusProps['messageConfig'];配置数据查询状态描述,比如有依赖字段描述
- `labelInValue`(可选):: boolean;响应数据是否包含label、value
#### 使用规则与行为
- 响应数据适配器
- 必填字段设置
- 参数Key映射
- 请求服务需求的数据,当设置selectorList后无效果
- 是否动态加载选项
- 配置数据查询状态描述,比如有依赖字段描述
- 选择数据响应类型(当用户选中后响应数据),默认值:last
- 响应数据是否包含label、value
- 级联选择器包装组件
#### 基础示例
```tsx
import { CascaderWrapper, type CascaderWrapperProps } from '@flatbiz/antd/cascader-wrapper';
const props: CascaderWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/cascader-wrapper/cascader-wrapper.tsx`
- `src/cascader-wrapper/index.ts`
- `src/cascader-wrapper/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/cascader-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### check-list LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/check-list` 的使用方式。
#### 模块定位
CheckListItem:FlatBiz antd 扩展模块。
#### 导入方式
```ts
import { CheckList } from '@flatbiz/antd/check-list';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `CheckListItem`
- `CheckListItemContentProps`
- `CheckListItemProps`
- `CheckListInner`
- `CheckListSelectedValue`
- `CheckListProps`
- `CheckList`
- `CheckListItemValue`
- `CheckListValue`
- `getValueList`
#### Props / 配置要点
##### CheckListItemContentProps
- `checked`(可选):: boolean
- `disabled`(可选):: boolean
- `onClick`(可选):: (event) => void
- `className`(可选):: string
- `readonly`(可选):: boolean
- `style`(可选):: CSSProperties
##### CheckListItemProps
- `value`(必填):: CheckListItemValue
- `disabled`(可选):: boolean
- `readonly`(可选):: boolean
- `children`(必填):: (data: CheckListItemContentProps) => ReactElement
- `className`(可选):: string
- `style`(可选):: CSSProperties
##### CheckListProps
- `multiple`(可选):: boolean
- `onChange`(可选):: ( value: CheckListSelectedValue, operateValue: CheckListItemValue ) => void
- `onPreChange`(可选):: (value: CheckListItemValue) => Promise
- `value`(可选):: CheckListSelectedValue
- `defaultValue`(可选):: CheckListSelectedValue
- `beforeExtra`(可选):: ReactNode
- `afterExtra`(可选):: ReactNode
- `stopPropagation`(可选):: boolean
- `required`(可选):: boolean
##### CheckListItemValue
- 声明:`export type CheckListItemValue = string | number;`
#### 基础示例
```tsx
import { CheckList, type CheckListItemContentProps } from '@flatbiz/antd/check-list';
const props: CheckListItemContentProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/check-list/check-list-item.tsx`
- `src/check-list/check-list.tsx`
- `src/check-list/context.ts`
- `src/check-list/index.ts`
- `src/check-list/types.ts`
- `src/check-list/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/check-list` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### checkbox-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/checkbox-wrapper` 的使用方式。
#### 模块定位
解决 Checkbox 只能接收boolean的限制,与Form.Item结合使用最佳
#### 导入方式
```ts
import { CheckboxWrapper } from '@flatbiz/antd/checkbox-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `CheckboxWrapper` - 解决 Checkbox 只能接收boolean的限制,与Form.Item结合使用最佳
- `CheckboxWrapperProps`
- `* from ./checkbox-wrapper.jsx`
#### 依赖的 antd 能力
`Checkbox`、`CheckboxProps`
#### Props / 配置要点
##### CheckboxWrapperProps
- `value`(可选):: string | number | boolean
- `checkedValue`(必填):: string | number | boolean
- `unCheckedValue`(必填):: string | number | boolean
- `onChange`(可选):: (value: string | number | boolean) => void
#### 使用规则与行为
- 解决 Checkbox 只能接收boolean的限制,与Form.Item结合使用最佳
#### 基础示例
```tsx
import { CheckboxWrapper, type CheckboxWrapperProps } from '@flatbiz/antd/checkbox-wrapper';
const props: CheckboxWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/checkbox-wrapper/checkbox-wrapper.tsx`
- `src/checkbox-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/checkbox-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### code-render LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/code-render` 的使用方式。
#### 模块定位
代码、json格式化渲染
#### 导入方式
```ts
import { CodeRender } from '@flatbiz/antd/code-render';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `CodeRender` - 代码、json格式化渲染
- `CodeRenderProps`
- `* from ./code.jsx`
#### Props / 配置要点
##### CodeRenderProps
- `code`(可选):: string | string[]
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `wrap`(可选):: boolean;是否换行,默认值:true
- `size`(可选):: 'small' | 'default'
#### 使用规则与行为
- 是否换行,默认值:true
- 代码、json格式化渲染
#### 默认值线索
- `wrap => true`
#### 基础示例
```tsx
import { CodeRender, type CodeRenderProps } from '@flatbiz/antd/code-render';
const props: CodeRenderProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/code-render/code.tsx`
- `src/code-render/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/code-render` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### color-picker-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/color-picker-wrapper` 的使用方式。
#### 模块定位
转换成 hex 格式颜色字符串,返回格式如:#1677ff
#### 导入方式
```ts
import { ColorPickerWrapper } from '@flatbiz/antd/color-picker-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `ColorPickerWrapper`
- `ColorPickerWrapperProps`
- `* from ./color-picker.jsx`
#### 依赖的 antd 能力
`ColorPicker`
#### Props / 配置要点
##### ColorPickerWrapperProps
- `value`(可选):: string;格式:#1677ff
- `onChange`(可选):: (hex?: string) => void;转换成 hex 格式颜色字符串,返回格式如:#1677ff
- `placeholder`(可选):: string
- `hideDeleteIcon`(可选):: boolean;是否隐藏删除图标
- `className`(可选):: string
- `rootClassName`(可选):: string;ColorPicker 弹框根节点类名
#### 使用规则与行为
- 转换成 hex 格式颜色字符串,返回格式如:#1677ff
- 是否隐藏删除图标
- ColorPicker 弹框根节点类名
#### 基础示例
```tsx
import { ColorPickerWrapper, type ColorPickerWrapperProps } from '@flatbiz/antd/color-picker-wrapper';
const props: ColorPickerWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/color-picker-wrapper/color-picker.tsx`
- `src/color-picker-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/color-picker-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### config-provider-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/config-provider-wrapper` 的使用方式。
#### 模块定位
antd ConfigProvider 扩展类
#### 导入方式
```ts
import { ConfigProviderWrapper } from '@flatbiz/antd/config-provider-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `ConfigProviderWrapper` - antd ConfigProvider 扩展类
- `ConfigProviderWrapperProps`
- `* from ./config-provider-wrapper.jsx`
#### 依赖的 antd 能力
`ConfigProvider`
#### Props / 配置要点
##### ConfigProviderWrapperProps
- `locale`(可选):: TLocale
- `customLocaleMessage`(可选):: Partial;自定义国际化数据
- `copyOperateIgnoreClass`(可选):: string[];同 fbaHooks.useCopyRemoveSpace[ignoreClass]
#### 使用规则与行为
- 自定义国际化数据
- 同 fbaHooks.useCopyRemoveSpace[ignoreClass]
- antd ConfigProvider 扩展类
#### 基础示例
```tsx
import { ConfigProviderWrapper, type ConfigProviderWrapperProps } from '@flatbiz/antd/config-provider-wrapper';
const props: ConfigProviderWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/config-provider-wrapper/config-provider-wrapper.tsx`
- `src/config-provider-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/config-provider-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### copy-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/copy-wrapper` 的使用方式。
#### 模块定位
自定义文本,显示在复制图标前或后
#### 导入方式
```ts
import { CopyWrapper } from '@flatbiz/antd/copy-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `CopyWrapper`
- `CopyWrapperProps`
- `* from ./copy.jsx`
#### 依赖的 antd 能力
`Flex`、`message`
#### Props / 配置要点
##### CopyWrapperProps
- `copyText`(必填):: string | (() => string)
- `copyAfterMsg`(可选):: string;复制后提示消息
- `hoverTips`(可选):: string | ((trigger) => string);复制鼠标悬浮提示
- `iconStyle`(可选):: CSSProperties;设置icon后失效
- `text`(可选):: ReactNode;自定义文本,显示在复制图标前或后
- `hiddenTips`(可选):: boolean
- `icon`(可选):: ReactNode;自定义复制icon图标
- `iconPosition`(可选):: 'left' | 'right';复制图标位置,text 为空时,此配置无效
#### 使用规则与行为
- 复制后提示消息
- 复制鼠标悬浮提示
- 设置icon后失效
- 自定义文本,显示在复制图标前或后
- 自定义复制icon图标
- 复制图标位置,text 为空时,此配置无效
#### 基础示例
```tsx
import { CopyWrapper, type CopyWrapperProps } from '@flatbiz/antd/copy-wrapper';
const props: CopyWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/copy-wrapper/copy.tsx`
- `src/copy-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/copy-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### css-node-hover LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/css-node-hover` 的使用方式。
#### 模块定位
css hover 效果
#### 导入方式
```ts
import { CssNodeHover } from '@flatbiz/antd/css-node-hover';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `CssNodeHover` - css hover 效果
- `CssHoverProps`
- `* from ./css-node-hover.jsx`
#### Props / 配置要点
##### CssHoverProps
- `children`(必填):: ReactElement | ReactElement[]
#### 使用规则与行为
- css hover 效果 @param props @returns
#### 基础示例
```tsx
import { CssNodeHover, type CssHoverProps } from '@flatbiz/antd/css-node-hover';
const props: CssHoverProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/css-node-hover/css-node-hover.tsx`
- `src/css-node-hover/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/css-node-hover` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### data-render LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/data-render` 的使用方式。
#### 模块定位
数据渲染,内置处理数据为空渲染
#### 导入方式
```ts
import { DataRender } from '@flatbiz/antd/data-render';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DataRender` - 数据渲染,内置处理数据为空渲染
- `DataRenderProps`
- `* from ./data-render.jsx`
#### 依赖的 antd 能力
`Empty`
#### Props / 配置要点
##### DataRenderProps
- `isEmpty`(必填):: boolean | (() => boolean)
- `empty`(可选):: ReactElement
- `emptyText`(可选):: string | ReactElement
- `emptyStyle`(可选):: CSSProperties
- `emptyClassName`(可选):: string
- `children`(必填):: ReactNode
#### 使用规则与行为
- 数据渲染,内置处理数据为空渲染
#### 基础示例
```tsx
import { DataRender, type DataRenderProps } from '@flatbiz/antd/data-render';
const props: DataRenderProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/data-render/data-render.tsx`
- `src/data-render/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/data-render` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### date-picker-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/date-picker-wrapper` 的使用方式。
#### 模块定位
DatePicker包装组件
#### 导入方式
```ts
import { DatePickerWrapper } from '@flatbiz/antd/date-picker-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DatePickerWrapper` - DatePicker包装组件
- `* from ./date.jsx`
- `DatePickerWrapperProps`
#### 依赖的 antd 能力
`DatePicker`、`GetProps`
#### Props / 配置要点
##### DatePickerType
- 声明:`type DatePickerType = GetProps; // BaseSelectRef`
##### DatePickerWrapperProps
- `value`(可选):: string;默认格式为 'YYYY-MM-DD'
- `onChange`(可选):: (value?: string) => void
- `disabledDateConfig`(可选):: { minDate?: TDayjsDateType; maxDate?: TDayjsDateType; disabledHourList?: number[]; disabledMinuteList?: number[]; disabledSecondList?: number[]; };禁用 小时 刻度列表,与日期无关
- `format`(可选):: TDayjsDateType;可自定义格式
- `outputNormalize`(可选):: (value?: TAny) => TAny;value 输出适配
- `inputNormalize`(可选):: (value?: TAny) => string | undefined;value 输入适配
#### 使用规则与行为
- DatePicker包装组件
- 默认格式为 'YYYY-MM-DD'
- 禁用 小时 刻度列表,与日期无关
- 禁用 分钟 刻度列表,与日期无关
- 禁用 秒钟 刻度列表,与日期无关
- 可自定义格式
- value 输出适配
- value 输入适配
#### 基础示例
```tsx
import { DatePickerWrapper, type DatePickerWrapperProps } from '@flatbiz/antd/date-picker-wrapper';
const props: DatePickerWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/date-picker-wrapper/date.tsx`
- `src/date-picker-wrapper/index.ts`
- `src/date-picker-wrapper/types.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/date-picker-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### date-range-picker-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/date-range-picker-wrapper` 的使用方式。
#### 模块定位
DatePicker.RangePicker包装组件
#### 导入方式
```ts
import { DateRangePickerWrapper } from '@flatbiz/antd/date-range-picker-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DateRangePickerWrapper` - DatePicker.RangePicker包装组件
- `* from ./date-range-picker-wrapper.jsx`
- `DateRangePickerWrapperProps`
#### 依赖的 antd 能力
`DatePicker`、`GetProps`
#### Props / 配置要点
##### DateRangePickerType
- 声明:`type DateRangePickerType = GetProps; // BaseSelectRef`
##### DateRangePickerWrapperProps
- `value`(可选):: [string, string]
- `onChange`(可选):: (value?: [string, string]) => void
- `disabledDateConfig`(可选):: { minDate?: TDayjsDateType; maxDate?: TDayjsDateType; maxDays?: number; disabledHourList?: number[]; disabledMinuteList?: number[]; disabledSecondList?: numb…;1. minDate、maxDate 与 format格式相同;默认:YYYY-MM-DD 2. maxDays 最大可选的天数
- `format`(可选):: TDayjsDateType
- `outputNormalize`(可选):: (value: [string, string]) => TAny;value 输出适配
- `inputNormalize`(可选):: (value?: TAny) => [string, string] | undefined;value 输入适配
#### 使用规则与行为
- DatePicker.RangePicker包装组件
- 1. minDate、maxDate 与 format格式相同;默认:YYYY-MM-DD 2. maxDays 最大可选的天数
- 禁用 小时 刻度列表,与日期无关
- 禁用 分钟 刻度列表,与日期无关
- 禁用 秒钟 刻度列表,与日期无关
- value 输出适配
- value 输入适配
#### 基础示例
```tsx
import { DateRangePickerWrapper, type DateRangePickerWrapperProps } from '@flatbiz/antd/date-range-picker-wrapper';
const props: DateRangePickerWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/date-range-picker-wrapper/date-range-picker-wrapper.tsx`
- `src/date-range-picker-wrapper/index.ts`
- `src/date-range-picker-wrapper/types.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/date-range-picker-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### date-range-picker-wrapper-form-item LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/date-range-picker-wrapper-form-item` 的使用方式。
#### 模块定位
包含了Form.Item组件的时间区间选择组件,时间区间组件可以定义成两个字段操作,不用再通过数组处理
#### 导入方式
```ts
import { DateRangePickerWrapperFormItem } from '@flatbiz/antd/date-range-picker-wrapper-form-item';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DateRangePickerWrapperFormItem` - 包含了Form.Item组件的时间区间选择组件,时间区间组件可以定义成两个字段操作,不用再通过数组处理
- `DateRangePickerWrapperFormItemProps`
- `* from ./form-item.jsx`
#### 依赖的 antd 能力
`Form`
#### Props / 配置要点
##### DateRangePickerWrapperFormItemProps
- `startName`(必填):: FormItemNamePath;开始的时间name
- `endName`(必填):: FormItemNamePath;结束的时间name
- `formListName`(可选):: Array;如果 DateRangePickerWrapperFormItem 在Form.List场景下 必传 @deprecated 使用 formListCompleteName 配置
- `formListCompleteName`(可选):: Array | string;前端 formItem 前缀FormName,当 TimeRangePickerWrapperFormItem 处在Form.List场景下,必传
- `dateRangePickerWrapperProps`(可选):: DateRangePickerWrapperProps
#### 使用规则与行为
- 开始的时间name
- 结束的时间name
- 如果 DateRangePickerWrapperFormItem 在Form.List场景下 必传 @deprecated 使用 formListCompleteName 配置
- 前端 formItem 前缀FormName,当 TimeRangePickerWrapperFormItem 处在Form.List场景下,必传
- 包含了Form.Item组件的时间区间选择组件,时间区间组件可以定义成两个字段操作,不用再通过数组处理
#### 基础示例
```tsx
import { DateRangePickerWrapperFormItem, type DateRangePickerWrapperFormItemProps } from '@flatbiz/antd/date-range-picker-wrapper-form-item';
const props: DateRangePickerWrapperFormItemProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/date-range-picker-wrapper-form-item/form-item.tsx`
- `src/date-range-picker-wrapper-form-item/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/date-range-picker-wrapper-form-item` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### delete-node LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/delete-node` 的使用方式。
#### 模块定位
删除节点,点击后会显示二次确认点击
#### 导入方式
```ts
import { DeleteNode } from '@flatbiz/antd/delete-node';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DeleteNode` - 删除节点,点击后会显示二次确认点击
- `* from ./delete-node.jsx`
#### 使用规则与行为
- 删除节点,点击后会显示二次确认点击
- 默认图标
- 确认图标
- 是否隐藏
#### 基础示例
```tsx
import { DeleteNode } from '@flatbiz/antd/delete-node';
;
```
#### 源码索引
- `src/delete-node/delete-node.tsx`
- `src/delete-node/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/delete-node` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dialog-alert LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dialog-alert` 的使用方式。
#### 模块定位
确认弹框
#### 导入方式
```ts
import { dialogAlert } from '@flatbiz/antd/dialog-alert';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `dialogAlert` - 确认弹框
- `DialogAlertProps`
- `* from ./dialog-alert.jsx`
- `bodyAppendDivElement`
- `removeBodyChild`
- `BodyAppendDivElementProps`
#### Props / 配置要点
##### DialogAlertProps
- `onClick`(可选):: (e: React.MouseEvent) => void | Promise
##### BodyAppendDivElementProps
- `divElement`(必填):: HTMLDivElement
- `elementId`(必填):: string
#### 使用规则与行为
- 确认弹框
#### 基础示例
```tsx
import { dialogAlert, type DialogAlertProps } from '@flatbiz/antd/dialog-alert';
const props: DialogAlertProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dialog-alert/dialog-alert.tsx`
- `src/dialog-alert/index.ts`
- `src/dialog-alert/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dialog-alert` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dialog-confirm LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dialog-confirm` 的使用方式。
#### 模块定位
确认弹框
#### 导入方式
```ts
import { dialogConfirm } from '@flatbiz/antd/dialog-confirm';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `dialogConfirm` - 确认弹框
- `* from ./dialog-confirm.jsx`
#### 使用规则与行为
- 确认弹框
#### 基础示例
```tsx
import { dialogConfirm } from '@flatbiz/antd/dialog-confirm';
;
```
#### 源码索引
- `src/dialog-confirm/dialog-confirm.tsx`
- `src/dialog-confirm/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dialog-confirm` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dialog-drag-modal LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dialog-drag-modal` 的使用方式。
#### 模块定位
可移动弹框
#### 导入方式
```ts
import { dialogDragModal } from '@flatbiz/antd/dialog-drag-modal';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `dialogDragModal` - 可移动弹框
- `DialogDragModalProps`
- `* from ./drag-modal.jsx`
#### 依赖的 antd 能力
`Form`、`FormInstance`、`Space`
#### Props / 配置要点
##### DialogDragModalProps
- `modalKey`(可选):: string;相同的modalKey,最多只有一个弹起状态
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `styles`(可选):: { header?: CSSProperties; body?: CSSProperties; footer?: CSSProperties; }
- `width`(可选):: number
- `bodyHeight`(可选):: number
- `event`(可选):: React.MouseEvent;触发弹起点击事件event,用于计算鼠标位置
- `xOffset`(可选):: number;定义弹出层距离触发点的x轴偏移量,设置event参数后有效
- `yOffset`(可选):: number;定义弹出层距离触发点的y轴偏移量,设置event参数后有效
- `title`(可选):: string
- `okText`(可选):: string | ReactElement
- `cancelText`(可选):: string | ReactElement
- `okHidden`(可选):: boolean
- `cancelHidden`(可选):: boolean
- `onOk`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `onCancel`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `content`(必填):: | string | ReactElement | ((form: FormInstance, operate: { onClose: TNoopDefine }) => ReactElement)
- `footer`(可选):: | null | ((form: FormInstance, operate: { onClose: TNoopDefine }) => ReactElement);覆盖当前footer,自定义操作按钮
- `footerOperateBeforeRender`(可选):: ( form: FormInstance, operate: { onClose: TNoopDefine } ) => ReactElement;当前footer操作按钮,左侧扩展
- `footerOperateAfterRender`(可选):: ( form: FormInstance, operate: { onClose: TNoopDefine } ) => ReactElement;当前footer操作按钮,右侧扩展
#### 使用规则与行为
- 相同的modalKey,最多只有一个弹起状态
- 触发弹起点击事件event,用于计算鼠标位置
- 定义弹出层距离触发点的x轴偏移量,设置event参数后有效
- 定义弹出层距离触发点的y轴偏移量,设置event参数后有效
- 覆盖当前footer,自定义操作按钮
- 当前footer操作按钮,左侧扩展
- 当前footer操作按钮,右侧扩展
- 可移动弹框
#### 基础示例
```tsx
import { dialogDragModal, type DialogDragModalProps } from '@flatbiz/antd/dialog-drag-modal';
const props: DialogDragModalProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dialog-drag-modal/drag-modal.tsx`
- `src/dialog-drag-modal/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dialog-drag-modal` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dialog-drawer LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dialog-drawer` 的使用方式。
#### 模块定位
抽屉弹框
#### 导入方式
```ts
import { dialogDrawer } from '@flatbiz/antd/dialog-drawer';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `dialogDrawer` - 抽屉弹框
- `DialogDrawerProps`
- `* from ./dialog-drawer.jsx`
#### 依赖的 antd 能力
`Drawer`、`DrawerProps`、`Form`、`FormInstance`、`Space`
#### Props / 配置要点
##### DialogDrawerProps
- `okText`(可选):: string | ReactElement
- `cancelText`(可选):: string | ReactElement
- `onOk`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `onCancel`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `content`(必填):: | string | ReactElement | ((form: FormInstance, operate: { onClose: TNoopDefine }) => ReactElement);content只在第一次弹起时,执行一次
- `configProviderProps`(可选):: ConfigProviderWrapperProps
- `okButtonExtraProps`(可选):: Omit< ButtonWrapperProps, 'onClick' | 'children' | 'loading' >
- `cancelButtonExtraProps`(可选):: Omit
- `okHidden`(可选):: boolean
- `cancelHidden`(可选):: boolean
- `operatePosition`(可选):: 'header' | 'footer';设置操作区域位置
- `extra`(可选):: ReactNode | ((form: FormInstance) => ReactElement);右上角自定义内容,如果operatePosition=header,此设置无效
- `operateRender`(可选):: ( form: FormInstance, extraData?: TPlainObject ) => ReactElement
#### 使用规则与行为
- 重新渲染footer
- content只在第一次弹起时,执行一次
- 设置操作区域位置
- 右上角自定义内容,如果operatePosition=header,此设置无效
- 抽屉弹框
- 重新渲染 footer, data为携带的数据,是footer的第二个参数
#### 基础示例
```tsx
import { dialogDrawer, type DialogDrawerProps } from '@flatbiz/antd/dialog-drawer';
const props: DialogDrawerProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dialog-drawer/context.ts`
- `src/dialog-drawer/dialog-drawer.tsx`
- `src/dialog-drawer/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dialog-drawer` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dialog-drawer-content LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dialog-drawer-content` 的使用方式。
#### 模块定位
当dialogDrawer底部操作按钮在业务content内部时,使用
#### 导入方式
```ts
import { DialogDrawerContent } from '@flatbiz/antd/dialog-drawer-content';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DialogDrawerContent` - 当dialogDrawer底部操作按钮在业务content内部时,使用
- `DialogDrawerContentProps`
- `* from ./content.jsx`
#### 依赖的 antd 能力
`Space`
#### Props / 配置要点
##### DialogDrawerContentProps
- `footer`(可选):: (data: { onClose: () => void }) => ReactElement
- `footerStyle`(可选):: CSSProperties
- `children`(可选):: ReactNode
- `okHidden`(可选):: boolean
- `cancelHidden`(可选):: boolean
- `okButtonExtraProps`(可选):: Omit< ButtonWrapperProps, 'onClick' | 'children' | 'loading' >
- `cancelButtonExtraProps`(可选):: Omit< ButtonWrapperProps, 'onClick' | 'children' | 'loading' >
- `okText`(可选):: string | ReactElement
- `cancelText`(可选):: string | ReactElement
- `onOk`(可选):: (e: React.MouseEvent) => void | Promise
- `onCancel`(可选):: (e: React.MouseEvent) => void | Promise
#### 使用规则与行为
- 当dialogDrawer底部操作按钮在业务content内部时,使用
#### 基础示例
```tsx
import { DialogDrawerContent, type DialogDrawerContentProps } from '@flatbiz/antd/dialog-drawer-content';
const props: DialogDrawerContentProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dialog-drawer-content/content.tsx`
- `src/dialog-drawer-content/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dialog-drawer-content` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dialog-loading LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dialog-loading` 的使用方式。
#### 模块定位
Loading弹框
#### 导入方式
```ts
import { dialogLoading } from '@flatbiz/antd/dialog-loading';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `dialogLoading` - Loading弹框
- `DialogLoadingProps`
- `* from ./dialog-loading.jsx`
#### 依赖的 antd 能力
`Modal`、`theme`
#### Props / 配置要点
##### DialogLoadingProps
- `className`(可选):: string
- `message`(可选):: string
- `mask`(可选):: boolean
#### 使用规则与行为
- Loading弹框
#### 基础示例
```tsx
import { dialogLoading, type DialogLoadingProps } from '@flatbiz/antd/dialog-loading';
const props: DialogLoadingProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dialog-loading/dialog-loading.tsx`
- `src/dialog-loading/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dialog-loading` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dialog-modal LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dialog-modal` 的使用方式。
#### 模块定位
居中弹框
#### 导入方式
```ts
import { dialogModal } from '@flatbiz/antd/dialog-modal';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `dialogModal` - 居中弹框
- `DialogModalProps`
- `* from ./dialog-modal.jsx`
#### 依赖的 antd 能力
`Form`、`FormInstance`、`Modal`、`ModalProps`
#### Props / 配置要点
##### DialogModalProps
- `size`(可选):: 'small' | 'middle' | 'large' | null;内置尺寸,根据比例固定高度、宽度,默认:无
- `onOk`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `onCancel`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `content`(必填):: | string | ReactElement | ((form: FormInstance, operate: { onClose: TNoopDefine }) => ReactElement);content只在第一次弹起时,执行一次
- `configProviderProps`(可选):: ConfigProviderWrapperProps
- `okHidden`(可选):: boolean
- `cancelHidden`(可选):: boolean
- `okButtonProps`(可选):: Omit
- `cancelButtonProps`(可选):: Omit< ButtonWrapperProps, 'hidden' | 'children' | 'onClick' >
- `bodyHeightPercent`(可选):: number;设置modal body height 为当前窗口height的百分比,例如:30 @deprecated 已失效,可通过size属性设置
- `titleExtra`(可选):: ReactElement
- `footer`(可选):: | null | ReactElement | ReactElement[] | ((form: FormInstance, extraData?: TPlainObject) => ReactElement);null则隐藏footer
- `bodyHeight`(可选):: number;内容高度,为styles.body.height快捷配置,优先级低于styles.body.height
#### 使用规则与行为
- 重新渲染footer
- 内置尺寸,根据比例固定高度、宽度,默认:无
- content只在第一次弹起时,执行一次
- 设置modal body height 为当前窗口height的百分比,例如:30 @deprecated 已失效,可通过size属性设置
- null则隐藏footer
- 内容高度,为styles.body.height快捷配置,优先级低于styles.body.height
- 居中弹框
- 重新渲染 footer, data为携带的数据,是footer的第二个参数
#### 基础示例
```tsx
import { dialogModal, type DialogModalProps } from '@flatbiz/antd/dialog-modal';
const props: DialogModalProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dialog-modal/context.ts`
- `src/dialog-modal/dialog-modal.tsx`
- `src/dialog-modal/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dialog-modal` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dialog-preview-image LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dialog-preview-image` 的使用方式。
#### 模块定位
图片预览
#### 导入方式
```ts
import { dialogPreviewImage } from '@flatbiz/antd/dialog-preview-image';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./preview-image.jsx`
- `dialogPreviewImage` - 图片预览
- `DialogPreviewImageProps`
#### 依赖的 antd 能力
`Image`
#### Props / 配置要点
##### DialogPreviewImageProps
- `imageUrl`(必填):: string
#### 使用规则与行为
- 图片预览
#### 基础示例
```tsx
import { dialogPreviewImage, type DialogPreviewImageProps } from '@flatbiz/antd/dialog-preview-image';
const props: DialogPreviewImageProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dialog-preview-image/index.ts`
- `src/dialog-preview-image/preview-image.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dialog-preview-image` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dialog-preview-image-list LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dialog-preview-image-list` 的使用方式。
#### 模块定位
图片列表预览
#### 导入方式
```ts
import { dialogPreviewImageList } from '@flatbiz/antd/dialog-preview-image-list';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./preview-image.jsx`
- `dialogPreviewImageList` - 图片列表预览
- `DialogPreviewImageListProps`
#### 依赖的 antd 能力
`Image`、`Space`
#### Props / 配置要点
##### DialogPreviewImageListProps
- `imageList`(必填):: PreviewImageItem[]
- `currentIndex`(必填):: number
#### 使用规则与行为
- 图片列表预览
#### 基础示例
```tsx
import { dialogPreviewImageList, type DialogPreviewImageListProps } from '@flatbiz/antd/dialog-preview-image-list';
const props: DialogPreviewImageListProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dialog-preview-image-list/index.ts`
- `src/dialog-preview-image-list/preview-image.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dialog-preview-image-list` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### drag-collapse LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/drag-collapse` 的使用方式。
#### 模块定位
可拖拽 折叠面板
#### 导入方式
```ts
import { DragCollapse } from '@flatbiz/antd/drag-collapse';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DragCollapse` - 可拖拽 折叠面板
- `* from ./drag-collapse.jsx`
- `SortableItem`
- `DragCollapseItemKey`
- `DragCollapseItem`
- `DragCollapseProps`
#### 依赖的 antd 能力
`Collapse`、`CollapseProps`
#### Props / 配置要点
##### SortableItemProps
- `openKeys`(必填):: DragCollapseItemKey[]
- `style`(可选):: CSSProperties
- `item`(必填):: DragCollapseItem
- `collapsible`(可选):: DragCollapseProps['collapsible']
- `expandIcon`(可选):: DragCollapseProps['expandIcon']
- `expandIconPosition`(可选):: DragCollapseProps['expandIconPosition']
- `size`(可选):: DragCollapseProps['size']
- `dragIcon`(可选):: DragCollapseProps['dragIcon']
- `hideDragIcon`(可选):: DragCollapseProps['hideDragIcon']
- `onChange`(必填):: (activeKey: DragCollapseItemKey) => void
- `isGray`(可选):: boolean
- `className`(可选):: string
- `isLast`(可选):: boolean
##### DragCollapseItemKey
- 声明:`export type DragCollapseItemKey = number | string;`
##### DragCollapseItem
- `key`(必填):: DragCollapseItemKey
- `header`(必填):: ReactNode
- `content`(必填):: ReactElement
##### DragCollapseProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `items`(必填):: DragCollapseItem[];面板数据
- `onDropChange`(必填):: (items: DragCollapseItem[]) => void;拖拽面板回调
- `accordion`(可选):: boolean;手风琴模式,只允许单个内容区域展开
- `activeKey`(可选):: DragCollapseItemKey | DragCollapseItemKey[];当前激活 tab 面板的key
- `collapsible`(可选):: CollapseProps['collapsible'];所有子面板是否可折叠或指定可折叠触发区域,可选: header | icon | disabled
- `defaultActiveKey`(可选):: DragCollapseItemKey[];初始化选中面板的 key
- `expandIcon`(可选):: CollapseProps['expandIcon'];自定义切换图标
- `expandIconPosition`(可选):: CollapseProps['expandIconPosition'];设置图标位置,可选:start | end
- `size`(可选):: CollapseProps['size'];设置折叠面板大小
- `hideDragIcon`(可选):: boolean;隐藏拖拽图标,默认不隐藏
- `dragIcon`(可选):: ReactElement;设置拖拽图标
- `onChange`(可选):: (activeKey?: DragCollapseItemKey | DragCollapseItemKey[]) => void;切换面板的回调
#### 使用规则与行为
- 可拖拽 折叠面板 @param props @returns
- 面板数据
- 拖拽面板回调
- 手风琴模式,只允许单个内容区域展开
- 当前激活 tab 面板的key
- 所有子面板是否可折叠或指定可折叠触发区域,可选: header | icon | disabled
- 初始化选中面板的 key
- 自定义切换图标
- 设置图标位置,可选:start | end
- 设置折叠面板大小
#### 基础示例
```tsx
import { DragCollapse, type SortableItemProps } from '@flatbiz/antd/drag-collapse';
const props: SortableItemProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/drag-collapse/drag-collapse.tsx`
- `src/drag-collapse/index.ts`
- `src/drag-collapse/sortable-item.tsx`
- `src/drag-collapse/types.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/drag-collapse` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### drag-collapse-form-list LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/drag-collapse-form-list` 的使用方式。
#### 模块定位
可拖拽 折叠面板+FormList
#### 导入方式
```ts
import { DragCollapseFormList } from '@flatbiz/antd/drag-collapse-form-list';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DragCollapseFormList` - 可拖拽 折叠面板+FormList
- `* from ./drag-collapse.jsx`
- `SortableItem`
- `SortableItemProps`
- `DragCollapseFormListContentProps`
- `DragCollapseFormListHeaderProps`
- `DragCollapseFormListProps`
#### 依赖的 antd 能力
`Collapse`、`CollapseProps`、`Form`、`FormListFieldData`、`FormListOperation`
#### Props / 配置要点
##### SortableItemProps
- `formListFieldData`(必填):: FormListFieldData
- `formListOperate`(必填):: FormListOperation
- `onChange`(必填):: (activeKey: number | string) => void
- `header`(必填):: DragCollapseFormListProps['header']
- `content`(必填):: DragCollapseFormListProps['content']
- `collapsible`(可选):: DragCollapseFormListProps['collapsible']
- `expandIcon`(可选):: DragCollapseFormListProps['expandIcon']
- `expandIconPosition`(可选):: DragCollapseFormListProps['expandIconPosition']
- `size`(可选):: DragCollapseFormListProps['size']
- `dragIcon`(可选):: DragCollapseFormListProps['dragIcon']
- `getItemDragDisabled`(可选):: DragCollapseFormListProps['getItemDragDisabled']
- `dragDisabled`(可选):: DragCollapseFormListProps['dragDisabled']
- `isGray`(可选):: boolean
- `isLast`(可选):: boolean
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `uid`(必填):: string | number
- `isActive`(可选):: boolean
- `headerStyle`(可选):: CSSProperties
- `index`(必填):: number
- `isOverlay`(可选):: boolean
- `formStageCompleteName`(必填):: Array
##### DragCollapseFormListContentProps
- `formListFieldData`(必填):: FormListFieldData;Form.List item fieldData
- `formStageCompleteName`(必填):: Array;当前阶段 完整 formItem name
- `operation`(必填):: FormListOperation;Form.List 操作项
- `uid`(必填):: string | number
- `getInsideFormItemName`(必填):: (key: string | string[]) => Array;获取当前FormList 内部 Form.Item name
- `getInsideFormItemData`(必填):: () => TPlainObject;获取当前 FormList Item 数据
- `index`(必填):: number;索引
##### DragCollapseFormListHeaderProps
- 声明:`export type DragCollapseFormListHeaderProps = DragCollapseFormListContentProps;`
##### DragCollapseFormListProps
- `uidFieldName`(可选):: string;formList item 数据中的唯一值,默认值:uid
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `formListName`(必填):: string | number | (string | number)[];formList name
- `formListCompleteName`(可选):: (string | number)[];当前组件嵌套在formList内部时,必传 例如:
- `onDropChange`(可选):: (items: TPlainObject[]) => void;拖拽面板回调
- `accordion`(可选):: boolean;手风琴模式,只允许单个内容区域展开
- `activeKey`(可选):: number | string | (number | string)[];当前激活 tab 面板的key
- `collapsible`(可选):: CollapseProps['collapsible'];所有子面板是否可折叠或指定可折叠触发区域,可选: header | icon | disabled
- `defaultActiveKey`(可选):: number | string | (number | string)[];初始化选中面板的 key
- `expandIcon`(可选):: CollapseProps['expandIcon'];自定义切换图标
- `expandIconPosition`(可选):: CollapseProps['expandIconPosition'];设置图标位置,可选:start | end
- `size`(可选):: CollapseProps['size'];设置折叠面板大小
- `dragIcon`(可选):: ReactElement;设置拖拽图标
- `onChange`(可选):: (activeKey?: number | string | (number | string)[]) => void;切换面板的回调
- `dragDisabled`(可选):: boolean;禁用拖拽,拖拽图标隐藏
- `header`(必填):: (data: DragCollapseFormListHeaderProps) => ReactElement;折叠面板 header 渲染
- `content`(必填):: (data: DragCollapseFormListContentProps) => ReactElement;折叠面板 content 渲染
- `getItemDragDisabled`(可选):: (uid: string | number, index: number) => boolean;设置面板禁止拖拽
- `rules`(可选):: FormListProps['rules']
#### 使用规则与行为
- 可拖拽 折叠面板+FormList
- Form.List item fieldData
- 当前阶段 完整 formItem name
- Form.List 操作项
- 获取当前FormList 内部 Form.Item name
- 获取当前 FormList Item 数据
- 索引
- formList item 数据中的唯一值,默认值:uid
- formList name
- 当前组件嵌套在formList内部时,必传 例如:
#### 基础示例
```tsx
import { DragCollapseFormList, type SortableItemProps } from '@flatbiz/antd/drag-collapse-form-list';
const props: SortableItemProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/drag-collapse-form-list/drag-collapse.tsx`
- `src/drag-collapse-form-list/index.ts`
- `src/drag-collapse-form-list/sortable-item.tsx`
- `src/drag-collapse-form-list/types.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/drag-collapse-form-list` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### drag-editable-card LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/drag-editable-card` 的使用方式。
#### 模块定位
可拖拽编辑卡片
#### 导入方式
```ts
import { DragEditableCard } from '@flatbiz/antd/drag-editable-card';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DragEditableCard` - 可拖拽编辑卡片
- `DragEditableCardProps`
- `Handle`
- `Handle2`
- `* from ./editable-card.jsx`
#### 依赖的 antd 能力
`Form`、`FormListFieldData`、`FormListOperation`、`Space`
#### Props / 配置要点
##### DragEditableCardProps
- `dragIcon`(可选):: ReactElement;拖拽图标自定义,默认使用 DragOutlined 图标
- `disabledDrag`(可选):: boolean;禁用拖拽
- `uidFieldKey`(必填):: string;表格数据唯一值字段Key
- `onDragChange`(可选):: ( dataSource: TPlainObject[], dragData: { activeId: string | number; overId?: string | number; activeIndex: number; overIndex: number; } ) => void;拖拽结束事件
- `dragTriggerPosition`(可选):: 'left' | 'right';拖拽触发位置,默认在左侧
##### HandleProps
- `dragIcon`(可选):: ReactElement
- `rowId`(必填):: string
- `children`(必填):: ReactElement
- `extraData`(可选):: { operation: FormListOperation; fields: FormListFieldData[]; index: number; required?: boolean; }
- `dragTriggerPosition`(可选):: 'left' | 'right'
- `onCustomGroupName`(可选):: (index: number) => string | ReactElement
##### Handle2Props
- `children`(必填):: ReactElement
- `extraData`(可选):: { operation: FormListOperation; fields: FormListFieldData[]; index: number; required?: boolean; }
- `onCustomGroupName`(可选):: (index: number) => string | ReactElement
#### 使用规则与行为
- 拖拽图标自定义,默认使用 DragOutlined 图标
- 禁用拖拽
- 表格数据唯一值字段Key
- 拖拽结束事件
- 拖拽触发位置,默认在左侧
- 可拖拽编辑卡片
#### 基础示例
```tsx
import { DragEditableCard, type DragEditableCardProps } from '@flatbiz/antd/drag-editable-card';
const props: DragEditableCardProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/drag-editable-card/editable-card.tsx`
- `src/drag-editable-card/handle.tsx`
- `src/drag-editable-card/handle2.tsx`
- `src/drag-editable-card/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/drag-editable-card` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### drag-editable-table LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/drag-editable-table` 的使用方式。
#### 模块定位
可拖拽编辑表格 @deprecated 已过期,请使用 DragEditableTablePro组件
#### 导入方式
```ts
import { DragEditableTable } from '@flatbiz/antd/drag-editable-table';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DragEditableTable` - 可拖拽编辑表格 @deprecated 已过期,请使用 DragEditableTablePro组件
- `DragEditableTableProps`
- `* from ./drag.jsx`
- `Row`
- `TableTrHandle`
#### 依赖的 antd 能力
`Form`
#### Props / 配置要点
##### DragEditableTableProps
- `dragIcon`(可选):: ReactElement;拖拽图标自定义,默认使用 DragOutlined 图标
- `disabledDrag`(可选):: boolean;禁用拖拽
- `uidFieldKey`(必填):: string;表格数据唯一值字段Key
- `onDragChange`(可选):: ( dataSource: TPlainObject[], dragData: { activeId: string | number; overId?: string | number; activeIndex: number; overIndex: number; } ) => void;拖拽结束事件
##### TableTrHandleProps
- `dragIcon`(可选):: ReactElement
#### 使用规则与行为
- 拖拽图标自定义,默认使用 DragOutlined 图标
- 禁用拖拽
- 表格数据唯一值字段Key
- 拖拽结束事件
- 可拖拽编辑表格 @deprecated 已过期,请使用 DragEditableTablePro组件
#### 基础示例
```tsx
import { DragEditableTable, type DragEditableTableProps } from '@flatbiz/antd/drag-editable-table';
const props: DragEditableTableProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/drag-editable-table/context.ts`
- `src/drag-editable-table/drag.tsx`
- `src/drag-editable-table/index.ts`
- `src/drag-editable-table/row.tsx`
- `src/drag-editable-table/table-tr-handle.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/drag-editable-table` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### drag-editable-table-pro LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/drag-editable-table-pro` 的使用方式。
#### 模块定位
可拖拽编辑表格
#### 导入方式
```ts
import { DragEditableTablePro } from '@flatbiz/antd/drag-editable-table-pro';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DragEditableTablePro` - 可拖拽编辑表格
- `DragEditableTableProProps`
- `* from ./drag.jsx`
- `Row`
- `TableTrHandle`
#### 依赖的 antd 能力
`Form`
#### Props / 配置要点
##### DragEditableTableProProps
- `dragIcon`(可选):: ReactElement;拖拽图标自定义,默认使用 DragOutlined 图标
- `disabledDrag`(可选):: boolean;禁用拖拽
- `uidFieldKey`(必填):: string;表格数据唯一值字段Key
- `onDragChange`(可选):: ( dataSource: TPlainObject[], dragData: { activeId: string | number; overId?: string | number; activeIndex: number; overIndex: number; } ) => void;拖拽结束事件
- `dragRowFixed`(可选):: boolean;是否固定拖拽行
##### TableTrHandleProps
- `dragIcon`(可选):: ReactElement
#### 使用规则与行为
- 拖拽图标自定义,默认使用 DragOutlined 图标
- 禁用拖拽
- 表格数据唯一值字段Key
- 拖拽结束事件
- 是否固定拖拽行
- 可拖拽编辑表格
#### 基础示例
```tsx
import { DragEditableTablePro, type DragEditableTableProProps } from '@flatbiz/antd/drag-editable-table-pro';
const props: DragEditableTableProProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/drag-editable-table-pro/context.ts`
- `src/drag-editable-table-pro/drag.tsx`
- `src/drag-editable-table-pro/index.ts`
- `src/drag-editable-table-pro/row.tsx`
- `src/drag-editable-table-pro/table-tr-handle.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/drag-editable-table-pro` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### drag-form-list LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/drag-form-list` 的使用方式。
#### 模块定位
可拖拽FormList
#### 导入方式
```ts
import { DragFormList } from '@flatbiz/antd/drag-form-list';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DragFormList` - 可拖拽FormList
- `* from ./drag-form-list.jsx`
- `SortableItem`
- `SortableItemProps`
- `DragFormListContentProps`
- `DragFormListProps`
#### 依赖的 antd 能力
`Empty`、`Form`
#### Props / 配置要点
##### FormListChildrenWrapperProps
- `wrapper`(可选):: DragFormListProps['formListChildrenWrapper']
- `children`(必填):: ReactElement
##### SortableItemProps
- `formListFieldData`(必填):: FormListFieldData
- `formListOperate`(必填):: FormListOperation
- `dragIcon`(可选):: DragFormListProps['dragIcon']
- `getItemDragDisabled`(可选):: DragFormListProps['getItemDragDisabled']
- `dragDisabled`(可选):: DragFormListProps['dragDisabled']
- `isGray`(可选):: boolean
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `uid`(必填):: string | number
- `index`(必填):: number
- `isOverlay`(可选):: boolean
- `formStageCompleteName`(必填):: (string | number)[]
- `children`(必填):: (data: DragFormListContentProps) => ReactElement
- `prevCompleteName`(必填):: (string | number)[]
- `uidFieldName`(必填):: string
##### DragFormListContentProps
- `formListFieldData`(必填):: FormListFieldData;Form.List item fieldData
- `formStageCompleteName`(必填):: (string | number)[];当前阶段 完整 formItem name
- `prevCompleteName`(必填):: (string | number)[];formList上一级 formItem完整name
- `operation`(必填):: FormListOperation;Form.List 操作项
- `index`(必填):: number;索引
- `getInsideFormItemName`(必填):: (key: string | string[]) => Array;获取当前FormList 内部 Form.Item name
- `getInsideFormItemData`(必填):: () => TPlainObject;获取当前 FormList Item 数据
- `uidKey`(必填):: string;唯一值字段Key
##### DragFormListProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `itemStyle`(可选):: CSSProperties
- `uidFieldName`(可选):: string;formList item 数据中的唯一值,默认值:uid
- `name`(必填):: string | number | (string | number)[];formList name
- `prevCompleteName`(必填):: (string | number)[];formList上一级 formItem完整name
- `onDropChange`(可选):: (items: TPlainObject[]) => void;拖拽回调
- `dragIcon`(可选):: ReactElement;设置拖拽图标
- `dragDisabled`(可选):: boolean;禁用拖拽,拖拽图标隐藏
- `getItemDragDisabled`(可选):: (uid: string | number, index: number) => boolean;设置item禁止拖拽
- `getAddRowDefaultValues`(可选):: () => TPlainObject;新增行默认值,自定义onTableAfterRender后失效
- `hiddenAddRowButton`(可选):: boolean;隐藏新增行按钮
- `onCustomAddRowButton`(可选):: (operation: FormListOperation) => ReactElement;自定义新增行按钮,getAddRowDefaultValues配置失效
- `children`(必填):: (data: DragFormListContentProps) => ReactElement;formListItem 内容
- `hiddenEmptyRender`(可选):: boolean;隐藏数据为空渲染
- `formListChildrenWrapper`(可选):: (props: { children: ReactElement }) => ReactElement;formList内部渲染包装,多用于FormListWrapper嵌套布局
- `rules`(可选):: FormListProps['rules'];Form.List rules
- `formListItemTitleList`(可选):: { title: string; required?: boolean; width?: number; }[];设置FormList字段标题&必填标志
- `formListItemTitleHorizontalUnionProps`(可选):: Omit< FormItemHorizontalUnionProps, 'groupConfigList' >;formListItemTitle HorizontalUnionProps 配置
- `itemGap`(可选):: number;FormList Item 之间间隙,默认值:16
#### 使用规则与行为
- 可拖拽FormList
- 只能通过getFieldValue取值
- Form.List item fieldData
- 当前阶段 完整 formItem name
- formList上一级 formItem完整name
- Form.List 操作项
- 索引
- 获取当前FormList 内部 Form.Item name
- 获取当前 FormList Item 数据
- 唯一值字段Key
#### 默认值线索
- `gap => -15`
#### 基础示例
```tsx
import { DragFormList, type FormListChildrenWrapperProps } from '@flatbiz/antd/drag-form-list';
const props: FormListChildrenWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/drag-form-list/drag-form-list.tsx`
- `src/drag-form-list/index.ts`
- `src/drag-form-list/sortable-item.tsx`
- `src/drag-form-list/types.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/drag-form-list` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### drag-table LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/drag-table` 的使用方式。
#### 模块定位
可拖拽表格
#### 导入方式
```ts
import { DragTable } from '@flatbiz/antd/drag-table';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DragTable` - 可拖拽表格
- `* from ./drag-table.jsx`
- `Row`
- `TableTrHandle`
- `TableTr`
#### 依赖的 antd 能力
`Table`
#### Props / 配置要点
##### DragTableProps
- `dragIcon`(可选):: false | ReactElement
- `uidFieldKey`(必填):: string;表格数据唯一值字段Key,未填或者无法唯一,都不能拖拽能力
- `dataSource`(可选):: TPlainObject[]
- `disabledDrag`(可选):: boolean;禁用拖拽
- `onDragChange`(可选):: ( dataSource: TPlainObject[], dragData: { activeId: string | number; activeIndex: number; overIndex: number; } ) => void;拖拽结束事件
##### TableTrHandleProps
- `dragIcon`(可选):: false | ReactElement
#### 使用规则与行为
- 表格数据唯一值字段Key,未填或者无法唯一,都不能拖拽能力
- 禁用拖拽
- 拖拽结束事件
- 可拖拽表格
#### 基础示例
```tsx
import { DragTable, type DragTableProps } from '@flatbiz/antd/drag-table';
const props: DragTableProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/drag-table/context.ts`
- `src/drag-table/drag-table.tsx`
- `src/drag-table/index.ts`
- `src/drag-table/row.tsx`
- `src/drag-table/table-tr-handle.tsx`
- `src/drag-table/table-tr.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/drag-table` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dropdown-menu-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dropdown-menu-wrapper` 的使用方式。
#### 模块定位
DropdownMenuWrapper 升级 antd 5.5.1 后,Dropdown 中 Popconfirm弹框使用存在问题,所以在 @flatbiz/antd@4.2.49版本修改为使用dialogConfirm组件实现二次弹框确认功能
#### 导入方式
```ts
import { DropdownMenuWrapper } from '@flatbiz/antd/dropdown-menu-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `DropdownMenuWrapper` - DropdownMenuWrapper 升级 antd 5.5.1 后,Dropdown 中 Popconfirm弹框使用存在问题,所以在 @flatbiz/antd@4.2.49版本修改为使用dialogConfirm组件实现二次弹框确认功能
- `DropdownMenuItem`
- `DropdownMenuWrapperProps`
- `* from ./dropdown-menu-wrapper.jsx`
- `parentsHasSticky`
#### 依赖的 antd 能力
`ButtonProps`、`Dropdown`、`DropdownProps`
#### Props / 配置要点
##### DropdownMenuItem
- `text`(可选):: string | ReactElement
- `color`(可选):: string
- `onClick`(可选):: (event: React.MouseEvent) => void | Promise
- `permission`(可选):: string
- `needConfirm`(可选):: boolean
- `confirmMessage`(可选):: ReactNode
- `hidden`(可选):: boolean
- `confirmModalProps`(可选):: DialogModalProps
- `stopPropagation`(可选):: boolean
##### DropdownMenuWrapperProps
- `menuList`(必填):: Array
- `isFixed`(可选):: boolean;dropdown 设置弹框根节点在body下
#### 使用规则与行为
- dropdown 设置弹框根节点在body下
- DropdownMenuWrapper 升级 antd 5.5.1 后,Dropdown 中 Popconfirm弹框使用存在问题,所以在 @flatbiz/antd@4.2.49版本修改为使用dialogConfirm组件实现二次弹框确认功能 @param props @returns
#### 基础示例
```tsx
import { DropdownMenuWrapper, type DropdownMenuWrapperProps } from '@flatbiz/antd/dropdown-menu-wrapper';
const props: DropdownMenuWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dropdown-menu-wrapper/dropdown-menu-wrapper.tsx`
- `src/dropdown-menu-wrapper/index.ts`
- `src/dropdown-menu-wrapper/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dropdown-menu-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### dynamic-node LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/dynamic-node` 的使用方式。
#### 模块定位
动态添加 element 元素
#### 导入方式
```ts
import { dynamicNode } from '@flatbiz/antd/dynamic-node';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `dynamicNode` - 动态添加 element 元素
- `TDynamicNodeProps`
- `* from ./dynamic-node.jsx`
#### Props / 配置要点
##### TDynamicNodeProps
- `className`(可选):: string
- `getContainer`(可选):: HTMLElement | (() => HTMLElement) | string
- `content`(可选):: ReactElement
- `fixed`(可选):: boolean
- `style`(可选):: CSSProperties
#### 使用规则与行为
- 动态添加 element 元素
#### 基础示例
```tsx
import { dynamicNode, type TDynamicNodeProps } from '@flatbiz/antd/dynamic-node';
const props: TDynamicNodeProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/dynamic-node/dynamic-node.tsx`
- `src/dynamic-node/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/dynamic-node` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### easy-form LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/easy-form` 的使用方式。
#### 模块定位
简单Form布局,可自定义网格布局
#### 导入方式
```ts
import { EasyForm } from '@flatbiz/antd/easy-form';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `EasyForm` - 简单Form布局,可自定义网格布局
- `EasyFormProps`
- `* from ./form.jsx`
#### 依赖的 antd 能力
`Form`
#### Props / 配置要点
##### EasyFormProps
- `forceColumn`(可选):: 1 | 2 | 3 | 4;强制定义一行显示几列,不考虑响应式
- `width`(可选):: number | string;Form显示宽度,可数值、可百分比;在小屏幕尺寸(xs、sm)上无效
- `gridGutter`(可选):: BoxRowProps['gutter'];网格间距
- `children`(必填):: ReactNode
- `isPure`(可选):: boolean;是否为纯净模式,对EasyForm的子节点不做任何包装处理
- `span`(可选):: number;栅格占位格数,最大值:24
#### 使用规则与行为
- 定义一行显示几列(当外层宽度尺寸大于 992px(lg) 时,一行显示几列), 默认值:3
- 强制定义一行显示几列,不考虑响应式
- Form显示宽度,可数值、可百分比;在小屏幕尺寸(xs、sm)上无效
- 网格间距
- 是否为纯净模式,对EasyForm的子节点不做任何包装处理
- 栅格占位格数,最大值:24
- 简单Form布局,可自定义网格布局
- 小屏幕不控制宽度
#### 默认值线索
- `gridGutter => ([15, 0] as GutterParams)`
#### 基础示例
```tsx
import { EasyForm, type EasyFormProps } from '@flatbiz/antd/easy-form';
const props: EasyFormProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/easy-form/form.tsx`
- `src/easy-form/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/easy-form` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### easy-table LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/easy-table` 的使用方式。
#### 模块定位
对 查询条件+表格数据 进行深度封装,内置数据交互处理
#### 导入方式
```ts
import { EasyTable } from '@flatbiz/antd/easy-table';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `filterCache`
- `firstQueryCache`
- `columnFoldCache`
- `EasyTableContext`
- `EditableFieldContextContextApi`
- `EasyTable`
- `EasyTableFilter` - 过滤条件
- `EasyTableFilterProps`
- `FoldOperateDropdown`
- `FoldOperate`
- `useColumnsAppendTips`
- `useColumnsAppendInnerColumn`
- `useColumnsToHidden`
- `useColumnByAsyncColumnRequest`
- `useEasyTable` - 在 EasyTable子组件内才可使用
- `EasyTableTable` - 表格渲染
- `EasyTableTableProps`
- `TEasyTableTableColumn`
- `EasyTableServiceConfig`
- `EasyTableProps`
- `EasyTableRefApi`
- `getFormFieldsValue`
- `requestParamsInternalAdapter` - 请求参数内部转换处理
#### 依赖的 antd 能力
`Badge`、`Checkbox`、`Drawer`、`Empty`、`Form`、`FormInstance`、`message`、`Popover`、`Space`、`Table`
#### Props / 配置要点
##### EditableFieldContextContextApi
- `cacheKey`(必填):: string
- `onRequest`(可选):: (params?: TPlainObject) => void
- `tableDataSource`(可选):: TPlainObject[]
- `tableTotal`(必填):: number
- `loading`(可选):: boolean
- `fieldNames`(必填):: TPlainObject
- `pageSize`(必填):: number
- `initialValues`(可选):: TPlainObject
- `onSetPaginationStatus`(必填):: (status: boolean) => void
- `getPaginationStatus`(必填):: () => boolean
- `onFormFinish`(可选):: (values?: TPlainObject) => void
- `form`(必填):: FormInstance
- `getEasyTableRef`(必填):: () => EasyTableRefApi
- `paginationFixed`(必填):: boolean
- `foldKeys`(必填):: string[]
- `onSetBaseColumns`(可选):: ( baseColumns?: TEasyTableTableColumn[] ) => void
- `onSetColumns`(可选):: (columns?: TEasyTableTableColumn[]) => void
- `columns`(可选):: TEasyTableTableColumn[]
- `dynamicColumnsConfig`(可选):: { showFoldKeyList: string[]; onChangeShowFoldKeyList: (keys: string[]) => void; columnFoldOpen: boolean; columnFoldConfig?: EasyTableProps['columnFoldConfig'…
- `filterFormItemKeys`(可选):: string[]
- `showCancelInitRequestTips`(可选):: boolean
##### EasyTableFilterProps
- `children`(必填):: | ReactElement | ReactElement[] | ((form: FormInstance) => ReactElement)
- `filterOperate`(可选):: (form: FormInstance) => FormOperateColProps;isPure = true时无效
- `isPure`(可选):: boolean;是否为纯净模式(查询条件布局是否自定义),
- `queryButtonProps`(可选):: Omit & { text?: string };查询按钮配置
- `resetButtonProps`(可选):: Omit & { text?: string };重置按钮配置
- `formClassName`(可选):: string;@deprecated已过期,使用 easyFormProps.className 配置
- `formStyle`(可选):: CSSProperties;@deprecated已过期,使用 easyFormProps.style 配置
- `filterWrapperStyle`(可选):: CSSProperties;filter Form 外层 BlockLayout style
- `filterWrapperClassName`(可选):: string;filter Form 外层 BlockLayout className
- `rightOperateAreaAppendType`(可选):: 'cover' | 'beforeAppend' | 'afterAppend';自定义 filterOperate.rightList 后 默认【查询、重置】按钮处理逻辑 1. cover:覆盖内部查询重置按钮(默认值) 2. beforeAppend:添加到【查询重置】按钮前面 3. afterAppend:添加到【查询重置】按钮后面 如果想隐藏【查询、重置】按钮中的某一个,可设置 queryButtonProps.hidden、resetButtonProps.hidden
- `defaultResetButtonTriggerRequest`(可选):: boolean;默认重启按钮触发请求,默认值:true
- `easyFormProps`(可选):: Omit< EasyFormProps, 'isPure' | 'column' | 'forceColumn' | 'width' | 'gridGutter' | 'children' >
##### FoldOperateProps
- `style`(可选):: CSSProperties
- `dataList`(必填):: { dataIndex: string; title: string }[]
- `onChange`(必填):: (keys: string[]) => void
- `cacheKey`(可选):: string
- `initSelectedRowKeys`(可选):: string[]
- `children`(可选):: ReactElement
##### FoldOperateProps
- `style`(可选):: CSSProperties
- `dataList`(可选):: { dataIndex?: string; title: string }[]
- `onChange`(必填):: (keys: string[]) => void
- `open`(可选):: boolean
- `onClose`(可选):: () => void
- `cacheKey`(可选):: string
- `initSelectedRowKeys`(可选):: string[]
##### EasyTableTableProps
- `children`(可选):: ReactElement | ReactElement[]
- `rowKey`(必填):: TableProps['rowKey'];表格行 key 的取值,
- `tableWrapperStyle`(可选):: CSSProperties;table Form 外层 SimpleLayout className
- `tableWrapperClassName`(可选):: string;table Form 外层 SimpleLayout className
- `columns`(必填):: TEasyTableTableColumn[]
- `isSync`(可选):: boolean;数据加载与表格初始化渲染 是否同步 @version 4.4.6
- `emptyShowSize`(可选):: 'small' | 'large';空效果显示尺寸,默认值:small @version 4.4.6
- `title`(可选):: ReactNode;标题
- `actions`(可选):: ReactElement[];与标题对齐的动作
- `tableButtomExtraContent`(可选):: ReactElement;表格底部额外内容
##### TEasyTableTableColumn
- `dataIndex`(可选):: keyof T | (string & {})
- `tipsWrapperProps`(可选):: string | TipsWrapperProps;会在 title 之后展示一个 icon
- `hidden`(可选):: boolean;是否隐藏
- `isFold`(可选):: boolean;是否折叠在更多中
- `asyncRender`(可选):: ( value: TAny, record: T, index: number, respData?: TAny ) => ReactNode;异步数据渲染,与asyncColumnRequest配合使用
- `defaultValue`(可选):: string;设置默认值,当数据为【undefined、null、''】时显示;自定义render后失效
##### EasyTableServiceConfig
- `onRequest`(可选):: (params?: TPlainObject) => Promise;接口配置
- `requestParamsAdapter`(可选):: ( params: TPlainObject, originalParams: TPlainObject ) => TPlainObject;请求参数处理
- `requestResultAdapter`(可选):: (params: TAny) => TPlainObject;接口相应数据处理
- `dynamicColumsAdapter`(可选):: ( respData?: TAny, columns?: TEasyTableTableColumn[] ) => TEasyTableTableColumn[] | undefined;动态列自定义渲染
##### EasyTableProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `children`(可选):: | ReactElement | ReactElement[] | ((dataSource?: TAny) => ReactElement)
- `modelKey`(可选):: string;EasyTable唯一值,可用于缓存查询条件 @deprecated 已过时,如果需要缓存数据请设置 cacheKey 参数
- `cacheKey`(可选):: string;缓存key
- `serviceConfig`(必填):: EasyTableServiceConfig;接口数据配置
- `initialValues`(可选):: TPlainObject;1. 查询条件Form initialValues 2. 接口其他参数,例如常量类型
- `pageSize`(可选):: number;分页单页条数,默认值:10
- `fieldNames`(可选):: { list?: string; total?: string; pageNo?: string; pageSize?: string; };字段映射,默认值:{ list:'list', total:'total', pageNo:'pageNo', pageSize:'pageSize' }
- `initRequest`(可选):: boolean;初始化是否请求,默认值:true;必须配合 cacheKey 一起使用 @deprecated 已过时,请使用 cancelInitAutoRequest、alwaysCancelInitAutoRequest 参数
- `cancelInitAutoRequest`(可选):: boolean | (() => boolean);取消初始化自动请求
- `alwaysCancelInitAutoRequest`(可选):: boolean | (() => boolean);永久关闭任何初始请求,任何情况下都不会自动发起初始请求。
- `onDataSourceChange`(可选):: (dataSource: TAny) => void;表格数据变更回调
- `onFormFinish`(可选):: (values?: TPlainObject) => void;如果自定义查询按钮,可设置 Form onFinish
- `isFull`(可选):: boolean;在父节点高度下,上下铺满;默认值:true
- `paginationFixed`(可选):: boolean;分页区域固定,不随滚动条滚动
- `pagination`(可选):: PaginationProps;1. 配合paginationFixed=true一起使用有效果 2. 当使用Table内的pagination时,在EasyTable.Table中配置分页属性
- `foldKeys`(可选):: string[];查询条件展开、收起,被收起key数组;数组内容为EasyTable.Filter 子节点key值
- `onRequestErrorHandle`(可选):: (error) => void;自定义处理服务异常
- `isInline`(可选):: boolean;是否inline模式
- `form`(可选):: FormInstance;Form 实例
- `columnFoldConfig`(可选):: { initSelectedKeys?: string[]; hidden?: boolean; icon?: ReactElement; text?: string; hoverTipText?: string; onChange?: (keys: string[]) => void; triggerType?…;字段折叠配置
- `asyncColumnRequest`(可选):: { dataIndex: string; onRequest: () => Promise; }[];配置表格列中需要异步请求数据
- `breforeRequest`(可选):: (form: FormInstance) => Promise;调用接口前自定义判断,返回Promise.resolve才能发起查询操作
- `filterFormItemKeys`(可选):: string[];指定查询条件验证的formItemKeys,设置后条件回车查询事件失效
- `removeRequestParamsEmptyValue`(可选):: boolean;移除请求参数中值为空字符串、null、undefined 的key值,默认值:true
- `fixedFooterExtraContent`(可选):: { top?: ReactElement; bottom?: ReactElement; };固定底部额外内容,当 paginationFixed=true 时有效,与分页水平对齐
#### 使用规则与行为
- 不要添加默认值
- 缓存的优先级高于 initialValues
- isPure = true时无效
- 是否为纯净模式(查询条件布局是否自定义),
- 查询按钮配置
- 重置按钮配置
- 网格布局设置 default = { xs: 24, sm: 12, md: 12, lg: 8, xl: 8, xxl: 6 }; small = { xs: 24, sm: 8, md: 8, lg: 6, xl: 6, xxl: 6 };
- filter Form 外层 BlockLayout style
- filter Form 外层 BlockLayout className
- 默认重启按钮触发请求,默认值:true
#### 默认值线索
- `removeRequestParamsEmptyValue => true`
#### 基础示例
```tsx
import { EasyTable, type EasyTableFilterProps } from '@flatbiz/antd/easy-table';
const props: EasyTableFilterProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/easy-table/cache.ts`
- `src/easy-table/context.ts`
- `src/easy-table/easy-table.tsx`
- `src/easy-table/filter.tsx`
- `src/easy-table/fold-operate-dropdown.tsx`
- `src/easy-table/fold-operate.tsx`
- `src/easy-table/hooks/columns.tsx`
- `src/easy-table/hooks.ts`
- `src/easy-table/index.ts`
- `src/easy-table/table.tsx`
- `src/easy-table/type.ts`
- `src/easy-table/utils.test.ts`
- `src/easy-table/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/easy-table` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### editable-card LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/editable-card` 的使用方式。
#### 模块定位
使用FormList实现可编辑卡片
#### 导入方式
```ts
import { EditableCard } from '@flatbiz/antd/editable-card';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `EditableCard` - 使用FormList实现可编辑卡片
- `* from ./editable-card.jsx`
- `EditableCardDataIndex`
- `EditableCardOperation`
- `EditableCardColumnItem` - 卡片内字段配置
- `EditableCardProps`
#### 依赖的 antd 能力
`ConfigProvider`、`Empty`、`Form`、`FormListFieldData`、`FormListOperation`
#### Props / 配置要点
##### EditableCardDataIndex
- 声明:`export type EditableCardDataIndex = string | string[];`
##### EditableCardColumnItem
卡片内字段配置
- `dataIndex`(必填):: EditableCardDataIndex | undefined;字段key值
- `editable`(必填):: | boolean | (( operation: Pick, index: number ) => boolean);是否可编辑
- `gridNumber`(可选):: number;布局占用网格数目(最大数值24)
- `title`(可选):: ReactElement | string;标题
- `formItemProps`(可选):: | Omit | (( operation: EditableCardOperation ) => Omit);Form.Item props
- `render`(可选):: (operation: EditableCardOperation) => ReactElement;通过 operation.editable 来判断渲染结构,其中render返回的根节点会作为 Form.Item 的children
- `tips`(可选):: string;会在 title 之后展示一个 icon
- `required`(可选):: boolean;为表格header中的字段添加必填标识,如果未配置 formItemProps.rules,内部会新增一条required rule
- `hidden`(可选):: (operation: EditableCardOperation, index: number) => boolean;隐藏域设置
- `remove`(可选):: (operation: EditableCardOperation, index: number) => boolean;移除设置,优先级高于 hidden
- `formItemContainer`(可选):: (formItem: ReactElement) => ReactElement | null
##### EditableCardProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `columns`(必填):: EditableCardColumnItem[];卡片内字段配置
- `formListCompleteName`(可选):: Array;当前Edittable处在formList内部时(必填),完整formItem的name
- `formListName`(必填):: Array | string;Form.List name
- `initialValue`(可选):: TPlainObject[];初始化值
- `rules`(可选):: FormListProps['rules'];Form.List rules
- `addRowDefaultValues`(可选):: () => TPlainObject;默认新增按钮新增行默认值,hiddenFooterBtn != true 有效
- `addRowBtnName`(可选):: ReactNode;自定义新增按钮名称
- `hiddenFooterBtn`(可选):: boolean;隐藏底部新增按钮
- `hiddenDeleteBtn`(可选):: boolean;隐藏默认删除按钮
- `contentBeforeRender`(可选):: ( formListOperation: FormListOperation, nextRowIndex: number ) => ReactElement | null;顶部区域渲染
- `contentAfterRender`(可选):: ( formListOperation: FormListOperation, nextRowIndex: number ) => ReactElement | null;底部区域渲染
- `onCustomGroupName`(可选):: (index: number) => string | ReactElement;设置默认卡片名称,设置 onCustomWrapper 后失效
- `onCustomWrapper`(可选):: ( children: ReactElement, extraData: { operation: FormListOperation; fields: FormListFieldData[]; fieldItem: FormListFieldData; index: number; required?: boo…;自定义卡片包裹,同时可自定义删除按钮、新增按钮
- `required`(可选):: boolean;设置必填,但只有一条数据时,隐藏默认删除按钮
- `cardClassName`(可选):: string;默认卡片样式
- `cardStyle`(可选):: CSSProperties;默认卡片样式
- `cardEasyFormProps`(可选):: Omit< EasyFormProps, 'nonuseFormWrapper' | 'isPure' | 'children' >;每个卡片内容都使用了 EasyForm 包裹,此处可设置 EasyFormProps
- `boxGridColSpan`(可选):: number;定义卡片网格水平跨度,最大值:24,默认值:24;设置 onCustomWrapper 后失效
- `cardExtraRender`(可选):: (extraData: { operation: FormListOperation; fields: FormListFieldData[]; fieldItem: FormListFieldData; index: number; required?: boolean; key: string; }) => …;默认卡片右侧布局,设置 onCustomWrapper 后失效
#### 使用规则与行为
- 使用FormList实现可编辑卡片
- 同一级内移动
- 是否可编辑
- 设置当前卡片指定字段值
- 获取当前卡片表单数据
- 当前卡片表单 name
- 当前卡片表单完整 name
- 当前卡片表单验证,需要自行指定nameList(dataIndex数组)
- 卡片内字段配置
- 字段key值
#### 基础示例
```tsx
import { EditableCard, type EditableCardProps } from '@flatbiz/antd/editable-card';
const props: EditableCardProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/editable-card/editable-card.tsx`
- `src/editable-card/index.ts`
- `src/editable-card/type.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/editable-card` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### editable-field LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/editable-field` 的使用方式。
#### 模块定位
可编辑字段组件
#### 导入方式
```ts
import { EditableField } from '@flatbiz/antd/editable-field';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `EditableField` - 可编辑字段组件
- `EditableFieldProps`
- `* from ./editable-field.jsx`
#### 依赖的 antd 能力
`Space`
#### Props / 配置要点
##### EditableFieldProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `editRender`(可选):: | ReactElement | ((data: { value?: TAny; onChange?: (data?: TAny) => void; }) => ReactElement)
- `viewRender`(可选):: (value?: TAny) => ReactNode
- `value`(可选):: TAny
- `onChange`(可选):: (data?: TAny) => void
- `placeholderValue`(可选):: string
- `isEditFull`(可选):: boolean;edit 区域是否铺满,showEditableIcon=false 无效
- `readonly`(可选):: boolean;只读状态
- `showEditable`(可选):: boolean;显示为编辑状态
- `showEditableIcon`(可选):: boolean;是否显示编辑、确认、取消操作icon,默认值:true
- `onClickEditIconPre`(可选):: (value?: TAny) => Promise;点击编辑按钮,操作前,返回reject不会开启编辑效果
- `onEditCallback`(可选):: (value?: TAny) => void
- `onClickConfirmIconPre`(可选):: (value?: TAny, preValue?: TAny) => Promise;点击确定按钮,操作前,返回reject不会执行确定功能
- `onConfirmCallback`(可选):: (value?: TAny, preValue?: TAny) => void
- `iconConfig`(可选):: { editIcon?: (options: { onClick: () => void }) => ReactElement; confirmIcon?: (options: { onClick: () => void }) => ReactElement; cancelIcon?: (options: { o…;组件操作Icon配置
#### 使用规则与行为
- edit 区域是否铺满,showEditableIcon=false 无效
- 只读状态
- 显示为编辑状态
- 是否显示编辑、确认、取消操作icon,默认值:true
- 点击编辑按钮,操作前,返回reject不会开启编辑效果
- 点击确定按钮,操作前,返回reject不会执行确定功能
- 组件操作Icon配置
- 可编辑字段组件 @param props @returns
- 为了处理 Input、TextArea等onChange取值
#### 默认值线索
- `showEditableIcon => true`
- `showEditableIcon => ctx.showEditableIcon`
- `readonly => ctx.readonly`
- `showEditable => ctx.showEditable`
#### 基础示例
```tsx
import { EditableField, type EditableFieldProps } from '@flatbiz/antd/editable-field';
const props: EditableFieldProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/editable-field/editable-field.tsx`
- `src/editable-field/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/editable-field` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### editable-field-provider LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/editable-field-provider` 的使用方式。
#### 模块定位
EditableFieldProvider 控制内部使有的 EditableField 状态
#### 导入方式
```ts
import { EditableFieldProvider } from '@flatbiz/antd/editable-field-provider';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `EditableFieldContext`
- `EditableFieldContextContextApi`
- `EditableFieldProvider` - EditableFieldProvider 控制内部使有的 EditableField 状态
- `EditableFieldProviderProps`
- `* from ./editable-field-provider.jsx`
#### Props / 配置要点
##### EditableFieldContextContextApi
- `readonly`(可选):: boolean
- `showEditable`(可选):: boolean
- `showEditableIcon`(可选):: boolean
- `isCtx`(必填):: boolean
##### EditableFieldProviderProps
- `children`(必填):: ReactElement
- `readonly`(可选):: boolean;是否只读
- `showEditable`(可选):: boolean;是否编辑状态
- `showEditableIcon`(可选):: boolean;是否显示编辑操作按钮
#### 使用规则与行为
- 是否只读
- 是否编辑状态
- 是否显示编辑操作按钮
- EditableFieldProvider 控制内部使有的 EditableField 状态 @param props @returns
#### 默认值线索
- `props => true`
#### 基础示例
```tsx
import { EditableFieldProvider, type EditableFieldProviderProps } from '@flatbiz/antd/editable-field-provider';
const props: EditableFieldProviderProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/editable-field-provider/context.ts`
- `src/editable-field-provider/editable-field-provider.tsx`
- `src/editable-field-provider/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/editable-field-provider` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### editable-table LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/editable-table` 的使用方式。
#### 模块定位
可编辑表格(通过FormList实现) @deprecated 已过期,请使用 EditableTablePro 组件 demo:https://fex.qa.tcshuke.com/docs/admin/main/table/row-editable1
#### 导入方式
```ts
import { EditableTable } from '@flatbiz/antd/editable-table';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `EditableTable` - 可编辑表格(通过FormList实现) @deprecated 已过期,请使用 EditableTablePro 组件 demo:https://fex.qa.tcshuke.com/docs/admin/main/table/row-editable1
- `EditableTableColumn` - antd 默认render功能此处不能使用
- `EditableTableProps`
- `CheckboxGroupFormItem`
- `DatePickerWrapperFormItem`
- `DateRangePickerWrapperFormItem`
- `FormItemAdapter`
- `FormItemAdapterProps`
- `InputNumberFormItem`
- `InputFormItem`
- `RadioGroupFormItem`
- `SelectorWrapperFormItem`
- `SwitchWrapperFormItem`
- `TextFormItem`
- `TextAreaFormItem`
- `UploadWrapperFormItem`
- `FormList`
- `FormListProps`
- `FormListItem`
- `FormListItemProps`
- `* from ./editable-table.jsx`
- `EditableTableName`
- `EditableTableRecordType`
- `EditableInputConfig`
- `EditableInputNumberConfig`
- `EditableSelectWrapperConfig`
- `EditableDatePickerWrapperConfig`
- `EditableDateRangePickerWrapperConfig`
- `EditableCheckboxGroupConfig`
- `EditableRadioGroupConfig`
- `EditableTextareaConfig`
- `EditableFileUploadConfig`
- `EditableSwitchWrapperConfig`
- `EditableCustomConfig` - 自定义编辑组件
- `EditableTypeConfig`
- `FieldSingleConfig`
- `FormListItemMethodOperateProps`
- `FormListMethodOperateProps`
- `FormListConfig`
- `EditableFormItemProps`
- `getEditable`
#### 依赖的 antd 能力
`Button`、`Checkbox`、`Form`、`FormItemProps`、`FormListFieldData`、`FormListOperation`、`InputNumber`、`InputNumberProps`、`InputProps`、`message`、`Radio`、`RadioGroupProps`、`Space`、`Table`、`TableProps`、`Tag`
#### Props / 配置要点
##### fieldConfigFunctionParams
- `tableRowIndex`(必填):: number
- `name`(必填):: EditableTableName
- `tableRowName`(必填):: EditableTableName
- `getTableRowData`(必填):: () => TPlainObject
##### EditableTableColumn
antd 默认render功能此处不能使用
- `tipsWrapperProps`(可选):: string | TipsWrapperProps;会在 title 之后展示一个 icon
- `dataIndex`(可选):: string
- `fieldConfig`(可选):: | FieldSingleConfig | FormListConfig | ((data: fieldConfigFunctionParams) => FieldSingleConfig | FormListConfig)
- `hiddenField`(可选):: | { dataIndex: string; } | { dataIndex: string; }[];隐藏域字段
- `renderMiddleware`(可选):: (item: { tableRowIndex: number; name: EditableTableName; tableRowName: EditableTableName; operation: FormListOperation; index: number; getTableRowData: () =>…;渲染中间件,如果renderMiddleware返回值为ReactElement格式,则会终止后续逻辑,fieldConfig配置将失效
- `tableChildrenColumnRender`(可选):: ( value: TAny, record: TPlainObject, index: number ) => ReactElement | null;table datasource children column 自定义渲染
- `required`(可选):: boolean;为表格header中的字段添加必填标识,无验证拦截功能
##### EditableTableProps
- `name`(必填):: EditableTableName;FormList name属性
- `completeName`(可选):: Array;当前Edittable处在formList内部时(必填),完整formItem的name
- `uidFieldKey`(必填):: string;表格行数据,唯一值字段Key
- `tableProps`(可选):: Omit< TableProps, 'dataSource' | 'columns' | 'rowKey' > & { cellVerticalAlign?: 'baseline' | 'middle' | 'top' | 'bottom'; }
- `columns`(必填):: EditableTableColumn[]
- `onTableBeforeRender`(可选):: ( formListOperation: FormListOperation, nextRowIndex: number ) => ReactElement | null
- `onTableAfterRender`(可选):: ( formListOperation: FormListOperation, nextRowIndex: number ) => ReactElement | null;设置后,将覆盖底部新增按钮
- `getAddRowDefaultValues`(可选):: () => TPlainObject;新增行默认值,自定义onTableAfterRender后失效
- `hiddenFooterBtn`(可选):: boolean;隐藏底部新增按钮,设置 onTableAfterRender后 失效
- `rules`(可选):: FormListProps['rules'];Form.List rules
- `emptyShowSize`(可选):: 'small' | 'large';空效果显示尺寸,默认值:small
- `className`(可选):: string
- `style`(可选):: CSSProperties
##### CheckboxGroupFormItemContent
- `value`(可选):: Array
- `onChange`(可选):: (value: TAny) => void
##### FormItemContentProps
- `value`(可选):: [string, string]
- `onChange`(可选):: (value?: [string, string]) => void
##### FormItemAdapterProps
- `name`(必填):: Array
- `completeName`(必填):: Array
- `fieldConfig`(必填):: FieldSingleConfig
- `tableRowIndex`(必填):: number
##### RadioGroupFormItemContent
- `value`(可选):: string | number
- `onChange`(可选):: (value: string | number) => void
##### FormItemContentProps
- `value`(可选):: string | number | Array
- `onChange`(可选):: (value: TAny) => void
#### 使用规则与行为
- antd 默认render功能此处不能使用
- 会在 title 之后展示一个 icon
- 隐藏域字段
- 渲染中间件,如果renderMiddleware返回值为ReactElement格式,则会终止后续逻辑,fieldConfig配置将失效
- table datasource children column 自定义渲染
- 为表格header中的字段添加必填标识,无验证拦截功能
- FormList name属性
- 当前Edittable处在formList内部时(必填),完整formItem的name
- 表格行数据,唯一值字段Key
- 设置后,将覆盖底部新增按钮
#### 基础示例
```tsx
import { EditableTable, type EditableTableProps } from '@flatbiz/antd/editable-table';
const props: EditableTableProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/editable-table/editable-table.tsx`
- `src/editable-table/form-item/checkbox-group.tsx`
- `src/editable-table/form-item/date-picker-wrapper.tsx`
- `src/editable-table/form-item/date-range-picker-wrapper.tsx`
- `src/editable-table/form-item/index.tsx`
- `src/editable-table/form-item/input-number.tsx`
- `src/editable-table/form-item/input.tsx`
- `src/editable-table/form-item/radio-group.tsx`
- `src/editable-table/form-item/selector-wrapper.tsx`
- `src/editable-table/form-item/switch-wrapper.tsx`
- `src/editable-table/form-item/text.tsx`
- `src/editable-table/form-item/textarea.tsx`
- `src/editable-table/form-item/upload-wrapper.tsx`
- `src/editable-table/form-list-item/form-list.tsx`
- `src/editable-table/form-list-item/index.tsx`
- `src/editable-table/index.ts`
- `src/editable-table/type.ts`
- `src/editable-table/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/editable-table` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### editable-table-pro LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/editable-table-pro` 的使用方式。
#### 模块定位
使用FormList实现可编辑表格
#### 导入方式
```ts
import { EditableTablePro } from '@flatbiz/antd/editable-table-pro';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `EditableTablePro` - 使用FormList实现可编辑表格
- `EditableTableProProps`
- `* from ./editable-table-pro.jsx`
- `EditableTableProDataIndex`
- `EditableTableProOperation`
- `EditableTableProColumnItem`
- `EditableTableProColumnItem2`
- `EditableTableProColumnItem1`
#### 依赖的 antd 能力
`Form`、`message`、`Space`、`Table`
#### Props / 配置要点
##### dataSourceRelativeItem
- `level`(必填):: number
- `parentUid`(可选):: string | number
- `index`(必填):: number
##### EditableTableProProps
- `columns`(必填):: EditableTableProColumnItem[];当存在表头分组时,columns 类型为 Array
- `formListCompleteName`(可选):: Array;当前Edittable处在formList内部时(必填),完整formItem的name
- `formListName`(必填):: Array | string;Form.List name
- `uidFieldKey`(必填):: string;唯一值字段Key
- `initialValue`(可选):: TPlainObject[];初始化值
- `childrenColumnName`(可选):: string;指定树形结构的列名,默认值:children
- `tableProps`(可选):: Omit< TableProps, 'dataSource' | 'columns' | 'rowKey' > & { // 如果重写了columns.onCell,则此配置失效 cellVerticalAlign?: 'baseline' | 'middle' | 'top' | '…;表格组件配置
- `rules`(可选):: FormListProps['rules'];Form.List rules
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `addRowDefaultValues`(可选):: () => TPlainObject;默认新增按钮新增行默认值,hiddenFooterBtn != true 有效
- `hiddenFooterBtn`(可选):: boolean;隐藏底部新增按钮
- `disabledFooterBtn`(可选):: boolean;禁用底部新增按钮
- `tableBeforeAreaRender`(可选):: ( formListOperation: FormListOperation, nextRowIndex: number ) => ReactElement | null;表格顶部区域渲染
- `tableAfterAreaRender`(可选):: ( formListOperation: FormListOperation, nextRowIndex: number ) => ReactElement | null;表格底部区域渲染
- `expandedRowKeys`(可选):: string[];展开的行key,一般用于初始化,重新tableProps.expandable.expandedRowKeys后失效
- `expandedIconLayout`(可选):: 'layout1' | 'layout2';展开图标布局,默认:layout1
##### EditableTableProDataIndex
- 声明:`export type EditableTableProDataIndex = string | readonly (string | number)[];`
##### EditableTableProColumnItem
- 声明:`export type EditableTableProColumnItem =`
##### EditableTableProColumnItem2
- `children`(可选):: EditableTableProColumnItem[]
##### EditableTableProColumnItem1
- `title`(可选):: ReactElement | string
- `dataIndex`(可选):: EditableTableProDataIndex
- `hidden`(可选):: boolean;是否隐藏
- `formItemProps`(可选):: | Omit | (( value: TAny, record: TPlainObject, index: number, operation: EditableTableProOperation ) => Omit ReactElement;通过 operation.editable 来判断渲染结构,其中render返回的根节点会作为 Form.Item 的children
- `editable`(必填):: boolean | ((record: TPlainObject, index: number) => boolean);是否可编辑
- `tipsWrapperProps`(可选):: string | TipsWrapperProps;会在 title 之后展示一个 icon
- `required`(可选):: boolean;为表格header中的字段添加必填标识,如果未配置 formItemProps.rules,内部会新增一条required rule
#### 使用规则与行为
- 当存在表头分组时,columns 类型为 Array
- 当前Edittable处在formList内部时(必填),完整formItem的name
- Form.List name
- 唯一值字段Key
- 初始化值
- 指定树形结构的列名,默认值:children
- 表格组件配置
- Form.List rules
- 默认新增按钮新增行默认值,hiddenFooterBtn != true 有效
- 隐藏底部新增按钮
#### 基础示例
```tsx
import { EditableTablePro, type EditableTableProProps } from '@flatbiz/antd/editable-table-pro';
const props: EditableTableProProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/editable-table-pro/editable-table-pro.tsx`
- `src/editable-table-pro/index.ts`
- `src/editable-table-pro/type.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/editable-table-pro` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### error-boundary-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/error-boundary-wrapper` 的使用方式。
#### 模块定位
react 异常拦截
#### 导入方式
```ts
import { ErrorBoundaryWrapper } from '@flatbiz/antd/error-boundary-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `ErrorBoundaryWrapper` - react 异常拦截
- `* from ./error-boundary.jsx`
#### 依赖的 antd 能力
`Alert`、`Button`
#### Props / 配置要点
##### ErrorBoundaryProps
- `message`(可选):: ReactNode
- `description`(可选):: ReactNode
- `children`(可选):: ReactNode
- `onRenderReset`(可选):: TNoopDefine
- `stackMaxHeight`(可选):: number | 'auto';栈消息最大高度,默认值200
#### 使用规则与行为
- 栈消息最大高度,默认值200
- react 异常拦截
#### 基础示例
```tsx
import { ErrorBoundaryWrapper, type ErrorBoundaryProps } from '@flatbiz/antd/error-boundary-wrapper';
const props: ErrorBoundaryProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/error-boundary-wrapper/error-boundary.tsx`
- `src/error-boundary-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/error-boundary-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### fba-app LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/fba-app` 的使用方式。
#### 模块定位
content只在第一次弹起时,执行一次
#### 导入方式
```ts
import { FbaApp } from '@flatbiz/antd/fba-app';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FbaAppContext`
- `FbaAppContextApi`
- `FbaAppAlert`
- `FbaAppAlertProps`
- `FbaAppConfirm`
- `FbaAppConfirmProps`
- `FbaAppDrawer`
- `FbaAppDrawerProps`
- `FbaAppLoading`
- `FbaAppLoadingProps`
- `FbaAppModal`
- `FbaAppModalProps`
- `useDialogDrawer` - 不支持多个弹框,第二个弹框可使用useDialogDrawer2
- `useDialogDrawer2` - 不支持多个弹框,第二个弹框可使用useDialogDrawer2
- `useDialogModal` - 不支持多个弹框,第二个弹框可使用useDialogModal2
- `useDialogModal2` - 不支持多个弹框
- `useDialogAlert` - 不支持多个弹框
- `useDialogConfirm` - 不支持多个弹框
- `useDialogLoading` - 不支持多个弹框
- `FbaApp`
#### 依赖的 antd 能力
`Drawer`、`DrawerProps`、`Form`、`FormInstance`、`Modal`、`ModalProps`、`Space`、`theme`
#### Props / 配置要点
##### FbaAppAlertProps
- `onClick`(可选):: (e: React.MouseEvent) => void | Promise
##### FbaAppConfirmProps
- 声明:`export type FbaAppConfirmProps = FbaAppModalProps;`
##### FbaAppDrawerProps
- `okText`(可选):: string | ReactElement
- `cancelText`(可选):: string | ReactElement
- `onOk`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `onCancel`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `content`(必填):: | string | ReactElement | (( form: FormInstance, operate: { onClose: DrawerProps['onClose'] } ) => ReactElement);content只在第一次弹起时,执行一次
- `okButtonExtraProps`(可选):: Omit< ButtonWrapperProps, 'onClick' | 'children' | 'loading' >
- `cancelButtonExtraProps`(可选):: Omit
- `okHidden`(可选):: boolean
- `cancelHidden`(可选):: boolean
- `operatePosition`(可选):: 'header' | 'footer';设置操作区域位置
- `extra`(可选):: ReactNode | ((form: FormInstance) => ReactElement);右上角自定义内容,如果operatePosition=header,此设置无效
- `operateRender`(可选):: ( form: FormInstance, extraData?: TPlainObject ) => ReactElement
##### FbaAppLoadingProps
- `className`(可选):: string
- `message`(可选):: string
- `mask`(可选):: boolean
##### FbaAppModalProps
- `size`(可选):: 'small' | 'middle' | 'large' | null;内置尺寸,根据比例固定高度、宽度
- `onOk`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `onCancel`(可选):: ( form: FormInstance, e: React.MouseEvent ) => void | Promise
- `onClose`(可选):: () => void
- `content`(必填):: | string | ReactElement | ((form: FormInstance, operate: { onClose: TNoopDefine }) => ReactElement);content只在第一次弹起时,执行一次
- `okHidden`(可选):: boolean
- `cancelHidden`(可选):: boolean
- `okButtonProps`(可选):: Omit
- `cancelButtonProps`(可选):: Omit< ButtonWrapperProps, 'hidden' | 'children' | 'onClick' >
- `bodyHeightPercent`(可选):: number;设置modal body height 为当前窗口height的百分比,例如:30 @deprecated 已失效,可通过size属性设置
- `titleExtra`(可选):: ReactElement
- `footer`(可选):: | null | ReactElement | ReactElement[] | ((form: FormInstance, extraData?: TPlainObject) => ReactElement);null则隐藏footer
- `bodyHeight`(可选):: number;内容高度,为styles.body.height快捷配置,优先级低于styles.body.height
#### 使用规则与行为
- 重新渲染footer
- content只在第一次弹起时,执行一次
- 设置操作区域位置
- 右上角自定义内容,如果operatePosition=header,此设置无效
- 内置尺寸,根据比例固定高度、宽度
- 设置modal body height 为当前窗口height的百分比,例如:30 @deprecated 已失效,可通过size属性设置
- null则隐藏footer
- 内容高度,为styles.body.height快捷配置,优先级低于styles.body.height
- 不支持多个弹框,第二个弹框可使用useDialogDrawer2
- 重新渲染 footer, data为携带的数据,是footer的第二个参数
#### 基础示例
```tsx
import { FbaApp, type FbaAppAlertProps } from '@flatbiz/antd/fba-app';
const props: FbaAppAlertProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/fba-app/context.ts`
- `src/fba-app/dialog-alert/index.tsx`
- `src/fba-app/dialog-confirm/index.tsx`
- `src/fba-app/dialog-drawer/context.ts`
- `src/fba-app/dialog-drawer/index.tsx`
- `src/fba-app/dialog-loading/index.tsx`
- `src/fba-app/dialog-modal/context.ts`
- `src/fba-app/dialog-modal/index.tsx`
- `src/fba-app/fba-app.tsx`
- `src/fba-app/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/fba-app` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### fba-hooks LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/fba-hooks` 的使用方式。
#### 模块定位
A helper to create a Context and Provider with no upfront default value, and without having to check for undefined all the time.
#### 导入方式
```ts
import { fbaHooks } from '@flatbiz/antd/fba-hooks';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `createCtx` - A helper to create a Context and Provider with no upfront default value, and without having to check for undefined all the time.
- `fbaHooks`
- `UseEffectParams`
- `UseEffectReturn`
- `EffectCallback`
- `DependencyList`
- `useArrayChange`
- `Demo`
- `useCopyRemoveSpace` - 移除复制文本中前后空格
- `CopyRemoveSpaceProps`
- `useEffectCustomAsync`
- `useEffectCustom`
- `useEffectOnce` - 只执行一次的 effect,后续依赖项变化不会再次执行
- `useMemoCustom` - 自定义控制 useMemo 依赖
- `usePrevious`
- `ShouldUpdateFunc`
- `useResponsivePoint` - 获取响应式节点
- `useThemeToken`
- `useUuid`
#### 依赖的 antd 能力
`Grid`、`theme`
#### Props / 配置要点
##### CopyRemoveSpaceProps
- `target`(可选):: () => Element;设置监听复制范围,如果不设置则监听全局
- `ignoreClass`(可选):: string[];忽略的class配置(不参与copy逻辑处理的class),例如:['ace_editor']
#### 使用规则与行为
- A helper to create a Context and Provider with no upfront default value, and without having to check for undefined all the time.
- 设置监听复制范围,如果不设置则监听全局
- 忽略的class配置(不参与copy逻辑处理的class),例如:['ace_editor']
- 移除复制文本中前后空格
- 只执行一次的 effect,后续依赖项变化不会再次执行
- 自定义控制 useMemo 依赖
- 获取响应式节点
#### 基础示例
```tsx
import { fbaHooks, type CopyRemoveSpaceProps } from '@flatbiz/antd/fba-hooks';
const props: CopyRemoveSpaceProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/fba-hooks/create-ctx.ts`
- `src/fba-hooks/index.ts`
- `src/fba-hooks/type.effect.ts`
- `src/fba-hooks/use-array-change.ts`
- `src/fba-hooks/use-copy-remove-space.ts`
- `src/fba-hooks/use-effect-custom-async.ts`
- `src/fba-hooks/use-effect-custom.ts`
- `src/fba-hooks/use-effect-once.ts`
- `src/fba-hooks/use-memo-custom.ts`
- `src/fba-hooks/use-previous.ts`
- `src/fba-hooks/use-responsive-point.ts`
- `src/fba-hooks/use-theme.ts`
- `src/fba-hooks/use-uuid.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/fba-hooks` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### fba-utils LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/fba-utils` 的使用方式。
#### 模块定位
手动触发Antd Form 的 onValuesChange
#### 导入方式
```ts
import { fbaUtils } from '@flatbiz/antd/fba-utils';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `fbaUtils`
- `* from ./fba-utils.js`
#### 依赖的 antd 能力
`FormInstance`
#### 使用规则与行为
- 手动触发Antd Form 的 onValuesChange
- 操作Antd Form
- 获取自定义antd主题
#### 基础示例
```tsx
import { fbaUtils } from '@flatbiz/antd/fba-utils';
;
```
#### 源码索引
- `src/fba-utils/fba-utils.ts`
- `src/fba-utils/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/fba-utils` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### file-export LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/file-export` 的使用方式。
#### 模块定位
文件导出
#### 导入方式
```ts
import { FileExport } from '@flatbiz/antd/file-export';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FileExport` - 文件导出
- `FileExportProps`
- `* from ./file-export.jsx`
#### 依赖的 antd 能力
`message`
#### Props / 配置要点
##### FileExportProps
- `action`(可选):: | (ReactElement & { onClick?: (e) => void }) | ((data: { onClick: (e) => void }) => ReactElement);触发节点
- `onRequest`(必填):: () => Promise<{ fileName: string; data: Blob }>;获取文件流数据
- `onExportPre`(可选):: () => void;导出操作前
- `onExportNext`(可选):: () => void;导出操作后
- `onExportError`(可选):: (error?: any) => void;导出操作失败,隐藏默认失败效果
#### 使用规则与行为
- 触发节点
- 获取文件流数据
- 导出操作前
- 导出操作后
- 导出操作失败,隐藏默认失败效果
- 文件导出
#### 基础示例
```tsx
import { FileExport, type FileExportProps } from '@flatbiz/antd/file-export';
const props: FileExportProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/file-export/file-export.tsx`
- `src/file-export/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/file-export` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### file-import LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/file-import` 的使用方式。
#### 模块定位
文件导入
#### 导入方式
```ts
import { FileImport } from '@flatbiz/antd/file-import';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FileImport` - 文件导入
- `FileImportProps`
- `* from ./file-import.jsx`
#### 依赖的 antd 能力
`Button`、`message`、`Upload`、`UploadProps`
#### Props / 配置要点
##### FileImportProps
- `onImportFinish`(可选):: (data?: TAny) => void;上传文件接口返回处理
- `buttonName`(可选):: string | ReactElement
- `children`(可选):: ReactNode | ((data: { loading: boolean }) => ReactNode)
#### 使用规则与行为
- 上传文件接口返回处理
- 文件导入
#### 基础示例
```tsx
import { FileImport, type FileImportProps } from '@flatbiz/antd/file-import';
const props: FileImportProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/file-import/file-import.tsx`
- `src/file-import/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/file-import` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### file-select LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/file-select` 的使用方式。
#### 模块定位
文件选择,内部不调用服务上传
#### 导入方式
```ts
import { FileSelect } from '@flatbiz/antd/file-select';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FileSelect` - 文件选择,内部不调用服务上传
- `FileSelectProps`
- `* from ./file-select.jsx`
#### 依赖的 antd 能力
`Button`、`Upload`
#### Props / 配置要点
##### FileSelectProps
- `buttonName`(可选):: string | ReactElement
- `children`(可选):: ReactNode
- `direction`(可选):: 'horizontal' | 'hertical';上传按钮与文件排版 默认:horizontal
- `onChange`(可选):: (file?: RcFile) => void
- `className`(可选):: string
- `isDragger`(可选):: boolean
- `draggerTriggerText`(可选):: string
- `draggerLayoutSize`(可选):: 'default' | 'middle' | 'large'
#### 使用规则与行为
- 上传按钮与文件排版 默认:horizontal
- 可选择文件格式,默认:.xlsx,.xls
- 文件选择,内部不调用服务上传
#### 基础示例
```tsx
import { FileSelect, type FileSelectProps } from '@flatbiz/antd/file-select';
const props: FileSelectProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/file-select/file-select.tsx`
- `src/file-select/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/file-select` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### flex-layout LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/flex-layout` 的使用方式。
#### 模块定位
flex布局,主要用于Flex结构性布局
#### 导入方式
```ts
import { FlexLayout } from '@flatbiz/antd/flex-layout';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FlexLayout` - flex布局,主要用于Flex结构性布局
- `FlexLayoutProps`
- `* from ./flex-layout.jsx`
#### Props / 配置要点
##### FlexLayoutProps
- `className`(可选):: string
- `fullIndex`(必填):: number | number[];子组件铺满的索引值,从0开始
- `direction`(可选):: 'vertical' | 'horizontal';方向,默认值vertical
- `onClick`(可选):: (event: React.MouseEvent) => void
- `style`(可选):: CSSProperties
- `gap`(可选):: number;间隙尺寸
- `children`(可选):: ReactNode | null | Array
#### 使用规则与行为
- 子组件铺满的索引值,从0开始
- 方向,默认值vertical
- 间隙尺寸
- flex布局,主要用于Flex结构性布局
#### 基础示例
```tsx
import { FlexLayout, type FlexLayoutProps } from '@flatbiz/antd/flex-layout';
const props: FlexLayoutProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/flex-layout/flex-layout.tsx`
- `src/flex-layout/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/flex-layout` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### form-grid LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/form-grid` 的使用方式。
#### 模块定位
网格响应式布局,默认值:{ xs: 24, sm: 12, md: 12, lg: 8, xl: 8, xxl: 6 }
#### 导入方式
```ts
import { FormGrid } from '@flatbiz/antd/form-grid';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FormCol` - 网格响应式布局,默认值:{ xs: 24, sm: 12, md: 12, lg: 8, xl: 8, xxl: 6 }
- `FormColProps`
- `FormOperateCol` - FormOperateCol 布局说明
- `FormOperateColProps`
- `FormRow` - FormItem网格响应式布局 ``` 1. 应用场景:Form条件布局 2. 子元素只能是 FormGrid.Col、FormGrid.OperateCol,其他会被忽略 3. 所有子元素中只能存在一个 FormGrid.OperateCol
- `FormRowProps`
- `FormGrid`
- `calculateOperateGrid` - 用于计算 operateCol 所占用网格数
#### 依赖的 antd 能力
`Col`、`Form`、`Row`、`RowProps`、`Space`、`SpaceProps`
#### Props / 配置要点
##### FormColProps
- `span`(可选):: number;栅格占位格数,替换lg、xl、xxl默认数据
- `xs`(可选):: number; sm?: number; md?: number; lg?: number; xl?: number; xxl?: number; forceAloneRow?: boolean; children?: ReactNode | ReactNode[]; // 隐藏,结构还在 hidden?: bo…;屏幕 < 576px
##### FormOperateColProps
- `className`(可选):: string
- `leftList`(可选):: Array
- `rightList`(可选):: Array
- `forceAloneRow`(可选):: boolean;强制单独一行
- `hidden`(可选):: boolean
- `leftSpaceProps`(可选):: SpaceProps
- `rightSpaceProps`(可选):: SpaceProps
##### FormRowProps
- `children`(可选):: ReactNode | ReactNode[]
#### 使用规则与行为
- 栅格占位格数,替换lg、xl、xxl默认数据
- 屏幕 < 576px
- 屏幕 ≥ 576px
- 屏幕 ≥ 768px
- 屏幕 ≥ 992px
- 屏幕 ≥ 1200px
- 屏幕 ≥ 1600px
- 强制单独一行
- 网格响应式布局,默认值:{ xs: 24, sm: 12, md: 12, lg: 8, xl: 8, xxl: 6 }
- FormOperateCol 布局说明
#### 基础示例
```tsx
import { FormGrid, type FormColProps } from '@flatbiz/antd/form-grid';
const props: FormColProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/form-grid/form-col.tsx`
- `src/form-grid/form-operate-col.tsx`
- `src/form-grid/form-row.tsx`
- `src/form-grid/index.ts`
- `src/form-grid/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/form-grid` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### form-item-group LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/form-item-group` 的使用方式。
#### 模块定位
FormItem 水平布局
#### 导入方式
```ts
import { FormItemGroup } from '@flatbiz/antd/form-item-group';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FormItemCard`
- `FormItemCardProps`
- `FormItemHorizontalUnion` - FormItem 水平布局
- `FormItemHorizontalUnionProps`
- `FormItemGroup`
#### 依赖的 antd 能力
`Form`
#### Props / 配置要点
##### FormItemCardProps
- `title`(可选):: string | ReactElement
- `children`(必填):: ReactElement | ReactElement[]
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `titleSign`(可选):: boolean
##### FormItemHorizontalUnionProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `label`(可选):: string | ReactElement
- `groupConfigList`(可选):: { hidden?: boolean; before?: ReactElement | string; width?: number | string; mainItem: ReactElement; after?: ReactElement | string; }[];水平布局元素
- `gap`(可选):: number;水平布局原始之间的间距
- `flexLayoutStyle`(可选):: CSSProperties
- `flexLayoutClassName`(可选):: string
- `hidden`(可选):: boolean
- `required`(可选):: boolean
- `colon`(可选):: boolean
#### 使用规则与行为
- 水平布局元素
- 设置宽度
- 水平布局原始之间的间距
- FormItem 水平布局 @param props @returns
#### 默认值线索
- `gap => 15`
#### 基础示例
```tsx
import { FormItemGroup, type FormItemCardProps } from '@flatbiz/antd/form-item-group';
const props: FormItemCardProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/form-item-group/card/index.tsx`
- `src/form-item-group/horizontal-union/index.tsx`
- `src/form-item-group/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/form-item-group` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### form-item-hidden LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/form-item-hidden` 的使用方式。
#### 模块定位
FormItemHidden:基于 antd 的 Form、FormItemProps 封装。
#### 导入方式
```ts
import { FormItemHidden } from '@flatbiz/antd/form-item-hidden';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FormItemHidden`
- `FormItemHiddenProps`
- `* from ./form-item-hidden.jsx`
#### 依赖的 antd 能力
`Form`、`FormItemProps`
#### Props / 配置要点
##### FormItemHiddenProps
- `name`(必填):: FormItemProps['name']
- `className`(可选):: string
- `style`(可选):: CSSProperties
#### 基础示例
```tsx
import { FormItemHidden, type FormItemHiddenProps } from '@flatbiz/antd/form-item-hidden';
const props: FormItemHiddenProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/form-item-hidden/form-item-hidden.tsx`
- `src/form-item-hidden/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/form-item-hidden` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### form-item-span LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/form-item-span` 的使用方式。
#### 模块定位
包裹EasyForm children item元素, 设置自定义栅格占位格数(使用在EasyForm一级子节点下生效)
#### 导入方式
```ts
import { FormItemSpan } from '@flatbiz/antd/form-item-span';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./span.jsx`
- `FormItemSpan` - 包裹EasyForm children item元素, 设置自定义栅格占位格数(使用在EasyForm一级子节点下生效)
- `FormItemSpanProps`
#### Props / 配置要点
##### FormItemSpanProps
- `span`(可选):: number
- `children`(可选):: ReactNode
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `hidden`(可选):: boolean;是否隐藏
- `remove`(可选):: boolean;是否移除
#### 使用规则与行为
- 是否隐藏
- 是否移除
- 包裹EasyForm children item元素, 设置自定义栅格占位格数(使用在EasyForm一级子节点下生效)
#### 基础示例
```tsx
import { FormItemSpan, type FormItemSpanProps } from '@flatbiz/antd/form-item-span';
const props: FormItemSpanProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/form-item-span/index.ts`
- `src/form-item-span/span.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/form-item-span` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### form-item-text LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/form-item-text` 的使用方式。
#### 模块定位
FormItem 文本显示,默认不换行,超出省略(鼠标悬浮可显示)
#### 导入方式
```ts
import { FormItemText } from '@flatbiz/antd/form-item-text';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FormItemTextContent`
- `FormItemText` - FormItem 文本显示,默认不换行,超出省略(鼠标悬浮可显示)
- `* from ./form-item-text.jsx`
- `RequestText` - FormItem 文本显示,默认不换行,超出省略(鼠标悬浮可显示)
- `FormItemTextServiceConfig`
- `FormItemTextProps`
- `useRequestFormItemText`
#### 依赖的 antd 能力
`Form`、`Spin`、`Tooltip`
#### Props / 配置要点
##### FormItemTextServiceConfig
- `onRequest`(可选):: (params?: TAny) => Promise
- `params`(可选):: TPlainObject;接口参数,当params发生变化后,会主动发送查询请求
- `invalidParamKey`(可选):: string[];标记serviceConfig.params中无效参数,被设置的params key 不传入服务接口入参
- `onResponseAdapter`(可选):: (respData?: TAny, value?: TAny) => TAny;如果没有配置 render,返回结果会直接进行dom渲染,如果非string类型会进行JSON.stringify处理
- `requiredParamsKeys`(可选):: string[];必须参数key列表,与params配合使用
##### FormItemTextProps
- `wrap`(可选):: boolean;是否换行,默认不换行,超出省略(鼠标悬浮可显示)
- `render`(可选):: (value?: TAny) => ReactNode;自定义数据显示
- `placeholderValue`(可选):: string;占位值,当 value 为 ''、undefined、null时显示
- `serviceConfig`(可选):: FormItemTextServiceConfig;发起服务调用显示数据,例如:数据为key,通过key查询text显示
#### 使用规则与行为
- FormItem 文本显示,默认不换行,超出省略(鼠标悬浮可显示)
- FormItem 文本显示,默认不换行,超出省略(鼠标悬浮可显示) @param props @returns
- 接口参数,当params发生变化后,会主动发送查询请求
- 标记serviceConfig.params中无效参数,被设置的params key 不传入服务接口入参
- 如果没有配置 render,返回结果会直接进行dom渲染,如果非string类型会进行JSON.stringify处理
- 必须参数key列表,与params配合使用
- 是否换行,默认不换行,超出省略(鼠标悬浮可显示)
- 自定义数据显示
- 占位值,当 value 为 ''、undefined、null时显示
- 发起服务调用显示数据,例如:数据为key,通过key查询text显示
#### 基础示例
```tsx
import { FormItemText, type FormItemTextProps } from '@flatbiz/antd/form-item-text';
const props: FormItemTextProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/form-item-text/content.tsx`
- `src/form-item-text/form-item-text.tsx`
- `src/form-item-text/index.ts`
- `src/form-item-text/request-text.tsx`
- `src/form-item-text/types.ts`
- `src/form-item-text/use-request.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/form-item-text` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### form-item-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/form-item-wrapper` 的使用方式。
#### 模块定位
对 Form.Item 包装处理
#### 导入方式
```ts
import { FormItemWrapper } from '@flatbiz/antd/form-item-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FormItemWrapper` - 对 Form.Item 包装处理
- `FormItemWrapperProps`
- `* from ./form-item-wrapper.jsx`
#### 依赖的 antd 能力
`Form`、`FormItemProps`
#### Props / 配置要点
##### FormItemWrapperProps
- `wrapper`(可选):: (children: ReactNode) => ReactElement
- `before`(可选):: ReactNode;设置wrapper后,before、after失效
- `after`(可选):: ReactNode;设置wrapper后,before、after失效
- `beforeAfterStyle`(可选):: CSSProperties;设置 before、after 属性的包装结构style
- `inputNormalize`(可选):: (value?: TAny) => TAny;value 序列化处理
- `outputNormalize`(可选):: (value?: TAny) => TAny;onChange 参数序列化处理 如果设置 normalize 属性,outputNormalize将失效
- `isClear`(可选):: boolean | ((formValues: TPlainObject) => boolean);隐藏 Form.Item,同时清除 Form.Item 值
- `hidden`(可选):: boolean | ((formValues: TPlainObject) => boolean);隐藏 Form.Item,不会清除 Form.Item 值
- `span`(可选):: number;栅格占位格数,最大值:24
- `children`(可选):: ReactNode;不支持函数式写法,如果需要使用dependencies获取表单值,可使用FormItemWrapperDependencies 组件
- `noStyle`(可选):: boolean
- `bottomGap`(可选):: number;底部间隙
##### FormItemWrapperChildrenProps
- `children`(必填):: ReactElement
- `value`(可选):: any
- `onChange`(可选):: (value?: any) => any
#### 使用规则与行为
- 设置wrapper后,before、after失效
- 设置 before、after 属性的包装结构style
- value 序列化处理
- onChange 参数序列化处理 如果设置 normalize 属性,outputNormalize将失效
- 隐藏 Form.Item,同时清除 Form.Item 值
- 隐藏 Form.Item,不会清除 Form.Item 值
- 栅格占位格数,最大值:24
- 不支持函数式写法,如果需要使用dependencies获取表单值,可使用FormItemWrapperDependencies 组件
- 底部间隙
- 对 Form.Item 包装处理
#### 基础示例
```tsx
import { FormItemWrapper, type FormItemWrapperProps } from '@flatbiz/antd/form-item-wrapper';
const props: FormItemWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/form-item-wrapper/form-item-wrapper.tsx`
- `src/form-item-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/form-item-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### form-item-wrapper-dependencies LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/form-item-wrapper-dependencies` 的使用方式。
#### 模块定位
FormItem依赖写法包装,当处在EasyForm内部时,不支持 此写法,使用 代替
#### 导入方式
```ts
import { FormItemWrapperDependencies } from '@flatbiz/antd/form-item-wrapper-dependencies';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FormItemWrapperDependencies` - FormItem依赖写法包装,当处在EasyForm内部时,不支持 此写法,使用 ReactElement
- `dependencies`(必填):: any[]
- `className`(可选):: string
- `style`(可选):: CSSProperties
#### 使用规则与行为
- FormItem依赖写法包装,当处在EasyForm内部时,不支持 此写法,使用 代替
#### 基础示例
```tsx
import { FormItemWrapperDependencies, type FormItemWrapperDependenciesProps } from '@flatbiz/antd/form-item-wrapper-dependencies';
const props: FormItemWrapperDependenciesProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/form-item-wrapper-dependencies/dependencies.tsx`
- `src/form-item-wrapper-dependencies/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/form-item-wrapper-dependencies` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### form-list-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/form-list-wrapper` 的使用方式。
#### 模块定位
Form.List 包装组件,使用更简单
#### 导入方式
```ts
import { FormListWrapper } from '@flatbiz/antd/form-list-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FormListWrapper` - Form.List 包装组件,使用更简单
- `* from ./form-list-wrapper.jsx`
- `FormListWrapperContentProps`
- `FormListWrapperProps`
#### 依赖的 antd 能力
`Empty`、`Form`
#### Props / 配置要点
##### FormListChildrenWrapperProps
- `wrapper`(可选):: FormListWrapperProps['formListChildrenWrapper']
- `children`(必填):: ReactElement
##### FormListWrapperContentProps
- `formListFieldData`(必填):: FormListFieldData;Form.List item fieldData
- `formStageCompleteName`(必填):: (string | number)[];当前阶段 完整 formItem name
- `prevCompleteName`(必填):: (string | number)[];formList上一级 formItem完整name
- `operation`(必填):: FormListOperation;Form.List 操作项
- `index`(必填):: number;索引
- `getInsideFormItemName`(必填):: (key: string | string[]) => Array;获取当前FormList 内部 Form.Item name
- `getInsideFormItemData`(必填):: () => TPlainObject;获取当前 FormList Item 数据
- `uidKey`(必填):: string;唯一值字段Key
##### FormListWrapperProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `uidFieldName`(可选):: string;formList item 数据中的唯一值,默认值:uid
- `name`(必填):: string | number | (string | number)[];formList name
- `prevCompleteName`(必填):: (string | number)[];formList上一级 formItem完整name
- `getAddRowDefaultValues`(可选):: () => TPlainObject;formListItem 内容
- `hiddenAddRowButton`(可选):: boolean;隐藏新增行按钮
- `onCustomAddRowButton`(可选):: (operation: FormListOperation) => ReactElement;自定义新增行按钮,getAddRowDefaultValues配置失效
- `children`(必填):: (data: FormListWrapperContentProps) => ReactElement;formListItem 内容
- `hiddenEmptyRender`(可选):: boolean;隐藏数据为空渲染
- `formListChildrenWrapper`(可选):: (props: { children: ReactElement }) => ReactElement;formList内部渲染包装,多用于FormListWrapper嵌套布局
- `rules`(可选):: FormListProps['rules'];Form.List rules
- `formListItemTitleList`(可选):: { title: string; required?: boolean; width?: number; }[];设置FormList字段标题&必填标志
- `formListItemTitleHorizontalUnionProps`(可选):: Omit< FormItemHorizontalUnionProps, 'groupConfigList' >;formListItemTitle HorizontalUnionProps 配置
- `itemGap`(可选):: number;FormList Item 之间间隙,默认值:16
#### 使用规则与行为
- Form.List 包装组件,使用更简单
- Form.List item fieldData
- 当前阶段 完整 formItem name
- formList上一级 formItem完整name
- Form.List 操作项
- 索引
- 获取当前FormList 内部 Form.Item name
- 获取当前 FormList Item 数据
- 唯一值字段Key
- formList item 数据中的唯一值,默认值:uid
#### 基础示例
```tsx
import { FormListWrapper, type FormListChildrenWrapperProps } from '@flatbiz/antd/form-list-wrapper';
const props: FormListChildrenWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/form-list-wrapper/form-list-wrapper.tsx`
- `src/form-list-wrapper/index.ts`
- `src/form-list-wrapper/types.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/form-list-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### form-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/form-wrapper` 的使用方式。
#### 模块定位
Form 包装组件,添加对formItem的布局控制
#### 导入方式
```ts
import { FormWrapper } from '@flatbiz/antd/form-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FormWrapper` - Form 包装组件,添加对formItem的布局控制
- `FormWrapperProps`
- `* from ./form-wrapper.jsx`
#### 依赖的 antd 能力
`Form`、`FormProps`
#### Props / 配置要点
##### FormWrapperProps
- `children`(必填):: ReactNode
#### 使用规则与行为
- Form 包装组件,添加对formItem的布局控制
#### 基础示例
```tsx
import { FormWrapper, type FormWrapperProps } from '@flatbiz/antd/form-wrapper';
const props: FormWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/form-wrapper/form-wrapper.tsx`
- `src/form-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/form-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### full-screen LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/full-screen` 的使用方式。
#### 模块定位
全屏显示(点击键盘ESC可关闭全屏显示)
#### 导入方式
```ts
import { FullScreen } from '@flatbiz/antd/full-screen';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `FullScreenInner`
- `useFullScreenHandleInner`
- `FullScreenHandleProps`
- `FullScreenProps`
- `FullScreen` - 全屏显示(点击键盘ESC可关闭全屏显示)
#### Props / 配置要点
##### FullScreenHandleProps
- `active`(必填):: boolean
- `toggle`(必填):: () => void
##### FullScreenProps
- `children`(必填):: ReactElement
- `handle`(必填):: FullScreenHandleProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
#### 使用规则与行为
- 全屏显示(点击键盘ESC可关闭全屏显示)
#### 基础示例
```tsx
import { FullScreen, type FullScreenHandleProps } from '@flatbiz/antd/full-screen';
const props: FullScreenHandleProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/full-screen/full-screen.tsx`
- `src/full-screen/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/full-screen` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### gap LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/gap` 的使用方式。
#### 模块定位
间隙组件
#### 导入方式
```ts
import { Gap } from '@flatbiz/antd/gap';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `Gap` - 间隙组件
- `GapProps`
- `* from ./gap.jsx`
#### Props / 配置要点
##### GapProps
- `height`(可选):: number
- `width`(可选):: number
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `inline`(可选):: boolean
#### 使用规则与行为
- 间隙组件 @param props @returns
#### 基础示例
```tsx
import { Gap, type GapProps } from '@flatbiz/antd/gap';
const props: GapProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/gap/gap.tsx`
- `src/gap/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/gap` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### icon-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/icon-wrapper` 的使用方式。
#### 模块定位
提示类型 @default 'tooltip'
#### 导入方式
```ts
import { IconWrapper } from '@flatbiz/antd/icon-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `IconWrapper`
- `IconWrapperProps`
- `* from ./icon-wrapper.jsx`
#### 依赖的 antd 能力
`Popover`、`Tooltip`
#### Props / 配置要点
##### IconWrapperProps
- `hoverTips`(可选):: string | ReactElement
- `tipsType`(可选):: 'popover' | 'tooltip';提示类型 @default 'tooltip'
- `icon`(可选):: ReactNode
- `style`(可选):: CSSProperties
- `wrapperStyle`(可选):: CSSProperties
- `text`(可选):: string | ReactElement
- `className`(可选):: string
- `size`(可选):: 'small' | 'middle' | 'large'
- `onClick`(可选):: (event) => void
- `hideHoverBgColor`(可选):: boolean
- `hidden`(可选):: boolean
- `position`(可选):: 'before' | 'after';图标对比文字的位置,默认:brefore
- `gap`(可选):: number;图标与文字之间的间距
#### 使用规则与行为
- 提示类型 @default 'tooltip'
- 图标对比文字的位置,默认:brefore
- 图标与文字之间的间距
#### 基础示例
```tsx
import { IconWrapper, type IconWrapperProps } from '@flatbiz/antd/icon-wrapper';
const props: IconWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/icon-wrapper/icon-wrapper.tsx`
- `src/icon-wrapper/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/icon-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### input-search-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/input-search-wrapper` 的使用方式。
#### 模块定位
#### 导入方式
```ts
import { InputSearchWrapper } from '@flatbiz/antd/input-search-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./input-search-wrapper.jsx`
- `InputSearchWrapper` -
- `InputSearchWrapperProps`
#### 依赖的 antd 能力
`Input`
#### Props / 配置要点
##### InputSearchWrapperProps
- 声明:`export type InputSearchWrapperProps = Omit;`
#### 基础示例
```tsx
import { InputSearchWrapper, type InputSearchWrapperProps } from '@flatbiz/antd/input-search-wrapper';
const props: InputSearchWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/input-search-wrapper/index.ts`
- `src/input-search-wrapper/input-search-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/input-search-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### input-text-area-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/input-text-area-wrapper` 的使用方式。
#### 模块定位
#### 导入方式
```ts
import { InputTextAreaWrapper } from '@flatbiz/antd/input-text-area-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./input-text-area-wrapper.jsx`
- `InputTextAreaWrapper` -
- `InputTextAreaWrapperProps`
#### 依赖的 antd 能力
`Input`
#### Props / 配置要点
##### InputTextAreaWrapperProps
#### 默认值线索
- `debounceDuration => 200`
#### 基础示例
```tsx
import { InputTextAreaWrapper, type InputTextAreaWrapperProps } from '@flatbiz/antd/input-text-area-wrapper';
const props: InputTextAreaWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/input-text-area-wrapper/index.ts`
- `src/input-text-area-wrapper/input-text-area-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/input-text-area-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### input-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/input-wrapper` 的使用方式。
#### 模块定位
#### 导入方式
```ts
import { InputWrapper } from '@flatbiz/antd/input-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./input-wrapper.jsx`
- `InputWrapper` -
- `InputWrapperProps`
#### 依赖的 antd 能力
`Input`、`InputProps`
#### Props / 配置要点
##### InputWrapperProps
#### 默认值线索
- `debounceDuration => 200`
#### 基础示例
```tsx
import { InputWrapper, type InputWrapperProps } from '@flatbiz/antd/input-wrapper';
const props: InputWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/input-wrapper/index.ts`
- `src/input-wrapper/input-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/input-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### label-value-render LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/label-value-render` 的使用方式。
#### 模块定位
label+value 列表布局
#### 导入方式
```ts
import { LabelValueRender } from '@flatbiz/antd/label-value-render';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./label-value.jsx`
- `LabelValueRender` - label+value 列表布局
- `LabelValueRenderProps`
- `TLabelValueItem`
- `TLabelValueRenderItem`
- `getRenderGrid`
#### Props / 配置要点
##### LabelValueRenderProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `forceColumn`(可选):: 1 | 2 | 3 | 4 | 6;强制定义一行显示几列,不考虑响应式
- `options`(必填):: TLabelValueItem[];数据源配置
- `ellipsis`(可选):: boolean;超过宽度将自动省略,默认值:true
- `border`(可选):: boolean;是否添加边框 @deprecated 已过期,请使用 bordered
- `bordered`(可选):: boolean;是否添加边框
- `labelAlign`(可选):: 'left' | 'right' | 'center';label对齐方式
- `labelWidth`(可选):: number | 'auto';label 宽度,默认值:100
- `width`(可选):: number
- `labelStyle`(可选):: CSSProperties;label 样式
- `valueStyle`(可选):: CSSProperties;value 样式
- `size`(可选):: 'default' | 'small'
- `direction`(可选):: 'vertical' | 'horizontal' | 'auto';label&value 方向布局
- `gutter`(可选):: [number, number];网格布局间距,默认值:[10, 0]
- `hiddenValueHover`(可选):: boolean;隐藏 value hover效果
##### TLabelValueItem
- `label`(必填):: string | ReactElement
- `value`(可选):: string | number | ReactElement
- `span`(可选):: 1 | 2 | 3 | 4 | 6 | 12;根据LabelValueRender.column配置,当前item占几列
- `hidden`(可选):: boolean;是否隐藏
- `ellipsis`(可选):: boolean;超出宽度是否隐藏
- `required`(可选):: boolean;是否添加必填标识
- `tips`(可选):: string;添加说明标签
- `onClick`(可选):: (e) => void;value 点击事件
- `hideTip`(可选):: boolean;关闭tooltip功能
- `valueNoWrapper`(可选):: boolean;value 渲染不使用 TextOverflow 包裹
- `labelStyle`(可选):: CSSProperties
- `valueStyle`(可选):: CSSProperties
- `style`(可选):: CSSProperties
##### TLabelValueRenderItem
- `grid`(必填):: number
- `isLast`(可选):: boolean
#### 使用规则与行为
- 定义一行显示几列, 默认值:4
- 强制定义一行显示几列,不考虑响应式
- 数据源配置
- 超过宽度将自动省略,默认值:true
- 是否添加边框 @deprecated 已过期,请使用 bordered
- 是否添加边框
- label对齐方式
- label 宽度,默认值:100
- label 样式
- value 样式
#### 默认值线索
- `bordered => bordered`
#### 基础示例
```tsx
import { LabelValueRender, type LabelValueRenderProps } from '@flatbiz/antd/label-value-render';
const props: LabelValueRenderProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/label-value-render/index.ts`
- `src/label-value-render/label-value.tsx`
- `src/label-value-render/types.ts`
- `src/label-value-render/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/label-value-render` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### local-loading LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/local-loading` 的使用方式。
#### 模块定位
局部加载,包含接口数据处理逻辑
#### 导入方式
```ts
import { LocalLoading } from '@flatbiz/antd/local-loading';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `LocalLoading` - 局部加载,包含接口数据处理逻辑
- `LocalLoadingInner` - 局部加载,包含接口数据处理逻辑
- `LocalLoadingServiceConfig`
- `LocalLoadingProps`
- `LocalLoadingRefApi`
#### 依赖的 antd 能力
`Button`、`Result`、`Spin`
#### Props / 配置要点
##### LocalLoadingServiceConfig
- `onRequest`(可选):: (params?: TAny) => Promise
- `params`(可选):: TPlainObject
- `invalidParamKey`(可选):: string[];标记serviceConfig.params中无效参数,被设置的params key 不传入服务接口入参
- `requiredParamsKeys`(可选):: string[];必填字段设置
##### LocalLoadingProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `contentStyle`(可选):: CSSProperties
- `serviceConfig`(必填):: LocalLoadingServiceConfig;接口数据配置
- `children`(可选):: (respData?: TAny) => ReactElement;children 为函数,参数【respData】为接口返回数据
- `isAsync`(可选):: boolean;是否异步,默认:false
- `loadingHeight`(可选):: number | string;loading高度,默认值:100;isAsync = true 无效
- `loadingSpinProps`(可选):: { tip?: string; content?: ReactElement; bgColor?: string; };loading spin 属性设置
- `textConfigs`(可选):: { requiredErrorText?: string; };必填异常文本
- `showRequiredError`(可选):: boolean;是否显示必填异常
- `errorRender`(可选):: (error?: TAny) => ReactElement;自定义异常渲染处理
- `contentScroll`(可选):: boolean;设置内部滚动,需要设置 style.height 才能生效,@5.0.16
- `height`(可选):: number | string;设置高度
#### 使用规则与行为
- 局部加载,包含接口数据处理逻辑
- 标记serviceConfig.params中无效参数,被设置的params key 不传入服务接口入参
- 必填字段设置
- 接口数据配置
- children 为函数,参数【respData】为接口返回数据
- 是否异步,默认:false
- loading高度,默认值:100;isAsync = true 无效
- loading spin 属性设置
- loading tip,默认值:Loading
- loading 内容
#### 默认值线索
- `loadingHeight => 100`
#### 基础示例
```tsx
import { LocalLoading, type LocalLoadingProps } from '@flatbiz/antd/local-loading';
const props: LocalLoadingProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/local-loading/context.ts`
- `src/local-loading/index.ts`
- `src/local-loading/local-loading.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/local-loading` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### markdown-editor LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/markdown-editor` 的使用方式。
#### 模块定位
markdown编辑器
#### 导入方式
```ts
import { MarkdownEditor } from '@flatbiz/antd/markdown-editor';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `MarkdownEditor` - markdown编辑器
- `ReactMdEditor` -
- `* from ./content.jsx`
- `MermaidViewBtn`
- `PluginMermaidCode`
- `MarkdownEditorProps`
- `UploadImageContent`
- `UploadImageBtn`
#### 依赖的 antd 能力
`Button`、`FormInstance`、`InputNumber`、`message`、`Spin`
#### Props / 配置要点
##### MarkdownEditorProps
- `style`(可选):: CSSProperties
- `className`(可选):: string
- `value`(可选):: string
- `onChange`(可选):: (value?: string) => void
- `onUploadImage`(可选):: (file: File) => Promise<{ url: string; name: string }>;图片上传回调,配置后,在工具栏中显示上传图片按钮
- `height`(可选):: number | string;当高度参数为百分比时,拖动条无效
- `hideToolbar`(可选):: boolean;是否隐藏工具栏
- `visibleDragbar`(可选):: boolean;是否可拖拽高度操作,默认值:true
- `readonly`(可选):: boolean;是否只读,设置后会隐藏工具栏部分功能
- `readonlyHeightAuto`(可选):: boolean;只读高度自适应,设置为 true 时,会根据内容自动调整高度,默认值:true
- `isDarkMode`(可选):: boolean;是否暗色模式,默认值:false
- `hideBorder`(可选):: boolean;是否隐藏边框
#### 使用规则与行为
- markdown编辑器
- 图片上传回调,配置后,在工具栏中显示上传图片按钮
- 当高度参数为百分比时,拖动条无效
- 是否隐藏工具栏
- 是否可拖拽高度操作,默认值:true
- 是否只读,设置后会隐藏工具栏部分功能
- 只读高度自适应,设置为 true 时,会根据内容自动调整高度,默认值:true
- 是否暗色模式,默认值:false
- 是否隐藏边框
#### 默认值线索
- `readonlyHeightAutoFt => readonlyHeightAuto ?? true`
#### 基础示例
```tsx
import { MarkdownEditor, type MarkdownEditorProps } from '@flatbiz/antd/markdown-editor';
const props: MarkdownEditorProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/markdown-editor/content.tsx`
- `src/markdown-editor/editor.tsx`
- `src/markdown-editor/index.ts`
- `src/markdown-editor/mermaid-view/index.tsx`
- `src/markdown-editor/plugin-mermaid.tsx`
- `src/markdown-editor/type.ts`
- `src/markdown-editor/upload-image/content.tsx`
- `src/markdown-editor/upload-image/index.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/markdown-editor` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### mention-editor LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/mention-editor` 的使用方式。
#### 模块定位
基于MentionWrapper封装的模版字符串配置组件 1. 提供变量,数字,链接等可选的模版参数 2. 不同类型模版参数可配置多个 3. mention 会根据 传入的params自动推断出关键字 4. 模版参数建议都以${_xxx}为格式 5. Demo: https://fex.qa.tcshuke.com/docs/admin/main/widget?key=mention-editor
#### 导入方式
```ts
import { MentionEditor } from '@flatbiz/antd/mention-editor';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./mention-editor.jsx`
- `MentionEditor` - 基于MentionWrapper封装的模版字符串配置组件 1. 提供变量,数字,链接等可选的模版参数 2. 不同类型模版参数可配置多个 3. mention 会根据 传入的params自动推断出关键字 4. 模版参数建议都以${_xxx}为格式 5. Demo: https:/…
- `OperationPresetProps`
- `MentionEditorProps`
- `ParamItem`
#### 依赖的 antd 能力
`Button`、`Flex`
#### Props / 配置要点
##### OperationPresetProps
- `icon`(必填):: ReactElement;icon
- `label`(可选):: string;模版参数文案
- `type`(必填):: string;模版参数类型
- `codePrefix`(必填):: string;自增code前缀
- `codeAdapter`(可选):: () => string | undefined;自定义生成模版参数code
##### MentionEditorProps
- `onSelectParam`(可选):: (item: ParamItem, prefix?: string) => void;onChange @item 点击的预设模版参数
- `prefix`(可选):: string;模版参数前缀 & | $
- `operations`(可选):: OperationPresetProps[];editor 支持添加的模版参数类型
- `params`(可选):: ParamItem[] | undefined;模版参数列表
##### ParamItem
- `code`(必填):: string;模版参数code
- `type`(必填):: 'text' | 'number' | 'link';模版参数类型 文本/数字/链接
- `value`(必填):: TAny;模版参数 value
#### 使用规则与行为
- icon
- 模版参数文案
- 模版参数类型
- 自增code前缀
- 自定义生成模版参数code
- onChange @item 点击的预设模版参数
- 模版参数前缀 & | $
- editor 支持添加的模版参数类型
- 模版参数列表
- 基于MentionWrapper封装的模版字符串配置组件 1. 提供变量,数字,链接等可选的模版参数 2. 不同类型模版参数可配置多个 3. mention 会根据 传入的params自动推断出关键字 4. 模版参数建议都以${_xxx}为格式 5. Demo: https://fex.qa.tcshuke.com/docs/admin/main/widget?key=mention-editor
#### 基础示例
来自模块 README 的示例:
```tsx
const index = useRef(0)
const [value, setValue] = useState();
const [params, setParams] = useState([
{ code: '${_var0}', type: 'text', value: '111' },
{ code: '${_var1}', type: 'text', value: '222' },
])
const onAddParams = (item, prefix) => {
setParams(preParams => [
...preParams,
item
])
}
return , codeAdapter: () => {
return '_text' + index.current++;
}
},
{ type: 'number', codePrefix: '_number', label: "数字参数", icon: },
{ type: 'link', codePrefix: '_link', label: "链接参数", icon: },
]}
params={params}
/>
```
#### README 摘要
MetionEditor
#### 源码索引
- `src/mention-editor/index.ts`
- `src/mention-editor/mention-editor.tsx`
- `src/mention-editor/readme.md`
- `src/mention-editor/types.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/mention-editor` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### mentions-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/mentions-wrapper` 的使用方式。
#### 模块定位
基于Antd Mentions进行二次封装,可实现输入内关键字整体控制,包括光标移动、关键词删除等
#### 导入方式
```ts
import { MentionsWrapper } from '@flatbiz/antd/mentions-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./mentions.jsx`
- `MentionsWrapper` - 基于Antd Mentions进行二次封装,可实现输入内关键字整体控制,包括光标移动、关键词删除等
- `MentionsWrapperRef`
- `MentionsWrapperProps`
- `OverallKeyWordsPosition`
- `getOverallKeyWordsPosition`
- `judgmentCursorInKeyWordsPosition` - 判断光标是否处在关键词位置内
#### 依赖的 antd 能力
`Mentions`
#### Props / 配置要点
##### MentionsWrapperProps
- `value`(可选):: string
- `onChange`(可选):: (value?: string) => void
- `prefix`(可选):: string | string[];设置列表提示关键字,例如:@、$等
- `onClick`(可选):: (value?: string) => void
- `onCursorChange`(可选):: (position: number) => void;光标移动回调
- `options`(可选):: string[];输入框内整体关键词列表
#### 使用规则与行为
- 设置列表提示关键字,例如:@、$等
- 光标移动回调
- 输入框内整体关键词列表
- 基于Antd Mentions进行二次封装,可实现输入内关键字整体控制,包括光标移动、关键词删除等
- 关键词位置
- 选中关键字/关键字+文字 的情况,直接删除
- 判断光标是否处在关键词位置内
#### 基础示例
来自模块 README 的示例:
```tsx
const [value, setValue] = useState();
{
console.log('onCursorChange', position);
}}
/>
```
#### README 摘要
MentionWrapper MetionEditor
#### 源码索引
- `src/mentions-wrapper/index.ts`
- `src/mentions-wrapper/mentions.tsx`
- `src/mentions-wrapper/readme.md`
- `src/mentions-wrapper/types.ts`
- `src/mentions-wrapper/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/mentions-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### modal-action LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/modal-action` 的使用方式。
#### 模块定位
弹框 触发器
#### 导入方式
```ts
import { ModalAction } from '@flatbiz/antd/modal-action';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./modal-action.jsx`
- `ModalAction` - 弹框 触发器
- `ModalActionProps`
#### Props / 配置要点
##### ModalActionProps
- `children`(必填):: | ReactElement | ((data: { onClose: () => void; open: boolean }) => ReactElement)
- `action`(可选):: | (ReactElement & { onClick?: (e) => void }) | ((data: { onClick: (e) => void; onClose: () => void; open: boolean; }) => ReactElement)
#### 使用规则与行为
- 弹框 触发器
#### 基础示例
```tsx
import { ModalAction, type ModalActionProps } from '@flatbiz/antd/modal-action';
const props: ModalActionProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/modal-action/index.ts`
- `src/modal-action/modal-action.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/modal-action` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### number-range-form-item LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/number-range-form-item` 的使用方式。
#### 模块定位
数字输入范围组件
#### 导入方式
```ts
import { NumberRangeFormItem } from '@flatbiz/antd/number-range-form-item';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./number-range.jsx`
- `NumberRangeFormItem` - 数字输入范围组件
- `NumberRangeFormItemProps`
#### 依赖的 antd 能力
`InputNumber`
#### Props / 配置要点
##### InputNumberProps
- 声明:`type InputNumberProps = GetProps;`
##### NumberRangeFormItemProps
- `minFormItemName`(必填):: FormItemNamePath
- `maxFormItemName`(必填):: FormItemNamePath
- `required`(可选):: boolean;是否必填
- `requiredRuleMessage`(可选):: string | [string, string];必填验证异常文案
- `rangeRuleMessage`(可选):: string | [string, string];范围验证异常文案
- `minInputNumberProps`(可选):: Omit
- `maxInputNumberProps`(可选):: Omit
- `isInputEqual`(可选):: boolean;最小值与最大值输入是否可以相同
#### 使用规则与行为
- 是否必填
- 必填验证异常文案
- 范围验证异常文案
- 最小值与最大值输入是否可以相同
- 数字输入范围组件
#### 基础示例
```tsx
import { NumberRangeFormItem, type InputNumberProps } from '@flatbiz/antd/number-range-form-item';
const props: InputNumberProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/number-range-form-item/index.ts`
- `src/number-range-form-item/number-range.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/number-range-form-item` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### page-fixed-footer LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/page-fixed-footer` 的使用方式。
#### 模块定位
PageFixedFooter:FlatBiz antd 扩展模块。
#### 导入方式
```ts
import { PageFixedFooter } from '@flatbiz/antd/page-fixed-footer';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./page-fixed-footer.jsx`
- `PageFixedFooter`
- `PageFixedFooterProps`
#### Props / 配置要点
##### PageFixedFooterProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `children`(可选):: ReactNode | ReactNode[]
- `hidden`(可选):: boolean
#### 基础示例
```tsx
import { PageFixedFooter, type PageFixedFooterProps } from '@flatbiz/antd/page-fixed-footer';
const props: PageFixedFooterProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/page-fixed-footer/index.ts`
- `src/page-fixed-footer/page-fixed-footer.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/page-fixed-footer` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### page404 LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/page404` 的使用方式。
#### 模块定位
Page404:基于 antd 的 Result 封装。
#### 导入方式
```ts
import { Page404 } from '@flatbiz/antd/page404';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./page404.jsx`
- `Page404`
- `Page404Props`
#### 依赖的 antd 能力
`Result`
#### Props / 配置要点
##### Page404Props
- `message`(可选):: string
#### 基础示例
```tsx
import { Page404, type Page404Props } from '@flatbiz/antd/page404';
const props: Page404Props = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/page404/index.ts`
- `src/page404/page404.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/page404` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### pagination-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/pagination-wrapper` 的使用方式。
#### 模块定位
由于 antd 5.3.x 分页Pagination组件,存在点击分页选择框时,一直朝下 issues:https://github.com/ant-design/ant-design/issues/36866 为了兼容,在 Pagination 中添加了 selectComponentClass 属性,后期antd 官方优化了bug,可取消 配置selectComponentClass
#### 导入方式
```ts
import { PaginationWrapper } from '@flatbiz/antd/pagination-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./pagination.jsx`
- `PaginationWrapper` - 由于 antd 5.3.x 分页Pagination组件,存在点击分页选择框时,一直朝下 issues:https://github.com/ant-design/ant-design/issues/36866 为了兼容,在 Pagination 中添加了 selectComp…
- `SmallSelect` - 由于 antd 5.3.x 分页Pagination组件,存在点击分页选择框框时,一直朝下 issues:https://github.com/ant-design/ant-design/issues/36866 为了兼容,在 Pagination 中添加了 selectCom…
- `LargeSelect`
- `MiddleSelect`
#### 依赖的 antd 能力
`Pagination`、`PaginationProps`、`Select`、`SelectProps`
#### 使用规则与行为
- 由于 antd 5.3.x 分页Pagination组件,存在点击分页选择框时,一直朝下 issues:https://github.com/ant-design/ant-design/issues/36866 为了兼容,在 Pagination 中添加了 selectComponentClass 属性,后期antd 官方优化了bug,可取消 配置selectComponentClass @param props @returns
- 由于 antd 5.3.x 分页Pagination组件,存在点击分页选择框框时,一直朝下 issues:https://github.com/ant-design/ant-design/issues/36866 为了兼容,在 Pagination 中添加了 selectComponentClass 属性,后期antd 官方优化了bug,可取消 配置selectComponentClass @param props @returns
#### 基础示例
```tsx
import { PaginationWrapper } from '@flatbiz/antd/pagination-wrapper';
;
```
#### 源码索引
- `src/pagination-wrapper/index.ts`
- `src/pagination-wrapper/pagination.tsx`
- `src/pagination-wrapper/select.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/pagination-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### pdf LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/pdf` 的使用方式。
#### 模块定位
pdf预览
#### 导入方式
```ts
import { Pdf } from '@flatbiz/antd/pdf';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `PdfDocument`
- `Pdf` - pdf预览
- `PdfPage`
#### 依赖的 antd 能力
`Result`、`Spin`
#### Props / 配置要点
##### CtxProps
- `getPdfInstance`(必填):: () => any
##### PdfProps
- `pdfUrl`(必填):: string
- `onLoadError`(可选):: (error: any) => void
- `onLoadSuccess`(可选):: (pdfInstance: any) => void
- `children`(必填):: ReactNode
- `error`(可选):: ReactElement | ((error) => ReactElement)
- `className`(可选):: string
##### PdfProps
- `onRenderSuccess`(可选):: (pageInstance: any, pdfInstance: any) => void
- `onRenderError`(可选):: (error: any, pdfInstance: any) => void
- `width`(可选):: number;pdf page宽度,高度根据比例适配
- `scale`(可选):: number;缩放比例,默认值:1,配置此参数后 width 属性失效,例如:1、0.6、0.8
- `gap`(可选):: number;pdf页面上下之间的间隙,默认值10
- `pageNumber`(必填):: number;页码
- `children`(可选):: ReactNode
- `onClick`(可选):: (e) => void
- `className`(可选):: string
- `style`(可选):: CSSProperties
#### 使用规则与行为
- pdf预览
- pdf page宽度,高度根据比例适配
- 缩放比例,默认值:1,配置此参数后 width 属性失效,例如:1、0.6、0.8
- pdf页面上下之间的间隙,默认值10
- 页码
#### 基础示例
```tsx
import { Pdf, type CtxProps } from '@flatbiz/antd/pdf';
const props: CtxProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/pdf/context.ts`
- `src/pdf/document.tsx`
- `src/pdf/index.ts`
- `src/pdf/page.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/pdf` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### pdf-preview LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/pdf-preview` 的使用方式。
#### 模块定位
pdf预览方式1
#### 导入方式
```ts
import { PdfPreview } from '@flatbiz/antd/pdf-preview';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./preview.jsx`
- `Navigation`
- `PdfPreview` - pdf预览方式1
- `PdfPreviewProps`
#### 依赖的 antd 能力
`Result`
#### Props / 配置要点
##### NavigationProps
- `numPages`(必填):: number
- `activeNumber`(必填):: number
- `onChangeActiveNumber`(必填):: (active: number) => void
- `scale`(可选):: number
- `navigationWidth`(可选):: number
- `pdfPageListHeightScope`(必填):: number[][]
- `pdfContentNodeId`(必填):: string
##### PdfPreviewProps
- `pdfUrl`(必填):: string
- `scale`(可选):: number;缩放比例,默认值:1
- `className`(可选):: string
- `navigationScale`(可选):: number;导航pdf,缩放比例,默认值:0.2
- `hiddenNavigation`(可选):: boolean;隐藏导航栏
- `navigationWidth`(可选):: number;导航栏宽度,默认值:200
#### 使用规则与行为
- 缩放比例,默认值:1
- 导航pdf,缩放比例,默认值:0.2
- 隐藏导航栏
- 导航栏宽度,默认值:200
- pdf预览方式1
- 计算 page 在文档流中的高度范围,包含竖直方向间距
#### 基础示例
```tsx
import { PdfPreview, type NavigationProps } from '@flatbiz/antd/pdf-preview';
const props: NavigationProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/pdf-preview/index.ts`
- `src/pdf-preview/navigation.tsx`
- `src/pdf-preview/preview.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/pdf-preview` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### pdf-preview2 LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/pdf-preview2` 的使用方式。
#### 模块定位
PDF预览方式2
#### 导入方式
```ts
import { PdfPreview2 } from '@flatbiz/antd/pdf-preview2';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./preview.jsx`
- `PdfPreview2` - PDF预览方式2
- `PdfPreview2Props`
#### Props / 配置要点
##### PdfPreview2Props
- `pdfUrl`(必填):: string
- `networkEnv`(可选):: 'inner' | 'outer';网络环境,inner/内网,outer/外网,默认inner
#### 使用规则与行为
- 网络环境,inner/内网,outer/外网,默认inner
- PDF预览方式2
#### 基础示例
```tsx
import { PdfPreview2, type PdfPreview2Props } from '@flatbiz/antd/pdf-preview2';
const props: PdfPreview2Props = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/pdf-preview2/index.ts`
- `src/pdf-preview2/preview.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/pdf-preview2` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### permission LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/permission` 的使用方式。
#### 模块定位
Permission:FlatBiz antd 扩展模块。
#### 导入方式
```ts
import { Permission } from '@flatbiz/antd/permission';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./permission.jsx`
- `Permission`
- `PermissionProps`
#### Props / 配置要点
##### PermissionProps
- `name`(可选):: string
- `children`(可选):: ReactNode | ReactNode[]
#### 基础示例
```tsx
import { Permission, type PermissionProps } from '@flatbiz/antd/permission';
const props: PermissionProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/permission/index.ts`
- `src/permission/permission.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/permission` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### pre-defined-class-name LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/pre-defined-class-name` 的使用方式。
#### 模块定位
预定义className
#### 导入方式
```ts
import { preDefinedClassName } from '@flatbiz/antd/pre-defined-class-name';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `formClassName` - 使用在Form组件上,预定义form-item label宽度
- `formItemClassName` - 使用在Form.Item组件上,预定义form-item label宽度
- `getFormLayoutClassName`
- `getFormItemLayoutClassName`
- `TFormLayoutPreClassNameProps`
- `TFormItemLayoutPreClassNameProps`
- `preDefinedClassName` - 预定义className
#### Props / 配置要点
##### TFormLayoutPreClassNameProps
- `labelWidth`(可选):: | 'auto' | '70' | '80' | '90' | '100' | '110' | '120' | '130' | '140' | '150' | '160' | '170' | '180' | '190' | '200';label宽度,Form内部所有FormItem label都生效
- `labelItemVertical`(可选):: boolean;labelItem 竖直布局
- `labelAlign`(可选):: 'left' | 'right';label 对齐方式
- `formItemGap`(可选):: '24' | '15' | '8' | '5' | '0';formItem之间竖直间距,默认值:24
- `className`(可选):: string;className 中可能会包含 preDefinedClassName.form.xx,优先级大于 labelWidth、labelItemVertical、labelAlign、formItemGap
##### TFormItemLayoutPreClassNameProps
- `labelWidth`(可选):: | 'auto' | '70' | '80' | '90' | '100' | '110' | '120' | '130' | '140' | '150' | '160' | '170' | '180' | '190' | '200';label宽度,Form内部所有FormItem label都生效
- `labelItemVertical`(可选):: boolean;labelItem 竖直布局
- `labelAlign`(可选):: 'left' | 'right';label 对齐方式
- `className`(可选):: string;className 中可能会包含 preDefinedClassName.formItem.xx,优先级大于 labelWidth、labelItemVertical、labelAlign
#### 使用规则与行为
- 使用在Form组件上,预定义form-item label宽度
- formItem之间的垂直间距为15
- formItem之间的垂直间距为8
- formItem之间的垂直间距为0
- 使用在Form.Item组件上,预定义form-item label宽度
- label宽度,Form内部所有FormItem label都生效
- labelItem 竖直布局
- label 对齐方式
- formItem之间竖直间距,默认值:24
- className 中可能会包含 preDefinedClassName.form.xx,优先级大于 labelWidth、labelItemVertical、labelAlign、formItemGap
#### 基础示例
```tsx
import { preDefinedClassName, type TFormLayoutPreClassNameProps } from '@flatbiz/antd/pre-defined-class-name';
const props: TFormLayoutPreClassNameProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/pre-defined-class-name/form/index.tsx`
- `src/pre-defined-class-name/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/pre-defined-class-name` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### preview-file-list LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/preview-file-list` 的使用方式。
#### 模块定位
正常列表:左侧缩略(图片可预览,非图片为文件图标);非图片整行点击下载。
#### 导入方式
```ts
import { PreviewFileList } from '@flatbiz/antd/preview-file-list';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./preview-file.jsx`
- `PreviewCard` - 正常列表:左侧缩略(图片可预览,非图片为文件图标);非图片整行点击下载。
- `PreviewCardProps`
- `PreviewCompact` - 紧凑模式:纵向窄行;图片行左侧为小眼睛(预览)、文件行左侧为下载图标; 点击图片行预览,点击文件行下载。
- `PreviewCompactProps`
- `downloadByUrl`
- `isImageUrl`
- `PreviewFileList`
- `FileListPreviewProps`
- `PreviewThumbnail` - 缩略:多块水平 Flex 排版、自动换行;仅展示缩略图或文件图标, 完整文件名通过 Tooltip 悬浮展示;悬停遮罩显示下载图标。
- `PreviewThumbnailProps`
#### 依赖的 antd 能力
`Image`、`Tag`、`Tooltip`、`Typography`
#### Props / 配置要点
##### FileImageThumbProps
- `previewUrl`(必填):: string
##### PreviewCardProps
- `imageList`(必填):: PreviewImageItem[]
##### PreviewCompactProps
- `imageList`(必填):: PreviewImageItem[]
##### FileListPreviewProps
- `imageList`(必填):: PreviewImageItem[]
- `imageSize`(可选):: number;图片大小,默认 50,viewType 为 thumbnail 时有效
- `viewType`(必填):: 'thumbnail' | 'card' | 'compact';card:卡片;thumbnail:缩略换行;compact:紧凑纵向列表,默认值为 card
##### ThumbnailImageBlockProps
- `previewUrl`(必填):: string
- `fileName`(可选):: string
- `imageSize`(必填):: number
- `imageList`(必填):: PreviewImageItem[]
##### PreviewThumbnailProps
- `list`(必填):: PreviewImageItem[]
- `imageSize`(可选):: number
#### 使用规则与行为
- 整块缩略区域(含 contain 留白)点击均可打开预览
- 正常列表:左侧缩略(图片可预览,非图片为文件图标);非图片整行点击下载。
- 紧凑模式:纵向窄行;图片行左侧为小眼睛(预览)、文件行左侧为下载图标; 点击图片行预览,点击文件行下载。
- 图片大小,默认 50,viewType 为 thumbnail 时有效
- card:卡片;thumbnail:缩略换行;compact:紧凑纵向列表,默认值为 card
- 缩略:图片 + 悬停遮罩与下载;点击图片区域预览,点下载图标下载
- 缩略:多块水平 Flex 排版、自动换行;仅展示缩略图或文件图标, 完整文件名通过 Tooltip 悬浮展示;悬停遮罩显示下载图标。
- 判断 url 是否为图片(与 click-event-render content 一致,支持带查询参数)
#### 基础示例
```tsx
import { PreviewFileList, type FileImageThumbProps } from '@flatbiz/antd/preview-file-list';
const props: FileImageThumbProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/preview-file-list/index.ts`
- `src/preview-file-list/preview-card.tsx`
- `src/preview-file-list/preview-compact.tsx`
- `src/preview-file-list/preview-file.tsx`
- `src/preview-file-list/preview-thumbnail.tsx`
- `src/preview-file-list/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/preview-file-list` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### radio-group-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/radio-group-wrapper` 的使用方式。
#### 模块定位
RadioGroupWrapper 为了解决 RadioGroup 组件不能取消选中问题
#### 导入方式
```ts
import { RadioGroupWrapper } from '@flatbiz/antd/radio-group-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./radio-group-wrapper.jsx`
- `RadioGroupWrapper` - RadioGroupWrapper 为了解决 RadioGroup 组件不能取消选中问题
- `RadioGroupWrapperValue`
- `RadioGroupWrapperOptionItem`
- `CustomRadioGroupProps`
#### 依赖的 antd 能力
`Radio`、`Space`
#### Props / 配置要点
##### RadioGroupWrapperOptionItem
- `label`(必填):: string | ReactElement
- `value`(必填):: RadioGroupWrapperValue
- `disabled`(可选):: boolean
##### CustomRadioGroupProps
- `value`(可选):: RadioGroupWrapperValue
- `onChange`(可选):: (value?: RadioGroupWrapperValue) => void
- `onPreChange`(可选):: (value?: RadioGroupWrapperValue) => Promise
- `options`(必填):: RadioGroupWrapperOptionItem[]
- `isCancel`(可选):: boolean;是否可取消选中,默认:false
- `disabled`(可选):: boolean
- `direction`(可选):: 'horizontal' | 'vertical';方向,默认值 horizontal
#### 使用规则与行为
- 是否可取消选中,默认:false
- 方向,默认值 horizontal
- RadioGroupWrapper 为了解决 RadioGroup 组件不能取消选中问题 @param props @returns
#### 基础示例
```tsx
import { RadioGroupWrapper, type CustomRadioGroupProps } from '@flatbiz/antd/radio-group-wrapper';
const props: CustomRadioGroupProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/radio-group-wrapper/index.ts`
- `src/radio-group-wrapper/radio-group-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/radio-group-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### relation-tree LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/relation-tree` 的使用方式。
#### 模块定位
左侧Tag+线占用宽度
#### 导入方式
```ts
import { RelationTree } from '@flatbiz/antd/relation-tree';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `RelationGroupList`
- `RelationGroupListProps`
- `RelationItem`
- `RelationItemProps`
- `Relation`
- `* from ./relation-tree.jsx`
- `* from ./type.js`
- `RelationTree`
- `RelationProps`
- `RelationTreeProps`
- `TRelationTreeCustomData`
- `TRelationTreeRelationItem`
- `TRelationTreeData`
- `TRelationTreeOperate`
- `deleteLoop`
- `filterSurplusData`
#### 依赖的 antd 能力
`Empty`、`Form`、`Tag`
#### Props / 配置要点
##### RelationGroupListProps
- `children`(必填):: ReactElement | ReactElement[] | null
- `className`(可选):: string
##### RelationItemProps
- `children`(必填):: ReactElement | null | Array
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `isFirst`(可选):: boolean
- `isLast`(可选):: boolean
- `onlyOne`(可选):: boolean
##### RelationItemRenderProps
- `relationItem`(必填):: TRelationTreeRelationItem
- `index`(必填):: number
- `onlyOne`(可选):: boolean
##### RelationProps
- `tagLineWidth`(可选):: number;左侧Tag+线占用宽度
- `indentWidth`(可选):: number;缩进宽度,配合【RelationGroup】使用
- `tagName`(可选):: string;连接线上Tag文案
- `tagColor`(可选):: string;连接线上Tag颜色
- `tagWidth`(可选):: number;连接线上Tag宽度
- `onTagClick`(可选):: (tagName?: string) => void;连接线上Tag点击事件
- `lineColor`(可选):: string;连接线颜色
- `solt1`(必填):: () => ReactElement
- `solt2`(可选):: () => ReactElement | null
- `className`(可选):: string
- `onlyOne`(可选):: boolean
- `onlyNoMainOne`(可选):: boolean
- `label`(可选):: string
##### RelationTreeProps
- `className`(可选):: string
- `dataSource`(可选):: TRelationTreeData
- `children`(可选):: ( data: TRelationTreeCustomData, operate: TRelationTreeOperate, extraData?: TPlainObject ) => ReactElement
- `onChange`(可选):: (dataSource?: TRelationTreeData) => void
- `relationProps`(可选):: Pick< RelationProps, 'tagLineWidth' | 'indentWidth' | 'tagColor' | 'tagWidth' | 'lineColor' >
- `onTagClick`(可选):: (uid: string, extraData?: TPlainObject) => void
##### TRelationTreeCustomData
- `uid`(必填):: string
##### TRelationTreeRelationItem
- `uid`(必填):: string
- `customData`(可选):: TRelationTreeCustomData
- `children`(可选):: TRelationTreeData[]
- `extraData`(可选):: TPlainObject
##### TRelationTreeData
- `uid`(必填):: string
- `tagName`(必填):: string
- `label`(可选):: string
- `relationList`(必填):: TRelationTreeRelationItem[]
- `extraData`(可选):: TPlainObject
#### 使用规则与行为
- 左侧Tag+线占用宽度
- 缩进宽度,配合【RelationGroup】使用
- 连接线上Tag文案
- 连接线上Tag颜色
- 连接线上Tag宽度
- 连接线上Tag点击事件
- 连接线颜色
#### 基础示例
```tsx
import { RelationTree, type RelationGroupListProps } from '@flatbiz/antd/relation-tree';
const props: RelationGroupListProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/relation-tree/compts/relation-group-list.tsx`
- `src/relation-tree/compts/relation-item.tsx`
- `src/relation-tree/compts/relation.tsx`
- `src/relation-tree/index.ts`
- `src/relation-tree/relation-tree.tsx`
- `src/relation-tree/type.ts`
- `src/relation-tree/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/relation-tree` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### request-status LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/request-status` 的使用方式。
#### 模块定位
RequestStatus:基于 antd 的 Empty、Spin 封装。
#### 导入方式
```ts
import { RequestStatus } from '@flatbiz/antd/request-status';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./request-status.jsx`
- `RequestStatus`
- `TRequestStatus`
- `TRequestStatusProps`
#### 依赖的 antd 能力
`Empty`、`Spin`
#### Props / 配置要点
##### TRequestStatusProps
- `status`(可选):: TRequestStatus
- `errorButton`(可选):: ReactElement
- `messageConfig`(可选):: Partial>
- `loading`(可选):: boolean
#### 基础示例
```tsx
import { RequestStatus, type TRequestStatusProps } from '@flatbiz/antd/request-status';
const props: TRequestStatusProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/request-status/index.ts`
- `src/request-status/request-status.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/request-status` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### resizable-drawer LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/resizable-drawer` 的使用方式。
#### 模块定位
最小宽度,默认值:400
#### 导入方式
```ts
import { ResizableDrawer } from '@flatbiz/antd/resizable-drawer';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `ResizableDrawer`
- `* from ./drawer.jsx`
- `ResizeHandle`
- `getZindex`
#### 依赖的 antd 能力
`Button`、`Space`
#### Props / 配置要点
##### ResizableDrawerProps
- `open`(可选):: boolean
- `onClose`(可选):: () => void
- `title`(可选):: ReactNode
- `width`(可选):: number
- `children`(可选):: ReactNode
- `footer`(可选):: ReactNode | null
- `hidenFooter`(可选):: boolean
- `maskClosable`(可选):: boolean
- `mask`(可选):: boolean
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `styles`(可选):: { header?: CSSProperties; body?: CSSProperties; footer?: CSSProperties; }
- `headerExtraRender`(可选):: ReactElement
- `zIndex`(可选):: number
- `onOk`(可选):: (e: React.MouseEvent) => void | Promise
- `cancelText`(可选):: string
- `okText`(可选):: string
- `minConstraints`(可选):: [number, number];最小宽度,默认值:400
- `maxConstraints`(可选):: [number, number];最大宽度,默认值:1200
#### 使用规则与行为
- 最小宽度,默认值:400
- 最大宽度,默认值:1200
#### 基础示例
```tsx
import { ResizableDrawer, type ResizableDrawerProps } from '@flatbiz/antd/resizable-drawer';
const props: ResizableDrawerProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/resizable-drawer/drawer.tsx`
- `src/resizable-drawer/index.ts`
- `src/resizable-drawer/resize-handle/index.tsx`
- `src/resizable-drawer/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/resizable-drawer` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### rich-text-editor LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/rich-text-editor` 的使用方式。
#### 模块定位
富文本编辑器,配置参考tinymce https://www.tiny.cloud/docs/tinymce/6
#### 导入方式
```ts
import { RichTextEditor } from '@flatbiz/antd/rich-text-editor';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./rich-text-editor.jsx`
- `* from ./preview.jsx`
- `Preview`
- `RichTextEditor` - 富文本编辑器,配置参考tinymce https://www.tiny.cloud/docs/tinymce/6
- `RichTextEditorProps`
- `editorTemplates`
- `defaultVarStyle`
- `varStyles`
#### 依赖的 antd 能力
`Image`、`message`
#### Props / 配置要点
##### RichTextEditorProps
- `height`(可选):: number;设置高度,默认:500
- `onChange`(可选):: (data?: string) => void
- `onUploadImage`(可选):: (file: File) => Promise;上传图片服务
- `imgPreview`(可选):: boolean;图片点击预览
- `init`(可选):: IAllProps['init'] & { img_ratio?: { min: number; max?: number; ratio: number }[]; paste_text_limit?: { limit: number; message: string; }; plugins_append?: st…;通过粘贴图片创建的img标签,显示压缩比例,此处min、max是和指图片宽度
- `onFullScreenChange`(可选):: (state?: boolean) => void;点击全屏按钮回调
- `className`(可选):: string
#### 使用规则与行为
- 设置高度,默认:500
- 上传图片服务
- 图片点击预览
- 通过粘贴图片创建的img标签,显示压缩比例,此处min、max是和指图片宽度
- 粘贴文本大小限制
- 插件添加;自定义plugins后失效
- 工具栏添加;自定义toolbar后失效
- 点击全屏按钮回调
- 富文本编辑器,配置参考tinymce https://www.tiny.cloud/docs/tinymce/6 @param props @returns
#### 基础示例
```tsx
import { RichTextEditor, type RichTextEditorProps } from '@flatbiz/antd/rich-text-editor';
const props: RichTextEditorProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/rich-text-editor/index.ts`
- `src/rich-text-editor/preview/index.ts`
- `src/rich-text-editor/preview/preview.tsx`
- `src/rich-text-editor/rich-text-editor.tsx`
- `src/rich-text-editor/template.ts`
- `src/rich-text-editor/types.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/rich-text-editor` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### rich-text-viewer LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/rich-text-viewer` 的使用方式。
#### 模块定位
预览 RichTextEditor 生成的富文本数据
#### 导入方式
```ts
import { RichTextViewer } from '@flatbiz/antd/rich-text-viewer';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./rich-text-viewer.jsx`
- `RichTextViewer` - 预览 RichTextEditor 生成的富文本数据
#### Props / 配置要点
##### RichTextViewerProps
- `value`(必填):: string
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `fullscreen`(可选):: boolean
- `onInit`(可选):: (editor: TinyMCEEditor) => void
- `children`(可选):: ReactElement
- `fullscreenIconTips`(可选):: string
#### 使用规则与行为
- 预览 RichTextEditor 生成的富文本数据 @param props @returns
#### 基础示例
```tsx
import { RichTextViewer, type RichTextViewerProps } from '@flatbiz/antd/rich-text-viewer';
const props: RichTextViewerProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/rich-text-viewer/index.ts`
- `src/rich-text-viewer/rich-text-viewer.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/rich-text-viewer` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### roll-location-center LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/roll-location-center` 的使用方式。
#### 模块定位
RollLocationCenter:FlatBiz antd 扩展模块。
#### 导入方式
```ts
import { RollLocationCenter } from '@flatbiz/antd/roll-location-center';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `RollLocationCenter`
- `RollLocationCenterProps`
- `* from ./center.jsx`
#### Props / 配置要点
##### RollLocationCenterProps
- `renderList`(必填):: { activeKey: string; render: ReactElement }[]
- `activeKey`(可选):: string
- `behavior`(可选):: ScrollBehavior
- `direction`(可选):: 'horizontal' | 'vertical'
- `style`(可选):: CSSProperties
- `className`(可选):: string
#### 基础示例
```tsx
import { RollLocationCenter, type RollLocationCenterProps } from '@flatbiz/antd/roll-location-center';
const props: RollLocationCenterProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/roll-location-center/center.tsx`
- `src/roll-location-center/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/roll-location-center` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### roll-location-in-view LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/roll-location-in-view` 的使用方式。
#### 模块定位
RollLocationInView:FlatBiz antd 扩展模块。
#### 导入方式
```ts
import { RollLocationInView } from '@flatbiz/antd/roll-location-in-view';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `RollLocationInView`
- `RollLocationInViewProps`
- `* from ./in-view.jsx`
#### Props / 配置要点
##### RollLocationInViewProps
- `renderList`(必填):: { activeKey: string; render: ReactElement }[]
- `activeKey`(可选):: string
- `behavior`(可选):: ScrollBehavior
- `direction`(可选):: 'horizontal' | 'vertical'
- `style`(可选):: CSSProperties
- `className`(可选):: string
#### 基础示例
```tsx
import { RollLocationInView, type RollLocationInViewProps } from '@flatbiz/antd/roll-location-in-view';
const props: RollLocationInViewProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/roll-location-in-view/in-view.tsx`
- `src/roll-location-in-view/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/roll-location-in-view` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### rule-describe LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/rule-describe` 的使用方式。
#### 模块定位
RuleDescribe:FlatBiz antd 扩展模块。
#### 导入方式
```ts
import { RuleDescribe } from '@flatbiz/antd/rule-describe';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./rule-describe.jsx`
- `RuleDescribe`
- `RuleDataItem`
- `RuleDescribeProps`
#### Props / 配置要点
##### RuleDataItem
- `title`(可选):: string | ReactElement
- `desc`(可选):: string | ReactElement
##### RuleDescribeProps
- `title`(可选):: string
- `showTitleIndex`(可选):: boolean
- `ruleDataList`(必填):: RuleDataItem[]
- `titleSign`(可选):: boolean
- `className`(可选):: string
- `ruleItemTitleStyle`(可选):: CSSProperties
- `ruleItemDescStyle`(可选):: CSSProperties
- `ruleItemStyle`(可选):: CSSProperties
#### 基础示例
```tsx
import { RuleDescribe, type RuleDescribeProps } from '@flatbiz/antd/rule-describe';
const props: RuleDescribeProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/rule-describe/index.ts`
- `src/rule-describe/rule-describe.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/rule-describe` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### search-menu LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/search-menu` 的使用方式。
#### 模块定位
列表搜索
#### 导入方式
```ts
import { SearchMenu } from '@flatbiz/antd/search-menu';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./search-menu.jsx`
- `ListView` - 搜索列表
- `IListViewProps`
- `SearchMenu` - 列表搜索
- `ISearchMenuProps`
- `IListViewItem`
#### 依赖的 antd 能力
`Empty`
#### Props / 配置要点
##### IListViewProps
- `dataList`(必填):: IListViewItem[]
- `value`(可选):: string
- `onChange`(可选):: (key: string, item: IListViewItem) => void
- `style`(可选):: CSSProperties
- `emptyView`(可选):: ReactElement;自定义空数据提示
##### ISearchMenuProps
- `size`(可选):: 'small' | 'default'
- `value`(可选):: string;如果传了value,就变成受控组件 目前只支持单选
- `onChange`(可选):: (key: string, targetItem?: TPlainObject) => void
- `dataSource`(必填):: TPlainObject[];树型源数据
- `lazySearch`(可选):: boolean;惰性搜索
- `searchKeyList`(可选):: string[];搜索目标字段
- `fieldNames`(可选):: { label?: string; key?: string; };格式化参数
- `renderItem`(可选):: (nodeData: TPlainObject) => ReactElement;自定义渲染条目
- `inputProps`(可选):: InputSearchWrapperProps;搜索框参数
- `searchExtraElement`(可选):: ReactElement;搜索位置额外元素
- `placeholder`(可选):: string
- `className`(可选):: string
- `wrapStyle`(可选):: CSSProperties
- `style`(可选):: CSSProperties
- `searchStyle`(可选):: CSSProperties
- `searchAutoFocus`(可选):: boolean;搜索框自动聚焦
- `showSearch`(可选):: boolean;是否显示搜索区域
##### IListViewItem
- `label`(必填):: ReactNode
- `key`(必填):: string
#### 使用规则与行为
- 自定义空数据提示
- 搜索列表 @param props @returns search menu list view
- 列表搜索 @param props @returns
- 格式化对象
- 可搜索的字段值
- 生成菜单列表
- 数据格式化
- 搜索
- 搜索词变换 @param e
- 点击条目
#### 基础示例
```tsx
import { SearchMenu, type IListViewProps } from '@flatbiz/antd/search-menu';
const props: IListViewProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/search-menu/index.ts`
- `src/search-menu/list-view/index.tsx`
- `src/search-menu/search-menu.tsx`
- `src/search-menu/type.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/search-menu` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### selector-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/selector-wrapper` 的使用方式。
#### 模块定位
选择器包装组件
#### 导入方式
```ts
import { SelectorWrapper } from '@flatbiz/antd/selector-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./selector-wrapper.jsx`
- `RefreshIcon`
- `SelectorWrapper` - 选择器包装组件
- `* from ./types.js`
- `SelectorWrapperValue`
- `SelectorServiceConfig`
- `SelectorWrapperProps`
- `useRequest`
- `getVauleList` - value存在两种格式 1. string | number; 2. labelInValue 格式
#### 依赖的 antd 能力
`Button`、`Select`、`SelectProps`
#### Props / 配置要点
##### SelectorServiceConfig
- `params`(可选):: TPlainObject
- `requiredParamsKeys`(可选):: string[];与 params 配合使用
- `onRequest`(可选):: (params?: TAny) => Promise
- `onRequestResultAdapter`(可选):: (respData: TAny) => TPlainObject[];响应数据适配器
##### SelectorWrapperProps
#### 使用规则与行为
- 选择器包装组件
- 与 params 配合使用
- 响应数据适配器
- 不支持 tags 模式,tags模式请使用 SelectorWrapperSimple 组件
- 设置请求唯一值
- 参数Key映射
- 请求服务需求的数据
- 同步设置选择器选项列表
- select 数据源发生变更时触发,第一次不调用
- select 数据源发生变更时触发,每次都会调用
#### 默认值线索
- `useCache => true`
#### 基础示例
```tsx
import { SelectorWrapper, type SelectorWrapperProps } from '@flatbiz/antd/selector-wrapper';
const props: SelectorWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/selector-wrapper/index.ts`
- `src/selector-wrapper/refresh-icon.tsx`
- `src/selector-wrapper/selector-wrapper.tsx`
- `src/selector-wrapper/types.ts`
- `src/selector-wrapper/use-request.ts`
- `src/selector-wrapper/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/selector-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### selector-wrapper-search LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/selector-wrapper-search` 的使用方式。
#### 模块定位
选择器简单包装组件
#### 导入方式
```ts
import { SelectorWrapperSearch } from '@flatbiz/antd/selector-wrapper-search';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./selector-wrapper-search.jsx`
- `SelectorWrapperSearch` - 选择器简单包装组件
- `SelectorWrapperSearchServiceConfig`
- `SelectorWrapperSearchProps`
#### 依赖的 antd 能力
`Button`、`Select`、`SelectProps`
#### Props / 配置要点
##### SelectorWrapperSearchServiceConfig
- `params`(可选):: TPlainObject
- `onRequest`(可选):: (params?: TAny) => TAny
- `requiredParamsKeys`(可选):: string[];与 params 配合使用
- `onRequestResultAdapter`(可选):: (respData: TAny) => TPlainObject[]
##### SelectorWrapperSearchProps
- `fieldNames`(可选):: { label: string; value: string; disabled?: string; searchKeyword?: string; list?: string; };参数Key映射
- `serviceConfig`(必填):: SelectorWrapperSearchServiceConfig;请求服务需求的数据
- `showAllOption`(可选):: true | TPlainObject;添加全部选项
- `onSelectorListChange`(可选):: (dataList: TPlainObject[]) => void;selectorList发生变更时触发,每次都会调用
- `onSelectorRequestError`(可选):: (error: Error) => void;通过服务获取数据异常回调
- `requestMessageConfig`(可选):: TRequestStatusProps['messageConfig'];交互文案配置
- `onLabelRenderAdapter`(可选):: (dataItem: TPlainObject) => string | ReactElement;label渲染适配器
#### 使用规则与行为
- 与 params 配合使用
- 参数Key映射
- 请求服务需求的数据
- 添加全部选项
- selectorList发生变更时触发,每次都会调用
- 通过服务获取数据异常回调
- 交互文案配置
- label渲染适配器
- 自定义keyword值,
- 选择器简单包装组件 @param props @returns
#### 基础示例
```tsx
import { SelectorWrapperSearch, type SelectorWrapperSearchProps } from '@flatbiz/antd/selector-wrapper-search';
const props: SelectorWrapperSearchProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/selector-wrapper-search/index.ts`
- `src/selector-wrapper-search/selector-wrapper-search.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/selector-wrapper-search` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### selector-wrapper-simple LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/selector-wrapper-simple` 的使用方式。
#### 模块定位
选择器简单包装组件
#### 导入方式
```ts
import { SelectorWrapperSimple } from '@flatbiz/antd/selector-wrapper-simple';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./selector-wrapper-simple.jsx`
- `SelectorWrapperSimple` - 选择器简单包装组件
- `SelectorWrapperSimpleServiceConfig`
- `SelectorWrapperSimpleProps`
#### 依赖的 antd 能力
`Button`、`Select`、`SelectProps`
#### Props / 配置要点
##### SelectorWrapperSimpleServiceConfig
- `params`(可选):: TPlainObject
- `onRequest`(可选):: (params?: TAny) => TAny
- `onRequestResultAdapter`(可选):: (respData: TAny) => TPlainObject[]
##### SelectorWrapperSimpleProps
- `fieldNames`(可选):: { label: string; value: string; disabled?: string; list?: string; };参数Key映射
- `serviceConfig`(必填):: SelectorWrapperSimpleServiceConfig;请求服务需求的数据
- `showAllOption`(可选):: true | TPlainObject;添加全部选项
- `onSelectorListChange`(可选):: (dataList: TPlainObject[]) => void;selectorList发生变更时触发,每次都会调用
- `onSelectorRequestError`(可选):: (error: Error) => void;通过服务获取数据异常回调
- `requestMessageConfig`(可选):: TRequestStatusProps['messageConfig']
#### 使用规则与行为
- 参数Key映射
- 请求服务需求的数据
- 添加全部选项
- selectorList发生变更时触发,每次都会调用
- 通过服务获取数据异常回调
- 选择器简单包装组件 @param props @returns
#### 基础示例
```tsx
import { SelectorWrapperSimple, type SelectorWrapperSimpleProps } from '@flatbiz/antd/selector-wrapper-simple';
const props: SelectorWrapperSimpleProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/selector-wrapper-simple/index.ts`
- `src/selector-wrapper-simple/selector-wrapper-simple.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/selector-wrapper-simple` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### sms-count-down LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/sms-count-down` 的使用方式。
#### 模块定位
短信验证码倒计时组件
#### 导入方式
```ts
import { SmsCountDown } from '@flatbiz/antd/sms-count-down';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./sms-count-down.jsx`
- `SmsCountDown` - 短信验证码倒计时组件
- `SmsCountDownProps` - 短信倒计时组件的属性接口 @extends Omit, 'onClick'> - 继承 div 元素的所有 HTML 属性,但排除 onClick(组件内部处理点击事件)
- `SmsCountDownRefApi` - 短信倒计时组件的 Ref API 接口 @description 通过 ref 可以访问组件内部的方法,用于外部程序化控制组件行为
#### Props / 配置要点
##### SmsCountDownProps
短信倒计时组件的属性接口 @extends Omit, 'onClick'> - 继承 div 元素的所有 HTML 属性,但排除 onClick(组件内部处理点击事件)
- `onSendRequest`(必填):: () => Promise;验证码发送请求函数 @returns Promise - 返回 Promise,成功时开始倒计时,失败时恢复初始状态 @description 当用户点击发送按钮时调用此函数,函数执行成功后会自动开始倒计时
- `totalTicks`(可选):: number;倒计时总时长(单位:秒) @default 60 @description 从开始倒计时到结束的总秒数,例如 60 表示倒计时 60 秒
- `duration`(可选):: number;倒计时更新间隔(单位:毫秒) @default 1000 @description 倒计时数值更新的频率,1000 表示每秒更新一次
- `autoStart`(可选):: boolean;是否自动开始倒计时 @default false @description - true: 组件挂载后自动开始倒计时(不会调用 onSendRequest) - false: 需要用户点击才会触发发送和倒计时 @note 自动开始时不会调用 onSendRequest,仅用于显示倒计时状态
- `sendTxt`(可选):: string;初始状态文案(未发送时显示) @default '获取验证码' @description 组件初始状态或倒计时结束后显示的文本
- `sentTxt`(可选):: string;倒计时完成后的文案 @default '重新获取' @description 倒计时结束后显示的文本,提示用户可以重新发送
- `processingTxt`(可选):: string;发送中状态文案 @default '发送中...' @description 点击发送按钮后,等待 onSendRequest 执行完成期间显示的文本
- `onTick`(可选):: (time: number) => void;倒计时数值变化时的回调函数 @param time - 当前剩余的秒数 @description 每次倒计时更新时都会调用此函数,可用于外部监听倒计时状态
#### 使用规则与行为
- 短信验证码倒计时组件 功能说明: - 提供短信验证码发送的倒计时功能 - 支持自定义倒计时时长、格式化文本、状态文案等 - 支持自动开始倒计时(不触发发送请求) - 支持通过 ref 手动触发发送 - 使用 ahooks 的 useCountDown 实现倒计时逻辑 使用场景: - 登录、注册、找回密码等需要发送短信验证码的场景 - 需要防止频繁点击发送验证码的场景
- 短信倒计时组件的属性接口 @extends Omit, 'onClick'> - 继承 div 元素的所有 HTML 属性,但排除 onClick(组件内部处理点击事件)
- 验证码发送请求函数 @returns Promise - 返回 Promise,成功时开始倒计时,失败时恢复初始状态 @description 当用户点击发送按钮时调用此函数,函数执行成功后会自动开始倒计时
- 倒计时总时长(单位:秒) @default 60 @description 从开始倒计时到结束的总秒数,例如 60 表示倒计时 60 秒
- 倒计时更新间隔(单位:毫秒) @default 1000 @description 倒计时数值更新的频率,1000 表示每秒更新一次
- 是否自动开始倒计时 @default false @description - true: 组件挂载后自动开始倒计时(不会调用 onSendRequest) - false: 需要用户点击才会触发发送和倒计时 @note 自动开始时不会调用 onSendRequest,仅用于显示倒计时状态
- 倒计时文本格式化模板 @default '{t}s' @description 使用 {t} 作为占位符,会被替换为剩余秒数 @example '{t}s' => '60s', '{t}秒后重试' => '60秒后重试'
- 初始状态文案(未发送时显示) @default '获取验证码' @description 组件初始状态或倒计时结束后显示的文本
- 倒计时完成后的文案 @default '重新获取' @description 倒计时结束后显示的文本,提示用户可以重新发送
- 发送中状态文案 @default '发送中...' @description 点击发送按钮后,等待 onSendRequest 执行完成期间显示的文本
#### 基础示例
```tsx
import { SmsCountDown, type SmsCountDownProps } from '@flatbiz/antd/sms-count-down';
const props: SmsCountDownProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/sms-count-down/index.ts`
- `src/sms-count-down/sms-count-down.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/sms-count-down` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### split-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/split-wrapper` 的使用方式。
#### 模块定位
分屏可拖动组件
#### 导入方式
```ts
import { SplitWrapper } from '@flatbiz/antd/split-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./split.jsx`
- `SplitWrapper` - 分屏可拖动组件
#### Props / 配置要点
##### SplitWrapperProps
- `panelStyle`(可选):: CSSProperties
#### 使用规则与行为
- 分屏可拖动组件
#### 基础示例
```tsx
import { SplitWrapper, type SplitWrapperProps } from '@flatbiz/antd/split-wrapper';
const props: SplitWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/split-wrapper/index.ts`
- `src/split-wrapper/split.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/split-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### styles LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/styles` 的使用方式。
#### 模块定位
Styles:FlatBiz antd 扩展模块。
#### 导入方式
```ts
import { styles } from '@flatbiz/antd/styles';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `styles`
#### 基础示例
```tsx
import { styles } from '@flatbiz/antd/styles';
;
```
#### 源码索引
- `src/styles/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/styles` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### svg-http-view LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/svg-http-view` 的使用方式。
#### 模块定位
http svg地址解析,可自定义颜色
#### 导入方式
```ts
import { SvgHttpView } from '@flatbiz/antd/svg-http-view';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./svg.jsx`
- `SvgHttpView` - http svg地址解析,可自定义颜色
- `SvgHttpViewProps`
#### Props / 配置要点
##### SvgHttpViewProps
- `svgPath`(必填):: string;svg地址
- `width`(可选):: number;默认:20px
- `height`(可选):: number;默认:20px
- `color`(可选):: string;svg 颜色, 默认:#555
- `onClick`(可选):: (e) => void
- `className`(可选):: string
- `style`(可选):: CSSProperties
#### 使用规则与行为
- svg地址
- 默认:20px
- svg 颜色, 默认:#555
- http svg地址解析,可自定义颜色
#### 基础示例
```tsx
import { SvgHttpView, type SvgHttpViewProps } from '@flatbiz/antd/svg-http-view';
const props: SvgHttpViewProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/svg-http-view/index.ts`
- `src/svg-http-view/svg.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/svg-http-view` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### switch-confirm-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/switch-confirm-wrapper` 的使用方式。
#### 模块定位
@description switch 切换时做二次pop提醒, 非可控组件【内部控制】 close:switch 由开启转换成关闭时pop弹出 open:switch 由开启转换成开启时pop弹出 all:switch 一直pop none:switch 不弹出 @field onRequest 请求函数 @field message message配置 success defaultError
#### 导入方式
```ts
import { SwitchConfirmWrapper } from '@flatbiz/antd/switch-confirm-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./switch-confirm-wrapper.jsx`
- `SwitchConfirmWrapper` - @description switch 切换时做二次pop提醒, 非可控组件【内部控制】 close:switch 由开启转换成关闭时pop弹出 open:switch 由开启转换成开启时pop弹出 all:switch 一直pop none:switch 不弹出 @field…
- `SwitchConfirmWrapperValue`
- `SwitchConfirmWrapperProps`
#### 依赖的 antd 能力
`message`、`Popconfirm`、`PopconfirmProps`、`Switch`、`SwitchProps`
#### Props / 配置要点
##### SwitchConfirmWrapperProps
- `value`(可选):: SwitchConfirmWrapperValue
- `checkedValue`(必填):: SwitchConfirmWrapperValue
- `unCheckedValue`(必填):: SwitchConfirmWrapperValue
- `needConfirm`(可选):: 'close' | 'open' | 'all' | 'none'
- `noMessage`(可选):: boolean
- `onChange`(可选):: (value: SwitchConfirmWrapperValue) => void
- `popConfirmProps`(可选):: | Pick | (( checked?: boolean ) => Pick)
- `serviceConfig`(可选):: { onRequest: (value: SwitchConfirmWrapperValue) => TAny; message?: { success?: string; defaultError?: string; }; }
#### 基础示例
```tsx
import { SwitchConfirmWrapper, type SwitchConfirmWrapperProps } from '@flatbiz/antd/switch-confirm-wrapper';
const props: SwitchConfirmWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/switch-confirm-wrapper/index.ts`
- `src/switch-confirm-wrapper/switch-confirm-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/switch-confirm-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### switch-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/switch-wrapper` 的使用方式。
#### 模块定位
解决Switch只能接收boolean的限制,与Form.Item结合使用最佳
#### 导入方式
```ts
import { SwitchWrapper } from '@flatbiz/antd/switch-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./switch-wrapper.jsx`
- `SwitchWrapper` - 解决Switch只能接收boolean的限制,与Form.Item结合使用最佳
- `SwitchWrapperValue`
- `SwitchWrapperProps`
#### 依赖的 antd 能力
`message`、`Switch`、`SwitchProps`、`Tooltip`、`TooltipProps`
#### Props / 配置要点
##### SwitchWrapperProps
- `value`(可选):: SwitchWrapperValue
- `checkedValue`(必填):: SwitchWrapperValue
- `unCheckedValue`(必填):: SwitchWrapperValue
- `onChange`(可选):: (value: SwitchWrapperValue) => void
- `tooltipProps`(可选):: Omit
- `tooltipTitle`(可选):: string | ((value?: SwitchWrapperValue) => string | undefined)
- `serviceConfig`(可选):: { onRequest: (value: SwitchWrapperValue) => TAny; message?: { success?: string; defaultError?: string; }; }
#### 使用规则与行为
- 解决Switch只能接收boolean的限制,与Form.Item结合使用最佳
#### 基础示例
```tsx
import { SwitchWrapper, type SwitchWrapperProps } from '@flatbiz/antd/switch-wrapper';
const props: SwitchWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/switch-wrapper/index.ts`
- `src/switch-wrapper/switch-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/switch-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### table-cell-render LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/table-cell-render` 的使用方式。
#### 模块定位
table 索引展示,如果存在pageSize、pageNo参数可分页展示索引,否则每页都从1开始 @param pageSize @param pageNo @returns
#### 导入方式
```ts
import { tableCellRender } from '@flatbiz/antd/table-cell-render';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `tableCellRender`
- `* from ./cell-render.jsx`
#### 依赖的 antd 能力
`Badge`、`Space`、`Tooltip`
#### Props / 配置要点
##### TableColumnIconRenderProps
- `extra`(必填):: ReactElement;额外内容,一般为Icon
- `extraPosition`(可选):: 'before' | 'after'
- `onClick`(可选):: (e) => void
- `showData`(可选):: boolean;是否显示原单元格数据,默认值:true
- `notOverflowShowExtra`(可选):: boolean;未溢出显示【extra】配置,默认值:true
#### 使用规则与行为
- table 索引展示,如果存在pageSize、pageNo参数可分页展示索引,否则每页都从1开始 @param pageSize @param pageNo @returns
- 最大显示Tag数量,超出折叠隐藏
- 触发maxShowCount后,被折叠的内容是否显示完整tag,默认值:false
- 未匹配到color时,是否显示Tag效果,默认值:true
- 是否显示分隔符,默认值:false
- 隐藏背景颜色, 默认值:true
- 隐藏背景颜色,默认:false
- 移除小数点后末尾零
- 额外内容,一般为Icon
- 是否显示原单元格数据,默认值:true
#### 默认值线索
- `showMaxNumber => 10`
#### 基础示例
```tsx
import { tableCellRender, type TableColumnIconRenderProps } from '@flatbiz/antd/table-cell-render';
const props: TableColumnIconRenderProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/table-cell-render/cell-render.tsx`
- `src/table-cell-render/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/table-cell-render` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### table-scrollbar LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/table-scrollbar` 的使用方式。
#### 模块定位
表格x轴浮动滚动条
#### 导入方式
```ts
import { TableScrollbar } from '@flatbiz/antd/table-scrollbar';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./table-scrollbar.jsx`
- `TableScrollbar` - 表格x轴浮动滚动条
#### 依赖的 antd 能力
`Affix`
#### Props / 配置要点
##### TableScrollProps
- `children`(必填):: ReactNode
- `target`(可选):: HTMLElement;y轴的滚动条
##### ScrollbarSummaryProps
- `target`(可选):: HTMLElement
#### 使用规则与行为
- y轴的滚动条
- 表格x轴浮动滚动条
#### 基础示例
```tsx
import { TableScrollbar, type TableScrollProps } from '@flatbiz/antd/table-scrollbar';
const props: TableScrollProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/table-scrollbar/index.ts`
- `src/table-scrollbar/table-scrollbar.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/table-scrollbar` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tabs-sticky LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tabs-sticky` 的使用方式。
#### 模块定位
Tabs吸顶组件
#### 导入方式
```ts
import { TabsSticky } from '@flatbiz/antd/tabs-sticky';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./tabs.jsx`
- `TabsSticky` - Tabs吸顶组件
- `TabsStickyProps`
#### 依赖的 antd 能力
`Affix`、`Tabs`
#### Props / 配置要点
##### TabsType
- 声明:`type TabsType = GetProps;`
##### TabsStickyProps
- `tabsProps`(必填):: Omit
- `headerRender`(可选):: ReactElement;tabs头部布局
- `clickTabToTop`(可选):: boolean;点击tabItem后,tab跳到顶部吸顶效果;默认值true
- `tabItemContentWrapperStyle`(可选):: (key: string) => CSSProperties;设置tabItem 内容包裹元素的样式
#### 使用规则与行为
- tabs头部布局
- 点击tabItem后,tab跳到顶部吸顶效果;默认值true
- 设置tabItem 内容包裹元素的样式
- Tabs吸顶组件
#### 基础示例
```tsx
import { TabsSticky, type TabsStickyProps } from '@flatbiz/antd/tabs-sticky';
const props: TabsStickyProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tabs-sticky/index.ts`
- `src/tabs-sticky/tabs.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tabs-sticky` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tabs-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tabs-wrapper` 的使用方式。
#### 模块定位
Tabs 包装组件
#### 导入方式
```ts
import { TabsWrapper } from '@flatbiz/antd/tabs-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./tabs-wrapper.jsx`
- `TabsWrapper` - Tabs 包装组件
- `TabsWrapperProps`
#### 依赖的 antd 能力
`Tabs`、`TabsProps`
#### Props / 配置要点
##### TabsWrapperProps
- `isSticky`(可选):: boolean;Tabs Header 提供 Sticky 效果,默认值:true @deprecated 已废弃 4.3.0版本移除,请使用 isFixed 属性
- `isFixed`(可选):: boolean;Tabs Header 提供 Fixed 效果,默认值:true
- `cancelActiveCache`(可选):: boolean;是否取消 active 缓存
- `activeCacheKey`(可选):: string
- `hiddenTabHeader`(可选):: boolean;隐藏头部
#### 使用规则与行为
- Tabs Header 提供 Sticky 效果,默认值:true @deprecated 已废弃 4.3.0版本移除,请使用 isFixed 属性
- Tabs Header 提供 Fixed 效果,默认值:true
- 是否取消 active 缓存
- 隐藏头部
- Tabs 包装组件
#### 基础示例
```tsx
import { TabsWrapper, type TabsWrapperProps } from '@flatbiz/antd/tabs-wrapper';
const props: TabsWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tabs-wrapper/index.ts`
- `src/tabs-wrapper/tabs-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tabs-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tag-group LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tag-group` 的使用方式。
#### 模块定位
Tag 列表显示
#### 导入方式
```ts
import { TagGroup } from '@flatbiz/antd/tag-group';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./tag-group.jsx`
- `TagGroup` - Tag 列表显示
- `TagGroupProps`
#### 依赖的 antd 能力
`Space`、`SpaceProps`、`Tag`
#### Props / 配置要点
##### TagGroupDataItem
- `label`(必填):: string
- `value`(必填):: string | number
- `color`(可选):: string
##### TagGroupProps
- `dataList`(必填):: TagGroupDataItem[]
- `colorMap`(可选):: Record;颜色配置数据,例如:{ 1:'red', 2: 'blue'} key值与 dataList中value相同
- `spaceProps`(可选):: SpaceProps
#### 使用规则与行为
- 颜色配置数据,例如:{ 1:'red', 2: 'blue'} key值与 dataList中value相同
- Tag 列表显示
#### 基础示例
```tsx
import { TagGroup, type TagGroupProps } from '@flatbiz/antd/tag-group';
const props: TagGroupProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tag-group/index.ts`
- `src/tag-group/tag-group.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tag-group` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tag-list-render LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tag-list-render` 的使用方式。
#### 模块定位
在列表数据dataList中通过value匹配数据,以Tag形式展示
#### 导入方式
```ts
import { TagListRender } from '@flatbiz/antd/tag-list-render';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./tag-list.jsx`
- `TagListRender` - 在列表数据dataList中通过value匹配数据,以Tag形式展示
- `TagListRenderValue`
- `TagListRenderDataItem`
- `TagListRenderProps`
#### 依赖的 antd 能力
`Popover`、`Tag`
#### Props / 配置要点
##### TagListRenderDataItem
- `label`(必填):: string
- `value`(必填):: TagListRenderValue
- `color`(可选):: string
##### TagListRenderProps
- `dataList`(必填):: TagListRenderDataItem[]
- `colorMap`(可选):: Record;颜色配置数据,例如:{ 1:'red', 2: 'blue'} key值与 dataList中value相同
- `value`(可选):: TagListRenderValue | TagListRenderValue[]
- `forceMatch`(可选):: boolean;是否强制匹配,默认值false
- `maxShowCount`(可选):: number;最大显示Tag数量,超出折叠隐藏
- `foldShowAllTag`(可选):: boolean;触发maxShowCount后,被折叠的内容是否显示完整tag,默认值:false
- `tagColor`(可选):: string;所有tag背景匹配此颜色,在colorMap为空、dataList中未配置color的情况下有效果
- `noColorShowTag`(可选):: boolean;未匹配到color时,是否显示Tag效果,默认值:true
#### 使用规则与行为
- 颜色配置数据,例如:{ 1:'red', 2: 'blue'} key值与 dataList中value相同
- 是否强制匹配,默认值false
- 最大显示Tag数量,超出折叠隐藏
- 触发maxShowCount后,被折叠的内容是否显示完整tag,默认值:false
- 所有tag背景匹配此颜色,在colorMap为空、dataList中未配置color的情况下有效果
- 未匹配到color时,是否显示Tag效果,默认值:true
- 在列表数据dataList中通过value匹配数据,以Tag形式展示
#### 基础示例
```tsx
import { TagListRender, type TagListRenderProps } from '@flatbiz/antd/tag-list-render';
const props: TagListRenderProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tag-list-render/index.ts`
- `src/tag-list-render/tag-list.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tag-list-render` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tag-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tag-wrapper` 的使用方式。
#### 模块定位
为 Tag 添加 loading 效果
#### 导入方式
```ts
import { TagWrapper } from '@flatbiz/antd/tag-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./tag-wrapper.jsx`
- `TagWrapper` - 为 Tag 添加 loading 效果
- `TagWrapperProps`
#### 依赖的 antd 能力
`Tag`、`TagProps`
#### Props / 配置要点
##### TagWrapperProps
- `onClick`(可选):: (e: React.MouseEvent) => Promise | void
- `loading`(可选):: boolean
#### 使用规则与行为
- 为 Tag 添加 loading 效果
#### 默认值线索
- `debounceDuration => 500`
#### 基础示例
```tsx
import { TagWrapper, type TagWrapperProps } from '@flatbiz/antd/tag-wrapper';
const props: TagWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tag-wrapper/index.ts`
- `src/tag-wrapper/tag-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tag-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### text-overflow LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/text-overflow` 的使用方式。
#### 模块定位
内容溢出截取,并在尾部添加...,被截取的添加Tooltip显示完整数据
#### 导入方式
```ts
import { TextOverflow } from '@flatbiz/antd/text-overflow';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./text-overflow.jsx`
- `OverflowAuto`
- `OverflowLength`
- `OverflowWidth`
- `TextOverflow` - 内容溢出截取,并在尾部添加...,被截取的添加Tooltip显示完整数据
- `TextOverflowProps`
#### 依赖的 antd 能力
`Tooltip`
#### Props / 配置要点
##### TextOverflowProps
- `text`(必填):: string | ReactElement;text 为ReactElement类型时,maxLength配置无效
- `maxWidth`(可选):: number;最大显示宽度
- `maxLength`(可选):: number;最大显示字数
- `hideTip`(可选):: boolean;关闭tooltip功能 文字超出后,鼠标移入,不展示全部文字
- `onClick`(可选):: (e) => void
- `className`(可选):: string
#### 使用规则与行为
- 内容溢出截取,并在尾部添加...,被截取的添加Tooltip显示完整数据
- text 为ReactElement类型时,maxLength配置无效
- 最大显示宽度
- 最大显示字数
- 关闭tooltip功能 文字超出后,鼠标移入,不展示全部文字
#### 基础示例
```tsx
import { TextOverflow, type TextOverflowProps } from '@flatbiz/antd/text-overflow';
const props: TextOverflowProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/text-overflow/index.ts`
- `src/text-overflow/overflow-auto.tsx`
- `src/text-overflow/overflow-length.tsx`
- `src/text-overflow/overflow-width.tsx`
- `src/text-overflow/text-overflow.tsx`
- `src/text-overflow/types.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/text-overflow` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### text-symbol-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/text-symbol-wrapper` 的使用方式。
#### 模块定位
为文字添加符号,例如:必填符号
#### 导入方式
```ts
import { TextSymbolWrapper } from '@flatbiz/antd/text-symbol-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./symbol.jsx`
- `TextSymbolWrapper` - 为文字添加符号,例如:必填符号
- `TextSymbolWrapperProps`
#### Props / 配置要点
##### TextSymbolWrapperProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `symbolType`(可选):: 'required';内置图标类型
- `symbol`(可选):: ReactNode;自定义标记符号,优先级大于 symbolType
- `position`(可选):: 'before' | 'after';标记位置,默认:brefore
- `text`(可选):: string | ReactElement;显示文本
- `symbolStyle`(可选):: CSSProperties
- `onSymbolClick`(可选):: (event) => void
- `hiddenSymbol`(可选):: boolean;只隐藏符号,不隐藏文案
- `gap`(可选):: number;图标与文字之间的间距
#### 使用规则与行为
- 内置图标类型
- 自定义标记符号,优先级大于 symbolType
- 标记位置,默认:brefore
- 显示文本
- 只隐藏符号,不隐藏文案
- 图标与文字之间的间距
- 为文字添加符号,例如:必填符号
#### 默认值线索
- `gap => 3`
#### 基础示例
```tsx
import { TextSymbolWrapper, type TextSymbolWrapperProps } from '@flatbiz/antd/text-symbol-wrapper';
const props: TextSymbolWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/text-symbol-wrapper/index.ts`
- `src/text-symbol-wrapper/symbol.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/text-symbol-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### time-picker-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/time-picker-wrapper` 的使用方式。
#### 模块定位
TimePicker组件包装
#### 导入方式
```ts
import { TimePickerWrapper } from '@flatbiz/antd/time-picker-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./time-picker-wrapper.jsx`
- `TimePickerWrapper` - TimePicker组件包装
- `TimePickerWrapperProps`
#### 依赖的 antd 能力
`TimePicker`、`TimePickerProps`
#### Props / 配置要点
##### TimePickerWrapperProps
- `value`(可选):: string
- `onChange`(可选):: (value?: string) => void
- `disabledTimeConfig`(可选):: { minTime?: TDayjsTimeType; maxTime?: TDayjsTimeType; disabledHourList?: number[]; disabledMinuteList?: number[]; disabledSecondList?: number[]; };1. minTime、maxTime设置为 DayjsTimeTypeEnum,默认格式:HH:mm:ss 2. minTime、maxTime格式必须与 format 相同
- `format`(可选):: TDayjsTimeType
#### 使用规则与行为
- 1. minTime、maxTime设置为 DayjsTimeTypeEnum,默认格式:HH:mm:ss 2. minTime、maxTime格式必须与 format 相同
- 禁用 小时 刻度列表,与日期无关
- 禁用 分钟 刻度列表,与日期无关
- 禁用 秒钟 刻度列表,与日期无关
- TimePicker组件包装
#### 基础示例
```tsx
import { TimePickerWrapper, type TimePickerWrapperProps } from '@flatbiz/antd/time-picker-wrapper';
const props: TimePickerWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/time-picker-wrapper/index.ts`
- `src/time-picker-wrapper/time-picker-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/time-picker-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### time-range-picker-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/time-range-picker-wrapper` 的使用方式。
#### 模块定位
TimePicker组件包装
#### 导入方式
```ts
import { TimeRangePickerWrapper } from '@flatbiz/antd/time-range-picker-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./time-range-picker-wrapper.jsx`
- `TimeRangePickerWrapper` - TimePicker组件包装
- `TimeRangePickerWrapperProps`
#### 依赖的 antd 能力
`TimePicker`、`TimeRangePickerProps`
#### Props / 配置要点
##### TimeRangePickerWrapperProps
- `value`(可选):: [string, string]
- `onChange`(可选):: (value?: [string, string]) => void
- `disabledTimeConfig`(可选):: { minTime?: TDayjsTimeType; maxTime?: TDayjsTimeType; disabledHourList?: number[]; disabledMinuteList?: number[]; disabledSecondList?: number[]; };1. minTime、maxTime设置格式,默认格式:HH:mm:ss 2. minTime、maxTime格式必须与 format 相同
- `format`(可选):: TDayjsTimeType
#### 使用规则与行为
- 1. minTime、maxTime设置格式,默认格式:HH:mm:ss 2. minTime、maxTime格式必须与 format 相同
- 禁用 小时 刻度列表,与日期无关
- 禁用 分钟 刻度列表,与日期无关
- 禁用 秒钟 刻度列表,与日期无关
- TimePicker组件包装
#### 基础示例
```tsx
import { TimeRangePickerWrapper, type TimeRangePickerWrapperProps } from '@flatbiz/antd/time-range-picker-wrapper';
const props: TimeRangePickerWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/time-range-picker-wrapper/index.ts`
- `src/time-range-picker-wrapper/time-range-picker-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/time-range-picker-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### time-range-picker-wrapper-form-item LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/time-range-picker-wrapper-form-item` 的使用方式。
#### 模块定位
包含了Form.Item组件的时间区间选择组件,时间区间组件可以定义成两个字段操作,不用再通过数组处理
#### 导入方式
```ts
import { TimeRangePickerWrapperFormItem } from '@flatbiz/antd/time-range-picker-wrapper-form-item';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./time-range-picker-wrapper-form-item.jsx`
- `TimeRangePickerWrapperFormItem` - 包含了Form.Item组件的时间区间选择组件,时间区间组件可以定义成两个字段操作,不用再通过数组处理
- `TimeRangePickerWrapperFormItemProps`
#### 依赖的 antd 能力
`Form`
#### Props / 配置要点
##### TimeRangePickerWrapperFormItemProps
- `startName`(必填):: FormItemNamePath;开始的时间name
- `endName`(必填):: FormItemNamePath;结束的时间name
- `formListName`(可选):: Array;如果 TimeRangePickerWrapperFormItem 在Form.List场景下 必传 @deprecated 使用 formListCompleteName 配置
- `formListCompleteName`(可选):: Array | string;前端 formItem 前缀FormName,当 TimeRangePickerWrapperFormItem 处在Form.List场景下,必传
- `timeRangePickerWrapperProps`(可选):: TimeRangePickerWrapperProps
#### 使用规则与行为
- 开始的时间name
- 结束的时间name
- 如果 TimeRangePickerWrapperFormItem 在Form.List场景下 必传 @deprecated 使用 formListCompleteName 配置
- 前端 formItem 前缀FormName,当 TimeRangePickerWrapperFormItem 处在Form.List场景下,必传
- 包含了Form.Item组件的时间区间选择组件,时间区间组件可以定义成两个字段操作,不用再通过数组处理
#### 基础示例
```tsx
import { TimeRangePickerWrapperFormItem, type TimeRangePickerWrapperFormItemProps } from '@flatbiz/antd/time-range-picker-wrapper-form-item';
const props: TimeRangePickerWrapperFormItemProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/time-range-picker-wrapper-form-item/index.ts`
- `src/time-range-picker-wrapper-form-item/time-range-picker-wrapper-form-item.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/time-range-picker-wrapper-form-item` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tips-title LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tips-title` 的使用方式。
#### 模块定位
TipsTitle:基于 antd 的 Flex 封装。
#### 导入方式
```ts
import { TipsTitle } from '@flatbiz/antd/tips-title';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./tips-title.jsx`
- `TipsTitle`
- `TipsTitleProps`
#### 依赖的 antd 能力
`Flex`
#### Props / 配置要点
##### TipsTitleProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `title`(必填):: string | ReactElement
- `titleStyle`(可选):: CSSProperties
- `contentStyle`(可选):: CSSProperties
- `children`(必填):: ReactNode
- `size`(可选):: 'default' | 'small'
- `helpIcon`(可选):: ReactElement;自定义 help icon
- `onHelp`(可选):: () => void;配置 helpIcon 后,此参数失效
- `hidden`(可选):: boolean
- `borderColor`(可选):: string
#### 基础示例
```tsx
import { TipsTitle, type TipsTitleProps } from '@flatbiz/antd/tips-title';
const props: TipsTitleProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tips-title/index.ts`
- `src/tips-title/tips-title.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tips-title` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tips-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tips-wrapper` 的使用方式。
#### 模块定位
为目标元素右侧添加Icon
#### 导入方式
```ts
import { TipsWrapper } from '@flatbiz/antd/tips-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./tips-wrapper.jsx`
- `TipsWrapper` - 为目标元素右侧添加Icon
- `TipsWrapperProps`
#### 依赖的 antd 能力
`Popover`、`PopoverProps`、`Tooltip`、`TooltipProps`
#### Props / 配置要点
##### TipsWrapperProps
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `children`(可选):: ReactNode
- `icon`(可选):: ReactElement
- `onClick`(可选):: (event) => void;Icon添加点击事件,设置hoverTips后失效
- `tipType`(可选):: 'popover' | 'tooltip';提示效果类型
- `popoverProps`(可选):: PopoverProps
- `tooltipProps`(可选):: TooltipProps
- `trigger`(可选):: 'icon' | 'all'
#### 使用规则与行为
- Icon添加点击事件,设置hoverTips后失效
- 提示效果类型
- 为目标元素右侧添加Icon
#### 基础示例
```tsx
import { TipsWrapper, type TipsWrapperProps } from '@flatbiz/antd/tips-wrapper';
const props: TipsWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tips-wrapper/index.ts`
- `src/tips-wrapper/tips-wrapper.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tips-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tree-modal LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tree-modal` 的使用方式。
#### 模块定位
树节点数据选择,一般用于选择员工等
#### 导入方式
```ts
import { TreeModal } from '@flatbiz/antd/tree-modal';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `HorizontalLayout`
- `TreeModal`
- `SelectItemList`
- `TreeModalContent` - 树节点数据选择,一般用于选择员工等
- `SelectContent`
- `TreeModelSelectItem`
- `TreeModelSelectValue`
- `TreeModalContentProps`
- `TreeModalProps`
- `VerticalLayout`
#### 依赖的 antd 能力
`Modal`
#### Props / 配置要点
##### TreeModelSelectItem
- `label`(必填):: string
- `value`(必填):: string | number
##### TreeModalContentProps
- `isMultiple`(可选):: boolean;是否多选,默认值:true
- `forceRender`(可选):: boolean
- `size`(可选):: 'small' | 'middle' | 'large';内置尺寸,根据比例固定高度、宽度,默认:large
- `fieldNames`(可选):: { label?: string; value?: string; children?: string; };字段映射
- `onRequest`(可选):: () => Promise;接口调用 @deprecated 已过期,使用 serviceConfig
- `serviceConfig`(可选):: { params?: TPlainObject; requiredParamsKeys?: string[]; onRequest?: (params?: TAny) => TAny; }
- `value`(可选):: TreeModelSelectValue
- `onChange`(可选):: (values?: TreeModelSelectItem[]) => void
- `textConfig`(可选):: { title: string; placeholder?: string; selectQuantityPrompt?: string; };选择为空提示,例如:请选择
- `treeProps`(可选):: Pick< TreeWrapperProps, | 'showSearch' | 'searchResultType' | 'searchPlaceholder' | 'searchValue' | 'loadDataFlag' | 'loadDataServiceConfig' | 'icon' | 'disa…
##### TreeModalProps
- `children`(可选):: ReactElement & { onClick?: (e) => void | Promise }
- `modalClassName`(可选):: string
- `modalWidth`(可选):: number
- `modalBodyHeight`(可选):: number
- `disabled`(可选):: boolean
#### 使用规则与行为
- 树节点数据选择,一般用于选择员工等
- 是否多选,默认值:true
- 内置尺寸,根据比例固定高度、宽度,默认:large
- 字段映射
- 接口调用 @deprecated 已过期,使用 serviceConfig
- 选择为空提示,例如:请选择
- 选择数量提示,例如:已选择{total}位用户
#### 默认值线索
- `isMultiple => true`
#### 基础示例
```tsx
import { TreeModal, type TreeModalContentProps } from '@flatbiz/antd/tree-modal';
const props: TreeModalContentProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tree-modal/horizontal.tsx`
- `src/tree-modal/index.ts`
- `src/tree-modal/select-item.tsx`
- `src/tree-modal/select-modal-content.tsx`
- `src/tree-modal/select-modal.tsx`
- `src/tree-modal/tree.tsx`
- `src/tree-modal/types.ts`
- `src/tree-modal/vertical.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tree-modal` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tree-modal-selector LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tree-modal-selector` 的使用方式。
#### 模块定位
树弹框选择器
#### 导入方式
```ts
import { TreeModalSelector } from '@flatbiz/antd/tree-modal-selector';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./selector.jsx`
- `TreeModalSelector` - 树弹框选择器
- `TreeModalSelectorProps`
- `TreeModalSelectorApi`
#### 依赖的 antd 能力
`message`、`Select`
#### Props / 配置要点
##### TreeModalSelectorProps
- `placeholder`(可选):: string
- `maxTagCount`(可选):: number | 'responsive';1. 可指定数量 2. 可设置 responsive,一行自适应显示
- `labelInValue`(可选):: boolean;是否返回label+value模式
- `onChange`(可选):: (values?: TreeModelSelectItem[] | TreeModelSelectItem) => void
- `maxCount`(可选):: number;最大选择数量
- `overMaxCountMsg`(可选):: string;超过最大选择数量提示文本
- `disabled`(可选):: boolean
- `allowClear`(可选):: boolean
#### 使用规则与行为
- 1. 可指定数量 2. 可设置 responsive,一行自适应显示
- 是否返回label+value模式
- 最大选择数量
- 超过最大选择数量提示文本
- 树弹框选择器
#### 默认值线索
- `placeholder => '请选择'`
- `allowClear => true`
#### 基础示例
```tsx
import { TreeModalSelector, type TreeModalSelectorProps } from '@flatbiz/antd/tree-modal-selector';
const props: TreeModalSelectorProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tree-modal-selector/index.ts`
- `src/tree-modal-selector/selector.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tree-modal-selector` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tree-selector-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tree-selector-wrapper` 的使用方式。
#### 模块定位
树选择器包装组件,由于过度封装,部分antd TreeSelect原始功能不支持,不满足情况的请使用antd TreeSelect实现
#### 导入方式
```ts
import { TreeSelectorWrapper } from '@flatbiz/antd/tree-selector-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./selector.jsx`
- `treeSelectorWrapperModel` -
- `ModelState`
- `TreeSelectorWrapper` - 树选择器包装组件,由于过度封装,部分antd TreeSelect原始功能不支持,不满足情况的请使用antd TreeSelect实现
- `TreeSelectorWrapperProps`
- `getExpandedKeysByValue`
- `getExpandedKeysByValues`
#### 依赖的 antd 能力
`Button`、`TreeSelect`、`TreeSelectProps`
#### Props / 配置要点
##### TreeSelectorServiceConfig
- `params`(可选):: TPlainObject
- `requiredParamsKeys`(可选):: string[]
- `onRequest`(可选):: (params?: TAny) => TAny
- `onRequestResultAdapter`(可选):: (respData: TAny) => TPlainObject[];响应数据适配器
##### TreeSelectorWrapperProps
- `modelKey`(可选):: string;设置请求唯一值
- `fieldNames`(可选):: { list?: string; label?: string; value?: string; children?: string; disabled?: string; };1. list 为 onRequest 返回数据中列表key值,可多级取值,例如: 'a.b.c' 2. 配置 serviceConfig.onRequestResultAdapter 后此配置失效
- `effectDependencyList`(可选):: DependencyList;useEffect依赖项数组,用于重新发起获取接口数据
- `serviceConfig`(可选):: TreeSelectorServiceConfig;请求服务需求的数据,当设置treeSelectorList后无效果
- `treeSelectorList`(可选):: TreeSelectProps['treeData'];当设置treeSelectorList后,serviceConfig 将失效
- `onTreeSelectorListChange`(可选):: ( treeSelectorList?: TreeSelectProps['treeData'] ) => void;treeSelectorList发生变更时触发
- `onTreeSelectorRequestError`(可选):: (error: Error) => void;通过服务获取数据异常回调,当设置treeSelectorList后无效果
- `showAllOption`(可选):: true | TPlainObject;添加全部选项
- `onChange`(可选):: ( selectedValue?: TreeSelectorWrapperValue, selectedData?: TPlainObject[] | TPlainObject, triggerInfo?: TPlainObject ) => void;1. 当 treeCheckable = true && treeCheckStrictly = true,如果选择的数据中含有父节点,selectedValue、selectedList返回数据包含父节点 2. 当 treeCheckable = true && treeCheckStrictly = false,selectedValue、selectedList返回的数据不包含父节点 3. 当 treeCheckable = f…
- `onTreeItemDataAdapter`(可选):: (dataItem: TPlainObject) => TPlainObject;tree item 数据适配器,返回的数据会通过fieldNames配置取数据
- `requestMessageConfig`(可选):: TRequestStatusProps['messageConfig'];自定义异常提示文案
- `value`(可选):: TreeSelectorWrapperValue;value格式
- `labelInValue`(可选):: boolean;treeCheckStrictly checkable 状态下节点选择完全受控(父子节点选中状态不再关联), 会使得 labelInValue 强制为 true
- `selectedParentCheckedAllChildrenList`(可选):: boolean;treeCheckStrictly = true模式下有效,点击父节点是否选中所有子节点,默认值:true
- `initRootExpand`(可选):: boolean;有唯一跟节点时,初始化是否展开,默认值:false
- `executeOnChangeInRenderFirstValue`(可选):: boolean;在第一次渲染value时,主动执行一次onChange
#### 使用规则与行为
- 响应数据适配器
- 设置请求唯一值
- 1. list 为 onRequest 返回数据中列表key值,可多级取值,例如: 'a.b.c' 2. 配置 serviceConfig.onRequestResultAdapter 后此配置失效
- useEffect依赖项数组,用于重新发起获取接口数据
- 请求服务需求的数据,当设置treeSelectorList后无效果
- 当设置treeSelectorList后,serviceConfig 将失效
- treeSelectorList发生变更时触发
- 通过服务获取数据异常回调,当设置treeSelectorList后无效果
- 添加全部选项
- 1. 当 treeCheckable = true && treeCheckStrictly = true,如果选择的数据中含有父节点,selectedValue、selectedList返回数据包含父节点 2. 当 treeCheckable = true && treeCheckStrictly = false,selectedValue、selectedList返回的数据不包含父节点 3. 当 treeCheckable = f…
#### 基础示例
```tsx
import { TreeSelectorWrapper, type TreeSelectorWrapperProps } from '@flatbiz/antd/tree-selector-wrapper';
const props: TreeSelectorWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tree-selector-wrapper/index.ts`
- `src/tree-selector-wrapper/model.ts`
- `src/tree-selector-wrapper/selector.tsx`
- `src/tree-selector-wrapper/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tree-selector-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### tree-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/tree-wrapper` 的使用方式。
#### 模块定位
Tree包装组件,默认返回父节点,可配置不返回
#### 导入方式
```ts
import { TreeWrapper } from '@flatbiz/antd/tree-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `getTreeDataList`
- `TreeWrapper` - Tree包装组件,默认返回父节点,可配置不返回
- `treeWrapperModel` -
- `ModelState`
- `TreeServiceConfig`
- `TreeLoadDataServiceConfig`
- `TreeWrapperMenuItem`
- `TreeWrapperProps`
- `TreeWrapperRefApi`
- `getDefaultExpandAllKeys`
- `getExpandedKeys`
- `getVauleList`
- `array2map`
- `treeWrapperValueDeepEqual` - value的类型包括 string、number、 Array、{ label: string, value: string | nuber }、 Array<{ label: string, value: string | nuber }> …
- `onTreeDrop`
- `dragNodeData`
- `getActualSelectKeyList` - 由于树节点过滤后,选中了父节点不一定是全部子节点,此处进行筛查
- `removeTargetNodeAndAllChildrenNode` - 移除指定节点以及所有子节点
- `removeAllSelectLeafNode` - 移除父节点全选下的叶子节点
- `removeAllParentNode` - 移除所有的父节点
- `completionParentChildrenNode` - values中的数据可能存在缺少父节点下的子节点情况,此处补齐
#### 依赖的 antd 能力
`Button`、`message`、`Spin`、`Tree`
#### Props / 配置要点
##### TreeServiceConfig
- `params`(可选):: TPlainObject
- `requiredParamsKeys`(可选):: string[]
- `onRequest`(可选):: (params?: TAny) => TAny
- `onRequestResultAdapter`(可选):: (respData: TAny) => TPlainObject[];响应数据适配器
##### TreeLoadDataServiceConfig
- `getParams`(可选):: (dataItem: TPlainObject) => TPlainObject
- `onRequest`(必填):: (params: TPlainObject) => TAny
- `onRequestResultAdapter`(可选):: (respData: TAny) => TPlainObject[];响应数据适配器
##### TreeWrapperMenuItem
- `title`(必填):: string
- `onClick`(必填):: (dataItem: TPlainObject, event) => void
- `icon`(可选):: ReactElement
##### TreeWrapperProps
- `modelKey`(可选):: string;设置请求唯一值
- `fieldNames`(可选):: { label?: string; value?: string; children?: string; list?: string; };字段映射
- `effectDependencyList`(可选):: DependencyList;useEffect依赖项数组,用于重新发起获取接口数据
- `serviceConfig`(可选):: TreeServiceConfig;请求服务需求的数据,当设置selectorTreeList后无效果
- `loadDataFlag`(可选):: boolean;是否开启异步加载
- `loadDataServiceConfig`(可选):: TreeLoadDataServiceConfig;异步加载数据配置
- `selectorTreeList`(可选):: TPlainObject[];当设置selectorTreeList后,serviceConfig将失效
- `onSelectorTreeListChange`(可选):: (dataList: TPlainObject[]) => void;通过服务获取数据后回调,当设置selectorList后无效果
- `onRequestResponseChange`(可选):: (data: TAny) => void;接口响应数据变更
- `onChange`(可选):: ( selectedKey?: TreeWrapperValue, operateNodeData?: TPlainObject[] | TPlainObject, operateAllNodeDataList?: TPlainObject[], extraData?: TPlainObject ) => void
- `searchValue`(可选):: string;搜索关键字,打开tree折叠过滤关键字
- `checkableResponseParentNode`(可选):: boolean;checkable模式下,onChange是否返回父节点,默认值true @description 已过期,请使用 checkableType 配置
- `menuTriggerType`(可选):: 'click' | 'hover';菜单触发类型,默认:click
- `menus`(可选):: (dataItem) => ButtonOperateProps
- `showSearch`(可选):: boolean
- `onSearchValueChange`(可选):: (searchValue?: string) => void
- `searchPlaceholder`(可选):: string
- `searchStyle`(可选):: CSSProperties
- `icon`(可选):: (data: { isParent: boolean; isLeaf: boolean; [key: string]: TAny; }) => ReactElement
- `requestMessageConfig`(可选):: TRequestStatusProps['messageConfig'];状态文案配置
- `value`(可选):: TreeWrapperValue;value格式
- `labelInValue`(可选):: boolean;选择的节点数据,是否包含label信息
- `labelInValueFieldNames`(可选):: { label: string; value: string }
- `disabledCanUse`(可选):: boolean;禁用状态是否可选,默认值true 当dateItem中包含 disabled 则数据为禁用状态
- `treeItemDataAdapter`(可选):: (dataItem: TPlainObject) => TPlainObject;treeItem数据适配器
- `searchExtraElement`(可选):: ReactElement;搜索位置额外元素
- `initRootExpand`(可选):: boolean;有唯一跟节点时,初始化是否展开,默认值:false
- `searchResultType`(可选):: 'highlight' | 'filter';搜素过滤方式,高亮 | 过滤;默认:filter
- 其余 8 个字段见源码类型定义。
#### 使用规则与行为
- Tree包装组件,默认返回父节点,可配置不返回 @param props @returns
- 获取树形原数据
- 响应数据适配器
- 设置请求唯一值
- 字段映射
- useEffect依赖项数组,用于重新发起获取接口数据
- 请求服务需求的数据,当设置selectorTreeList后无效果
- 是否开启异步加载
- 异步加载数据配置
- 当设置selectorTreeList后,serviceConfig将失效
#### 默认值线索
- `menuTriggerType => 'click'`
- `searchPlaceholder => '搜索'`
- `data => []`
#### 基础示例
```tsx
import { TreeWrapper, type TreeWrapperProps } from '@flatbiz/antd/tree-wrapper';
const props: TreeWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/tree-wrapper/hooks.ts`
- `src/tree-wrapper/index.ts`
- `src/tree-wrapper/model.ts`
- `src/tree-wrapper/tree-wrapper.tsx`
- `src/tree-wrapper/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/tree-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### types LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/types` 的使用方式。
#### 模块定位
图片预览项
#### 导入方式
```ts
import { types } from '@flatbiz/antd/types';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `types`
- `FormItemNamePath`
- `TLocale`
- `TFbaLocale`
- `PreviewImageItem` - 图片预览项
#### Props / 配置要点
##### FormItemNamePath
- 声明:`export type FormItemNamePath = string | number | Array;`
##### PreviewImageItem
图片预览项
- `fileName`(可选):: string
- `fileKey`(可选):: string
- `previewUrl`(必填):: string
#### 使用规则与行为
- 数据加载异常默认文案
- 图片预览项
#### 基础示例
```tsx
import { types } from '@flatbiz/antd/types';
;
```
#### 源码索引
- `src/types/index.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/types` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### upload-multi-type LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/upload-multi-type` 的使用方式。
#### 模块定位
上传组件,同时支持多种上传方式,支持【点击&拖拽上传】、【粘贴上传】
#### 导入方式
```ts
import { UploadMultiType } from '@flatbiz/antd/upload-multi-type';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `UploadMultiType` - 上传组件,同时支持多种上传方式,支持【点击&拖拽上传】、【粘贴上传】
- `FileListView`
- `* from ./content.jsx`
- `UploadMultiTypeFileItem`
#### 依赖的 antd 能力
`Button`、`message`、`Spin`、`Tabs`
#### Props / 配置要点
##### UploadMultiTypeProps
- `value`(可选):: string[] | UploadMultiTypeFileItem[]
- `onChange`(可选):: (v: any) => void
- `onUploadFile`(必填):: (file: File) => Promise;上传文件
- `maxCount`(可选):: number;最大上传数量
- `onlyUploadImage`(可选):: boolean;只上传图片,默认:false;设置accept时,此配置无效
- `disabled`(可选):: boolean
##### UploadMultiTypeFileItem
- `name`(可选):: string
- `url`(必填):: string
#### 使用规则与行为
- 上传文件
- 最大上传数量
- 上传文件类型,例如:image/*, video/*, audio/*
- 只上传图片,默认:false;设置accept时,此配置无效
- 上传组件,同时支持多种上传方式,支持【点击&拖拽上传】、【粘贴上传】
#### 基础示例
```tsx
import { UploadMultiType, type UploadMultiTypeProps } from '@flatbiz/antd/upload-multi-type';
const props: UploadMultiTypeProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/upload-multi-type/content.tsx`
- `src/upload-multi-type/file-view.tsx`
- `src/upload-multi-type/index.ts`
- `src/upload-multi-type/type.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/upload-multi-type` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### upload-wrapper LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/upload-wrapper` 的使用方式。
#### 模块定位
文件上传,支持拖拽上传
#### 导入方式
```ts
import { UploadWrapper } from '@flatbiz/antd/upload-wrapper';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `* from ./upload-wrapper.jsx`
- `UploadWrapper` - 文件上传,支持拖拽上传
- `UploadWrapperFileItem`
- `UploadWrapperProps`
- `getBase64`
#### 依赖的 antd 能力
`Button`、`Image`、`message`、`Upload`、`UploadFile`、`UploadProps`
#### Props / 配置要点
##### UploadWrapperFileItem
- `uid`(必填):: string
- `name`(必填):: string
- `url`(可选):: string
##### UploadWrapperProps
- `value`(可选):: T[] | T
- `onChange`(可选):: (value?: T[]) => void
- `onUploadError`(可选):: (message?: string) => void
- `onUploadChange`(可选):: (info: UploadChangeParam) => void
- `fieldNames`(可选):: { uid: string; name?: string; url?: string; size?: string | number; };属性取值映射
- `onRequestResultAdapter`(可选):: (respData: TAny) => TPlainObject;接口响应数据适配器,如果配置了fieldNames,适配器返回值会再进过fieldNames转换
- `triggerText`(可选):: ReactNode;操作触发显示文本
- `limitHidden`(可选):: boolean;超过maxCount 隐藏上传入口
- `autoSubmit`(可选):: boolean;自动提交,默认:true
- `imagePreviewAccept`(可选):: string[];图片预览文件类型,默认:['png', 'jpg', 'jpeg', 'gif', 'heic', 'heif']
- `extraOperate`(可选):: { icon: ReactElement; onClick: (file: UploadFile, fileList: UploadFile[], e) => void; }[];配置文件额外操作
- `isDragger`(可选):: boolean;是否使用拖拽上传
- `draggerLayoutSize`(可选):: 'default' | 'middle' | 'large'
#### 使用规则与行为
- 属性取值映射
- 文件大小
- 接口响应数据适配器,如果配置了fieldNames,适配器返回值会再进过fieldNames转换
- 操作触发显示文本
- 超过maxCount 隐藏上传入口
- 自动提交,默认:true
- 图片预览开关, 重写 onPreview 方法后失效
- 图片预览文件类型,默认:['png', 'jpg', 'jpeg', 'gif', 'heic', 'heif']
- 配置文件额外操作
- 是否使用拖拽上传
#### 默认值线索
- `imagePreviewAccept => ['png', 'jpg', 'jpeg', 'gif', 'heic', 'heif']`
- `draggerLayoutSize => 'default'`
- `value => undefined`
#### 基础示例
```tsx
import { UploadWrapper, type UploadWrapperProps } from '@flatbiz/antd/upload-wrapper';
const props: UploadWrapperProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/upload-wrapper/index.ts`
- `src/upload-wrapper/upload-wrapper.tsx`
- `src/upload-wrapper/utils.ts`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/upload-wrapper` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
### x-mind-preview LLMs.txt
> 供 LLM 快速理解 `@flatbiz/antd/x-mind-preview` 的使用方式。
#### 模块定位
额外的数据,用于使用时自定义渲染
#### 导入方式
```ts
import { XMindPreview } from '@flatbiz/antd/x-mind-preview';
// 也可以从主入口导入:import { ... } from '@flatbiz/antd';
```
#### 公开导出
- `useCallbackRef`
- `* from ./x-mind-preview.jsx`
- `TXMindTreeItem`
- `XMindPreview`
- `IXMindPreviewProps`
#### Props / 配置要点
##### TXMindTreeItem
- `data`(可选):: { text: string; uid: string; extraData?: TPlainObject; };节点文本
- `children`(必填):: TXMindTreeItem[];子节点
##### IXMindPreviewProps
- `data`(可选):: TXMindTreeItem
- `className`(可选):: string
- `style`(可选):: CSSProperties
- `renderNode`(可选):: (node: TXMindTreeItem) => { width?: number; height?: number; reactNode: ReactNode; } | void;自定义节点渲染内容: 默认情况 xmind 会自动计算节点的宽高, 自定义渲染react组件,因为初始拿不到宽高,所以要返回一个节点宽高 - 默认宽高 200 22 - 返回值为空则使用默认渲染 @param node @returns
#### 使用规则与行为
- 节点文本
- 全局唯一id
- 额外的数据,用于使用时自定义渲染
- 子节点
- 自定义节点渲染内容: 默认情况 xmind 会自动计算节点的宽高, 自定义渲染react组件,因为初始拿不到宽高,所以要返回一个节点宽高 - 默认宽高 200 22 - 返回值为空则使用默认渲染 @param node @returns
- 防止dom id重复,id在一个组件内需要时唯一的
- 数据更新重置状态
- 只有第一次渲染的时候更新画布位置
#### 基础示例
```tsx
import { XMindPreview, type IXMindPreviewProps } from '@flatbiz/antd/x-mind-preview';
const props: IXMindPreviewProps = {
// 按业务传入必要参数
};
;
```
#### 源码索引
- `src/x-mind-preview/_hooks/use-callback-ref.tsx`
- `src/x-mind-preview/index.ts`
- `src/x-mind-preview/type.ts`
- `src/x-mind-preview/x-mind-preview.tsx`
#### 给 LLM 的注意事项
- 优先使用 `@flatbiz/antd/x-mind-preview` 或主入口 `@flatbiz/antd` 的公开导出,不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时,以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数,请读取上方源码索引中的类型定义和 JSDoc。
## 生成说明
- 本文档由 `scripts/generate-llms-docs.mjs` 根据 `src/index.ts`、各模块源码、JSDoc 和 README 自动生成。
- 重新生成:在 `packages/antd` 目录执行 `node scripts/generate-llms-docs.mjs`。