-
Notifications
You must be signed in to change notification settings - Fork 138
/
types.ts
618 lines (547 loc) Β· 14.9 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
/**
* @license
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://github.com/IDuxFE/idux/blob/main/LICENSE
*/
/* eslint-disable @typescript-eslint/no-explicit-any */
import type { BreakpointKey } from '@idux/cdk/breakpoint'
import type { PopperPlacement, PopperTrigger } from '@idux/cdk/popper'
import type { PortalTargetType } from '@idux/cdk/portal'
import type { AlertType } from '@idux/components/alert'
import type { AvatarShape, AvatarSize } from '@idux/components/avatar'
import type { ButtonSize } from '@idux/components/button'
import type { CardSize } from '@idux/components/card'
import type { CarouselDotPlacement, CarouselDotTrigger } from '@idux/components/carousel'
import type { CascaderData } from '@idux/components/cascader'
import type { CollapseSize } from '@idux/components/collapse'
import type { DatePickerType } from '@idux/components/date-picker'
import type { DescLabelAlign, DescLayout, DescSize } from '@idux/components/desc'
import type { FormLabelAlign, FormLayout, FormSize } from '@idux/components/form'
import type { ListSize } from '@idux/components/list'
import type { LoadingBarAnimation } from '@idux/components/loading-bar'
import type { Locale } from '@idux/components/locales'
import type { MenuData, MenuTheme } from '@idux/components/menu'
import type { MessageType } from '@idux/components/message'
import type { ModalType } from '@idux/components/modal'
import type { NotificationPlacement, NotificationType } from '@idux/components/notification'
import type { PaginationSize } from '@idux/components/pagination'
import type { ProgressFormat, ProgressIcons, ProgressSize } from '@idux/components/progress'
import type { ResultStatus } from '@idux/components/result'
import type { SelectData } from '@idux/components/select'
import type { SpinSize, SpinTipAlignType } from '@idux/components/spin'
import type { StepperLabelPlacement, StepperSize } from '@idux/components/stepper'
import type {
TableColumnAlign,
TableColumnIndexable,
TableColumnSortOrder,
TableEmptyCellOptions,
TablePaginationPosition,
TableSize,
} from '@idux/components/table'
import type { TabsSize } from '@idux/components/tabs'
import type { TagShape } from '@idux/components/tag'
import type { TextCopyIconRenderer, TextExpandIconRenderer } from '@idux/components/text'
import type { TextareaAutoRows, TextareaResize } from '@idux/components/textarea'
import type { DeepPartialThemeTokens, PresetTheme, ThemeProviderAttachTo } from '@idux/components/theme'
import type { TargetGap, TourMaskOptions } from '@idux/components/tour'
import type { TreeExpandIconRenderer, TreeNode } from '@idux/components/tree'
import type { UploadFilesType, UploadIconType, UploadRequestMethod, UploadRequestOption } from '@idux/components/upload'
import type { OverlayContainerType } from '@idux/components/utils'
import type { VNode, VNodeChild } from 'vue'
export interface GlobalConfig {
common: CommonConfig
locale: Locale
theme: ThemeConfig
alert: AlertConfig
anchor: AnchorConfig
avatar: AvatarConfig
backTop: BackTopConfig
badge: BadgeConfig
button: ButtonConfig
card: CardConfig
carousel: CarouselConfig
cascader: CascaderConfig
checkbox: CheckboxConfig
collapse: CollapseConfig
datePicker: DatePickerConfig
desc: DescConfig
divider: DividerConfig
drawer: DrawerConfig
dropdown: DropdownConfig
empty: EmptyConfig
form: FormConfig
icon: IconConfig
input: InputConfig
inputNumber: InputNumberConfig
list: ListConfig
loadingBar: LoadingBarConfig
image: ImageConfig
imageViewer: ImageViewerConfig
menu: MenuConfig
message: MessageConfig
modal: ModalConfig
notification: NotificationConfig
pagination: PaginationConfig
popconfirm: PopconfirmConfig
popover: PopoverConfig
progress: ProgressConfig
radio: RadioConfig
rate: RateConfig
result: ResultConfig
row: RowConfig
select: SelectConfig
skeleton: SkeletonConfig
space: SpaceConfig
spin: SpinConfig
statistic: StatisticConfig
stepper: StepperConfig
switch: SwitchConfig
tabs: TabsConfig
table: TableConfig
tag: TagConfig
tagGroup: TagGroupConfig
textarea: TextareaConfig
text: TextConfig
timePicker: TimePickerConfig
transfer: TransferConfig
tooltip: TooltipConfig
tour: TourConfig
tree: TreeConfig
treeSelect: TreeSelectConfig
upload: UploadConfig
uploadFiles: UploadFilesConfig
}
export type GlobalConfigKey = keyof GlobalConfig
export interface CommonConfig {
prefixCls: string
overlayContainer?: OverlayContainerType
overlayZIndex: number | (() => number)
}
export interface ThemeConfig extends DeepPartialThemeTokens {
presetTheme: PresetTheme
injectThemeStyle: boolean
hashed: boolean
attachTo?: ThemeProviderAttachTo
}
export interface AlertConfig {
closable: boolean
icon: string | Partial<Record<AlertType, string>>
}
export interface AnchorConfig {
bounds: number
hideLinkBall: boolean
}
export interface AvatarConfig {
gap: number
icon: string | VNode
shape: AvatarShape
size: AvatarSize | Partial<Record<BreakpointKey, number>>
}
export interface BackTopConfig {
duration: number
visibilityHeight: number
}
export interface BadgeConfig {
/**
* @deprecated
*/
dot: boolean
overflowCount: number | string
showZero: boolean
}
export interface ButtonConfig {
size: ButtonSize
waveless: boolean
}
export interface CardConfig {
size: CardSize
borderless: boolean
hoverable: boolean
shadow: boolean
}
export interface CarouselConfig {
autoplayTime: number
dotPlacement: CarouselDotPlacement
showArrow: boolean
trigger: CarouselDotTrigger
}
export interface CascaderConfig {
borderless: boolean
clearIcon: string
childrenKey: string
expandIcon: string
fullPath: boolean
getKey: string | ((data: CascaderData<any>) => any)
labelKey: string
overlayContainer?: OverlayContainerType
overlayMatchWidth: boolean
size: FormSize
suffix: string
}
export interface CheckboxConfig {
size: FormSize
waveless: boolean
}
export interface CollapseConfig {
accordion: boolean
borderless: boolean
expandIcon: string
ghost: boolean
size: CollapseSize
}
export interface DatePickerConfig {
allowInput: boolean | 'overlay'
borderless: boolean
clearable: boolean
clearIcon: string
format?: Partial<Record<DatePickerType, string>>
size: FormSize
suffix: string
overlayContainer?: OverlayContainerType
}
export interface DescConfig {
col: number | Record<BreakpointKey, number>
colonless: boolean
labelAlign: DescLabelAlign
layout: DescLayout
size: DescSize
}
export interface DividerConfig {
dashed: boolean
plain: boolean
labelPlacement: 'start' | 'center' | 'end'
size: 'sm' | 'md' | 'lg'
}
export interface DrawerConfig {
closable: boolean
closeIcon: string
closeOnEsc: boolean
container?: PortalTargetType
distance: number
height: string | number
mask: boolean
maskClosable: boolean
width: string | number
}
export interface DropdownConfig {
autoAdjust: boolean
destroyOnHide: boolean
offset: [number, number]
overlayContainer?: OverlayContainerType
placement: PopperPlacement
showArrow: boolean
trigger: PopperTrigger
}
export interface EmptyConfig {
/**
* @deprecated
*/
icon?: string | VNode
image?: string | VNode
}
export interface FormConfig {
colonless: boolean
labelAlign: FormLabelAlign
layout: FormLayout
size: FormSize
labelTooltipIcon: string
controlTooltipIcon: string
}
export interface IconConfig {
loadIconDynamically?: (iconName: string) => Promise<string>
}
export interface InputConfig {
borderless: boolean
clearable: boolean
clearIcon: string
size: FormSize
trim: boolean
}
export interface InputNumberConfig {
keyboard: boolean
size: FormSize
}
export interface ListConfig {
size: ListSize
borderless: boolean
}
export interface LoadingBarConfig {
animation: LoadingBarAnimation
container?: PortalTargetType
mask: boolean
}
export interface ImageConfig {
preview: boolean
}
export interface ImageViewerConfig {
container?: PortalTargetType
loop: boolean
maskClosable: boolean
zoom: number[]
}
export interface MenuConfig {
getKey: string | ((data: MenuData<any>) => any)
indent: number
offset: [number, number]
overlayContainer?: OverlayContainerType
suffix: string
theme: MenuTheme
}
export interface MessageConfig {
container?: PortalTargetType
destroyOnHover: boolean
duration: number
icon: Partial<Record<MessageType, string | VNode | (() => VNodeChild)>>
maxCount: number
top?: number | string
}
export interface ModalConfig {
animatable: boolean
centered: boolean
closable: boolean
closeIcon: string
closeOnEsc: boolean
container?: PortalTargetType
icon?: Partial<Record<ModalType, string | VNode | (() => VNodeChild)>>
mask: boolean
maskClosable: boolean
/**
* @deprecated
*/
width?: string | number
}
export interface NotificationConfig {
container?: PortalTargetType
destroyOnHover: boolean
duration: number
icon?: Partial<Record<NotificationType, string | VNode | (() => VNodeChild)>>
closeIcon?: string | VNode
maxCount: number
offset: number | string | (string | number)[]
placement: NotificationPlacement
}
export interface PaginationConfig {
pageSize: number
pageSizes: number[]
showQuickJumper: boolean
showSizeChanger: boolean
showTitle: boolean
showTotal: boolean
simple: boolean
size: PaginationSize
}
export interface PopconfirmConfig {
autoAdjust: boolean
delay: number | [number | null, number | null]
destroyOnHide: boolean
overlayContainer?: OverlayContainerType
placement: PopperPlacement
trigger: PopperTrigger
offset: [number, number]
}
export interface PopoverConfig {
autoAdjust: boolean
delay: number | [number | null, number | null]
destroyOnHide: boolean
overlayContainer?: OverlayContainerType
placement: PopperPlacement
showArrow: boolean
trigger: PopperTrigger
closeIcon: string
offset: [number, number]
}
export interface ProgressConfig {
size: ProgressSize
format: ProgressFormat
strokeLinecap: 'round' | 'square'
icon: Partial<ProgressIcons>
}
export interface RadioConfig {
size: FormSize
waveless: boolean
}
export interface RateConfig {
allowHalf: boolean
clearable: boolean
count: number
icon: string
size: FormSize
}
export interface ResultConfig {
status: ResultStatus
icon?: Partial<Record<ResultStatus, string | VNode>>
}
export interface RowConfig {
wrap: boolean
}
export interface SelectConfig {
borderless: boolean
childrenKey: string
clearIcon: string
getKey: string | ((data: SelectData<any>) => any)
labelKey: string
offset: [number, number]
overlayContainer?: OverlayContainerType
overlayMatchWidth: boolean
size: FormSize
suffix: string
}
export interface SkeletonConfig {
animated: boolean
}
export interface SpaceConfig {
size: number | string | [number | string, number | string]
wrap: boolean
}
export interface SpinConfig {
icon?: string
tip: string
tipAlign: SpinTipAlignType
size: SpinSize
strokeWidth?: Partial<Record<SpinSize, number>>
radius?: Partial<Record<SpinSize, number>>
}
export interface StatisticConfig {
precision: number
formatter: NumFormatter
}
export interface NumFormatted {
value: string
int: string
decimal: string
}
export type NumFormatter = (value: string | number, precision: number) => NumFormatted
export interface StepperConfig {
clickable: boolean
labelPlacement: StepperLabelPlacement
size: StepperSize
}
export interface SwitchConfig {
size: FormSize
}
export interface TabsConfig {
size: TabsSize
}
export interface TableConfig {
autoHeight: boolean
borderless: boolean
childrenKey: string
getKey: string | ((data: any) => any)
size: TableSize
scrollToTopOnChange?: boolean
emptyCell?: string | ((options: TableEmptyCellOptions) => VNodeChild)
pagination: { position: TablePaginationPosition } & Partial<PaginationConfig>
columnBase: TableColumnBaseConfig
columnExpandable: TableColumnExpandableConfig
columnSelectable: TableColumnSelectableConfig
columnIndexable: Omit<TableColumnIndexable, 'type'>
}
export interface TableColumnBaseConfig {
align: TableColumnAlign
filterable: { multiple: boolean; footer: true }
sortable: { nextTooltip: boolean; orders: TableColumnSortOrder[] }
}
export interface TableColumnExpandableConfig {
showLine: boolean
icon: string | VNodeChild | ((options: { expanded: boolean; record: any }) => string | VNodeChild)
}
export interface TableColumnSelectableConfig {
showIndex: boolean
}
export interface TagConfig {
shape?: TagShape
}
export interface TagGroupConfig {
gap: number | string
wrap: boolean
}
export interface TextareaConfig {
autoRows: boolean | TextareaAutoRows
clearable: boolean
clearIcon: string
computeCount?: (value: string) => string
maxCount?: number | string
resize: TextareaResize
size: FormSize
showCount: boolean
trim: boolean
}
export interface TextConfig {
copyIcon: string | TextCopyIconRenderer | [string, string]
expandIcon?: string | TextExpandIconRenderer | [string, string]
}
export interface TimePickerConfig {
borderless: boolean
clearable: boolean
clearIcon: string
size: FormSize
suffix: string
overlayContainer?: OverlayContainerType
allowInput: boolean | 'overlay'
format: string
}
export interface TransferConfig {
getKey: string
searchable?: boolean | { source: boolean; target: boolean }
clearable: boolean
clearIcon: string
showSelectAll: boolean
}
export interface TooltipConfig {
autoAdjust: boolean
delay: number | [number | null, number | null]
destroyOnHide: boolean
overlayContainer?: OverlayContainerType
placement: PopperPlacement
offset: [number, number]
trigger: PopperTrigger
}
export interface TourConfig {
animatable: boolean
gap: TargetGap
mask: boolean | TourMaskOptions
offset: [number, number]
overlayContainer?: string | HTMLElement
placement: PopperPlacement
showArrow: boolean
scrollIntoViewOptions: boolean | ScrollIntoViewOptions
closeOnClick: boolean
closeOnEsc: boolean
closable: boolean
}
export interface TreeConfig {
autoHeight: boolean
blocked: boolean
childrenKey: string
expandIcon: string | TreeExpandIconRenderer | [string, string]
draggableIcon: string
getKey: string | ((data: TreeNode<any>) => any)
labelKey: string
showLine: boolean
}
export interface TreeSelectConfig {
borderless: boolean
childrenKey: string
clearIcon: string
getKey: string | ((data: TreeNode<any>) => any)
labelKey: string
offset: [number, number]
overlayContainer?: OverlayContainerType
overlayMatchWidth: boolean
size: FormSize
suffix: string
}
export interface UploadConfig {
multiple: boolean
dragable: boolean
directory: boolean
name: string
withCredentials: boolean
requestMethod: UploadRequestMethod
customRequest?: (option: UploadRequestOption) => { abort: () => void }
}
export interface UploadFilesConfig {
type: UploadFilesType
icon: Partial<Record<UploadIconType, string | VNode>>
}