@ukic/docs 2.1.0-beta.11 → 2.1.0-beta.13

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.
Files changed (2) hide show
  1. package/docs.json +891 -70
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "timestamp": "2023-04-12T14:40:39",
2
+ "timestamp": "2023-05-16T15:37:47",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
5
  "version": "2.20.0",
@@ -508,6 +508,102 @@
508
508
  "optional": true,
509
509
  "required": false
510
510
  },
511
+ {
512
+ "name": "form",
513
+ "type": "string",
514
+ "mutable": false,
515
+ "attr": "form",
516
+ "reflectToAttr": false,
517
+ "docs": "The <form> element to associate the button with.",
518
+ "docsTags": [],
519
+ "values": [
520
+ {
521
+ "type": "string"
522
+ }
523
+ ],
524
+ "optional": true,
525
+ "required": false
526
+ },
527
+ {
528
+ "name": "formaction",
529
+ "type": "string",
530
+ "mutable": false,
531
+ "attr": "formaction",
532
+ "reflectToAttr": false,
533
+ "docs": "The URL that processes the information submitted by the button. It overrides the action attribute of the button's form owner. Does nothing if there is no form owner.",
534
+ "docsTags": [],
535
+ "values": [
536
+ {
537
+ "type": "string"
538
+ }
539
+ ],
540
+ "optional": true,
541
+ "required": false
542
+ },
543
+ {
544
+ "name": "formenctype",
545
+ "type": "string",
546
+ "mutable": false,
547
+ "attr": "formenctype",
548
+ "reflectToAttr": false,
549
+ "docs": "The way the submitted form data is encoded.",
550
+ "docsTags": [],
551
+ "values": [
552
+ {
553
+ "type": "string"
554
+ }
555
+ ],
556
+ "optional": true,
557
+ "required": false
558
+ },
559
+ {
560
+ "name": "formmethod",
561
+ "type": "string",
562
+ "mutable": false,
563
+ "attr": "formmethod",
564
+ "reflectToAttr": false,
565
+ "docs": "The HTTP method used to submit the form.",
566
+ "docsTags": [],
567
+ "values": [
568
+ {
569
+ "type": "string"
570
+ }
571
+ ],
572
+ "optional": true,
573
+ "required": false
574
+ },
575
+ {
576
+ "name": "formnovalidate",
577
+ "type": "boolean",
578
+ "mutable": false,
579
+ "attr": "formnovalidate",
580
+ "reflectToAttr": false,
581
+ "docs": "If `true`, the form will not be validated when submitted.",
582
+ "docsTags": [],
583
+ "values": [
584
+ {
585
+ "type": "boolean"
586
+ }
587
+ ],
588
+ "optional": true,
589
+ "required": false
590
+ },
591
+ {
592
+ "name": "formtarget",
593
+ "type": "string",
594
+ "mutable": false,
595
+ "attr": "formtarget",
596
+ "reflectToAttr": false,
597
+ "docs": "The place to display the response from submitting the form. It overrides the target attribute of the button's form owner.",
598
+ "docsTags": [],
599
+ "values": [
600
+ {
601
+ "type": "string"
602
+ }
603
+ ],
604
+ "optional": true,
605
+ "required": false
606
+ },
511
607
  {
512
608
  "name": "fullWidth",
513
609
  "type": "boolean",
@@ -817,7 +913,13 @@
817
913
  "passive": false
818
914
  }
819
915
  ],
