clickgo 7.8.0 → 7.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,873 +1,28 @@
1
- import * as lCore from './core';
2
- import * as lCommand from './command';
3
- import * as lDom from './dom';
4
- import * as lControl from './control';
5
- import type * as lNativeEvents from './native/events';
6
1
  /**
7
- * --- 初始化系统级 ID,仅能设置一次 ---
8
- * @param id 系统级 ID
9
- */
10
- export declare function initSysId(id: string): void;
11
- /** --- Panel 与 Form 共用的抽象类 --- */
12
- declare abstract class AbstractCommon {
13
- /** --- 当前视图内局部注册的应用组件 --- */
14
- readonly components: Record<string, new () => AbstractComponent>;
15
- /** --- 当前文件在包内的路径 --- */
16
- get filename(): string;
17
- /** --- 当前控件的名字 --- */
18
- get controlName(): string;
19
- set controlName(v: string);
20
- /** --- 当前的任务 ID --- */
21
- get taskId(): string;
22
- /** --- 当前的窗体 ID --- */
23
- get formId(): string;
24
- set formFocus(b: boolean);
25
- /** --- 当前文件的包内路径不以 / 结尾 --- */
26
- get path(): string;
27
- /** --- 样式独占前缀 --- */
28
- get prep(): string;
29
- /** --- 当前的语言 --- */
30
- get locale(): string;
31
- /** --- 当前语言的标准 HTML lang 标签 --- */
32
- get localeTag(): string;
33
- /** --- 当前语言的书写方向 --- */
34
- get localeDirection(): 'ltr' | 'rtl';
35
- /**
36
- * --- 获取语言内容 ---
37
- */
38
- get l(): (key: string, data?: string[], origin?: boolean) => string;
39
- /** --- layout 中 :class 的转义 --- */
40
- get classPrepend(): (cla: any) => string;
41
- /**
42
- * --- 监视变动 ---
43
- * @param name 监视的属性
44
- * @param cb 回调
45
- * @param opt 参数
46
- */
47
- watch<T extends this, TK extends keyof T, TR>(name: TK | (() => TR), cb: (val: T[TK] & TR, old: T[TK] & TR) => void | Promise<void>, opt?: {
48
- 'immediate'?: boolean;
49
- 'deep'?: boolean;
50
- }): () => void;
51
- /**
52
- * --- 获取 refs 情况 ---
53
- */
54
- get refs(): Record<string, HTMLElement & lControl.AbstractControl & Record<string, any>>;
55
- /** --- 获取当前的 HTML DOM --- */
56
- get element(): HTMLElement;
57
- /**
58
- * --- 等待渲染 ---
59
- */
60
- get nextTick(): () => Promise<void>;
61
- /**
62
- * --- 判断当前事件可否执行 ---
63
- * @param e 鼠标、触摸、键盘事件
64
- */
65
- allowEvent(e: PointerEvent | KeyboardEvent): boolean;
66
- /**
67
- * --- 触发系统方法 ---
68
- * @param name 方法名
69
- * @param param1 参数1
70
- * @param param2 参数2
71
- */
72
- trigger(name: lCore.TGlobalEvent, param1?: boolean | Error | string, param2?: string): Promise<void>;
73
- /**
74
- * --- 给一个窗体发送一个对象,不会知道成功与失败状态 ---
75
- * @param fid formId 要接收对象的 form id
76
- * @param obj 要发送的对象
77
- */
78
- send(fid: string, obj: Record<string, any>): void;
79
- onBeforeCreate(): void | Promise<void>;
80
- onCreated(): void | Promise<void>;
81
- onBeforeMount(): void | Promise<void>;
82
- onBeforeUpdate(): void | Promise<void>;
83
- onUpdated(): void | Promise<void>;
84
- onBeforeUnmount(): void | Promise<void>;
85
- onUnmounted(): void | Promise<void>;
86
- }
87
- /** --- Panel 控件抽象类 --- */
88
- export declare abstract class AbstractPanel extends AbstractCommon {
89
- /** --- 当前的 panel ID --- */
90
- get panelId(): string;
91
- /** --- 当前 panel 所在窗体的窗体对象,系统会在创建时重写本函数 --- */
92
- get rootForm(): AbstractForm & Record<string, any>;
93
- /** --- 当前 panel 所在的 panel control 对象,系统会在创建时重写本函数 --- */
94
- get rootPanel(): lControl.AbstractControl & Record<string, any>;
95
- /** --- 获取母窗体的 formHash --- */
96
- get formHash(): string;
97
- /** --- 设置母窗体的 formHash --- */
98
- set formHash(fh: string);
99
- /** --- 获取 form 的 formhash with data 值 --- */
100
- get formHashData(): Record<string, any>;
101
- set formHashData(v: Record<string, any>);
102
- /** --- 将母窗体的 form hash 回退 --- */
103
- formHashBack(): Promise<void>;
104
- /** --- 发送一段数据到自己这个 panel 控件,本质上也是调用的 panel 控件的 send 方法,主要用来实现发送给跳转后的 panel --- */
105
- sendToRootPanel(data: Record<string, any>): void;
106
- /** --- 母窗体进入 form hash 为源的步进条 --- */
107
- enterStep(list: Array<{
108
- /** --- 步骤 hash,第一个必须为当前 hash --- */
109
- 'value': string;
110
- 'label'?: string;
111
- 'icon'?: string;
112
- 'desc'?: string;
113
- }>): Promise<boolean>;
114
- /** --- 目窗体完成当前步骤 --- */
115
- doneStep(): Promise<void>;
116
- /** --- 当前的 nav(若有)传递过来的 qs --- */
117
- qs: Record<string, string>;
118
- /** --- 确定不再使用 qs 时可调用此方法清空,这样再次通过相同 qs 进入本 panel 依然会响应 qschange 事件 --- */
119
- clearQs(): void;
120
- /** --- 当前窗体是否是焦点 --- */
121
- get formFocus(): boolean;
122
- onShow(e: IAbstractPanelShowEvent): void | Promise<void>;
123
- onShowed(): void | Promise<void>;
124
- onHide(): void | Promise<void>;
125
- onMounted(): void | Promise<void>;
126
- /** --- 接收 send 传递过来的 data 数据(是 panel 控件的 send,不是 form 的 send) --- */
127
- onReceive(data: Record<string, any>): void | Promise<void>;
128
- /** --- qs 变动时调用,如果只是用来做 qs 数据处理,建议用此方法 --- */
129
- onQsChange(): void | Promise<void>;
130
- /** --- 无论是 show 还是 qschange 都会触发,优先触发 show 或 qschange 事件本身,之后触发这个 --- */
131
- onQsChangeShow(e: IAbstractPanelQsChangeShowEvent): void | Promise<void>;
132
- }
133
- /** --- Form/Panel 内使用的应用局部组件抽象类 --- */
134
- export declare abstract class AbstractComponent extends AbstractCommon {
135
- /** --- 当前组件内继续局部注册的应用组件 --- */
136
- readonly components: Record<string, new () => AbstractComponent>;
137
- /** --- 当前组件所在窗体的创建序号 --- */
138
- get findex(): number;
139
- /** --- 当前组件所在窗体的窗体对象 --- */
140
- private _rootForm;
141
- get rootForm(): AbstractForm & Record<string, any>;
142
- /** --- 当前组件是否跟随宿主窗体获得焦点 --- */
143
- get formFocus(): boolean;
144
- /** --- 获取宿主 Form/Panel 的语言内容 --- */
145
- get l(): (key: string, data?: string[]) => string;
146
- /** --- 获取宿主窗体语言内容 --- */
147
- get fl(): (key: string, data?: string[]) => string;
148
- /** --- 应用组件动态 class 的隔离前缀 --- */
149
- get classPrepend(): (cla: any) => string;
150
- /** --- 组件内部文件,由系统重写 --- */
151
- readonly packageFiles: Record<string, Blob | string>;
152
- /** --- 组件参数,由用户定义重写 --- */
153
- readonly props: {};
154
- /** --- 组件事件,由用户定义重写 --- */
155
- readonly emits: Record<string, null | ((payload: any) => boolean)>;
156
- /** --- 组件的子插槽 --- */
157
- readonly slots: Record<string, () => any[]>;
158
- /** --- 获取某插槽所有子项 --- */
159
- get slotsAll(): (name: string) => any[];
160
- /** --- 获取 props 中的 boolean 类型值 --- */
161
- get propBoolean(): (name: keyof this['props']) => boolean;
162
- /** --- 获取 props 中的 number 类型值 --- */
163
- get propNumber(): (name: keyof this['props']) => number;
164
- /** --- 获取 props 中的 int 类型值 --- */
165
- get propInt(): (name: keyof this['props']) => number;
166
- /** --- 获取 props 中的 array 类型值 --- */
167
- get propArray(): (name: keyof this['props']) => any[];
168
- /** --- 向上触发组件事件 --- */
169
- emit(name: string, ...v: any[]): void;
170
- /** --- 获取上层控件或组件 --- */
171
- get parent(): lControl.AbstractControl & AbstractComponent & AbstractForm & Record<string, any>;
172
- /** --- 根据 controlName 查询上层对象 --- */
173
- get parentByName(): (controlName: string) => Record<string, any> | null;
174
- /** --- 根据 access 查询上层对象 --- */
175
- get parentByAccess(): (name: string, val: string) => Record<string, any> | null;
176
- /** --- 组件挂载好后触发 --- */
177
- onMounted(): void | Promise<void>;
178
- }
179
- /** --- 窗体的抽象类 --- */
180
- export declare abstract class AbstractForm extends AbstractCommon {
181
- /**
182
- * --- Native 普通启动及再次启动事件;网页不触发,App/Form 要求 root ---
183
- * @param event 业务参数、原生工作目录、来源及请求 ID
184
- * @returns 无;各层级独立收到通知,同一业务动作由应用选择一处执行
185
- */
186
- onNativeLaunch(event: lNativeEvents.INativeLaunchEvent): void | Promise<void>;
187
- /**
188
- * --- Native 文件打开全局事件,要求宿主启用 openFiles;App/Form 要求 root ---
189
- * @param paths 不含 /storage/ 的 ClickGo 绝对文件路径
190
- * @param info startup、second-instance、association 或 drop 来源及请求 ID
191
- * @returns 无;各层级独立通知,业务自行确认、保存和打开
192
- */
193
- onNativeOpenFiles(paths: string[], info: lNativeEvents.INativeOpenFilesInfo): void | Promise<void>;
194
- /** --- 当前是否完全创建完毕 --- */
195
- isReady: boolean;
196
- /** --- 是否是 native 下无边框的第一个窗体 --- */
197
- isNativeNoFrameFirst: boolean;
198
- /** --- 当前的窗体创建的位数 --- */
199
- get findex(): number;
200
- /** --- 获取 form 的 hash 值,不是浏览器的 hash --- */
201
- get formHash(): string;
202
- set formHash(v: string);
203
- /** --- 获取 form 的 formhash with data 值 --- */
204
- get formHashData(): Record<string, any>;
205
- set formHashData(v: Record<string, any>);
206
- /** --- 是否是置顶 --- */
207
- get topMost(): boolean;
208
- set topMost(v: boolean);
209
- /** --- 是否是置底 --- */
210
- get bottomMost(): boolean;
211
- set bottomMost(v: boolean);
212
- /**
213
- * --- 是否在本窗体上显示遮罩层 ---
214
- */
215
- get isMask(): boolean;
216
- /** --- 当前窗体是否是焦点 --- */
217
- get formFocus(): boolean;
218
- /** --- 当前窗体是否显示在任务栏 --- */
219
- get showInSystemTask(): boolean;
220
- set showInSystemTask(v: boolean);
221
- /** --- 将在 form 完全装载完后执行,如果已经装载完则立即执行 --- */
222
- ready(cb: () => void | Promise<void>): void;
223
- /** --- form hash 回退 --- */
224
- formHashBack(): Promise<void>;
225
- /** --- 发送一段数据到 panel 控件,本质上也是调用的 panel 控件的 send 方法 --- */
226
- sendToPanel(panel: lControl.AbstractControl & Record<string, any>, data: Record<string, any>): void;
227
- /** --- 覆盖整个窗体的 loading(实际值) --- */
228
- private _loading;
229
- /** --- 覆盖整个窗体的 loading --- */
230
- get loading(): boolean;
231
- set loading(val: boolean);
232
- /** --- 是否阻止任何人修改 loading --- */
233
- lockLoading: boolean;
234
- private _inStep;
235
- /** --- 当前是否在 step 环节中 --- */
236
- get inStep(): boolean;
237
- /** --- 序列化后的 step value 值 --- */
238
- private readonly _stepValues;
239
- /** --- 进入 form hash 为源的步进条 --- */
240
- enterStep(list: Array<{
241
- /** --- 步骤 hash,第一个必须为当前 hash --- */
242
- 'value': string;
243
- 'label'?: string;
244
- 'icon'?: string;
245
- 'desc'?: string;
246
- }>): Promise<boolean>;
247
- /** --- 更新步进条,用于动态改变某个项的 hash 值时使用 --- */
248
- updateStep(index: number, value: string): boolean;
249
- /** --- 完成当前步骤条 --- */
250
- doneStep(): Promise<void>;
251
- /** --- 当前是不是初次显示 --- */
252
- private _firstShow;
253
- /**
254
- * --- 显示窗体 ---
255
- */
256
- show(): Promise<void>;
257
- /**
258
- * --- 显示独占的窗体 ---
259
- */
260
- showDialog(): Promise<string>;
261
- /**
262
- * --- 让窗体隐藏 ---
263
- */
264
- hide(): void;
265
- /**
266
- * --- 关闭当前窗体 ---
267
- */
268
- close(): void;
269
- /**
270
- * --- dialog mask 窗体返回值,在 close 之后会进行传导 ---
271
- */
272
- dialogResult: string;
273
- onMounted(data: Record<string, any>): void | Promise<void>;
274
- /** --- 接收 send 传递过来的 data 数据 --- */
275
- onReceive(data: Record<string, any>): void | Promise<void>;
276
- /**
277
- * --- 宿主活跃状态改变时广播;初始化不通知,内部切换 Form 不触发 ---
278
- * @param active 页面可见且拥有焦点时为 true;切换页签、窗口或焦点移出页面时为 false
279
- * @returns 无
280
- */
281
- onActiveChanged(active: boolean): void | Promise<void>;
282
- /** --- 屏幕大小改变事件 --- */
283
- onScreenResize(): void | Promise<void>;
284
- /** --- 系统配置变更事件 --- */
285
- onConfigChanged<T extends keyof lCore.IConfig>(n: keyof lCore.IConfig, v: lCore.IConfig[T]): void;
286
- /** --- 窗体创建事件 --- */
287
- onFormCreated(taskId: string, formId: string, title: string, icon: string, showInSystemTask: boolean): void | Promise<void>;
288
- /** --- 窗体销毁事件 --- */
289
- onFormRemoved(taskId: string, formId: string, title: string, icon: string): void | Promise<void>;
290
- /** --- 窗体标题改变事件 --- */
291
- onFormTitleChanged(taskId: string, formId: string, title: string): void | Promise<void>;
292
- /** --- 窗体图标改变事件 --- */
293
- onFormIconChanged(taskId: string, formId: string, icon: string): void | Promise<void>;
294
- /** --- 窗体最小化状态改变事件 --- */
295
- onFormStateMinChanged(taskId: string, formId: string, state: boolean): void | Promise<void>;
296
- /** --- 窗体最大化状态改变事件 --- */
297
- onFormStateMaxChanged(taskId: string, formId: string, state: boolean): void | Promise<void>;
298
- /** --- 窗体显示状态改变事件 --- */
299
- onFormShowChanged(taskId: string, formId: string, state: boolean): void | Promise<void>;
300
- /** --- 窗体获得焦点事件 --- */
301
- onFormFocused(taskId: string, formId: string): void | Promise<void>;
302
- /** --- 窗体丢失焦点事件 --- */
303
- onFormBlurred(taskId: string, formId: string): void | Promise<void>;
304
- /** --- 窗体闪烁事件 --- */
305
- onFormFlash(taskId: string, formId: string): void | Promise<void>;
306
- /** --- 窗体是否显示在任务栏属性改变事件 --- */
307
- onFormShowInSystemTaskChange(taskId: string, formId: string, value: boolean): void | Promise<void>;
308
- /** --- 窗体的 formHash 改变事件 --- */
309
- onFormHashChange(taskId: string, formId: string, value: string, data: Record<string, any>): void | Promise<void>;
310
- /**
311
- * --- 托盘注册通知;通过 task.getTrayList(this) 读取快照 ---
312
- * @param taskId 所属任务
313
- * @param trayId 托盘 ID
314
- * @returns 无返回值
315
- */
316
- onTrayCreated(taskId: string, trayId: string): void | Promise<void>;
317
- /**
318
- * --- 托盘数据变更通知 ---
319
- * @param taskId 所属任务
320
- * @param trayId 托盘 ID
321
- * @returns 无返回值
322
- */
323
- onTrayChanged(taskId: string, trayId: string): void | Promise<void>;
324
- /**
325
- * --- 托盘删除通知 ---
326
- * @param taskId 所属任务
327
- * @param trayId 托盘 ID
328
- * @returns 无返回值
329
- */
330
- onTrayRemoved(taskId: string, trayId: string): void | Promise<void>;
331
- /**
332
- * --- 自己的托盘左键点击,只投递到所属任务 ---
333
- * @param trayId 托盘 ID
334
- * @returns 无返回值
335
- */
336
- onTrayClick(trayId: string): void | Promise<void>;
337
- /**
338
- * --- 自己的托盘菜单命令,只投递到所属任务 ---
339
- * @param trayId 托盘 ID
340
- * @param menuId 菜单命令
341
- * @returns 无返回值
342
- */
343
- onTrayMenuClick(trayId: string, menuId: string): void | Promise<void>;
344
- /** --- 任务开始事件 --- */
345
- onTaskStarted(taskId: string): void | Promise<void>;
346
- /** --- 任务结束事件 --- */
347
- onTaskEnded(taskId: string): void | Promise<void>;
348
- /**
349
- * --- 页面级 WebMCP 接入状态变化,所有 Form 共用同一状态 ---
350
- * @param status 浏览器接入状态,与 command.getAgentInfo 的 webMcp.status 一致
351
- * @returns 无返回值
352
- */
353
- onWebMcpStatusChanged(status: lCommand.TWebMcpStatus): void | Promise<void>;
354
- /**
355
- * --- Launcher 显示状态改变事件 ---
356
- * @param state 是否显示
357
- * @returns 无返回值
358
- */
359
- onLauncherShowChanged(state: boolean): void | Promise<void>;
360
- /** --- launcher 文件夹名称修改事件 --- */
361
- onLauncherFolderNameChanged(id: string, name: string): void | Promise<void>;
362
- /** --- location hash 改变事件 --- */
363
- onHashChanged(hash: string): void | Promise<void>;
364
- /** --- 键盘按下事件 --- */
365
- onKeydown(e: KeyboardEvent): void | Promise<void>;
366
- /** --- 键盘弹起事件 --- */
367
- onKeyup(e: KeyboardEvent): void | Promise<void>;
368
- }
369
- export declare let simpleSystemTaskRoot: lCore.IVue;
370
- export declare let launcherRoot: lCore.IVue;
371
- export declare const elements: {
372
- 'wrap': HTMLDivElement;
373
- 'list': HTMLDivElement;
374
- 'popList': HTMLDivElement;
375
- 'circular': HTMLDivElement;
376
- 'rectangle': HTMLDivElement;
377
- 'keyboard': HTMLDivElement;
378
- 'notify': HTMLElement;
379
- 'alert': HTMLElement;
380
- 'simpletask': HTMLDivElement;
381
- 'launcher': HTMLDivElement;
382
- 'confirm': HTMLDivElement;
383
- 'init': () => void;
384
- };
385
- /**
386
- * --- 刷新系统根节点及任务窗体的语言方向 ---
387
- * @param taskId 仅刷新指定任务,省略时刷新全部任务
388
- */
389
- export declare function refreshLocaleDirection(taskId?: string): void;
390
- /** --- 显示系统级询问框 --- */
391
- export declare function superConfirm(current: string, html: string): Promise<boolean>;
392
- /** --- 显示系统级虚拟键盘 --- */
393
- export declare function showKeyboard(): void;
394
- /** --- 隐藏系统级虚拟键盘 --- */
395
- export declare function hideKeyboard(): void;
396
- /**
397
- * --- 最小化某个窗体 ---
398
- * @param formId 窗体 id
399
- */
400
- export declare function min(formId: string): boolean;
401
- /**
402
- * --- 最大化某个窗体 ---
403
- * @param formId 窗体 id
404
- */
405
- export declare function max(formId: string): boolean;
406
- /**
407
- * --- 关闭一个窗体 ---
408
- * @param formId 窗体 id
409
- */
410
- export declare function close(formId: string): boolean;
411
- /**
412
- * --- 绑定窗体拖动大小事件,在 pointerdown 中绑定 ---
413
- * @param e 事件源
414
- * @param border 调整大小的方位
415
- */
416
- export declare function bindResize(e: PointerEvent, border: lDom.TDomBorder): void;
417
- /**
418
- * --- 绑定窗体拖动事件,在 pointerdown 中绑定 ---
419
- * @param e 事件源
420
- */
421
- export declare function bindDrag(e: PointerEvent): void;
422
- /**
423
- * --- 重置所有已经最大化的窗体大小和位置 ---
424
- */
425
- export declare function refreshMaxPosition(): void;
426
- /**
427
- * --- 根据窗体 id 获取 task id ---
428
- * @param formId 窗体 id
429
- */
430
- export declare function getTaskId(formId: string): string;
431
- /**
432
- * --- 获取窗体信息 ---
433
- * @param formId 窗体 id
434
- */
435
- export declare function get(formId: string): IFormInfo | null;
436
- /**
437
- * --- 给一个窗体发送一个对象,不会知道成功与失败状态,用 this.send 替代 ---
438
- * @param formId 要接收对象的 form id
439
- * @param obj 要发送的对象
440
- */
441
- export declare function send(formId: string, obj: Record<string, any>): void;
442
- /**
443
- * --- 获取 form list 的简略情况 ---
444
- * @param taskId 任务 ID
445
- */
446
- export declare function getList(taskId: lCore.TCurrent): Record<string, IFormInfo>;
447
- /**
448
- * --- 获取当前有焦点的窗体 form id ---
449
- */
450
- export declare function getFocus(): string | null;
451
- /**
452
- * --- 当前活跃中的 panelId 列表 ---
453
- */
454
- export declare const activePanels: Record<string, string[]>;
455
- /**
456
- * --- 获取窗体当前活跃中的 panelId 列表 ---
457
- * @param formId 要获取的窗体 id
458
- */
459
- export declare function getActivePanel(formId: string): string[];
460
- /**
461
- * --- 移除 form 中正在活跃中的 panel id (panel 本身被置于隐藏时)
462
- * @param current 当前任务 id
463
- * @param formId 所属 form id
464
- * @param panelId panel id
465
- */
466
- export declare function removeActivePanel(current: lCore.TCurrent, formId: string, panelId: string): boolean;
467
- /**
468
- * --- 将 form 中某个 panel 设置为活动的 ---
469
- * @param current 当前任务 id
470
- * @param formId 所属 form id
471
- * @param panelId panel id
472
- */
473
- export declare function setActivePanel(current: lCore.TCurrent, formId: string, panelId: string): boolean;
474
- /**
475
- * --- 修改窗体 hash ---
476
- * @param formId 要修改的窗体 ID
477
- * @param hash 修改的值,不含 #
478
- */
479
- export declare function hash(formId: string, hash: string): boolean;
480
- /**
481
- * --- 获取窗体的 hash ---
482
- */
483
- export declare function getHash(formId: string): string;
484
- /**
485
- * --- 将窗体的 hash 退回上一个 ---
486
- */
487
- export declare function hashBack(formId: string): Promise<boolean>;
488
- /**
489
- * --- 改变 form 的焦点 class ---
490
- * @param formId 变更后的 form id
491
- */
492
- export declare function changeFocus(formId?: string): Promise<void>;
493
- /**
494
- * --- 获取当前 z-index 值最大的 form id(除了 top 模式的窗体和最小化的窗体) ---
495
- * @param current 当前任务 id
496
- * @param out 排除选项
497
- */
498
- export declare function getMaxZIndexID(current: lCore.TCurrent, out?: {
499
- 'taskIds'?: string[];
500
- 'formIds'?: string[];
501
- }): Promise<string | null>;
502
- /**
503
- * --- 让最大的 z index 窗体获取焦点(不含 top 和最小化的) ---
504
- */
505
- export declare function changeFocusMaxZIndex(): Promise<void>;
506
- /**
507
- * --- 根据 border 方向 获取理论窗体大小 ---
508
- * @param border 显示的位置代号
509
- * @param area 布局区域,默认避开任务栏
510
- * @returns 对应区域内的窗体矩形
511
- */
512
- export declare function getRectByBorder(border: lDom.TDomBorderCustom, area?: lCore.IAvailArea): {
513
- 'width': number;
514
- 'height': number;
515
- 'left': number;
516
- 'top': number;
517
- };
518
- /**
519
- * --- 显示从小到大的圆圈动画特效对象 ---
520
- * @param x X 坐标
521
- * @param y Y 坐标
522
- */
523
- export declare function showCircular(x: number, y: number): void;
524
- /**
525
- * --- 移动矩形到新位置 ---
526
- * @param border 显示的位置代号
527
- * @returns 无返回值
528
- */
529
- export declare function moveRectangle(border: lDom.TDomBorderCustom): void;
530
- /**
531
- * --- 显示从小到大的矩形动画特效对象 ---
532
- * @param x 起始位置
533
- * @param y 起始位置
534
- * @param border 最大时位置代号
535
- */
536
- export declare function showRectangle(x: number, y: number, border: lDom.TDomBorderCustom): void;
537
- /**
538
- * --- 结束时请隐藏矩形 ---
539
- */
540
- export declare function hideRectangle(): void;
541
- /**
542
- * --- 从下方弹出 alert ---
543
- * @param content 内容
544
- * @param type 样式,可留空
545
- */
546
- export declare function alert(content: string, type?: 'default' | 'primary' | 'info' | 'warning' | 'danger' | 'cg'): number;
547
- /**
548
- * --- 按当前可用区域和实际高度重新排列通知 ---
549
- * @returns 无返回值
550
- */
551
- export declare function refreshNotifyPosition(): void;
552
- /**
553
- * --- 弹出右下角信息框 ---
554
- * @param opt timeout 默认 5 秒,最大 10 分钟
555
- * @returns notify id,一定大于 0
556
- */
557
- export declare function notify(opt: INotifyOptions): number;
558
- /**
559
- * --- 修改 notify 的进度条进度 ---
560
- * @param notifyId notify id
561
- * @param per 进度,0 - 100 或 0% - 100% (0 - 1)
562
- */
563
- export declare function notifyProgress(notifyId: number, per: number): void;
564
- /**
565
- * --- 修改 notify 的提示信息 ---
566
- * @param notifyId notify id
567
- * @param opt 参数
568
- */
569
- export declare function notifyContent(notifyId: number, opt: INotifyContentOptions): void;
570
- /**
571
- * --- 隐藏 notify ---
572
- * @param notifyId 要隐藏的 notify id
573
- */
574
- export declare function hideNotify(notifyId: number): void;
575
- /**
576
- * --- 将标签追加到 pop 层 ---
577
- * @param el 要追加的标签
578
- */
579
- export declare function appendToPop(el: HTMLElement): void;
580
- /**
581
- * --- 将标签从 pop 层移除 ---
582
- * @param el 要移除的标签
583
- */
584
- export declare function removeFromPop(el: HTMLElement): void;
585
- /**
586
- * --- 获取 pop 显示出来的坐标并报系统全局记录 ---
587
- * @param el 响应的元素
588
- * @param pop 要显示 pop 元素
589
- * @param direction 要显示方向(以 $el 为准的 h 水平 v 垂直 t 垂直水平居中)或坐标
590
- * @param opt width / height 显示的 pop 定义自定义宽/高度,可省略;null,true 代表为空也会显示,默认为 false; autoPosition, 因 pop 内部内容变动导致的自动更新 pop 位置,默认 false,autoScroll,因原元素位置变更导致 pop 位置变更,默认 false,flow: 是否加入 pop 流,默认加入,不加入的话将不会自动隐藏
591
- */
592
- export declare function showPop(el: HTMLElement | lCore.IVue, pop: HTMLElement | lCore.IVue | undefined, direction: 'h' | 'v' | 't' | PointerEvent | {
593
- x: number;
594
- y: number;
595
- }, opt?: {
596
- 'size'?: {
597
- width?: number;
598
- height?: number;
599
- };
600
- 'null'?: boolean;
601
- 'autoPosition'?: boolean;
602
- 'autoScroll'?: boolean;
603
- 'flow'?: boolean;
604
- /** --- 滚动内容默认 auto;带外部箭头的提示框使用 visible --- */
605
- 'overflow'?: 'auto' | 'visible';
606
- /** --- 展示托管方式 --- */
607
- 'way'?: 'normal' | 'click' | 'hover';
608
- }): void;
609
- /**
610
- * --- 隐藏正在显示中的所有 pop,或指定 pop/el ---
611
- */
612
- export declare function hidePop(pop?: HTMLElement | lCore.IVue): void;
613
- /** --- 检测 pop 是不是刚刚显示的 --- */
614
- export declare function isJustPop(el: HTMLElement | number): boolean;
615
- /**
616
- * --- 点下 pointerdown 屏幕任意一位置时根据点击处处理隐藏 pop 和焦点丢失事件,鼠标和 touch 只会响应一个 ---
617
- * @param e 事件对象
618
- */
619
- export declare function doFocusAndPopEvent(e: PointerEvent): Promise<void>;
620
- /**
621
- * --- 移除一个 form(关闭窗口) ---
622
- * @param formId 要移除的 form id
623
- */
624
- export declare function remove(formId: string): boolean;
625
- /**
626
- * --- 移除 panel 挂载,通常发生在 panel 控件的 onBeforeUnmount 中 ---
627
- * @param id panel id
628
- * @param vapp panel 的 vapp 对象 ---
629
- * @param el panel 控件
630
- */
631
- export declare function removePanel(id: string, vapp: lCore.IVApp, el: HTMLElement): boolean;
632
- /**
633
- * --- 创建 panel 对象,一般情况下无需使用 ---
634
- * @param rootPanel 根 panel 控件
635
- * @param cls 路径字符串或 AbstractPanel 类
636
- * @param opt 选项
637
- */
638
- export declare function createPanel<T extends AbstractPanel>(rootPanel: lControl.AbstractControl, cls: string | (new () => T), opt?: {
639
- /** --- 布局内容 --- */
640
- 'layout'?: string;
641
- /** --- 样式内容 --- */
642
- 'style'?: string;
643
- /** --- cls 为 string 时,path 参数才有效,为基准路径,如果不以 / 结尾则以最后一个 / 字符为准 --- */
644
- 'path'?: string;
645
- }): Promise<{
646
- 'id': string;
647
- 'vapp': lCore.IVApp;
648
- 'vroot': T;
649
- }>;
650
- /**
651
- * --- 创建一个窗体 ---
652
- * @param current 当前任务 ID
653
- * @param cls 路径字符串或 AbstractForm 类
654
- * @param data 要传递的对象
655
- * @param opt 其他替换选项
656
- */
657
- export declare function create<T extends AbstractForm>(current: lCore.TCurrent, cls: string | (new () => T), data?: Record<string, any>, opt?: {
658
- 'layout'?: string;
659
- 'style'?: string;
660
- /** --- cls 为 string 时,path 参数才有效,为基准路径,如果不以 / 结尾则以最后一个 / 字符为准 --- */
661
- 'path'?: string;
662
- }): Promise<T>;
663
- /**
664
- * --- 显示一个 dialog ---
665
- * @param current 当前任务
666
- * @param opt 选项或者一段文字
667
- */
668
- export declare function dialog(current: lCore.TCurrent, opt: string | IFormDialogOptions): Promise<string>;
669
- /**
670
- * --- 显示一个验证码窗口 ---
671
- * @param current 当前任务
672
- * @param opt 选项
673
- * @returns 验证是否通过
674
- */
675
- export declare function captcha(current: lCore.TCurrent, opt: IFormCaptchaOptions): Promise<false | lControl.ICaptchaResultEvent>;
676
- /**
677
- * --- 显示一个 confirm ---
678
- * @param current 当前任务 id
679
- * @param opt 选项或者一段文字
680
- */
681
- export declare function confirm(current: lCore.TCurrent, opt: string | IFormConfirmOptions): Promise<boolean | number>;
682
- /**
683
- * --- 显示一个输入框 dialog ---
684
- * @param current 当前任务 id
685
- * @param opt 选项或者提示文字
686
- */
687
- export declare function prompt(current: lCore.TCurrent, opt: string | IFormPromptOptions): Promise<string>;
688
- /**
689
- * --- 让窗体闪烁 ---
690
- * @param current 所属的 taskId
691
- * @param formId 要闪烁的窗体 id,必填
692
- */
693
- export declare function flash(current: lCore.TCurrent, formId: string): Promise<void>;
694
- /**
695
- * --- 查询 Launcher 当前显示状态,供首次挂载时同步 ---
696
- * @returns 是否显示
697
- */
698
- export declare function getLauncherShow(): boolean;
699
- /**
700
- * --- 显示 launcher 界面;状态变化时通知所有应用与窗体 ---
701
- * @returns 无返回值
702
- */
703
- export declare function showLauncher(): void;
704
- /**
705
- * --- 隐藏 launcher 界面;重复关闭不重复通知或安排清理 ---
706
- * @returns 无返回值
707
- */
708
- export declare function hideLauncher(): void;
709
- export declare function init(): void;
710
- /** --- AbstractPanel 显示事件 --- */
711
- export interface IAbstractPanelShowEvent {
712
- 'detail': {
713
- 'data': Record<string, any>;
714
- /** --- 是否是 nav 模式 --- */
715
- 'nav': boolean;
716
- /** --- 仅 nav 联动时有效,代表是前进还是回退 --- */
717
- 'action': 'forword' | 'back';
718
- /** --- 仅 nav 联动时有效,代表上一个的 formHash 的值 --- */
719
- 'previous': string;
720
- /** --- 仅 nav 联动时有效,代表本次 show 的时候 qs 是否发生了变化 --- */
721
- 'qsChange': boolean;
722
- };
723
- }
724
- /** --- AbstractPanel qsChange 显示事件 --- */
725
- export interface IAbstractPanelQsChangeShowEvent {
726
- 'detail': {
727
- 'data': Record<string, any>;
728
- /** --- 是否是 nav 模式 --- */
729
- 'nav': boolean;
730
- /** --- 仅 nav 联动时有效,代表是前进还是回退 --- */
731
- 'action': 'forword' | 'back';
732
- /** --- 仅 nav 联动时有效,代表上一个的 formHash 的值 --- */
733
- 'previous': string;
734
- /** --- 仅 nav 联动时有效,代表本次 qs 是否发生了变化 --- */
735
- 'qsChange': boolean;
736
- };
737
- }
738
- /** --- 运行时 task 中的 form 对象 --- */
739
- export interface IForm {
740
- 'id': string;
741
- 'vapp': lCore.IVApp;
742
- 'vroot': lCore.IVue;
743
- /** --- 是否已经执行过了关闭窗体方法,此处加判断为了防止重复执行 close 导致的 bug --- */
744
- 'closed': boolean;
745
- }
746
- /** --- Form 的简略情况,通常在 list 当中 --- */
747
- export interface IFormInfo {
748
- 'taskId': string;
749
- 'title': string;
750
- 'icon': string;
751
- 'stateMax': boolean;
752
- 'stateMin': boolean;
753
- 'show': boolean;
754
- 'focus': boolean;
755
- 'showInSystemTask': boolean;
756
- }
757
- /** --- 移动 drag 到新位置函数的选项 --- */
758
- export interface IMoveDragOptions {
759
- 'top'?: number;
760
- 'left'?: number;
761
- 'width'?: number;
762
- 'height'?: number;
763
- 'icon'?: boolean;
764
- }
765
- /** --- 弹出 notify 信息框的选项 --- */
766
- export interface INotifyOptions {
767
- 'title'?: string;
768
- /** --- 正文 --- */
769
- 'content'?: string;
770
- /** --- 浅色描述 --- */
771
- 'note'?: string;
772
- 'icon'?: string | null;
773
- 'timeout'?: number;
774
- 'type'?: 'primary' | 'info' | 'warning' | 'danger' | 'progress';
775
- 'progress'?: boolean;
776
- }
777
- /** --- notify 信息框的修改选项 --- */
778
- export interface INotifyContentOptions {
779
- 'title'?: string;
780
- 'content'?: string;
781
- 'note'?: string;
782
- /** --- 可顺便修改进度 --- */
783
- 'progress'?: number;
784
- /** --- 设置后将在 x 毫秒后隐藏,这不会大于创建时的设置的总时长 --- */
785
- 'timeout'?: number;
786
- }
787
- /** --- Dialog 选项 --- */
788
- export interface IFormDialogOptions {
789
- /** --- dialog 窗体标题,不传则使用默认标题 dialog --- */
790
- 'title'?: string;
791
- /** --- dialog 内容,支持直接传布局字符串 --- */
792
- 'content': string;
793
- /** --- 底部按钮文本列表,默认使用当前语言的确定按钮文本 --- */
794
- 'buttons'?: string[];
795
- /** --- 点击按钮后是否自动将按钮文本写入 dialogResult,默认 true --- */
796
- 'autoDialogResult'?: boolean;
797
- /** --- dialog 控件内容布局方向,h 为横向,v 为纵向 --- */
798
- 'direction'?: 'h' | 'v';
799
- /** --- dialog 控件内容区项目间距,会透传给 dialog 控件 --- */
800
- 'gutter'?: number | string;
801
- /** --- dialog 控件宽度,传数字时为像素值,传 fill 时代表填充可用宽度 --- */
802
- 'width'?: number | string;
803
- /** --- dialog 控件高度,传数字时为像素值,传 fill 时代表填充可用高度 --- */
804
- 'height'?: number | string;
805
- /** --- dialog 控件内容区是否显示内边距,默认表现与控件自身一致 --- */
806
- 'padding'?: boolean | string;
807
- /** --- 传值,需要用 data.x 读取 --- */
808
- 'data'?: Record<string, any>;
809
- /** --- 传值,需要用 methods.x 读取 --- */
810
- 'methods'?: Record<string, (...param: any) => any>;
811
- /** --- 样式表 --- */
812
- 'style'?: string;
813
- /** --- 路径基,以 / 结束或文件路径则以文件的基路径为准,可留空 --- */
814
- 'path'?: string;
815
- /**
816
- * --- 点击按钮触发事件,不能用 Promise ---
817
- * @param e 数据事件
818
- * @param button 按钮的文本
819
- */
820
- select?: (this: AbstractForm & {
821
- 'data': Record<string, any>;
822
- 'methods': Record<string, (...param: any) => any>;
823
- }, e: IFormDialogSelectEvent, button: string) => void;
824
- /**
825
- * --- 窗体挂载完成事件 ---
826
- */
827
- onMounted?: () => void | Promise<void>;
828
- }
829
- export interface IFormDialogSelectEvent extends lControl.ICustomEvent {
830
- 'detail': {
831
- 'button': string;
832
- };
833
- }
834
- /** --- Confirm 选项 --- */
835
- export interface IFormConfirmOptions {
836
- 'title'?: string;
837
- 'content': string;
838
- 'cancel'?: boolean;
839
- }
840
- /** --- 显示验证码选项 --- */
841
- export interface IFormCaptchaOptions {
842
- /** --- 验证码服务商 --- */
843
- 'factory': 'tc' | 'cf';
844
- /** --- 验证码 key --- */
845
- 'akey': string;
846
- }
847
- /** --- Prompt 选项 --- */
848
- export interface IFormPromptOptions {
849
- /** --- 标题 --- */
850
- 'title'?: string;
851
- /** --- 内容说明 --- */
852
- 'content': string;
853
- /** --- 文本默认值 --- */
854
- 'text'?: string;
855
- /** --- 是否显示取消按钮,默认显示 --- */
856
- 'cancel'?: boolean;
857
- /**
858
- * --- 点击按钮触发事件 ---
859
- * @param e 数据事件
860
- * @param button true 代表确定,false 代表取消
861
- */
862
- 'select'?: (this: AbstractForm & {
863
- 'data': Record<string, any>;
864
- }, e: IFormPromptSelectEvent, button: boolean) => void;
865
- }
866
- export interface IFormPromptSelectEvent extends lControl.ICustomEvent {
867
- 'detail': {
868
- /** --- true 代表确定,false 代表取消 --- */
869
- 'button': boolean;
870
- 'value': string;
871
- };
872
- }
873
- export {};
2
+ * Copyright 2007-2025 MAIYUN.NET
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * https://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ export { initSysId } from './form/state';
17
+ export { AbstractPanel } from './form/abstract-panel';
18
+ export { AbstractComponent } from './form/abstract-component';
19
+ export { AbstractForm } from './form/abstract-form';
20
+ export { min, max, close, bindResize, bindDrag, refreshMaxPosition, getTaskId, get, send, getList, getFocus, activePanels, getActivePanel, removeActivePanel, setActivePanel, hash, getHash, hashBack, changeFocus, getMaxZIndexID, changeFocusMaxZIndex, flash, } from './form/window';
21
+ export { getRectByBorder, showCircular, moveRectangle, showRectangle, hideRectangle } from './form/effects';
22
+ export { dialog, captcha, confirm, prompt } from './form/dialog';
23
+ export { create, createPanel } from './form/create';
24
+ export { remove, removePanel } from './form/remove';
25
+ export { elements, simpleSystemTaskRoot, launcherRoot, refreshLocaleDirection, superConfirm, showKeyboard, hideKeyboard, getLauncherShow, showLauncher, hideLauncher, init, } from './form/system';
26
+ export { showPop, hidePop, isJustPop, doFocusAndPopEvent, appendToPop, removeFromPop } from './form/popup';
27
+ export { alert, refreshNotifyPosition, notify, notifyProgress, notifyContent, hideNotify } from './form/notification';
28
+ export type { IAbstractPanelShowEvent, IAbstractPanelQsChangeShowEvent, IForm, IFormInfo, IMoveDragOptions, INotifyOptions, INotifyContentOptions, IFormDialogOptions, IFormDialogSelectEvent, IFormConfirmOptions, IFormCaptchaOptions, IFormPromptOptions, IFormPromptSelectEvent, } from './form/types';