prefixCls |
set prefix class |
string |
c7n |
proPrefixCls |
set prefix class for pro components |
string |
c7n-pro |
iconfontPrefix |
iconfont css prefix |
string |
icon |
icons |
List of iconfont, used for IconPicker. |
string[] | { [categoryName: string]: string[] } |
import { categories } from 'choerodon-ui-font' |
cacheRecords |
默认缓存选中和变更的记录 |
boolean |
|
ripple |
Whether to open the ripple effect |
boolean |
true |
lookupCache |
lookup cache config. maxAge - cache max age max - cache max length |
object |
{ maxAge: 1000 _ 60 _ 10, max: 100 } |
lookupUrl |
Lookup value url or hook which return url |
string | ((code: string) => string) |
code => `/common/code/${code}/` |
lookupAxiosConfig |
Lookup fetch axios config, more info: AxiosRequestConfig. By default, url is lookupUrl and method is post. |
AxiosRequestConfig | ({ dataSet: DataSet, record: Record, params?: any, lookupCode: string }) => AxiosRequestConfig |
post |
lovDefineUrl |
Lov configure url or hook which return url |
string | ((code: string) => string) |
code => `/sys/lov/lov_define?code=${code}` |
lovDefineAxiosConfig |
hook for Lov configure axios config, more info: AxiosRequestConfig. By default, url is lovDefineUrl and method is post. |
AxiosRequestConfig | (code: string, field?: Field) => AxiosRequestConfig |
- |
lovDefineBatchAxiosConfig |
返回 lov 配置批量查询配置的钩子,详见AxiosRequestConfig。 |
(codes: string[]) => AxiosRequestConfig |
- |
useLovDefineBatch |
是否使用批量查询 lov 配置 |
(code: string, field: Field) => boolean |
noop |
lookupAxiosMethod |
值列表请求的类型 |
Http method |
'post' |
lovQueryUrl |
Lov query url or hook which return url |
string | ((code: string, lovConfig?: LovConfig, { dataSet, params, data }) => string) |
code => `/common/lov/dataset/${code}` |
lovQueryAxiosConfig |
hook for Lov query axios config, more info: AxiosRequestConfig. By default, url is lovQueryUrl and method is post. |
AxiosRequestConfig | (code: string, lovConfig?: LovConfig, { dataSet, params, data }) => AxiosRequestConfig |
- |
lovTableProps |
全局配置lov的tableProps,当同时存在lovTableProps以及的时候会进行一层合并 |
TableProps | (multiple?: boolean) => TableProps
|
{} |
lovModalProps |
Lov 弹窗属性,详见ModalProps
|
ModalProps |
|
lovAutoSelectSingle |
Lov 点击查询仅存在一条数据时自动选中且不弹窗 |
boolean |
false |
lovNoCache |
默认 Lov noCache |
boolean |
|
lovQueryBar |
默认 Lov Table 的 queryBar |
string |
normal |
lovQueryBarProps |
默认 Lov Table queryBar 的 queryBarProps |
object |
|
lovQueryCachedSelected |
lov 查询缓存已勾选记录 |
(code: string, cachedSelected: Map<string, Record>) => Promise<object[]> |
|
lookupBatchAxiosConfig |
hook for batch lookup query, more info:AxiosRequestConfig。 |
(codes: string[]) => AxiosRequestConfig |
- |
useLookupBatch |
是否使用批量查询快码 |
(code: string, field: Field) => boolean |
noop |
selectReverse |
Whether to enable the pull-down multi-select reverse function. |
boolean |
true |
selectOptionsFilter |
选项过滤。 |
(record: Record) => boolean |
|
selectSearchable |
是否开启下拉搜索功能。 |
boolean |
false |
selectBoxSearchable |
是否开启下拉搜索功能。 |
boolean |
false |
selectReserveParam |
是否保留查询参数。 |
boolean |
true |
selectPagingOptionContent |
渲染分页 option |
ReactNode |
··· |
selectTrigger |
下拉弹出触发方式 |
Action[] |
['focus', 'click'] |
axios |
Replace the built-in axios instance |
AxiosInstance |
|
autoCount |
默认 DataSet 的 autoCount |
boolean |
true |
dataKey |
default dataKey of DataSet |
string |
rows |
totalKey |
default totalKey of DataSet |
string |
total |
countKey |
默认 DataSet 的 countKey |
string |
needCountFlag |
statusKey |
The status key in the data submitted by the DataSet by default. |
string |
__status |
tlsKey |
Multi-language key in the DataSet data by default. |
string |
__tls |
status |
Default status map of data submitted by DataSet. |
{ add: string, update: string, delete: string } |
{ add: 'add', update: 'update', delete: 'delete' } |
labelLayout |
default labelLayout of Form |
string |
horizontal |
queryBar |
default queryBar of table |
string |
normal |
queryBarProps |
默认 Table queryBar 的 queryBarProps |
object |
|
tableVirtual |
default virtual of Table and based on the granularity of rows and columns |
boolean | (rows: number, columns: number) => boolean |
|
tableVirtualCell |
default virtualCell of Table |
boolean |
|
tableBorder |
default border of table |
boolean |
true |
tableColumnEditorBorder |
default columnEditorBorder of Table |
boolean |
tableBorder |
tableHighLightRow |
Default Table current line highlight, 可选值: boolean | focus | click, true - 始终显示高亮行, 'click' - 点击行后始终显示高亮行, 'focus' - 表格获焦时显示高亮行 |
boolean |
true |
tableSelectedHighLightRow |
Default Table selected line highlight |
boolean |
false |
tableParityRow |
Default Table parity line |
boolean |
|
tableRowHeight |
默认 Table 行高 |
auto | number | ({ size }) => number | auto |
30 |
tableHeaderRowHeight |
默认 Table 头行高 |
auto | number | ({ size }) => number | auto |
tableRowHeight |
tableFooterRowHeight |
默认 Table 脚行高 |
auto | number | ({ size }) => number | auto |
tableRowHeight |
tableExpandIcon |
Default Table custom expansion icon |
({ prefixCls, expanded, expandable, needIndentSpaced, record, onExpand }) => ReactNode |
|
tableSpinProps |
Default Table spin props |
SpinProps |
{ size: Size.default, wrapperClassName: '' } |
tableButtonProps |
Default Table button props |
ButtonProps |
{ color: 'primary', funcType: 'flat' } |
tableButtonsLimit |
默认 Table 头部显示功能按钮的数量,超出限制放入更多下拉 |
number |
|
tableCommandProps |
Default Table command props |
ButtonProps |
{ color: 'primary', funcType: 'flat' } |
tableShowSelectionTips |
Table默认显示选中记录提示 |
boolean |
false |
tableShowCachedTips |
Table默认显示缓存记录提示, 优先级高于 tableShowSelectionTips |
boolean |
false |
tableShowSortIcon |
Table默认显示可排序icon |
boolean |
false |
tableAlwaysShowRowBox |
Table是否一直显示rowbox,开启后在其他模式下也会显示rowbox |
boolean |
false |
tableUseMouseBatchChoose |
Table是否使用鼠标批量选择,开启后在rowbox的情况下可以进行鼠标拖动批量选择,在起始的rowbox处按下,在结束位置松开 |
boolean |
false |
tableEditorNextKeyEnterDown |
Table是否开启可编辑行回车编辑下一行 |
boolean |
true |
tableColumnResizable |
Default Table columnResizable |
boolean |
true |
tableColumnHideable |
Default Table columnHideable |
boolean |
true |
performanceTableColumnHideable |
默认 performanceTable 列可调整显示 |
boolean |
true |
tableColumnTitleEditable |
Default Table columnTitleEditable |
boolean |
false |
performanceTableColumnTitleEditable |
默认 performanceTable 列可编辑标题 |
boolean |
false |
tableColumnDraggable |
Default Table columnDraggable |
boolean |
false |
tableColumnResizeTransition |
Excessive effect of column dragging |
boolean |
true |
tableHeightChangeable |
Default Table heightChangeable |
boolean |
true |
tablePageSizeChangeable |
Default Table pageSizeChangeable |
boolean |
false |
performanceTableColumnDraggable |
performanceTable 是否开启列拖拽 |
boolean |
false |
performanceTableAutoHeight |
performanceTable 是否开启自动高度,传入对象则自适应父节点高度,为 true 则由内容撑开高度) |
boolean | { type: 'minHeight' | 'maxHeight', diff: number} |
false |
tableRowDraggable |
Default Table rowDraggable |
boolean |
false |
tableDragColumnAlign |
Default align of Table row drag handler |
'left'|'right' |
- |
tableAutoFocus |
Table 新增行自动聚焦至第一个可编辑字段 |
boolean |
false |
tableColumnOnCell |
Custom cell property configuration |
(dataSet, record, column) => object |
- |
tableColumnAlign |
默认表格列对齐方式 |
(column, field) => 'left' | 'center' | 'right' | undefined |
Function |
tableColumnDefaultWidth |
默认表格列宽度, 只在出横向滚动条时起作用 |
number |
100 |
tableColumnDefaultMinWidth |
默认表格列最小宽度 |
number |
50 |
tableColumnFilterPopover |
默认表格渲染不同前端筛选组件 |
(props: FilterPopoverProps) => ReactNode |
|
tableColumnResizeTrigger |
表格列宽拖拽分割线触发方式 |
'mouseDown'|'hover' |
'mouseDown' |
tableAggregationColumnDefaultWidth |
默认表格聚合列宽度, 只在出横向滚动条时起作用 |
number |
250 |
tableAggregationColumnDefaultMinWidth |
默认表格聚合列最小宽度 |
number |
50 |
tableKeyboard |
Table 开启或关闭新增的快捷按钮事件 |
boolean |
false |
tableFilterAdapter |
Table 筛选条请求适配器 |
({ type, config, searchCode, queryDataSet} )=>AxiosRequestConfig |
|
tableFilterSuffix |
Table 筛选条按钮预留区 |
ReactNode |
|
tableFilterSearchText |
Table 筛选条快速搜索参数名 |
string |
'params' |
tableAutoHeightDiff |
Table 自动高度误差值配置 |
number |
80 |
confirm |
变更检查行为自定义,可与modifiedCheckMessage关联使用(source - 修改提示信息来源 查询条:'query' 翻页: undefined) |
(message: any, dataSet?: DataSet, source?: string) => Promise |
async (message) => (await confirm(message)) !== 'cancel' |
customizable |
是否开启个性化 |
boolean | Customizable
|
false |
customizedSave |
Table 个性化保存的钩子 |
(code, customized, component: keyof Customizable) => void |
(code, customized) => localStorage.setItem(table.customized.${code} , JSON.stringify(customized)) |
customizedLoad |
Table 个性化加载的钩子 |
(code, component: keyof Customizable) => Promise |
(code) => Promise.resolve(JSON.parse(localStorage.getItem(table.customized.${code} ) || 'null')) |
tableShowRemovedRow |
默认 Table 是否显示临时移除的行,默认置灰显示 |
boolean |
true |
pagination |
默认 pagination 的属性 |
TablePaginationConfig | false |
详见Pagination
|
defaultActiveFirstOption |
默认 Select 高亮第一个选项 |
boolean |
true |
dropdownMatchSelectWidth |
默认下拉框匹配输入框宽度 |
boolean |
true |
modalSectionBorder |
Default if Modal header and foot have a border line |
boolean |
true |
drawerSectionBorder |
Default if drawer header and foot have a border line |
boolean |
true |
drawerTransitionName |
抽屉模式使用的动画, 可选值: 'slide-right' 'slide-left' 'slide-up' 'slide-down' |
string |
'slide-right' |
drawerHeaderFooterCombined |
抽屉模式头脚组合展示 |
boolean |
false |
modalOkFirst |
Default the ok button of Modal is ranked first |
boolean |
true |
modalKeyboard |
Does Modal support keyboard esc off |
boolean |
true |
modalAutoCenter |
Whether Modal is centered by default |
boolean |
false |
modalMaskClosable |
点击蒙层是否允许关闭,可选 boolean | click | dblclick |
boolean | string |
false |
drawerOkFirst |
The ok button of the default Modal drawer is ranked first, and has a higher priority than modalOkFirst |
boolean | undefined |
undefined |
modalResizable |
modal是否可调整大小 |
boolean |
|
modalMovable |
modal是否可移动 |
boolean |
|
modalClosable |
modal关闭按钮 |
boolean |
|
buttonFuncType |
Default Button function type |
string |
raised |
buttonColor |
Default Button color |
string |
default |
autoInsertSpaceInButton |
设置为 true 时,添加按钮中 2 个汉字之间的空格 |
boolean |
false |
renderEmpty |
自定义组件空状态。componentName会接收到的值为 Table Select ,在实现函数的时候需要对这两个输入进行处理,注意需要同时处理Table以及Select,默认值参考源代码的defaultRenderEmpty
|
(componentName: string) => ReactNode |
- |
defaultValidationMessages |
Default validation messages. More info: ValidationMessages
|
ValitionMessages |
- |
validationMessageFormatter |
校验信息格式器 |
ValidationMessageFormatter: (message?: string, injectOptons?: any) => Promise | any |
(message, injectOptions) => message && injectOptions ? formatReactTemplate(message, injectOptions) : message |
validationMessageReportFormatter |
校验报告信息格式器 |
ValidationMessageReportFormatter: (message: any) => Promise<string | undefined> | string | undefined |
(message) => getReactNodeText(<span>{message}</span>) |
generatePageQuery |
分页参数转换的钩子 |
({ page?: number, pageSize?: number, totalCount?: number, count?: 'Y' | 'N', defaultCount?: 'Y' | 'N', onlyCount?: 'Y' | 'N', sortName?: string, sortOrder?: string, sort?: string[] }) => object |
- |
feedback |
The feedback of DataSet for query and submit. More info: Feedback
|
Feedback |
|
transport |
Default transport of DataSet. More info: Transport
|
Transport |
|
formatter |
Date formatter. jsonDate is the format of the data in request and response, and the date is converted to timestamp when it is empty. More info:Formatter
|
Formatter |
|
useColon |
Form是否使用冒号,当开启时会在所有的label后面加上冒号 |
boolean |
false |
requiredMarkAlign |
控制必输星号位置 |
left | right
|
left |
collapseExpandIconPosition |
全局配置 collapse 图标位置 |
left | right
|
left |
collapseExpandIcon |
全局配置 collapse 自定义切换图标 |
(panelProps) => ReactNode | text (预置icon + 展开收起文字) |
无 |
collapseTrigger |
全局配置切换面板的触发位置 |
header | icon
|
header |
textFieldAutoComplete |
全局配置textField的autoComplete属性 |
可选值: on off
|
|
resultStatusRenderer |
custom status render,you can add status renderer or cover status renderer, support the gloabal config |
object-> {string:react.ReactNode} |
- |
numberFieldNonStrictStep |
全局配置 NumberField 的 nonStrictStep 属性 |
boolean |
false |
numberFieldFormatter |
NumberField格式器 |
FormatNumberFunc: (value: string, lang: string, options: Intl.NumberFormatOptions) => string |
|
numberFieldFormatterOptions |
NumberField格式器参数,可以与组件值进行合并 |
FormatNumberFuncOptions: { lang?: string, options?: Intl.NumberFormatOptions } |
|
currencyFormatter |
Currency格式器 |
FormatNumberFunc: (value: string, lang: string, options: Intl.NumberFormatOptions) => string |
|
currencyFormatterOptions |
Currency格式器参数,可以与组件值进行合并 |
FormatNumberFuncOptions: { lang?: string, options?: Intl.NumberFormatOptions } |
|
showLengthInfo |
全局配置是否展示长度信息 |
boolean |
|
showInvalidDate |
显示无效日期 |
boolean |
|
showRequiredColorsOnlyEmpty |
只有在空值时显示必填背景色和边框色 |
boolean |
|
showValidation |
校验信息提示方式 |
tooltip | newLine
|
tooltip |
showHelp |
显示提示信息的方式 |
tooltip | newLine | label | none
|
newline |
highlightRenderer |
高亮渲染器 |
({ title, content, dataSet, record, name, className, style }, element) => ReactNode |
|
performanceEnabled |
开启性能监控 |
{ Table: boolean } |
{ Table: false } |
tooltip |
是否开启提示, 参数 target 详见 TooltipTarget
|
Tooltip.always | Tooltip.overflow | Tooltip.none | function(target) |
|
tooltipTheme |
Tooltip 主题 或 返回主题的钩子, 参数 target 详见 TooltipTarget
|
dark | light | function(target) |
(target) => target === 'validation' ? 'light' : 'dark' |
tooltipPlacement |
Tooltip 位置 或 返回位置的钩子, 参数 placement 详见 TooltipPlacement
|
placement | function(target) |
TooltipPlacement |
attachment |
附件上传配置 |
AttachmentConfig |
|
tabsInkBarStyle |
Tabs 墨条样式 |
CSSProperties |
|
tabsDefaultChangeable |
默认 Tabs 个性化是否可配置默认页签 |
boolean |
true |
numberFieldKeyboard |
control UP DOWN keyboard events for NumberField component |
boolean |
true |
dateTimePickerOkButton |
日期时间控件是否显示确定按钮 |
boolean |
false |
lovShowSelectedInView |
Lov 多选时,viewMode 为 modal 或 drawer,在对话框中显示已选记录 |
boolean | (viewMode) => boolean |
(viewMode) => viewMode === 'drawer' |
lovSelectionProps |
Lov 显示已选记录时的参数 |
SelectionProps |
|
onPerformance |
性能监控埋点函数 |
(type, event) => void |
|
onTabsChange |
Tabs 变更事件, 初始化时也会触发, 可用于监控埋点 |
(props: { activeKey:string, activeGroupKey?:string, title: string, groupTitle?:string, code?:string }) => void |
|
onButtonClick |
按钮点击事件, 可用于监控埋点 |
(props: { title:string, icon?:string }) => void |
|
onComponentValidationReport |
组件触发校验报告事件 |
(props: { showInvalid: boolean; component: object }) => void |
|
min |
最小值 |
min: (FieldType) => value |
|
max |
最大值 |
max: (FieldType) => value |
|
xlsx |
异步获取 xlsx 库 |
() => import('xlsx') |
|
colorPreset |
ColorPicker是否开启备选色板 |
boolean |
false |
uploadShowReUploadIcon |
基础 Upload 组件文件上传失败后是否显示重新上传按钮。当 listType 为 picture-card: true 为 icon, text 为文字形式; 其他 listType 都为文字形式 |
boolean | 'text' | (file: UploadFile, listType: UploadListType) => (boolean | 'text') |
|
fieldMaxTagCount |
默认 FormField 的 maxTagCount 属性 |
boolean |
|
fieldMaxTagPlaceholder |
默认 FormField 的 maxTagPlaceholder 属性 |
ReactNode | (omittedValues: any[]) => ReactNode |
|
fieldFocusMode |
字段聚焦模式 |
checked | focus
|
checked |
formAutoFocus |
The first editable component is automatically focused in the form. If the form is in the Modal pop-up window, you need to manually set the autoFocus of Modal to false |
boolean |
false |
labelAlign |
Form 标签文字对齐方式, 只在 labelLayout 为horizontal 时起作用,可选值: left center right
|
string |
right |
useZeroFilledDecimal |
NumberField 和 Currency 组件的值是否在输入和显示时开启根据 precision 补零,真实值不受影响 |
boolean |
|
rangeSeparator |
自定义组件 range 模式的分隔符 |
string |
~ |
Опубликовать ( 0 )