820
- "styles": [],
916
+ "styles": [
917
+ {
918
+ "name": "--min-width",
919
+ "annotation": "prop",
920
+ "docs": "Minimum width of the button."
921
+ }
922
+ ],
821
923
  "slots": [
822
924
  {
823
925
  "name": "icon",
@@ -829,9 +931,11 @@
829
931
  "ic-alert",
830
932
  "ic-card",
831
933
  "ic-horizontal-scroll",
934
+ "ic-menu",
832
935
  "ic-menu-item",
833
936
  "ic-navigation-button",
834
937
  "ic-navigation-menu",
938
+ "ic-pagination",
835
939
  "ic-search-bar",
836
940
  "ic-select",
837
941
  "ic-side-navigation",
@@ -862,6 +966,9 @@
862
966
  "ic-horizontal-scroll": [
863
967
  "ic-button"
864
968
  ],
969
+ "ic-menu": [
970
+ "ic-button"
971
+ ],
865
972
  "ic-menu-item": [
866
973
  "ic-button"
867
974
  ],
@@ -871,6 +978,9 @@
871
978
  "ic-navigation-menu": [
872
979
  "ic-button"
873
980
  ],
981
+ "ic-pagination": [
982
+ "ic-button"
983
+ ],
874
984
  "ic-search-bar": [
875
985
  "ic-button"
876
986
  ],
@@ -1409,6 +1519,23 @@
1409
1519
  "optional": false,
1410
1520
  "required": false
1411
1521
  },
1522
+ {
1523
+ "name": "small",
1524
+ "type": "boolean",
1525
+ "mutable": false,
1526
+ "attr": "small",
1527
+ "reflectToAttr": false,
1528
+ "docs": "If true, the small styling will be applied to the checkbox.",
1529
+ "docsTags": [],
1530
+ "default": "false",
1531
+ "values": [
1532
+ {
1533
+ "type": "boolean"
1534
+ }
1535
+ ],
1536
+ "optional": true,
1537
+ "required": false
1538
+ },
1412
1539
  {
1413
1540
  "name": "value",
1414
1541
  "type": "string",
@@ -3973,6 +4100,7 @@
3973
4100
  "parts": [],
3974
4101
  "dependents": [
3975
4102
  "ic-button",
4103
+ "ic-menu",
3976
4104
  "ic-step",
3977
4105
  "ic-toast"
3978
4106
  ],
@@ -3986,6 +4114,9 @@
3986
4114
  "ic-button": [
3987
4115
  "ic-loading-indicator"
3988
4116
  ],
4117
+ "ic-menu": [
4118
+ "ic-loading-indicator"
4119
+ ],
3989
4120
  "ic-step": [
3990
4121
  "ic-loading-indicator"
3991
4122
  ],
@@ -4203,10 +4334,24 @@
4203
4334
  "ic-select"
4204
4335
  ],
4205
4336
  "dependencies": [
4206
- "ic-typography"
4337
+ "ic-loading-indicator",
4338
+ "ic-typography",
4339
+ "ic-button"
4207
4340
  ],
4208
4341
  "dependencyGraph": {
4209
4342
  "ic-menu": [
4343
+ "ic-loading-indicator",
4344
+ "ic-typography",
4345
+ "ic-button"
4346
+ ],
4347
+ "ic-loading-indicator": [
4348
+ "ic-typography"
4349
+ ],
4350
+ "ic-button": [
4351
+ "ic-loading-indicator",
4352
+ "ic-tooltip"
4353
+ ],
4354
+ "ic-tooltip": [
4210
4355
  "ic-typography"
4211
4356
  ],
4212
4357
  "ic-search-bar": [
@@ -5460,24 +5605,51 @@
5460
5605
  }
5461
5606
  },
5462
5607
  {
5463
- "filePath": "./src/components/ic-popover-menu/ic-popover-menu.tsx",
5608
+ "filePath": "./src/components/ic-pagination/ic-pagination.tsx",
5464
5609
  "encapsulation": "shadow",
5465
- "tag": "ic-popover-menu",
5466
- "readme": "# ic-popover-menu\n\nThis is a wrapper component to be placed around one or more ic-menu-item components.\n",
5467
- "docs": "This is a wrapper component to be placed around one or more ic-menu-item components.",
5610
+ "tag": "ic-pagination",
5611
+ "readme": "# ic-pagination\n\n\n",
5612
+ "docs": "",
5468
5613
  "docsTags": [],
5469
5614
  "usage": {},
5470
5615
  "props": [
5471
5616
  {
5472
- "name": "anchor",
5473
- "type": "string",
5617
+ "name": "adjacentCount",
5618
+ "type": "number",
5619
+ "mutable": true,
5620
+ "attr": "adjacent-count",
5621
+ "reflectToAttr": false,
5622
+ "docs": "The number of pages displayed adjacent to the current page when using 'complex' type pagination. Accepted values are 0, 1 & 2.",
5623
+ "docsTags": [],
5624
+ "default": "1",
5625
+ "values": [
5626
+ {
5627
+ "type": "number"
5628
+ }
5629
+ ],
5630
+ "optional": false,
5631
+ "required": false
5632
+ },
5633
+ {
5634
+ "name": "appearance",
5635
+ "type": "\"dark\" | \"default\" | \"light\"",
5474
5636
  "mutable": false,
5475
- "attr": "anchor",
5637
+ "attr": "appearance",
5476
5638
  "reflectToAttr": false,
5477
- "docs": "The ID of the element the popover menu will anchor itself to. This is required unless the popover is a submenu.",
5639
+ "docs": "The appearance of the pagination, e.g. dark, light or the default.",
5478
5640
  "docsTags": [],
5641
+ "default": "\"default\"",
5479
5642
  "values": [
5480
5643
  {
5644
+ "value": "dark",
5645
+ "type": "string"
5646
+ },
5647
+ {
5648
+ "value": "default",
5649
+ "type": "string"
5650
+ },
5651
+ {
5652
+ "value": "light",
5481
5653
  "type": "string"
5482
5654
  }
5483
5655
  ],
@@ -5485,80 +5657,474 @@
5485
5657
  "required": false
5486
5658
  },
5487
5659
  {
5488
- "name": "open",
5489
- "type": "boolean",
5660
+ "name": "boundaryCount",
5661
+ "type": "number",
5490
5662
  "mutable": true,
5491
- "attr": "open",
5492
- "reflectToAttr": true,
5493
- "docs": "If `true`, the popover menu will be displayed.",
5663
+ "attr": "boundary-count",
5664
+ "reflectToAttr": false,
5665
+ "docs": "The number of pages displayed as boundary items to the current page when using 'complex' type pagination. Accepted values are 0, 1 & 2.",
5494
5666
  "docsTags": [],
5495
- "default": "undefined",
5667
+ "default": "1",
5496
5668
  "values": [
5497
5669
  {
5498
- "type": "boolean"
5670
+ "type": "number"
5499
5671
  }
5500
5672
  ],
5501
5673
  "optional": false,
5502
5674
  "required": false
5503
5675
  },
5504
5676
  {
5505
- "name": "submenuId",
5506
- "type": "string",
5677
+ "name": "defaultPage",
5678
+ "type": "number",
5507
5679
  "mutable": false,
5508
- "attr": "submenu-id",
5680
+ "attr": "default-page",
5509
5681
  "reflectToAttr": false,
5510
- "docs": "The unique identifier for a popover submenu.",
5682
+ "docs": "The default page to display.",
5511
5683
  "docsTags": [],
5684
+ "default": "1",
5512
5685
  "values": [
5513
5686
  {
5514
- "type": "string"
5687
+ "type": "number"
5515
5688
  }
5516
5689
  ],
5517
- "optional": true,
5690
+ "optional": false,
5518
5691
  "required": false
5519
- }
5520
- ],
5521
- "methods": [],
5522
- "events": [],
5523
- "listeners": [
5524
- {
5525
- "event": "handleMenuItemClick",
5526
- "capture": false,
5527
- "passive": false
5528
5692
  },
5529
5693
  {
5530
- "event": "triggerPopoverMenuInstance",
5531
- "capture": true,
5532
- "passive": false
5533
- },
5534
- {
5535
- "event": "click",
5536
- "target": "document",
5537
- "capture": false,
5538
- "passive": false
5694
+ "name": "disabled",
5695
+ "type": "boolean",
5696
+ "mutable": false,
5697
+ "attr": "disabled",
5698
+ "reflectToAttr": false,
5699
+ "docs": "If `true`, the pagination will not allow interaction.",
5700
+ "docsTags": [],
5701
+ "default": "false",
5702
+ "values": [
5703
+ {
5704
+ "type": "boolean"
5705
+ }
5706
+ ],
5707
+ "optional": false,
5708
+ "required": false
5539
5709
  },
5540
5710
  {
5541
- "event": "keydown",
5542
- "target": "document",
5543
- "capture": false,
5544
- "passive": false
5545
- }
5546
- ],
5547
- "styles": [
5548
- {
5549
- "name": "--ic-z-index-popover",
5550
- "annotation": "prop",
5551
- "docs": "z-index of popover menu."
5711
+ "name": "hideCurrentPage",
5712
+ "type": "boolean",
5713
+ "mutable": false,
5714
+ "attr": "hide-current-page",
5715
+ "reflectToAttr": false,
5716
+ "docs": "If `true`, the current page of the simple pagination will not be displayed.",
5717
+ "docsTags": [],
5718
+ "default": "false",
5719
+ "values": [
5720
+ {
5721
+ "type": "boolean"
5722
+ }
5723
+ ],
5724
+ "optional": false,
5725
+ "required": false
5552
5726
  },
5553
5727
  {
5554
- "name": "--max-height",
5555
- "annotation": "prop",
5556
- "docs": "Maximum height of the popover menu."
5728
+ "name": "hideFirstAndLastPageButton",
5729
+ "type": "boolean",
5730
+ "mutable": false,
5731
+ "attr": "hide-first-and-last-page-button",
5732
+ "reflectToAttr": false,
5733
+ "docs": "If `true`, the first and last page buttons will not be displayed.",
5734
+ "docsTags": [],
5735
+ "default": "false",
5736
+ "values": [
5737
+ {
5738
+ "type": "boolean"
5739
+ }
5740
+ ],
5741
+ "optional": false,
5742
+ "required": false
5557
5743
  },
5558
5744
  {
5559
- "name": "--popover-width",
5560
- "annotation": "prop",
5561
- "docs": "Default width of the popover menu."
5745
+ "name": "label",
5746
+ "type": "string",
5747
+ "mutable": false,
5748
+ "attr": "label",
5749
+ "reflectToAttr": false,
5750
+ "docs": "The label for the pagination item (applicable when simple pagination is being used).",
5751
+ "docsTags": [],
5752
+ "default": "\"Page\"",
5753
+ "values": [
5754
+ {
5755
+ "type": "string"
5756
+ }
5757
+ ],
5758
+ "optional": false,
5759
+ "required": false
5760
+ },
5761
+ {
5762
+ "name": "pages",
5763
+ "type": "number",
5764
+ "mutable": false,
5765
+ "attr": "pages",
5766
+ "reflectToAttr": false,
5767
+ "docs": "The total number of pages.",
5768
+ "docsTags": [],
5769
+ "values": [
5770
+ {
5771
+ "type": "number"
5772
+ }
5773
+ ],
5774
+ "optional": false,
5775
+ "required": true
5776
+ },
5777
+ {
5778
+ "name": "type",
5779
+ "type": "\"complex\" | \"simple\"",
5780
+ "mutable": false,
5781
+ "attr": "type",
5782
+ "reflectToAttr": false,
5783
+ "docs": "The type of pagination to be used.",
5784
+ "docsTags": [],
5785
+ "default": "\"simple\"",
5786
+ "values": [
5787
+ {
5788
+ "value": "complex",
5789
+ "type": "string"
5790
+ },
5791
+ {
5792
+ "value": "simple",
5793
+ "type": "string"
5794
+ }
5795
+ ],
5796
+ "optional": false,
5797
+ "required": false
5798
+ }
5799
+ ],
5800
+ "methods": [],
5801
+ "events": [
5802
+ {
5803
+ "event": "icPageChange",
5804
+ "detail": "IcChangeEventDetail",
5805
+ "bubbles": true,
5806
+ "cancelable": true,
5807
+ "composed": true,
5808
+ "docs": "Emitted when a page is selected.",
5809
+ "docsTags": []
5810
+ }
5811
+ ],
5812
+ "listeners": [
5813
+ {
5814
+ "event": "paginationItemClick",
5815
+ "capture": false,
5816
+ "passive": false
5817
+ }
5818
+ ],
5819
+ "styles": [],
5820
+ "slots": [],
5821
+ "parts": [],
5822
+ "dependents": [],
5823
+ "dependencies": [
5824
+ "ic-button",
5825
+ "ic-pagination-item"
5826
+ ],
5827
+ "dependencyGraph": {
5828
+ "ic-pagination": [
5829
+ "ic-button",
5830
+ "ic-pagination-item"
5831
+ ],
5832
+ "ic-button": [
5833
+ "ic-loading-indicator",
5834
+ "ic-tooltip"
5835
+ ],
5836
+ "ic-loading-indicator": [
5837
+ "ic-typography"
5838
+ ],
5839
+ "ic-tooltip": [
5840
+ "ic-typography"
5841
+ ],
5842
+ "ic-pagination-item": [
5843
+ "ic-typography"
5844
+ ]
5845
+ }
5846
+ },
5847
+ {
5848
+ "filePath": "./src/components/ic-pagination-item/ic-pagination-item.tsx",
5849
+ "encapsulation": "shadow",
5850
+ "tag": "ic-pagination-item",
5851
+ "readme": "# ic-pagination-item\n\n\n",
5852
+ "docs": "",
5853
+ "docsTags": [],
5854
+ "usage": {},
5855
+ "props": [
5856
+ {
5857
+ "name": "appearance",
5858
+ "type": "\"dark\" | \"default\" | \"light\"",
5859
+ "mutable": false,
5860
+ "attr": "appearance",
5861
+ "reflectToAttr": false,
5862
+ "docs": "The appearance of the pagination, e.g. dark, light or the default.",
5863
+ "docsTags": [],
5864
+ "values": [
5865
+ {
5866
+ "value": "dark",
5867
+ "type": "string"
5868
+ },
5869
+ {
5870
+ "value": "default",
5871
+ "type": "string"
5872
+ },
5873
+ {
5874
+ "value": "light",
5875
+ "type": "string"
5876
+ }
5877
+ ],
5878
+ "optional": false,
5879
+ "required": false
5880
+ },
5881
+ {
5882
+ "name": "ariaOverride",
5883
+ "type": "boolean",
5884
+ "mutable": false,
5885
+ "attr": "aria-override",
5886
+ "reflectToAttr": false,
5887
+ "docs": "If true the aria-label will be set to `Page X of Y`, where X is the current page and Y is the page count.",
5888
+ "docsTags": [],
5889
+ "default": "false",
5890
+ "values": [
5891
+ {
5892
+ "type": "boolean"
5893
+ }
5894
+ ],
5895
+ "optional": false,
5896
+ "required": false
5897
+ },
5898
+ {
5899
+ "name": "disabled",
5900
+ "type": "boolean",
5901
+ "mutable": false,
5902
+ "attr": "disabled",
5903
+ "reflectToAttr": false,
5904
+ "docs": "If `true`, the pagination item will be disabled.",
5905
+ "docsTags": [],
5906
+ "default": "false",
5907
+ "values": [
5908
+ {
5909
+ "type": "boolean"
5910
+ }
5911
+ ],
5912
+ "optional": false,
5913
+ "required": false
5914
+ },
5915
+ {
5916
+ "name": "label",
5917
+ "type": "string",
5918
+ "mutable": false,
5919
+ "attr": "label",
5920
+ "reflectToAttr": false,
5921
+ "docs": "The label for the pagination item (applicable when simple pagination is being used).",
5922
+ "docsTags": [],
5923
+ "default": "\"Page \"",
5924
+ "values": [
5925
+ {
5926
+ "type": "string"
5927
+ }
5928
+ ],
5929
+ "optional": false,
5930
+ "required": false
5931
+ },
5932
+ {
5933
+ "name": "page",
5934
+ "type": "number",
5935
+ "mutable": false,
5936
+ "attr": "page",
5937
+ "reflectToAttr": false,
5938
+ "docs": "The current page number.",
5939
+ "docsTags": [],
5940
+ "values": [
5941
+ {
5942
+ "type": "number"
5943
+ }
5944
+ ],
5945
+ "optional": false,
5946
+ "required": false
5947
+ },
5948
+ {
5949
+ "name": "pages",
5950
+ "type": "number",
5951
+ "mutable": false,
5952
+ "attr": "pages",
5953
+ "reflectToAttr": false,
5954
+ "docs": "The total number of pages.",
5955
+ "docsTags": [],
5956
+ "values": [
5957
+ {
5958
+ "type": "number"
5959
+ }
5960
+ ],
5961
+ "optional": false,
5962
+ "required": false
5963
+ },
5964
+ {
5965
+ "name": "selected",
5966
+ "type": "boolean",
5967
+ "mutable": false,
5968
+ "attr": "selected",
5969
+ "reflectToAttr": false,
5970
+ "docs": "If `true`, the pagination item will be selected.",
5971
+ "docsTags": [],
5972
+ "default": "false",
5973
+ "values": [
5974
+ {
5975
+ "type": "boolean"
5976
+ }
5977
+ ],
5978
+ "optional": false,
5979
+ "required": false
5980
+ },
5981
+ {
5982
+ "name": "type",
5983
+ "type": "\"ellipsis\" | \"page\" | \"simple-current\"",
5984
+ "mutable": false,
5985
+ "attr": "type",
5986
+ "reflectToAttr": false,
5987
+ "docs": "The type of pagination item - 'page' or 'ellipsis'.",
5988
+ "docsTags": [],
5989
+ "values": [
5990
+ {
5991
+ "value": "ellipsis",
5992
+ "type": "string"
5993
+ },
5994
+ {
5995
+ "value": "page",
5996
+ "type": "string"
5997
+ },
5998
+ {
5999
+ "value": "simple-current",
6000
+ "type": "string"
6001
+ }
6002
+ ],
6003
+ "optional": false,
6004
+ "required": false
6005
+ }
6006
+ ],
6007
+ "methods": [],
6008
+ "events": [],
6009
+ "listeners": [],
6010
+ "styles": [],
6011
+ "slots": [],
6012
+ "parts": [],
6013
+ "dependents": [
6014
+ "ic-pagination"
6015
+ ],
6016
+ "dependencies": [
6017
+ "ic-typography"
6018
+ ],
6019
+ "dependencyGraph": {
6020
+ "ic-pagination-item": [
6021
+ "ic-typography"
6022
+ ],
6023
+ "ic-pagination": [
6024
+ "ic-pagination-item"
6025
+ ]
6026
+ }
6027
+ },
6028
+ {
6029
+ "filePath": "./src/components/ic-popover-menu/ic-popover-menu.tsx",
6030
+ "encapsulation": "shadow",
6031
+ "tag": "ic-popover-menu",
6032
+ "readme": "# ic-popover-menu\n\nThis is a wrapper component to be placed around one or more ic-menu-item components.\n",
6033
+ "docs": "This is a wrapper component to be placed around one or more ic-menu-item components.",
6034
+ "docsTags": [],
6035
+ "usage": {},
6036
+ "props": [
6037
+ {
6038
+ "name": "anchor",
6039
+ "type": "string",
6040
+ "mutable": false,
6041
+ "attr": "anchor",
6042
+ "reflectToAttr": false,
6043
+ "docs": "The ID of the element the popover menu will anchor itself to. This is required unless the popover is a submenu.",
6044
+ "docsTags": [],
6045
+ "values": [
6046
+ {
6047
+ "type": "string"
6048
+ }
6049
+ ],
6050
+ "optional": false,
6051
+ "required": false
6052
+ },
6053
+ {
6054
+ "name": "open",
6055
+ "type": "boolean",
6056
+ "mutable": true,
6057
+ "attr": "open",
6058
+ "reflectToAttr": true,
6059
+ "docs": "If `true`, the popover menu will be displayed.",
6060
+ "docsTags": [],
6061
+ "default": "undefined",
6062
+ "values": [
6063
+ {
6064
+ "type": "boolean"
6065
+ }
6066
+ ],
6067
+ "optional": false,
6068
+ "required": false
6069
+ },
6070
+ {
6071
+ "name": "submenuId",
6072
+ "type": "string",
6073
+ "mutable": false,
6074
+ "attr": "submenu-id",
6075
+ "reflectToAttr": false,
6076
+ "docs": "The unique identifier for a popover submenu.",
6077
+ "docsTags": [],
6078
+ "values": [
6079
+ {
6080
+ "type": "string"
6081
+ }
6082
+ ],
6083
+ "optional": true,
6084
+ "required": false
6085
+ }
6086
+ ],
6087
+ "methods": [],
6088
+ "events": [],
6089
+ "listeners": [
6090
+ {
6091
+ "event": "handleMenuItemClick",
6092
+ "capture": false,
6093
+ "passive": false
6094
+ },
6095
+ {
6096
+ "event": "triggerPopoverMenuInstance",
6097
+ "capture": true,
6098
+ "passive": false
6099
+ },
6100
+ {
6101
+ "event": "click",
6102
+ "target": "document",
6103
+ "capture": false,
6104
+ "passive": false
6105
+ },
6106
+ {
6107
+ "event": "keydown",
6108
+ "target": "document",
6109
+ "capture": false,
6110
+ "passive": false
6111
+ }
6112
+ ],
6113
+ "styles": [
6114
+ {
6115
+ "name": "--ic-z-index-popover",
6116
+ "annotation": "prop",
6117
+ "docs": "z-index of popover menu."
6118
+ },
6119
+ {
6120
+ "name": "--max-height",
6121
+ "annotation": "prop",
6122
+ "docs": "Maximum height of the popover menu."
6123
+ },
6124
+ {
6125
+ "name": "--popover-width",
6126
+ "annotation": "prop",
6127
+ "docs": "Default width of the popover menu."
5562
6128
  }
5563
6129
  ],
5564
6130
  "slots": [],
@@ -6510,6 +7076,57 @@
6510
7076
  "optional": false,
6511
7077
  "required": true
6512
7078
  },
7079
+ {
7080
+ "name": "loading",
7081
+ "type": "boolean",
7082
+ "mutable": true,
7083
+ "attr": "loading",
7084
+ "reflectToAttr": false,
7085
+ "docs": "Trigger loading state when fetching options asyncronously",
7086
+ "docsTags": [],
7087
+ "default": "false",
7088
+ "values": [
7089
+ {
7090
+ "type": "boolean"
7091
+ }
7092
+ ],
7093
+ "optional": true,
7094
+ "required": false
7095
+ },
7096
+ {
7097
+ "name": "loadingErrorLabel",
7098
+ "type": "string",
7099
+ "mutable": false,
7100
+ "attr": "loading-error-label",
7101
+ "reflectToAttr": false,
7102
+ "docs": "Change the message displayed when external loading times out.",
7103
+ "docsTags": [],
7104
+ "default": "\"Loading Error\"",
7105
+ "values": [
7106
+ {
7107
+ "type": "string"
7108
+ }
7109
+ ],
7110
+ "optional": true,
7111
+ "required": false
7112
+ },
7113
+ {
7114
+ "name": "loadingLabel",
7115
+ "type": "string",
7116
+ "mutable": false,
7117
+ "attr": "loading-label",
7118
+ "reflectToAttr": false,
7119
+ "docs": "Change the message displayed whilst the options are being loaded externally.",
7120
+ "docsTags": [],
7121
+ "default": "\"Loading...\"",
7122
+ "values": [
7123
+ {
7124
+ "type": "string"
7125
+ }
7126
+ ],
7127
+ "optional": true,
7128
+ "required": false
7129
+ },
6513
7130
  {
6514
7131
  "name": "name",
6515
7132
  "type": "string",
@@ -6628,6 +7245,22 @@
6628
7245
  "optional": false,
6629
7246
  "required": false
6630
7247
  },
7248
+ {
7249
+ "name": "timeout",
7250
+ "type": "number",
7251
+ "mutable": false,
7252
+ "attr": "timeout",
7253
+ "reflectToAttr": false,
7254
+ "docs": "If using external filtering, set a timeout for when loading takes too long.",
7255
+ "docsTags": [],
7256
+ "values": [
7257
+ {
7258
+ "type": "number"
7259
+ }
7260
+ ],
7261
+ "optional": true,
7262
+ "required": false
7263
+ },
6631
7264
  {
6632
7265
  "name": "value",
6633
7266
  "type": "string",
@@ -6735,6 +7368,15 @@
6735
7368
  "docs": "Emitted when option is highlighted within the menu",
6736
7369
  "docsTags": []
6737
7370
  },
7371
+ {
7372
+ "event": "icRetryLoad",
7373
+ "detail": "IcValueEventDetail",
7374
+ "bubbles": true,
7375
+ "cancelable": true,
7376
+ "composed": true,
7377
+ "docs": "Emitted when the 'retry loading' button is clicked",
7378
+ "docsTags": []
7379
+ },
6738
7380
  {
6739
7381
  "event": "icSearchBarBlur",
6740
7382
  "detail": "IcSearchBarBlurEventDetail",
@@ -6820,7 +7462,9 @@
6820
7462
  "ic-typography"
6821
7463
  ],
6822
7464
  "ic-menu": [
6823
- "ic-typography"
7465
+ "ic-loading-indicator",
7466
+ "ic-typography",
7467
+ "ic-button"
6824
7468
  ]
6825
7469
  }
