capacitor-extended-dialog 0.0.2 → 0.0.4

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.
package/dist/docs.json CHANGED
@@ -11,13 +11,18 @@
11
11
  "parameters": [
12
12
  {
13
13
  "name": "options",
14
- "docs": "",
14
+ "docs": "- Alert configuration options.",
15
15
  "type": "AlertOptions"
16
16
  }
17
17
  ],
18
18
  "returns": "any",
19
- "tags": [],
20
- "docs": "",
19
+ "tags": [
20
+ {
21
+ "name": "param",
22
+ "text": "options - Alert configuration options."
23
+ }
24
+ ],
25
+ "docs": "Show an alert dialog with a single dismiss button.",
21
26
  "complexTypes": [
22
27
  "AlertOptions"
23
28
  ],
@@ -29,13 +34,22 @@
29
34
  "parameters": [
30
35
  {
31
36
  "name": "options",
32
- "docs": "",
37
+ "docs": "- Confirm configuration options.",
33
38
  "type": "ConfirmOptions"
34
39
  }
35
40
  ],
36
41
  "returns": "any",
37
- "tags": [],
38
- "docs": "",
42
+ "tags": [
43
+ {
44
+ "name": "param",
45
+ "text": "options - Confirm configuration options."
46
+ },
47
+ {
48
+ "name": "returns",
49
+ "text": "The user's confirmation choice."
50
+ }
51
+ ],
52
+ "docs": "Show a confirmation dialog with OK and Cancel buttons.",
39
53
  "complexTypes": [
40
54
  "ConfirmOptions",
41
55
  "ConfirmResult"
@@ -48,13 +62,22 @@
48
62
  "parameters": [
49
63
  {
50
64
  "name": "options",
51
- "docs": "",
65
+ "docs": "- Prompt configuration options.",
52
66
  "type": "PromptOptions"
53
67
  }
54
68
  ],
55
69
  "returns": "any",
56
- "tags": [],
57
- "docs": "",
70
+ "tags": [
71
+ {
72
+ "name": "param",
73
+ "text": "options - Prompt configuration options."
74
+ },
75
+ {
76
+ "name": "returns",
77
+ "text": "The entered text and whether the dialog was cancelled."
78
+ }
79
+ ],
80
+ "docs": "Show a prompt dialog with a text input field.",
58
81
  "complexTypes": [
59
82
  "PromptOptions",
60
83
  "PromptResult"
@@ -67,13 +90,22 @@
67
90
  "parameters": [
68
91
  {
69
92
  "name": "options",
70
- "docs": "",
93
+ "docs": "- Single select configuration options.",
71
94
  "type": "SingleSelectOptions"
72
95
  }
73
96
  ],
74
97
  "returns": "any",
75
- "tags": [],
76
- "docs": "",
98
+ "tags": [
99
+ {
100
+ "name": "param",
101
+ "text": "options - Single select configuration options."
102
+ },
103
+ {
104
+ "name": "returns",
105
+ "text": "The selected value and whether the dialog was cancelled."
106
+ }
107
+ ],
108
+ "docs": "Show a single-select dialog where the user picks one option.",
77
109
  "complexTypes": [
78
110
  "SingleSelectOptions",
79
111
  "SingleSelectResult"
@@ -86,18 +118,55 @@
86
118
  "parameters": [
87
119
  {
88
120
  "name": "options",
89
- "docs": "",
121
+ "docs": "- Multi select configuration options.",
90
122
  "type": "MultiSelectOptions"
91
123
  }
92
124
  ],
93
125
  "returns": "any",
94
- "tags": [],
95
- "docs": "",
126
+ "tags": [
127
+ {
128
+ "name": "param",
129
+ "text": "options - Multi select configuration options."
130
+ },
131
+ {
132
+ "name": "returns",
133
+ "text": "The selected values and whether the dialog was cancelled."
134
+ }
135
+ ],
136
+ "docs": "Show a multi-select dialog where the user picks one or more options.",
96
137
  "complexTypes": [
97
138
  "MultiSelectOptions",
98
139
  "MultiSelectResult"
99
140
  ],
100
141
  "slug": "multiselect"
142
+ },
143
+ {
144
+ "name": "sheet",
145
+ "signature": "(options: SheetOptions) => any",
146
+ "parameters": [
147
+ {
148
+ "name": "options",
149
+ "docs": "- Sheet configuration options.",
150
+ "type": "SheetOptions"
151
+ }
152
+ ],
153
+ "returns": "any",
154
+ "tags": [
155
+ {
156
+ "name": "param",
157
+ "text": "options - Sheet configuration options."
158
+ },
159
+ {
160
+ "name": "returns",
161
+ "text": "Whether the user confirmed or cancelled the sheet."
162
+ }
163
+ ],
164
+ "docs": "Show a sheet dialog with a header, title, and structured data rows.",
165
+ "complexTypes": [
166
+ "SheetOptions",
167
+ "SheetResult"
168
+ ],
169
+ "slug": "sheet"
101
170
  }
102
171
  ],
103
172
  "properties": []
@@ -112,8 +181,13 @@
112
181
  "properties": [
113
182
  {
114
183
  "name": "buttonTitle",
115
- "tags": [],
116
- "docs": "",
184
+ "tags": [
185
+ {
186
+ "text": "\"OK\"",
187
+ "name": "default"
188
+ }
189
+ ],
190
+ "docs": "Title for the dismiss button.",
117
191
  "complexTypes": [],
118
192
  "type": "string | undefined"
119
193
  }
@@ -128,15 +202,25 @@
128
202
  "properties": [
129
203
  {
130
204
  "name": "okButtonTitle",
131
- "tags": [],
132
- "docs": "",
205
+ "tags": [
206
+ {
207
+ "text": "\"OK\"",
208
+ "name": "default"
209
+ }
210
+ ],
211
+ "docs": "Title for the confirmation button.",
133
212
  "complexTypes": [],
134
213
  "type": "string | undefined"
135
214
  },
136
215
  {
137
216
  "name": "cancelButtonTitle",
138
- "tags": [],
139
- "docs": "",
217
+ "tags": [
218
+ {
219
+ "text": "\"Cancel\"",
220
+ "name": "default"
221
+ }
222
+ ],
223
+ "docs": "Title for the cancel button.",
140
224
  "complexTypes": [],
141
225
  "type": "string | undefined"
142
226
  }
@@ -152,7 +236,7 @@
152
236
  {
153
237
  "name": "value",
154
238
  "tags": [],
155
- "docs": "",
239
+ "docs": "Whether the user confirmed (`true`) or cancelled (`false`).",
156
240
  "complexTypes": [],
157
241
  "type": "boolean"
158
242
  }
@@ -167,29 +251,39 @@
167
251
  "properties": [
168
252
  {
169
253
  "name": "okButtonTitle",
170
- "tags": [],
171
- "docs": "",
254
+ "tags": [
255
+ {
256
+ "text": "\"OK\"",
257
+ "name": "default"
258
+ }
259
+ ],
260
+ "docs": "Title for the confirmation button.",
172
261
  "complexTypes": [],
173
262
  "type": "string | undefined"
174
263
  },
175
264
  {
176
265
  "name": "cancelButtonTitle",
177
- "tags": [],
178
- "docs": "",
266
+ "tags": [
267
+ {
268
+ "text": "\"Cancel\"",
269
+ "name": "default"
270
+ }
271
+ ],
272
+ "docs": "Title for the cancel button.",
179
273
  "complexTypes": [],
180
274
  "type": "string | undefined"
181
275
  },
182
276
  {
183
277
  "name": "inputPlaceholder",
184
278
  "tags": [],
185
- "docs": "",
279
+ "docs": "Placeholder text shown in the input field when empty.",
186
280
  "complexTypes": [],
187
281
  "type": "string | undefined"
188
282
  },
189
283
  {
190
284
  "name": "inputText",
191
285
  "tags": [],
192
- "docs": "",
286
+ "docs": "Pre-filled value for the input field.",
193
287
  "complexTypes": [],
194
288
  "type": "string | undefined"
195
289
  },
@@ -217,14 +311,14 @@
217
311
  {
218
312
  "name": "value",
219
313
  "tags": [],
220
- "docs": "",
314
+ "docs": "The text entered by the user. Empty string if cancelled.",
221
315
  "complexTypes": [],
222
316
  "type": "string"
223
317
  },
224
318
  {
225
319
  "name": "cancelled",
226
320
  "tags": [],
227
- "docs": "",
321
+ "docs": "Whether the user cancelled the dialog.",
228
322
  "complexTypes": [],
229
323
  "type": "boolean"
230
324
  }
@@ -240,7 +334,7 @@
240
334
  {
241
335
  "name": "options",
242
336
  "tags": [],
243
- "docs": "",
337
+ "docs": "List of options to display for selection.",
244
338
  "complexTypes": [
245
339
  "SelectOption"
246
340
  ],
@@ -249,21 +343,31 @@
249
343
  {
250
344
  "name": "selectedValue",
251
345
  "tags": [],
252
- "docs": "",
346
+ "docs": "Value of the initially selected option.",
253
347
  "complexTypes": [],
254
348
  "type": "string | undefined"
255
349
  },
256
350
  {
257
351
  "name": "okButtonTitle",
258
- "tags": [],
259
- "docs": "",
352
+ "tags": [
353
+ {
354
+ "text": "\"OK\"",
355
+ "name": "default"
356
+ }
357
+ ],
358
+ "docs": "Title for the confirmation button.",
260
359
  "complexTypes": [],
261
360
  "type": "string | undefined"
262
361
  },
263
362
  {
264
363
  "name": "cancelButtonTitle",
265
- "tags": [],
266
- "docs": "",
364
+ "tags": [
365
+ {
366
+ "text": "\"Cancel\"",
367
+ "name": "default"
368
+ }
369
+ ],
370
+ "docs": "Title for the cancel button.",
267
371
  "complexTypes": [],
268
372
  "type": "string | undefined"
269
373
  }
@@ -279,14 +383,14 @@
279
383
  {
280
384
  "name": "label",
281
385
  "tags": [],
282
- "docs": "",
386
+ "docs": "Display text for the option.",
283
387
  "complexTypes": [],
284
388
  "type": "string"
285
389
  },
286
390
  {
287
391
  "name": "value",
288
392
  "tags": [],
289
- "docs": "",
393
+ "docs": "Value returned when the option is selected.",
290
394
  "complexTypes": [],
291
395
  "type": "string"
292
396
  }
@@ -302,14 +406,14 @@
302
406
  {
303
407
  "name": "value",
304
408
  "tags": [],
305
- "docs": "",
409
+ "docs": "The value of the selected option, or `null` if cancelled.",
306
410
  "complexTypes": [],
307
411
  "type": "string | null"
308
412
  },
309
413
  {
310
414
  "name": "cancelled",
311
415
  "tags": [],
312
- "docs": "",
416
+ "docs": "Whether the user cancelled the dialog.",
313
417
  "complexTypes": [],
314
418
  "type": "boolean"
315
419
  }
@@ -325,7 +429,7 @@
325
429
  {
326
430
  "name": "options",
327
431
  "tags": [],
328
- "docs": "",
432
+ "docs": "List of options to display for selection.",
329
433
  "complexTypes": [
330
434
  "SelectOption"
331
435
  ],
@@ -334,21 +438,31 @@
334
438
  {
335
439
  "name": "selectedValues",
336
440
  "tags": [],
337
- "docs": "",
441
+ "docs": "Values of the initially selected options.",
338
442
  "complexTypes": [],
339
443
  "type": "{} | undefined"
340
444
  },
341
445
  {
342
446
  "name": "okButtonTitle",
343
- "tags": [],
344
- "docs": "",
447
+ "tags": [
448
+ {
449
+ "text": "\"OK\"",
450
+ "name": "default"
451
+ }
452
+ ],
453
+ "docs": "Title for the confirmation button.",
345
454
  "complexTypes": [],
346
455
  "type": "string | undefined"
347
456
  },
348
457
  {
349
458
  "name": "cancelButtonTitle",
350
- "tags": [],
351
- "docs": "",
459
+ "tags": [
460
+ {
461
+ "text": "\"Cancel\"",
462
+ "name": "default"
463
+ }
464
+ ],
465
+ "docs": "Title for the cancel button.",
352
466
  "complexTypes": [],
353
467
  "type": "string | undefined"
354
468
  }
@@ -364,14 +478,115 @@
364
478
  {
365
479
  "name": "values",
366
480
  "tags": [],
367
- "docs": "",
481
+ "docs": "The values of the selected options. Empty array if cancelled.",
368
482
  "complexTypes": [],
369
483
  "type": "{}"
370
484
  },
371
485
  {
372
486
  "name": "cancelled",
373
487
  "tags": [],
374
- "docs": "",
488
+ "docs": "Whether the user cancelled the dialog.",
489
+ "complexTypes": [],
490
+ "type": "boolean"
491
+ }
492
+ ]
493
+ },
494
+ {
495
+ "name": "SheetOptions",
496
+ "slug": "sheetoptions",
497
+ "docs": "",
498
+ "tags": [],
499
+ "methods": [],
500
+ "properties": [
501
+ {
502
+ "name": "headerLogo",
503
+ "tags": [],
504
+ "docs": "Header logo - supports base64 data URL or HTTP/HTTPS URL",
505
+ "complexTypes": [],
506
+ "type": "string | undefined"
507
+ },
508
+ {
509
+ "name": "title",
510
+ "tags": [],
511
+ "docs": "Sheet title",
512
+ "complexTypes": [],
513
+ "type": "string"
514
+ },
515
+ {
516
+ "name": "rows",
517
+ "tags": [],
518
+ "docs": "Description rows",
519
+ "complexTypes": [
520
+ "SheetRow"
521
+ ],
522
+ "type": "{}"
523
+ },
524
+ {
525
+ "name": "confirmButtonTitle",
526
+ "tags": [],
527
+ "docs": "Confirm button title",
528
+ "complexTypes": [],
529
+ "type": "string | undefined"
530
+ },
531
+ {
532
+ "name": "cancelButtonTitle",
533
+ "tags": [],
534
+ "docs": "Cancel button title",
535
+ "complexTypes": [],
536
+ "type": "string | undefined"
537
+ },
538
+ {
539
+ "name": "mode",
540
+ "tags": [],
541
+ "docs": "Dialog mode",
542
+ "complexTypes": [
543
+ "DialogMode"
544
+ ],
545
+ "type": "DialogMode"
546
+ }
547
+ ]
548
+ },
549
+ {
550
+ "name": "SheetRow",
551
+ "slug": "sheetrow",
552
+ "docs": "",
553
+ "tags": [],
554
+ "methods": [],
555
+ "properties": [
556
+ {
557
+ "name": "title",
558
+ "tags": [],
559
+ "docs": "Row title (required)",
560
+ "complexTypes": [],
561
+ "type": "string"
562
+ },
563
+ {
564
+ "name": "logo",
565
+ "tags": [],
566
+ "docs": "Optional logo/icon - supports base64 data URL or HTTP/HTTPS URL",
567
+ "complexTypes": [],
568
+ "type": "string | undefined"
569
+ },
570
+ {
571
+ "name": "value",
572
+ "tags": [],
573
+ "docs": "Optional value displayed on the right",
574
+ "complexTypes": [],
575
+ "type": "string | undefined"
576
+ }
577
+ ]
578
+ },
579
+ {
580
+ "name": "SheetResult",
581
+ "slug": "sheetresult",
582
+ "docs": "",
583
+ "tags": [],
584
+ "methods": [],
585
+ "properties": [
586
+ {
587
+ "name": "confirmed",
588
+ "tags": [],
589
+ "docs": "True if confirmed, false if cancelled",
375
590
  "complexTypes": [],
376
591
  "type": "boolean"
377
592
  }
@@ -379,6 +594,22 @@
379
594
  }
380
595
  ],
381
596
  "enums": [],
382
- "typeAliases": [],
597
+ "typeAliases": [
598
+ {
599
+ "name": "DialogMode",
600
+ "slug": "dialogmode",
601
+ "docs": "Dialog presentation mode.\n\n- `'basic'` — Standard modal dialog (default)\n- `'fullscreen'` — Full-screen dialog presentation",
602
+ "types": [
603
+ {
604
+ "text": "'basic'",
605
+ "complexTypes": []
606
+ },
607
+ {
608
+ "text": "'fullscreen'",
609
+ "complexTypes": []
610
+ }
611
+ ]
612
+ }
613
+ ],
383
614
  "pluginConfigs": []
384
615
  }