跳转到内容

搜索表单

搜索表单包含输入框、单选框、下拉选择、多选框等用户输入组件,用于收集数据并执行过滤搜索。

布局

按钮样式

无保存条件

过滤

自动搜索

高级搜索

搜索表单事件

搜索表单项事件

搜索表单能力

输入参数

名称说明类型默认值
modelData搜索表单模型数据Object as IDESearchForm-
context应用上下文对象Object as IContext-
params视图参数对象Object as IParams{}
provider部件适配器Object as IControlProvider-
isSimple是否是简单模式,即直接传入数据,不加载数据Boolean-
data简单模式下传入的数据Object as IData-
loadDefault是否默认加载数据Booleantrue

状态

名称说明类型默认值
isCreated控制器是否走完created生命周期booleanfalse
isMounted控制器是否走完mounted生命周期booleanfalse
isDestroyed控制器是否走完destroy生命周期booleanfalse
context应用上下文对象IApiContext{}
activated当前部件是否为激活状态(缓存下的激活状态,一般与框架的生命周期相同)booleanfalse
isSimple是否是简单模式,简单模式下不加载数据,而是由父组件传值booleanfalse
isLoading部件是否正在加载booleanfalse
loadDefault是否默认加载数据booleantrue
disabled部件禁用状态booleanfalse
maskOption部件遮罩参数IApiMaskOption-
isLoaded是否加载完数据booleanfalse
data表单数据IApiData{}
processing是否正在处理中(动态控制,值规则,表单项更新等逻辑中)booleanfalse
modified是否被修改过booleanfalse
activeTab当前激活分页string-
formIsDestroyed表单是否销毁(UI)booleanfalse
simpleDataIndex简单模式数据索引number0
enableStoredFilters是否启用存储过滤条件booleantrue
storedFilters存储的过滤条件集合IApiStoredFilter[][]

控制器

名称说明类型
id控制器实例的唯一标识,创建时自动生成 string
state状态对象,泛型 S
model模型对象,泛型 T
context应用上下文对象 IApiContext
params视图参数对象 IApiParams
view当前视图控制器 IApiViewController & IApiData
ctrlId部件标识 string
controlParams部件参数 IApiParams
layoutPanel部件布局面板控制器 IApiViewLayoutPanelController & IApiData
runMode运行模式(DESIGN:设计模式,RUNTIME:运行时) 'DESIGN' | 'RUNTIME'
details所有表单项成员的控制器 { [key: string]: IApiFormDetailController }
formItems表单项控制器集合 IApiFormDetailController[]
formMDCtrls表单多数据部件控制器集合 IApiFormMDCtrlController[]
formDruipart表单关系界面控制器集合 IApiFormDruipartController[]
force强制更新,触发render函数(_callback?: () => void) => void
startLoading开始加载() => Promise<void>
endLoading加载完毕() => Promise<void>
getControlType获取部件类型() => string
enable取消部件禁用() => void
disabled设置部件禁用(options?: IApiMaskOption) => void
emitDEDataChange触发实体数据变更的通知(type: 'create' | 'update' | 'remove', data: IApiData) => void
getData获取表单数据() => IApiData[]
getReal获取原始实体数据() => IApiData[]
refresh刷新当前部件() => Promise<void>
changeCollapse切换折叠(params?: { tag?: string; expand?: boolean }) => void
setActiveTab设置表单激活分页(name: string) => void
setDataValue设置表单数据(name: string, value: unknown, ignore?: boolean) => Promise<void>
setDetailError设置指定项错误提示(name: string, message: string) => void
validate表单校验() => Promise<boolean>
silentValidate表单静默校验() => Promise<boolean>
getFormDetail获取表单成员(type: K, id: string) => IApiFormDetailMapping[K]
getSimpleDataIndex获取简单模式下当前表单的数据索引() => number
load加载数据() => Promise<IApiData>
getFilterParams获取搜索表单的过滤参数() => IApiParams
search执行搜索行为() => Promise<void>
reset重置() => Promise<void>
storeFilter存储搜索条件(name: string) => Promise<void>
applyStoredFilter应用保存的过滤条件(index: number) => void
removeStoredFilter删除保存的过滤条件(index: number) => Promise<void>

事件

名称描述类型
onCreated自身的准备工作完成(如模型加载,各种初始化,init结束){eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onMounted没有下级组件created之后的生命周期,有下级时需要等所有下级组件onMounted完成后触发{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onBeforeDestroy组件销毁前{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onDestroyed自身组件被销毁时触发{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onActivated自身组件重新激活{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onDeactivated自身组件暂时停用{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onUIAction界面行为执行{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onRefreshSuccess刷新成功{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onFormDataChange表单数据变更事件{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onBeforeLoadDraft加载草稿前{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onLoadDraftSuccess加载草稿成功后{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onLoadDraftError加载草稿失败后{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onFormDetailEvent表单里的成员事件监听{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onSearch搜索事件{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
openAdvanceSearch打开高级搜索{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}

控件动态参数

名称说明类型默认值
emptyhiddenunit表单项无值时,其对应的值单位(如'天'、'%'等)是否隐藏booleanfalse
enablestoredfilters设置为true的时候初始化时就会去加载保存的过滤条件,并将过滤条件附加在后续搜索行为的查询参数中booleantrue

部件成员

类型名称接口
BUTTON表单按钮IApiFormButtonController
BUTTONLIST表单按钮组IApiFormButtonListController
DRUIPART表单关系界面IApiFormDruipartController
GROUPPANEL表单分组IApiFormGroupPanelController
FORMITEM表单项IApiFormItemController
MDCTRL_LIST表单多数据部件(列表)IApiFormMDCtrlMDController
MDCTRL_GRID表单多数据部件(表格)IApiFormMDCtrlMDController
MDCTRL_DATAVIEW表单多数据部件(卡片)IApiFormMDCtrlMDController
MDCTRL_FORM表单多数据部件(表单)IApiFormMDCtrlFormController
MDCTRL_REPEATER表单多数据部件(重复器)IApiFormMDCtrlRepeaterController
FORMPAGE表单分页IApiFormPageController
RAWITEM表单直接内容IApiFormRawItemController
TABPAGE表单分页部件分页IApiFormTabPageController
TABPANEL表单分页部件IApiFormTabPanelController
未来已来,立即拥抱应用融合的力量
Released under the MIT License.