6826
7470
  },
@@ -7110,6 +7754,57 @@
7110
7754
  "optional": false,
7111
7755
  "required": true
7112
7756
  },
7757
+ {
7758
+ "name": "loading",
7759
+ "type": "boolean",
7760
+ "mutable": true,
7761
+ "attr": "loading",
7762
+ "reflectToAttr": false,
7763
+ "docs": "Trigger loading state when fetching options asyncronously",
7764
+ "docsTags": [],
7765
+ "default": "false",
7766
+ "values": [
7767
+ {
7768
+ "type": "boolean"
7769
+ }
7770
+ ],
7771
+ "optional": true,
7772
+ "required": false
7773
+ },
7774
+ {
7775
+ "name": "loadingErrorLabel",
7776
+ "type": "string",
7777
+ "mutable": false,
7778
+ "attr": "loading-error-label",
7779
+ "reflectToAttr": false,
7780
+ "docs": "Change the message displayed when external loading times out.",
7781
+ "docsTags": [],
7782
+ "default": "\"Loading Error\"",
7783
+ "values": [
7784
+ {
7785
+ "type": "string"
7786
+ }
7787
+ ],
7788
+ "optional": true,
7789
+ "required": false
7790
+ },
7791
+ {
7792
+ "name": "loadingLabel",
7793
+ "type": "string",
7794
+ "mutable": false,
7795
+ "attr": "loading-label",
7796
+ "reflectToAttr": false,
7797
+ "docs": "Change the message displayed whilst the options are being loaded externally.",
7798
+ "docsTags": [],
7799
+ "default": "\"Loading...\"",
7800
+ "values": [
7801
+ {
7802
+ "type": "string"
7803
+ }
7804
+ ],
7805
+ "optional": true,
7806
+ "required": false
7807
+ },
7113
7808
  {
7114
7809
  "name": "name",
7115
7810
  "type": "string",
@@ -7267,6 +7962,22 @@
7267
7962
  "optional": true,
7268
7963
  "required": false
7269
7964
  },
