choerodon-ui

import { AxiosRequestConfig } from 'axios'; import { CSSProperties, ReactNode } from 'react'; import { AttachmentConfig as DataSetAttachmentConfig, Config as DataSetConfig, DefaultConfig as DataSetDefaultConfig, Formatter, Status } from 'choerodon-ui/dataset/configure'; import { Tooltip, FieldFocusMode } from '../../pro/es/core/enum'; import { expandIconProps, Suffixes, TableCustomized, TablePaginationConfig, TableProps, TableQueryBarHook, TableQueryBarHookCustomProps } from '../../pro/es/table/Table'; import { SelectionProps } from '../../pro/es/lov/Lov'; import { PerformanceTableCustomized } from '../../pro/es/performance-table/Table'; import { ButtonProps } from '../../pro/es/button/Button'; import { ColumnAlign, DragColumnAlign, HighLightRowType, TableAutoHeightType, TableColumnResizeTriggerType, TableQueryBarType } from '../../pro/es/table/enum'; import Record from '../../pro/es/data-set/Record'; import Field from '../../pro/es/data-set/Field'; import { LabelLayout, ShowValidation, LabelAlign, RequiredMarkAlign } from '../../pro/es/form/enum'; import { ShowHelp } from '../../pro/es/field/enum'; import { ButtonColor, FuncType } from '../../pro/es/button/enum'; import { HighlightRenderer } from '../../pro/es/field/FormField'; import { SpinProps } from '../../pro/es/spin'; import { FormatNumberFunc, FormatNumberFuncOptions } from '../../pro/es/number-field/NumberField'; import { ModalCustomized, ModalProps } from '../../pro/es/modal/interface'; import { ColumnProps, FilterPopoverProps, onCellProps } from '../../pro/es/table/Column'; import { AttachmentListType } from '../../pro/es/attachment/Attachment'; import AttachmentFile from '../../pro/es/data-set/AttachmentFile'; import { BoardCustomized } from '../../pro/es/board/interface'; import { Action } from '../trigger/enum'; import { Size } from '../_util/enum'; import { TooltipPlacement, TooltipTheme } from '../tooltip'; import { PanelProps } from '../collapse'; import { TabsCustomized } from '../tabs/Tabs'; import defaults from './default'; import { UploadListReUploadIconFunc } from '../upload/interface'; export { Status, Formatter }; export declare type renderEmptyHandler = (componentName?: string) => ReactNode; export declare type PerformanceEvents = { Table: { name: string; url: string | undefined; size: number; timing: { fetchStart: number; fetchEnd: number; loadStart: number; loadEnd: number; renderStart: number; renderEnd: number; }; }; }; export declare type PerformanceEventHook<T extends keyof PerformanceEvents> = (key: T, event: PerformanceEvents[T]) => void; export declare type TooltipTarget = 'table-cell' | 'output' | 'label' | 'button' | 'select-option' | 'validation' | 'help' | 'text-field-disabled'; export declare type TooltipHook = (target?: TooltipTarget) => Tooltip | undefined; export declare type TooltipThemeHook = (target?: TooltipTarget) => TooltipTheme; export declare type TooltipPlacementHook = (target?: TooltipTarget) => TooltipPlacement; export declare type LovTablePropsHook = (multiple?: boolean) => Partial<TableProps>; export declare type LovViewTarget = 'modal' | 'drawer'; /** * @deprecated */ export declare type FormatBigNumberFunc = (value: string, lang: string, options: Intl.NumberFormatOptions, bigNumberTarget: 'currency' | 'number-field') => string; export declare type LovShowSelectedInViewHook = (viewMode?: LovViewTarget) => boolean; export declare type TableFilterAdapterProps = ({ type, config, searchCode, queryDataSet }: { type: any; config: any; searchCode: any; queryDataSet: any; }) => AxiosRequestConfig; export declare type Customizable = { Table?: boolean; PerformanceTable?: boolean; Tabs?: boolean; Modal?: boolean; Board?: boolean; }; export interface Customized { Table?: TableCustomized; PerformanceTable?: PerformanceTableCustomized; Tabs?: TabsCustomized; Modal?: ModalCustomized; Board?: BoardCustomized | BoardCustomized[] | any; } export declare type CustomizedSave = <T extends keyof Customized>(code: string, customized: Customized[T], component?: T) => void; export declare type CustomizedLoad = <T extends keyof Customized>(code: string, component: T, params?: any) => Promise<Customized[T] | null>; export interface AttachmentConfig extends DataSetAttachmentConfig { renderIcon?: (attachment: AttachmentFile, listType: AttachmentListType, defaultIcon: ReactNode) => ReactNode; renderHistory?: (props: { attachment: AttachmentFile; bucketName?: string; bucketDirectory?: string; storageCode?: string; attachmentUUID: string; }) => ReactNode; } export interface Config extends DataSetConfig { prefixCls?: string; proPrefixCls?: string; iconfontPrefix?: string; ripple?: boolean; collapseExpandIconPosition?: string; collapseExpandIcon?: ((panelProps: PanelProps) => ReactNode) | 'text'; collapseTrigger?: string; lovQueryCachedSelected?: (code: string, cachedSelected: Map<string, Record>) => Promise<object[]>; lovTableProps?: Partial<TableProps> | LovTablePropsHook; lovModalProps?: Partial<ModalProps>; lovAutoSelectSingle?: boolean; lovQueryBar?: TableQueryBarType | TableQueryBarHook; lovQueryBarProps?: Partial<TableQueryBarHookCustomProps>; lovShowSelectedInView?: boolean | LovShowSelectedInViewHook; lovSelectionProps?: SelectionProps; lovNoCache?: boolean; labelLayout?: LabelLayout; /** * form 标签文字对齐方式 * 可选值： 'left' | 'center' | 'right' * @default right; */ labelAlign?: LabelAlign; queryBar?: TableQueryBarType | TableQueryBarHook; queryBarProps?: Partial<TableQueryBarHookCustomProps>; tableVirtual?: boolean | ((rows: number, columns: number) => boolean); tableVirtualCell?: boolean; tableVirtualBuffer?: { columnBuffer?: number; columnThreshold?: number; }; tableBorder?: boolean; tableColumnEditorBorder?: boolean; tableHighLightRow?: boolean | HighLightRowType; tableParityRow?: boolean; tableSelectedHighLightRow?: boolean; tableRowHeight?: 'auto' | number | ((props: { size: Size; }) => 'auto' | number); tableHeaderRowHeight?: 'auto' | number | ((props: { size: Size; }) => 'auto' | number); tableFooterRowHeight?: 'auto' | number | ((props: { size: Size; }) => 'auto' | number); tableColumnResizable?: boolean; tableColumnHideable?: boolean; performanceTableColumnHideable?: boolean; tableColumnTitleEditable?: boolean; tableHeightChangeable?: boolean; tablePageSizeChangeable?: boolean; performanceTableColumnTitleEditable?: boolean; tableDragColumnAlign?: DragColumnAlign; tableColumnDraggable?: boolean; tableColumnResizeTransition?: boolean; performanceTableColumnDraggable?: boolean; tableRowDraggable?: boolean; tableExpandIcon?: (props: expandIconProps) => ReactNode; tableSpinProps?: SpinProps; tableButtonProps?: ButtonProps; tableCommandProps?: ButtonProps; tableColumnOnCell?: (props: onCellProps) => object; tableColumnAlign?: (column: ColumnProps, field?: Field, record?: Record) => ColumnAlign | undefined; tableColumnDefaultWidth?: number; tableColumnDefaultMinWidth?: number; tableColumnResizeTrigger?: TableColumnResizeTriggerType; tableColumnFilterPopover?: (props: FilterPopoverProps) => ReactNode; tableAggregationColumnDefaultWidth?: number; tableAggregationColumnDefaultMinWidth?: number; tableShowCachedTips?: boolean; tableShowSelectionTips?: boolean; tableShowSortIcon?: boolean; tableAlwaysShowRowBox?: boolean; tableUseMouseBatchChoose?: boolean; tableEditorNextKeyEnterDown?: boolean; tableAutoFocus?: boolean; tableKeyboard?: boolean; tableFilterAdapter?: TableFilterAdapterProps; tableFilterSuffix?: Suffixes[]; tableFilterSearchText?: string; tableAutoHeightDiff?: number; performanceTableAutoHeight?: boolean | { type: TableAutoHeightType; diff: number; }; tableShowRemovedRow?: boolean; tableButtonsLimit?: number; pagination?: TablePaginationConfig | false; modalSectionBorder?: boolean; drawerSectionBorder?: boolean; drawerTransitionName?: string; modalMovable?: boolean; modalAutoCenter?: boolean; modalOkFirst?: boolean; drawerOkFirst?: boolean; drawerHeaderFooterCombined?: boolean; modalButtonProps?: ButtonProps; modalKeyboard?: boolean; modalMaskClosable?: boolean | 'click' | 'dblclick'; modalResizable?: boolean; modalClosable?: boolean; buttonFuncType?: FuncType; buttonColor?: ButtonColor; autoInsertSpaceInButton?: boolean; renderEmpty?: renderEmptyHandler; highlightRenderer?: HighlightRenderer; icons?: { [key: string]: string[]; } | string[]; dropdownMatchSelectWidth?: boolean; defaultActiveFirstOption?: boolean; selectReverse?: boolean; selectOptionsFilter?: (record: Record, index: number, records: Record[]) => boolean; selectPagingOptionContent?: string | ReactNode; selectSearchable?: boolean; selectBoxSearchable?: boolean; selectReserveParam?: boolean; selectTrigger?: Action[]; secretFieldEnable?: () => boolean; secretFieldTypes?: () => object[]; secretFieldFetchVerifyCode?: (type: string) => Promise<object>; secretFieldQueryData?: (params: object) => Promise<object | string>; secretFieldSaveData?: (params: object) => Promise<object | string>; useColon?: boolean; requiredMarkAlign?: RequiredMarkAlign; textFieldAutoComplete?: string; resultStatusRenderer?: object; numberFieldFormatter?: FormatNumberFunc; numberFieldFormatterOptions?: FormatNumberFuncOptions; currencyFormatter?: FormatNumberFunc; currencyFormatterOptions?: FormatNumberFuncOptions; /** * 聚焦类型：checked 默认聚焦选中文本，focus 聚焦显示光标 */ fieldFocusMode?: FieldFocusMode; /** * 是否聚焦到 Form 可编辑的第一个表单组件上 */ formAutoFocus?: boolean; /** * 是否显示长度信息 */ showLengthInfo?: boolean; /** * moment非法时显示Invalid date */ showInvalidDate?: boolean; /** * 只有在空值时显示必填背景色和边框色 */ showRequiredColorsOnlyEmpty?: boolean; /** * 性能监控钩子 */ onPerformance?: PerformanceEventHook<keyof PerformanceEvents>; onTabsChange?: (props: { activeKey: string; title: string; activeGroupKey?: string; groupTitle?: string; code?: string; }) => void; onButtonClick?: (props: { title: string; icon?: string; }) => void; onComponentValidationReport?: (props: { showInvalid: boolean; component: any; }) => void; /** * 开启性能监控 */ performanceEnabled?: { [key in keyof PerformanceEvents]: boolean; }; /** * tooltip */ tooltip?: Tooltip | TooltipHook; /** * tooltip 主题 */ tooltipTheme?: TooltipTheme | TooltipThemeHook; /** * tooltip 位置 */ tooltipPlacement?: TooltipPlacement | TooltipPlacementHook; /** * 附件相关配置 */ attachment?: AttachmentConfig; /** * 表单校验提示方式 */ showValidation?: ShowValidation; /** * 显示提示信息的方式 */ showHelp?: ShowHelp; /** * Tabs 墨条样式 */ tabsInkBarStyle?: CSSProperties; /** * Tabs 个性化是否开启默认可配置 */ tabsDefaultChangeable?: boolean; /** * 个性化开关 */ customizable?: boolean | Customizable; customizedSave?: CustomizedSave; customizedLoad?: CustomizedLoad; /** * NumberField 是否启用UP DOWN键盘事件 */ numberFieldKeyboard?: boolean; /** * NumberField 和 Currency 组件的值是否在输入和显示时开启根据 precision 补零，真实值不受影响 */ useZeroFilledDecimal?: boolean; /** * 日期时间控件是否显示确定按钮 */ dateTimePickerOkButton?: boolean; fieldMaxTagPlaceholder?: ReactNode | ((omittedValues: any[]) => ReactNode); fieldMaxTagCount?: number; /** * 是否开启备选色板 */ colorPreset?: boolean; /** * Upload 组件文件上传失败后是否显示重新上传按钮。 * 当 listType 为 picture-card: true 为 icon, text 为文字形式; 其他 listType 都为文字形式 */ uploadShowReUploadIcon?: boolean | 'text' | UploadListReUploadIconFunc; /** * 输入框 range 分隔符 */ rangeSeparator?: string; /** * @deprecated */ validationTooltipTheme?: TooltipTheme; /** * @deprecated */ tableColumnTooltip?: Tooltip; /** * @deprecated */ buttonTooltip?: Tooltip; /** * @deprecated */ selectOptionTooltip?: Tooltip; /** * @deprecated */ labelTooltip?: Tooltip; /** * @deprecated */ excludeUseColonTagList?: string[]; /** * @deprecated */ tableDefaultRenderer?: ReactNode; /** * @deprecated * 同 tableColumnDraggable */ tableDragColumn?: boolean; /** * @deprecated * 同 tableRowDraggable */ tableDragRow?: boolean; /** * @deprecated */ lovTableCustomizable?: boolean; /** * @deprecated */ tableCustomizable?: boolean; /** * @deprecated */ performanceTableCustomizable?: boolean; /** * @deprecated */ tableCustomizedSave?: CustomizedSave; /** * @deprecated */ tableCustomizedLoad?: CustomizedLoad; /** * @deprecated */ bigNumberFormatter?: FormatBigNumberFunc; } export declare type ConfigKeys = keyof Config; export declare type DefaultConfig = DataSetDefaultConfig & (typeof defaults); export { getConfig, getPrefixCls, getProPrefixCls, getCustomizable, isCustomizable } from './utils'; export default function configure(config: Config, merge?: boolean): void;