@ukic/docs 2.1.0-beta.15 → 2.1.0-beta.17
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/docs.json +385 -7
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
"timestamp": "2023-
|
|
2
|
+
"timestamp": "2023-07-13T09:57:07",
|
|
3
3
|
"compiler": {
|
|
4
4
|
"name": "@stencil/core",
|
|
5
|
-
"version": "
|
|
6
|
-
"typescriptVersion": "
|
|
5
|
+
"version": "3.3.1",
|
|
6
|
+
"typescriptVersion": "5.0.4"
|
|
7
7
|
},
|
|
8
8
|
"components": [
|
|
9
9
|
{
|
|
@@ -189,7 +189,9 @@
|
|
|
189
189
|
}
|
|
190
190
|
],
|
|
191
191
|
"parts": [],
|
|
192
|
-
"dependents": [
|
|
192
|
+
"dependents": [
|
|
193
|
+
"ic-dialog"
|
|
194
|
+
],
|
|
193
195
|
"dependencies": [
|
|
194
196
|
"ic-typography",
|
|
195
197
|
"ic-button"
|
|
@@ -208,6 +210,9 @@
|
|
|
208
210
|
],
|
|
209
211
|
"ic-tooltip": [
|
|
210
212
|
"ic-typography"
|
|
213
|
+
],
|
|
214
|
+
"ic-dialog": [
|
|
215
|
+
"ic-alert"
|
|
211
216
|
]
|
|
212
217
|
}
|
|
213
218
|
},
|
|
@@ -930,6 +935,7 @@
|
|
|
930
935
|
"dependents": [
|
|
931
936
|
"ic-alert",
|
|
932
937
|
"ic-card",
|
|
938
|
+
"ic-dialog",
|
|
933
939
|
"ic-horizontal-scroll",
|
|
934
940
|
"ic-menu",
|
|
935
941
|
"ic-menu-item",
|
|
@@ -963,6 +969,9 @@
|
|
|
963
969
|
"ic-card": [
|
|
964
970
|
"ic-button"
|
|
965
971
|
],
|
|
972
|
+
"ic-dialog": [
|
|
973
|
+
"ic-button"
|
|
974
|
+
],
|
|
966
975
|
"ic-horizontal-scroll": [
|
|
967
976
|
"ic-button"
|
|
968
977
|
],
|
|
@@ -2295,6 +2304,357 @@
|
|
|
2295
2304
|
]
|
|
2296
2305
|
}
|
|
2297
2306
|
},
|
|
2307
|
+
{
|
|
2308
|
+
"filePath": "./src/components/ic-dialog/ic-dialog.tsx",
|
|
2309
|
+
"encapsulation": "shadow",
|
|
2310
|
+
"tag": "ic-dialog",
|
|
2311
|
+
"readme": "# ic-dialog\n\n\n",
|
|
2312
|
+
"docs": "",
|
|
2313
|
+
"docsTags": [],
|
|
2314
|
+
"usage": {},
|
|
2315
|
+
"props": [
|
|
2316
|
+
{
|
|
2317
|
+
"name": "alertHeading",
|
|
2318
|
+
"type": "string",
|
|
2319
|
+
"mutable": false,
|
|
2320
|
+
"attr": "alert-heading",
|
|
2321
|
+
"reflectToAttr": false,
|
|
2322
|
+
"docs": "If a status is set, sets the heading for the displayed alert.",
|
|
2323
|
+
"docsTags": [],
|
|
2324
|
+
"values": [
|
|
2325
|
+
{
|
|
2326
|
+
"type": "string"
|
|
2327
|
+
}
|
|
2328
|
+
],
|
|
2329
|
+
"optional": true,
|
|
2330
|
+
"required": false
|
|
2331
|
+
},
|
|
2332
|
+
{
|
|
2333
|
+
"name": "alertMessage",
|
|
2334
|
+
"type": "string",
|
|
2335
|
+
"mutable": false,
|
|
2336
|
+
"attr": "alert-message",
|
|
2337
|
+
"reflectToAttr": false,
|
|
2338
|
+
"docs": "If a status is set, sets the message for the displayed alert.",
|
|
2339
|
+
"docsTags": [],
|
|
2340
|
+
"values": [
|
|
2341
|
+
{
|
|
2342
|
+
"type": "string"
|
|
2343
|
+
}
|
|
2344
|
+
],
|
|
2345
|
+
"optional": true,
|
|
2346
|
+
"required": false
|
|
2347
|
+
},
|
|
2348
|
+
{
|
|
2349
|
+
"name": "buttonProps",
|
|
2350
|
+
"type": "{ label: string; onclick: string; }[]",
|
|
2351
|
+
"mutable": false,
|
|
2352
|
+
"reflectToAttr": false,
|
|
2353
|
+
"docs": "Sets the label and onclick functions for default buttons.",
|
|
2354
|
+
"docsTags": [],
|
|
2355
|
+
"default": "[\n {\n label: \"Cancel\",\n onclick: \"this.cancelDialog();\",\n },\n { label: \"Confirm\", onclick: \"this.confirmDialog();\" },\n ]",
|
|
2356
|
+
"values": [
|
|
2357
|
+
{
|
|
2358
|
+
"type": "{ label: string; onclick: string; }[]"
|
|
2359
|
+
}
|
|
2360
|
+
],
|
|
2361
|
+
"optional": true,
|
|
2362
|
+
"required": false
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
"name": "buttons",
|
|
2366
|
+
"type": "boolean",
|
|
2367
|
+
"mutable": false,
|
|
2368
|
+
"attr": "buttons",
|
|
2369
|
+
"reflectToAttr": false,
|
|
2370
|
+
"docs": "If set to `false`, dialog controls will not be displayed overriding buttonProps or slotted dialog controls.",
|
|
2371
|
+
"docsTags": [],
|
|
2372
|
+
"default": "true",
|
|
2373
|
+
"values": [
|
|
2374
|
+
{
|
|
2375
|
+
"type": "boolean"
|
|
2376
|
+
}
|
|
2377
|
+
],
|
|
2378
|
+
"optional": true,
|
|
2379
|
+
"required": false
|
|
2380
|
+
},
|
|
2381
|
+
{
|
|
2382
|
+
"name": "closeOnBackdropClick",
|
|
2383
|
+
"type": "boolean",
|
|
2384
|
+
"mutable": false,
|
|
2385
|
+
"attr": "close-on-backdrop-click",
|
|
2386
|
+
"reflectToAttr": false,
|
|
2387
|
+
"docs": "If set to `true`, the dialog will not close when the backdrop is clicked.",
|
|
2388
|
+
"docsTags": [],
|
|
2389
|
+
"default": "true",
|
|
2390
|
+
"values": [
|
|
2391
|
+
{
|
|
2392
|
+
"type": "boolean"
|
|
2393
|
+
}
|
|
2394
|
+
],
|
|
2395
|
+
"optional": true,
|
|
2396
|
+
"required": false
|
|
2397
|
+
},
|
|
2398
|
+
{
|
|
2399
|
+
"name": "destructive",
|
|
2400
|
+
"type": "boolean",
|
|
2401
|
+
"mutable": false,
|
|
2402
|
+
"attr": "destructive",
|
|
2403
|
+
"reflectToAttr": false,
|
|
2404
|
+
"docs": "If default buttons are displayed, sets the 'primary' or rightmost button to the destructive variant. Stops initial focus being set on the 'primary' or rightmost default or slotted button.",
|
|
2405
|
+
"docsTags": [],
|
|
2406
|
+
"default": "false",
|
|
2407
|
+
"values": [
|
|
2408
|
+
{
|
|
2409
|
+
"type": "boolean"
|
|
2410
|
+
}
|
|
2411
|
+
],
|
|
2412
|
+
"optional": true,
|
|
2413
|
+
"required": false
|
|
2414
|
+
},
|
|
2415
|
+
{
|
|
2416
|
+
"name": "dismissLabel",
|
|
2417
|
+
"type": "string",
|
|
2418
|
+
"mutable": false,
|
|
2419
|
+
"attr": "dismiss-label",
|
|
2420
|
+
"reflectToAttr": false,
|
|
2421
|
+
"docs": "Sets the dismiss label tooltip and aria label.",
|
|
2422
|
+
"docsTags": [],
|
|
2423
|
+
"default": "\"Dismiss\"",
|
|
2424
|
+
"values": [
|
|
2425
|
+
{
|
|
2426
|
+
"type": "string"
|
|
2427
|
+
}
|
|
2428
|
+
],
|
|
2429
|
+
"optional": true,
|
|
2430
|
+
"required": false
|
|
2431
|
+
},
|
|
2432
|
+
{
|
|
2433
|
+
"name": "heading",
|
|
2434
|
+
"type": "string",
|
|
2435
|
+
"mutable": false,
|
|
2436
|
+
"attr": "heading",
|
|
2437
|
+
"reflectToAttr": false,
|
|
2438
|
+
"docs": "Sets the heading for the dialog.",
|
|
2439
|
+
"docsTags": [],
|
|
2440
|
+
"values": [
|
|
2441
|
+
{
|
|
2442
|
+
"type": "string"
|
|
2443
|
+
}
|
|
2444
|
+
],
|
|
2445
|
+
"optional": false,
|
|
2446
|
+
"required": true
|
|
2447
|
+
},
|
|
2448
|
+
{
|
|
2449
|
+
"name": "label",
|
|
2450
|
+
"type": "string",
|
|
2451
|
+
"mutable": false,
|
|
2452
|
+
"attr": "label",
|
|
2453
|
+
"reflectToAttr": false,
|
|
2454
|
+
"docs": "Sets the optional label for the dialog which appears above the heading.",
|
|
2455
|
+
"docsTags": [],
|
|
2456
|
+
"values": [
|
|
2457
|
+
{
|
|
2458
|
+
"type": "string"
|
|
2459
|
+
}
|
|
2460
|
+
],
|
|
2461
|
+
"optional": true,
|
|
2462
|
+
"required": false
|
|
2463
|
+
},
|
|
2464
|
+
{
|
|
2465
|
+
"name": "size",
|
|
2466
|
+
"type": "\"large\" | \"medium\" | \"small\"",
|
|
2467
|
+
"mutable": false,
|
|
2468
|
+
"attr": "size",
|
|
2469
|
+
"reflectToAttr": false,
|
|
2470
|
+
"docs": "Sets the maximum and minimum height and width for the dialog.",
|
|
2471
|
+
"docsTags": [],
|
|
2472
|
+
"default": "\"small\"",
|
|
2473
|
+
"values": [
|
|
2474
|
+
{
|
|
2475
|
+
"value": "large",
|
|
2476
|
+
"type": "string"
|
|
2477
|
+
},
|
|
2478
|
+
{
|
|
2479
|
+
"value": "medium",
|
|
2480
|
+
"type": "string"
|
|
2481
|
+
},
|
|
2482
|
+
{
|
|
2483
|
+
"value": "small",
|
|
2484
|
+
"type": "string"
|
|
2485
|
+
}
|
|
2486
|
+
],
|
|
2487
|
+
"optional": true,
|
|
2488
|
+
"required": false
|
|
2489
|
+
},
|
|
2490
|
+
{
|
|
2491
|
+
"name": "status",
|
|
2492
|
+
"type": "\"error\" | \"info\" | \"neutral\" | \"success\" | \"warning\"",
|
|
2493
|
+
"mutable": false,
|
|
2494
|
+
"attr": "status",
|
|
2495
|
+
"reflectToAttr": false,
|
|
2496
|
+
"docs": "If set, displays an alert of the corresponding variant below the heading.",
|
|
2497
|
+
"docsTags": [],
|
|
2498
|
+
"values": [
|
|
2499
|
+
{
|
|
2500
|
+
"value": "error",
|
|
2501
|
+
"type": "string"
|
|
2502
|
+
},
|
|
2503
|
+
{
|
|
2504
|
+
"value": "info",
|
|
2505
|
+
"type": "string"
|
|
2506
|
+
},
|
|
2507
|
+
{
|
|
2508
|
+
"value": "neutral",
|
|
2509
|
+
"type": "string"
|
|
2510
|
+
},
|
|
2511
|
+
{
|
|
2512
|
+
"value": "success",
|
|
2513
|
+
"type": "string"
|
|
2514
|
+
},
|
|
2515
|
+
{
|
|
2516
|
+
"value": "warning",
|
|
2517
|
+
"type": "string"
|
|
2518
|
+
}
|
|
2519
|
+
],
|
|
2520
|
+
"optional": true,
|
|
2521
|
+
"required": false
|
|
2522
|
+
}
|
|
2523
|
+
],
|
|
2524
|
+
"methods": [
|
|
2525
|
+
{
|
|
2526
|
+
"name": "cancelDialog",
|
|
2527
|
+
"returns": {
|
|
2528
|
+
"type": "Promise<void>",
|
|
2529
|
+
"docs": ""
|
|
2530
|
+
},
|
|
2531
|
+
"signature": "cancelDialog() => Promise<void>",
|
|
2532
|
+
"parameters": [],
|
|
2533
|
+
"docs": "Cancels the dialog. Used by the default 'Cancel' button or can be called manually to trigger cancelling of dialog.",
|
|
2534
|
+
"docsTags": []
|
|
2535
|
+
},
|
|
2536
|
+
{
|
|
2537
|
+
"name": "confirmDialog",
|
|
2538
|
+
"returns": {
|
|
2539
|
+
"type": "Promise<void>",
|
|
2540
|
+
"docs": ""
|
|
2541
|
+
},
|
|
2542
|
+
"signature": "confirmDialog() => Promise<void>",
|
|
2543
|
+
"parameters": [],
|
|
2544
|
+
"docs": "Confirms the dialog. Used by the default 'Confirm' button or can be called manually to trigger confirming of dialog.",
|
|
2545
|
+
"docsTags": []
|
|
2546
|
+
},
|
|
2547
|
+
{
|
|
2548
|
+
"name": "hideDialog",
|
|
2549
|
+
"returns": {
|
|
2550
|
+
"type": "Promise<void>",
|
|
2551
|
+
"docs": ""
|
|
2552
|
+
},
|
|
2553
|
+
"signature": "hideDialog() => Promise<void>",
|
|
2554
|
+
"parameters": [],
|
|
2555
|
+
"docs": "Use to hide the dialog.",
|
|
2556
|
+
"docsTags": []
|
|
2557
|
+
},
|
|
2558
|
+
{
|
|
2559
|
+
"name": "showDialog",
|
|
2560
|
+
"returns": {
|
|
2561
|
+
"type": "Promise<void>",
|
|
2562
|
+
"docs": ""
|
|
2563
|
+
},
|
|
2564
|
+
"signature": "showDialog() => Promise<void>",
|
|
2565
|
+
"parameters": [],
|
|
2566
|
+
"docs": "Use to show the dialog.",
|
|
2567
|
+
"docsTags": []
|
|
2568
|
+
}
|
|
2569
|
+
],
|
|
2570
|
+
"events": [
|
|
2571
|
+
{
|
|
2572
|
+
"event": "icDialogCancelled",
|
|
2573
|
+
"detail": "void",
|
|
2574
|
+
"bubbles": true,
|
|
2575
|
+
"cancelable": true,
|
|
2576
|
+
"composed": true,
|
|
2577
|
+
"docs": "Cancelation event emitted when default 'Cancel' button clicked or 'cancelDialog' method is called.",
|
|
2578
|
+
"docsTags": []
|
|
2579
|
+
},
|
|
2580
|
+
{
|
|
2581
|
+
"event": "icDialogClosed",
|
|
2582
|
+
"detail": "void",
|
|
2583
|
+
"bubbles": true,
|
|
2584
|
+
"cancelable": true,
|
|
2585
|
+
"composed": true,
|
|
2586
|
+
"docs": "Emitted when dialog has closed.",
|
|
2587
|
+
"docsTags": []
|
|
2588
|
+
},
|
|
2589
|
+
{
|
|
2590
|
+
"event": "icDialogConfirmed",
|
|
2591
|
+
"detail": "void",
|
|
2592
|
+
"bubbles": true,
|
|
2593
|
+
"cancelable": true,
|
|
2594
|
+
"composed": true,
|
|
2595
|
+
"docs": "Confirmation event emitted when default 'Confirm' primary button clicked or 'confirmDialog' method is called.",
|
|
2596
|
+
"docsTags": []
|
|
2597
|
+
},
|
|
2598
|
+
{
|
|
2599
|
+
"event": "icDialogOpened",
|
|
2600
|
+
"detail": "void",
|
|
2601
|
+
"bubbles": true,
|
|
2602
|
+
"cancelable": true,
|
|
2603
|
+
"composed": true,
|
|
2604
|
+
"docs": "Emitted when dialog has opened.",
|
|
2605
|
+
"docsTags": []
|
|
2606
|
+
}
|
|
2607
|
+
],
|
|
2608
|
+
"listeners": [
|
|
2609
|
+
{
|
|
2610
|
+
"event": "keydown",
|
|
2611
|
+
"target": "document",
|
|
2612
|
+
"capture": false,
|
|
2613
|
+
"passive": false
|
|
2614
|
+
},
|
|
2615
|
+
{
|
|
2616
|
+
"event": "click",
|
|
2617
|
+
"capture": false,
|
|
2618
|
+
"passive": false
|
|
2619
|
+
}
|
|
2620
|
+
],
|
|
2621
|
+
"styles": [
|
|
2622
|
+
{
|
|
2623
|
+
"name": "--ic-z-index-dialog",
|
|
2624
|
+
"annotation": "prop",
|
|
2625
|
+
"docs": "z-index of dialog"
|
|
2626
|
+
}
|
|
2627
|
+
],
|
|
2628
|
+
"slots": [],
|
|
2629
|
+
"parts": [],
|
|
2630
|
+
"dependents": [],
|
|
2631
|
+
"dependencies": [
|
|
2632
|
+
"ic-typography",
|
|
2633
|
+
"ic-button",
|
|
2634
|
+
"ic-alert"
|
|
2635
|
+
],
|
|
2636
|
+
"dependencyGraph": {
|
|
2637
|
+
"ic-dialog": [
|
|
2638
|
+
"ic-typography",
|
|
2639
|
+
"ic-button",
|
|
2640
|
+
"ic-alert"
|
|
2641
|
+
],
|
|
2642
|
+
"ic-button": [
|
|
2643
|
+
"ic-loading-indicator",
|
|
2644
|
+
"ic-tooltip"
|
|
2645
|
+
],
|
|
2646
|
+
"ic-loading-indicator": [
|
|
2647
|
+
"ic-typography"
|
|
2648
|
+
],
|
|
2649
|
+
"ic-tooltip": [
|
|
2650
|
+
"ic-typography"
|
|
2651
|
+
],
|
|
2652
|
+
"ic-alert": [
|
|
2653
|
+
"ic-typography",
|
|
2654
|
+
"ic-button"
|
|
2655
|
+
]
|
|
2656
|
+
}
|
|
2657
|
+
},
|
|
2298
2658
|
{
|
|
2299
2659
|
"filePath": "./src/components/ic-divider/ic-divider.tsx",
|
|
2300
2660
|
"encapsulation": "scoped",
|
|
@@ -4286,7 +4646,7 @@
|
|
|
4286
4646
|
{
|
|
4287
4647
|
"name": "value",
|
|
4288
4648
|
"type": "string",
|
|
4289
|
-
"mutable":
|
|
4649
|
+
"mutable": true,
|
|
4290
4650
|
"attr": "value",
|
|
4291
4651
|
"reflectToAttr": false,
|
|
4292
4652
|
"docs": "The value of the currently selected option.",
|
|
@@ -6382,7 +6742,7 @@
|
|
|
6382
6742
|
"events": [
|
|
6383
6743
|
{
|
|
6384
6744
|
"event": "icChange",
|
|
6385
|
-
"detail": "
|
|
6745
|
+
"detail": "IcChangeEventDetail",
|
|
6386
6746
|
"bubbles": true,
|
|
6387
6747
|
"cancelable": true,
|
|
6388
6748
|
"composed": true,
|
|
@@ -6395,6 +6755,11 @@
|
|
|
6395
6755
|
"event": "icCheck",
|
|
6396
6756
|
"capture": false,
|
|
6397
6757
|
"passive": false
|
|
6758
|
+
},
|
|
6759
|
+
{
|
|
6760
|
+
"event": "icSelectedChange",
|
|
6761
|
+
"capture": false,
|
|
6762
|
+
"passive": false
|
|
6398
6763
|
}
|
|
6399
6764
|
],
|
|
6400
6765
|
"styles": [],
|
|
@@ -6585,7 +6950,16 @@
|
|
|
6585
6950
|
"bubbles": true,
|
|
6586
6951
|
"cancelable": true,
|
|
6587
6952
|
"composed": true,
|
|
6588
|
-
"docs": "Emitted when
|
|
6953
|
+
"docs": "Emitted when the radio option is selected.",
|
|
6954
|
+
"docsTags": []
|
|
6955
|
+
},
|
|
6956
|
+
{
|
|
6957
|
+
"event": "icSelectedChange",
|
|
6958
|
+
"detail": "void",
|
|
6959
|
+
"bubbles": true,
|
|
6960
|
+
"cancelable": true,
|
|
6961
|
+
"composed": true,
|
|
6962
|
+
"docs": "Emitted when the radio option is selected or deselected.",
|
|
6589
6963
|
"docsTags": []
|
|
6590
6964
|
},
|
|
6591
6965
|
{
|
|
@@ -11160,6 +11534,7 @@
|
|
|
11160
11534
|
"ic-classification-banner",
|
|
11161
11535
|
"ic-data-entity",
|
|
11162
11536
|
"ic-data-row",
|
|
11537
|
+
"ic-dialog",
|
|
11163
11538
|
"ic-footer",
|
|
11164
11539
|
"ic-footer-link-group",
|
|
11165
11540
|
"ic-hero",
|
|
@@ -11213,6 +11588,9 @@
|
|
|
11213
11588
|
"ic-data-row": [
|
|
11214
11589
|
"ic-typography"
|
|
11215
11590
|
],
|
|
11591
|
+
"ic-dialog": [
|
|
11592
|
+
"ic-typography"
|
|
11593
|
+
],
|
|
11216
11594
|
"ic-footer": [
|
|
11217
11595
|
"ic-typography"
|
|
11218
11596
|
],
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ukic/docs",
|
|
3
|
-
"version": "2.1.0-beta.
|
|
3
|
+
"version": "2.1.0-beta.17",
|
|
4
4
|
"description": "API documentation for @ukic components",
|
|
5
5
|
"main": "docs.json",
|
|
6
6
|
"types": "docs.d.ts",
|
|
@@ -9,5 +9,5 @@
|
|
|
9
9
|
"docs.d.ts"
|
|
10
10
|
],
|
|
11
11
|
"license": "MIT",
|
|
12
|
-
"gitHead": "
|
|
12
|
+
"gitHead": "7d0f6c6e808b4a5758e68c1b4b0fa4d596c95330"
|
|
13
13
|
}
|