7965
+ {
7966
+ "name": "timeout",
7967
+ "type": "number",
7968
+ "mutable": false,
7969
+ "attr": "timeout",
7970
+ "reflectToAttr": false,
7971
+ "docs": "If using external filtering, set a timeout for when loading takes too long.",
7972
+ "docsTags": [],
7973
+ "values": [
7974
+ {
7975
+ "type": "number"
7976
+ }
7977
+ ],
7978
+ "optional": true,
7979
+ "required": false
7980
+ },
7270
7981
  {
7271
7982
  "name": "validationStatus",
7272
7983
  "type": "\"\" | \"error\" | \"success\" | \"warning\"",
@@ -7397,6 +8108,15 @@
7397
8108
  "composed": true,
7398
8109
  "docs": "Emitted when option is highlighted within the menu.\nHighlighting a menu item will trigger an `icChange/onIcChange` due to the value being updated.",
7399
8110
  "docsTags": []
8111
+ },
8112
+ {
8113
+ "event": "icRetryLoad",
8114
+ "detail": "IcValueEventDetail",
8115
+ "bubbles": true,
8116
+ "cancelable": true,
8117
+ "composed": true,
8118
+ "docs": "Emitted when the 'retry loading' button is clicked",
8119
+ "docsTags": []
7400
8120
  }
