-
-
Notifications
You must be signed in to change notification settings - Fork 15.4k
/
message-box.type.ts
216 lines (166 loc) Β· 5.57 KB
/
message-box.type.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
import type { AppContext, CSSProperties, Component, VNode } from 'vue'
import type { ComponentSize } from '@element-plus/constants'
type MessageType = '' | 'success' | 'warning' | 'info' | 'error'
export type Action = 'confirm' | 'close' | 'cancel'
export type MessageBoxType = '' | 'prompt' | 'alert' | 'confirm'
export type MessageBoxData = MessageBoxInputData & Action
export interface MessageBoxInputData {
value: string
action: Action
}
export interface MessageBoxInputValidator {
(value: string): boolean | string
}
export declare interface MessageBoxState {
autofocus: boolean
title: string
message: string
type: MessageType
icon: string | Component
customClass: string
customStyle: CSSProperties
showInput: boolean
inputValue: string
inputPlaceholder: string
inputType: string
inputPattern: RegExp
inputValidator: MessageBoxInputValidator
inputErrorMessage: string
showConfirmButton: boolean
showCancelButton: boolean
action: Action
dangerouslyUseHTMLString: boolean
confirmButtonText: string
cancelButtonText: string
confirmButtonLoading: boolean
cancelButtonLoading: boolean
confirmButtonClass: string
confirmButtonDisabled: boolean
cancelButtonClass: string
editorErrorMessage: string
beforeClose:
| null
| ((action: Action, instance: MessageBoxState, done: () => void) => void)
callback: null | Callback
distinguishCancelAndClose: boolean
modalFade: boolean
modalClass: string
// refer to: https://github.com/ElemeFE/element/commit/2999279ae34ef10c373ca795c87b020ed6753eed
// seemed ok for now without this state.
// isOnComposition: false, // temporary remove
validateError: boolean
zIndex: number
}
export type Callback =
| ((value: string, action: Action) => any)
| ((action: Action) => any)
/** Options used in MessageBox */
export interface ElMessageBoxOptions {
/**
* auto focus when open message-box
*/
autofocus?: boolean
/** Callback before MessageBox closes, and it will prevent MessageBox from closing */
beforeClose?: (
action: Action,
instance: MessageBoxState,
done: () => void
) => void
/** Custom class name for MessageBox */
customClass?: string
/** Custom inline style for MessageBox */
customStyle?: CSSProperties
/** MessageBox closing callback if you don't prefer Promise */
callback?: Callback
/** Text content of cancel button */
cancelButtonText?: string
/** Text content of confirm button */
confirmButtonText?: string
/** Custom class name of cancel button */
cancelButtonClass?: string
/** Custom class name of confirm button */
confirmButtonClass?: string
/** Whether to align the content in center */
center?: boolean
/** Whether MessageBox can be drag */
draggable?: boolean
/** Draggable MessageBox can overflow the viewport */
overflow?: boolean
/** Content of the MessageBox */
message?: string | VNode | (() => VNode)
/** Title of the MessageBox */
title?: string | ElMessageBoxOptions
/** Message type, used for icon display */
type?: MessageType
/** Message box type */
boxType?: MessageBoxType
/** Custom icon component */
icon?: string | Component
/** Whether message is treated as HTML string */
dangerouslyUseHTMLString?: boolean
/** Whether to distinguish canceling and closing */
distinguishCancelAndClose?: boolean
/** Whether to lock body scroll when MessageBox prompts */
lockScroll?: boolean
/** Whether to show a cancel button */
showCancelButton?: boolean
/** Whether to show a confirm button */
showConfirmButton?: boolean
/** Whether to show a close button */
showClose?: boolean
/** Whether to use round button */
roundButton?: boolean
/** Whether MessageBox can be closed by clicking the mask */
closeOnClickModal?: boolean
/** Whether MessageBox can be closed by pressing the ESC */
closeOnPressEscape?: boolean
/** Whether to close MessageBox when hash changes */
closeOnHashChange?: boolean
/** Whether to show an input */
showInput?: boolean
/** Placeholder of input */
inputPlaceholder?: string
/** Initial value of input */
inputValue?: string
/** Regexp for the input */
inputPattern?: RegExp
/** Input Type: text, textArea, password or number */
inputType?: string
/** Validation function for the input. Should returns a boolean or string. If a string is returned, it will be assigned to inputErrorMessage */
inputValidator?: MessageBoxInputValidator
/** Error message when validation fails */
inputErrorMessage?: string
/** Custom size of confirm and cancel buttons */
buttonSize?: ComponentSize
/** Custom element to append the message box to */
appendTo?: HTMLElement | string
}
export type ElMessageBoxShortcutMethod = ((
message: ElMessageBoxOptions['message'],
options?: ElMessageBoxOptions,
appContext?: AppContext | null
) => Promise<MessageBoxData>) &
((
message: ElMessageBoxOptions['message'],
title: ElMessageBoxOptions['title'],
options?: ElMessageBoxOptions,
appContext?: AppContext | null
) => Promise<MessageBoxData>)
export interface IElMessageBox {
_context: AppContext | null
/** Show a message box */
// (message: string, title?: string, type?: string): Promise<MessageBoxData>
/** Show a message box */
(
options: ElMessageBoxOptions,
appContext?: AppContext | null
): Promise<MessageBoxData>
/** Show an alert message box */
alert: ElMessageBoxShortcutMethod
/** Show a confirm message box */
confirm: ElMessageBoxShortcutMethod
/** Show a prompt message box */
prompt: ElMessageBoxShortcutMethod
/** Close current message box */
close(): void
}