forked from quasarframework/quasar
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNotify.json
More file actions
300 lines (262 loc) · 9.25 KB
/
Notify.json
File metadata and controls
300 lines (262 loc) · 9.25 KB
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
{
"injection": "$q.notify",
"quasarConfOptions": {
"propName": "notify",
"definition": {
"color": {
"extends": "color"
},
"textColor": {
"extends": "color"
},
"message": {
"type": "String",
"desc": "The content of your message",
"examples": [ "John Doe pinged you" ]
},
"html": {
"type": "Boolean",
"desc": "Render message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"
},
"icon": {
"extends": "icon"
},
"avatar": {
"type": "String",
"desc": "URL to an avatar/image; Suggestion: use statics folder",
"examples": [
"(statics folder) statics/img/something.png",
"(relative path format) require('./my_img.jpg')",
"(URL) https://some-site.net/some-img.gif"
]
},
"position": {
"type": "String",
"desc": "Window side/corner to stick to",
"default": "bottom",
"values": [
"top-left", "top-right",
"bottom-left", "bottom-right",
"top", "bottom", "left", "right", "center"
],
"examples": [ "top-right" ]
},
"classes": {
"type": "String",
"desc": "Add CSS class(es) to the notification for easier customization",
"examples": [
"my-notif-class"
]
},
"timeout": {
"type": "Number",
"desc": "Amount of time to display (in milliseconds)",
"default": 5000,
"examples": [ 2500 ]
},
"closeBtn": {
"type": "String",
"desc": "Convenient way to add a dismiss button with a specific label, without using the 'actions' convoluted prop",
"examples": [ "Close me" ]
},
"multiLine": {
"type": "Boolean",
"desc": "Put notification into multi-line mode; If this prop isn't used and more than one 'action' is specified then notification goes into multi-line mode by default"
}
}
},
"methods": {
"create": {
"tsInjectionPoint": true,
"desc": "Creates a notification; Same as calling $q.notify(...)",
"params": {
"opts": {
"type": ["Object", "String"],
"desc": "For syntax, check quasar.conf options parameters",
"definition": {
"color": {
"extends": "color"
},
"textColor": {
"extends": "color"
},
"message": {
"type": "String",
"desc": "The content of your message",
"examples": [ "John Doe pinged you" ],
"required": true
},
"html": {
"type": "Boolean",
"desc": "Render message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"
},
"icon": {
"extends": "icon"
},
"avatar": {
"type": "String",
"desc": "URL to an avatar/image; Suggestion: use statics folder",
"examples": [
"(statics folder) statics/img/something.png",
"(relative path format) require('./my_img.jpg')",
"(URL) https://some-site.net/some-img.gif"
]
},
"position": {
"type": "String",
"desc": "Window side/corner to stick to",
"default": "bottom",
"values": [
"top-left", "top-right",
"bottom-left", "bottom-right",
"top", "bottom", "left", "right", "center"
],
"examples": [ "top-right" ]
},
"classes": {
"type": "String",
"desc": "Add CSS class(es) to the notification for easier customization",
"examples": [
"my-notif-class"
]
},
"timeout": {
"type": "Number",
"desc": "Amount of time to display (in milliseconds)",
"default": 5000,
"examples": [ 2500 ]
},
"actions": {
"type": "Array",
"desc": "Notification actions (buttons); If a 'handler' is specified or not, clicking/tapping on the button will also close the notification; Also check 'closeBtn' convenience prop",
"examples": [
"[ { label: 'Show', handler: (Function) }, { icon: 'map', handler: (Function), color: 'yellow' }, { label: 'Learn more', noDismiss: true, handler: (Function) } ]"
]
},
"onDismiss": {
"type": "Function",
"desc": "Function to call when notification gets dismissed",
"params": null,
"returns": null,
"examples": [
"() => { console.log('Dismissed') }"
]
},
"closeBtn": {
"type": "String",
"desc": "Convenience way to add a dismiss button with a specific label, without using the 'actions' convoluted prop",
"examples": [ "Close me" ]
},
"multiLine": {
"type": "Boolean",
"desc": "Put notification into multi-line mode; If this prop isn't used and more than one 'action' is specified then notification goes into multi-line mode by default"
},
"ignoreDefaults": {
"type": "Boolean",
"desc": "Ignore the default configuration (set by setDefaults()) for this instance only",
"addedIn": "v1.1.0"
}
},
"required": true,
"__exemption": [ "examples" ]
}
},
"returns": {
"type": "Function",
"desc": "Calling this function hides the notification",
"params": null,
"returns": null
}
},
"setDefaults": {
"desc": "Merge options into the default ones",
"params": {
"opts": {
"type": "Object",
"desc": "For syntax, check quasar.conf options parameters",
"definition": {
"color": {
"extends": "color"
},
"textColor": {
"extends": "color"
},
"message": {
"type": "String",
"desc": "The content of your message",
"examples": [ "John Doe pinged you" ],
"required": true
},
"html": {
"type": "Boolean",
"desc": "Render message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"
},
"icon": {
"extends": "icon"
},
"avatar": {
"type": "String",
"desc": "URL to an avatar/image; Suggestion: use statics folder",
"examples": [
"(statics folder) statics/img/something.png",
"(relative path format) require('./my_img.jpg')",
"(URL) https://some-site.net/some-img.gif"
]
},
"position": {
"type": "String",
"desc": "Window side/corner to stick to",
"default": "bottom",
"values": [
"top-left", "top-right",
"bottom-left", "bottom-right",
"top", "bottom", "left", "right", "center"
],
"examples": [ "top-right" ]
},
"classes": {
"type": "String",
"desc": "Add CSS class(es) to the notification for easier customization",
"examples": [
"my-notif-class"
]
},
"timeout": {
"type": "Number",
"desc": "Amount of time to display (in milliseconds)",
"default": 5000,
"examples": [ 2500 ]
},
"actions": {
"type": "Array",
"desc": "Notification actions (buttons); If a 'handler' is specified or not, clicking/tapping on the button will also close the notification; Also check 'closeBtn' convenience prop",
"examples": [
"[ { label: 'Show', handler: (Function) }, { icon: 'map', handler: (Function), color: 'yellow' } ]"
]
},
"onDismiss": {
"type": "Function",
"desc": "Function to call when notification gets dismissed",
"params": null,
"returns": null,
"examples": [
"() => { console.log('Dismissed') }"
]
},
"closeBtn": {
"type": "String",
"desc": "Convenience way to add a dismiss button with a specific label, without using the 'actions' convoluted prop",
"examples": [ "Close me" ]
},
"multiLine": {
"type": "Boolean",
"desc": "Put notification into multi-line mode; If this prop isn't used and more than one 'action' is specified then notification goes into multi-line mode by default"
}
},
"required": true,
"__exemption": [ "examples" ]
}
}
}
}
}