7401
8121
  ],
7402
8122
  "listeners": [],
@@ -7448,7 +8168,9 @@
7448
8168
  "ic-typography"
7449
8169
  ],
7450
8170
  "ic-menu": [
7451
- "ic-typography"
8171
+ "ic-loading-indicator",
8172
+ "ic-typography",
8173
+ "ic-button"
7452
8174
  ],
7453
8175
  "ic-input-validation": [
7454
8176
  "ic-typography"
@@ -8495,6 +9217,16 @@
8495
9217
  "event": "tabClick",
8496
9218
  "capture": false,
8497
9219
  "passive": false
9220
+ },
9221
+ {
9222
+ "event": "tabCreated",
9223
+ "capture": false,
9224
+ "passive": false
9225
+ },
9226
+ {
9227
+ "event": "tabPanelCreated",
9228
+ "capture": false,
9229
+ "passive": false
8498
9230
  }
8499
9231
  ],
8500
9232
  "styles": [],
@@ -8519,9 +9251,15 @@
8519
9251
  "mutable": false,
8520
9252
  "attr": "context-id",
8521
9253
  "reflectToAttr": true,
8522
- "docs": "The unique context needed if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.",
8523
- "docsTags": [],
9254
+ "docs": "",
9255
+ "docsTags": [
9256
+ {
9257
+ "name": "deprecated",
9258
+ "text": "This is no longer required.\nThe context id is passed down from `ic-tab-context`"
9259
+ }
9260
+ ],
8524
9261
  "default": "\"default\"",
9262
+ "deprecation": "This is no longer required.\nThe context id is passed down from `ic-tab-context`",
8525
9263
  "values": [
8526
9264
  {
8527
9265
  "type": "string"
@@ -8608,9 +9346,15 @@
8608
9346
  "mutable": false,
8609
9347
  "attr": "context-id",
8610
9348
  "reflectToAttr": true,
8611
- "docs": "The unique context needed if using multiple tabs inside one another i.e. rendering another tabs inside a tab panel.",
8612
- "docsTags": [],
9349
+ "docs": "",
9350
+ "docsTags": [
9351
+ {
9352
+ "name": "deprecated",
9353
+ "text": "This is no longer required.\nThe context id is passed down from `ic-tab-context`"
9354
+ }
9355
+ ],
8613
9356
  "default": "\"default\"",
9357
+ "deprecation": "This is no longer required.\nThe context id is passed down from `ic-tab-context`",
8614
9358
  "values": [
8615
9359
  {
8616
9360
  "type": "string"
@@ -9094,6 +9838,26 @@
9094
9838
  "optional": false,
9095
9839
  "required": true
9096
9840
  },
9841
+ {
9842
+ "name": "max",
9843
+ "type": "number | string",
9844
+ "mutable": false,
9845
+ "attr": "max",
9846
+ "reflectToAttr": false,
9847
+ "docs": "The maximum number that can be accepted as a value, when `type` is `number` and `rows` is `1`. (NOTE: Ensure to include visual indication of max value in `helperText` or `label`)",
9848
+ "docsTags": [],
9849
+ "default": "undefined",
9850
+ "values": [
9851
+ {
9852
+ "type": "number"
9853
+ },
9854
+ {
9855
+ "type": "string"
9856
+ }
9857
+ ],
9858
+ "optional": false,
9859
+ "required": false
9860
+ },
9097
9861
  {
9098
9862
  "name": "maxLength",
9099
9863
  "type": "number",
@@ -9111,6 +9875,26 @@
9111
9875
  "optional": false,
9112
9876
  "required": false
9113
9877
  },
9878
+ {
9879
+ "name": "min",
9880
+ "type": "number | string",
9881
+ "mutable": false,
9882
+ "attr": "min",
9883
+ "reflectToAttr": false,
9884
+ "docs": "The minimum number that can be accepted as a value, when `type` is `number` and `rows` is `1`. (NOTE: Ensure to include visual indication of min value in `helperText` or `label`)",
9885
+ "docsTags": [],
9886
+ "default": "undefined",
9887
+ "values": [
9888
+ {
9889
+ "type": "number"
9890
+ },
9891
+ {
9892
+ "type": "string"
9893
+ }
9894
+ ],
9895
+ "optional": false,
9896
+ "required": false
9897
+ },
9114
9898
  {
9115
9899
  "name": "name",
9116
9900
  "type": "string",
@@ -9538,7 +10322,7 @@
9538
10322
  {
9539
10323
  "name": "autoDismissTimeout",
9540
10324
  "type": "number",
9541
- "mutable": false,
10325
+ "mutable": true,
9542
10326
  "attr": "auto-dismiss-timeout",
9543
10327
  "reflectToAttr": false,
9544
10328
  "docs": "If toast dismissMode is set to `automatic`, use this prop to define the time before the toast dismisses (in MILLISECONDS)\n(NOTE: Has a minimum value of `5000ms`)",
@@ -9572,7 +10356,7 @@
9572
10356
  {
9573
10357
  "name": "dismissMode",
9574
10358
  "type": "\"automatic\" | \"manual\"",
9575
- "mutable": false,
10359
+ "mutable": true,
9576
10360
  "attr": "dismiss-mode",
9577
10361
  "reflectToAttr": false,
9578
10362
  "docs": "How the toast will be dismissed. If manual will display a dismiss button.",
@@ -9642,7 +10426,7 @@
9642
10426
  {
9643
10427
  "name": "variant",
9644
10428
  "type": "\"error\" | \"info\" | \"neutral\" | \"success\" | \"warning\"",
9645
- "mutable": false,
10429
+ "mutable": true,
9646
10430
  "attr": "variant",
9647
10431
  "reflectToAttr": false,
9648
10432
  "docs": "The variant of the toast being rendered",
@@ -9930,7 +10714,28 @@
9930
10714
  "required": false
9931
10715
  }
9932
10716
  ],
9933
- "methods": [],
10717
+ "methods": [
10718
+ {
10719
+ "name": "displayTooltip",
10720
+ "returns": {
10721
+ "type": "Promise<void>",
10722
+ "docs": ""
10723
+ },
10724
+ "signature": "displayTooltip(show: boolean, persistTooltip?: boolean) => Promise<void>",
10725
+ "parameters": [],
10726
+ "docs": "Method to programmatically show/hide the tooltip without needing to interact with an anchor element",
10727
+ "docsTags": [
10728
+ {
10729
+ "name": "param",
10730
+ "text": "show Whether to show or hide the tooltip"
10731
+ },
10732
+ {
10733
+ "name": "param",
10734
+ "text": "persistTooltip Whether the tooltip should stay on the screen when actions are performed that would previously dismiss the tooltip, such as on hover"
10735
+ }
10736
+ ]
10737
+ }
10738
+ ],
9934
10739
  "events": [],
9935
10740
  "listeners": [],
9936
10741
  "styles": [
@@ -10226,7 +11031,7 @@
10226
11031
  },
10227
11032
  {
10228
11033
  "name": "variant",
10229
- "type": "\"body\" | \"caption\" | \"caption-uppercase\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"label\" | \"label-uppercase\" | \"subtitle-large\" | \"subtitle-small\"",
11034
+ "type": "\"body\" | \"caption\" | \"caption-uppercase\" | \"code-extra-small\" | \"code-large\" | \"code-small\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"label\" | \"label-uppercase\" | \"subtitle-large\" | \"subtitle-small\"",
10230
11035
  "mutable": false,
10231
11036
  "attr": "variant",
10232
11037
  "reflectToAttr": false,
@@ -10246,6 +11051,18 @@
10246
11051
  "value": "caption-uppercase",
10247
11052
  "type": "string"
10248
11053
  },
11054
+ {
11055
+ "value": "code-extra-small",
11056
+ "type": "string"
11057
+ },
11058
+ {
11059
+ "value": "code-large",
11060
+ "type": "string"
11061
+ },
11062
+ {
11063
+ "value": "code-small",
11064
+ "type": "string"
11065
+ },
10249
11066
  {
10250
11067
  "value": "h1",
10251
11068
  "type": "string"
@@ -10311,6 +11128,7 @@
10311
11128
  "ic-navigation-item",
10312
11129
  "ic-navigation-menu",
10313
11130
  "ic-page-header",
11131
+ "ic-pagination-item",
10314
11132
  "ic-popover-menu",
10315
11133
  "ic-radio-option",
10316
11134
  "ic-select",
@@ -10389,6 +11207,9 @@
10389
11207
  "ic-page-header": [
10390
11208
  "ic-typography"
10391
11209
  ],
11210
+ "ic-pagination-item": [
11211
+ "ic-typography"
11212
+ ],
10392
11213
  "ic-popover-menu": [
10393
11214
  "ic-typography"
10394
11215
  ],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ukic/docs",
3
- "version": "2.1.0-beta.11",
3
+ "version": "2.1.0-beta.13",
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": "c2853b352452de9cf09157c2b704ec7466b34d4c"
12
+ "gitHead": "7664d68763eab819ccf264f23a36a2390d45c22e"
13
13
  }