@ukic/docs 2.1.0-beta.12 → 2.1.0-beta.14
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 +724 -84
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"timestamp": "2023-05-
|
|
2
|
+
"timestamp": "2023-05-17T09:42:39",
|
|
3
3
|
"compiler": {
|
|
4
4
|
"name": "@stencil/core",
|
|
5
5
|
"version": "2.20.0",
|
|
@@ -913,7 +913,13 @@
|
|
|
913
913
|
"passive": false
|
|
914
914
|
}
|
|
915
915
|
],
|
|
916
|
-
"styles": [
|
|
916
|
+
"styles": [
|
|
917
|
+
{
|
|
918
|
+
"name": "--min-width",
|
|
919
|
+
"annotation": "prop",
|
|
920
|
+
"docs": "Minimum width of the button."
|
|
921
|
+
}
|
|
922
|
+
],
|
|
917
923
|
"slots": [
|
|
918
924
|
{
|
|
919
925
|
"name": "icon",
|
|
@@ -925,9 +931,11 @@
|
|
|
925
931
|
"ic-alert",
|
|
926
932
|
"ic-card",
|
|
927
933
|
"ic-horizontal-scroll",
|
|
934
|
+
"ic-menu",
|
|
928
935
|
"ic-menu-item",
|
|
929
936
|
"ic-navigation-button",
|
|
930
937
|
"ic-navigation-menu",
|
|
938
|
+
"ic-pagination",
|
|
931
939
|
"ic-search-bar",
|
|
932
940
|
"ic-select",
|
|
933
941
|
"ic-side-navigation",
|
|
@@ -958,6 +966,9 @@
|
|
|
958
966
|
"ic-horizontal-scroll": [
|
|
959
967
|
"ic-button"
|
|
960
968
|
],
|
|
969
|
+
"ic-menu": [
|
|
970
|
+
"ic-button"
|
|
971
|
+
],
|
|
961
972
|
"ic-menu-item": [
|
|
962
973
|
"ic-button"
|
|
963
974
|
],
|
|
@@ -967,6 +978,9 @@
|
|
|
967
978
|
"ic-navigation-menu": [
|
|
968
979
|
"ic-button"
|
|
969
980
|
],
|
|
981
|
+
"ic-pagination": [
|
|
982
|
+
"ic-button"
|
|
983
|
+
],
|
|
970
984
|
"ic-search-bar": [
|
|
971
985
|
"ic-button"
|
|
972
986
|
],
|
|
@@ -4086,6 +4100,7 @@
|
|
|
4086
4100
|
"parts": [],
|
|
4087
4101
|
"dependents": [
|
|
4088
4102
|
"ic-button",
|
|
4103
|
+
"ic-menu",
|
|
4089
4104
|
"ic-step",
|
|
4090
4105
|
"ic-toast"
|
|
4091
4106
|
],
|
|
@@ -4099,6 +4114,9 @@
|
|
|
4099
4114
|
"ic-button": [
|
|
4100
4115
|
"ic-loading-indicator"
|
|
4101
4116
|
],
|
|
4117
|
+
"ic-menu": [
|
|
4118
|
+
"ic-loading-indicator"
|
|
4119
|
+
],
|
|
4102
4120
|
"ic-step": [
|
|
4103
4121
|
"ic-loading-indicator"
|
|
4104
4122
|
],
|
|
@@ -4316,10 +4334,24 @@
|
|
|
4316
4334
|
"ic-select"
|
|
4317
4335
|
],
|
|
4318
4336
|
"dependencies": [
|
|
4319
|
-
"ic-
|
|
4337
|
+
"ic-loading-indicator",
|
|
4338
|
+
"ic-typography",
|
|
4339
|
+
"ic-button"
|
|
4320
4340
|
],
|
|
4321
4341
|
"dependencyGraph": {
|
|
4322
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": [
|
|
4323
4355
|
"ic-typography"
|
|
4324
4356
|
],
|
|
4325
4357
|
"ic-search-bar": [
|
|
@@ -5450,29 +5482,492 @@
|
|
|
5450
5482
|
"required": false
|
|
5451
5483
|
},
|
|
5452
5484
|
{
|
|
5453
|
-
"name": "sticky",
|
|
5454
|
-
"type": "boolean",
|
|
5485
|
+
"name": "sticky",
|
|
5486
|
+
"type": "boolean",
|
|
5487
|
+
"mutable": false,
|
|
5488
|
+
"attr": "sticky",
|
|
5489
|
+
"reflectToAttr": false,
|
|
5490
|
+
"docs": "If `true`, the page header will be sticky at all breakpoints.",
|
|
5491
|
+
"docsTags": [],
|
|
5492
|
+
"default": "false",
|
|
5493
|
+
"values": [
|
|
5494
|
+
{
|
|
5495
|
+
"type": "boolean"
|
|
5496
|
+
}
|
|
5497
|
+
],
|
|
5498
|
+
"optional": true,
|
|
5499
|
+
"required": false
|
|
5500
|
+
},
|
|
5501
|
+
{
|
|
5502
|
+
"name": "stickyDesktopOnly",
|
|
5503
|
+
"type": "boolean",
|
|
5504
|
+
"mutable": false,
|
|
5505
|
+
"attr": "sticky-desktop-only",
|
|
5506
|
+
"reflectToAttr": false,
|
|
5507
|
+
"docs": "If `true`, the page header will only be sticky for viewport widths of 992px and above.",
|
|
5508
|
+
"docsTags": [],
|
|
5509
|
+
"default": "false",
|
|
5510
|
+
"values": [
|
|
5511
|
+
{
|
|
5512
|
+
"type": "boolean"
|
|
5513
|
+
}
|
|
5514
|
+
],
|
|
5515
|
+
"optional": true,
|
|
5516
|
+
"required": false
|
|
5517
|
+
},
|
|
5518
|
+
{
|
|
5519
|
+
"name": "subheading",
|
|
5520
|
+
"type": "string",
|
|
5521
|
+
"mutable": false,
|
|
5522
|
+
"attr": "subheading",
|
|
5523
|
+
"reflectToAttr": false,
|
|
5524
|
+
"docs": "The subtitle to render on the page header.",
|
|
5525
|
+
"docsTags": [],
|
|
5526
|
+
"values": [
|
|
5527
|
+
{
|
|
5528
|
+
"type": "string"
|
|
5529
|
+
}
|
|
5530
|
+
],
|
|
5531
|
+
"optional": true,
|
|
5532
|
+
"required": false
|
|
5533
|
+
}
|
|
5534
|
+
],
|
|
5535
|
+
"methods": [],
|
|
5536
|
+
"events": [],
|
|
5537
|
+
"listeners": [],
|
|
5538
|
+
"styles": [
|
|
5539
|
+
{
|
|
5540
|
+
"name": "--ic-z-index-page-header",
|
|
5541
|
+
"annotation": "prop",
|
|
5542
|
+
"docs": "z-index of page-header"
|
|
5543
|
+
}
|
|
5544
|
+
],
|
|
5545
|
+
"slots": [
|
|
5546
|
+
{
|
|
5547
|
+
"name": "actions",
|
|
5548
|
+
"docs": "Content will be rendered in the action area, adjacent to the title area."
|
|
5549
|
+
},
|
|
5550
|
+
{
|
|
5551
|
+
"name": "breadcrumbs",
|
|
5552
|
+
"docs": "Content will be rendered in the breadcrumb area, above the title and action areas."
|
|
5553
|
+
},
|
|
5554
|
+
{
|
|
5555
|
+
"name": "heading",
|
|
5556
|
+
"docs": "Content will be rendered in the title area, in place of the heading."
|
|
5557
|
+
},
|
|
5558
|
+
{
|
|
5559
|
+
"name": "heading-adornment",
|
|
5560
|
+
"docs": "Content will be rendered in the title area, adjacent to the heading."
|
|
5561
|
+
},
|
|
5562
|
+
{
|
|
5563
|
+
"name": "input",
|
|
5564
|
+
"docs": "Content will be rendered in the input area, below the title area and adjacent to the action area."
|
|
5565
|
+
},
|
|
5566
|
+
{
|
|
5567
|
+
"name": "stepper",
|
|
5568
|
+
"docs": "Content will be rendered in the navigation area, below the title and action areas. Note: stepper slot cannot be used when the tabs slot is being used."
|
|
5569
|
+
},
|
|
5570
|
+
{
|
|
5571
|
+
"name": "subheading",
|
|
5572
|
+
"docs": "Content will be rendered in the title area, in place of the subheading."
|
|
5573
|
+
},
|
|
5574
|
+
{
|
|
5575
|
+
"name": "tabs",
|
|
5576
|
+
"docs": "Content will be rendered in the navigation area, below the title and action areas. Note: the stepper slot cannot be used when the tabs slot is being used."
|
|
5577
|
+
}
|
|
5578
|
+
],
|
|
5579
|
+
"parts": [],
|
|
5580
|
+
"dependents": [],
|
|
5581
|
+
"dependencies": [
|
|
5582
|
+
"ic-section-container",
|
|
5583
|
+
"ic-typography",
|
|
5584
|
+
"ic-horizontal-scroll"
|
|
5585
|
+
],
|
|
5586
|
+
"dependencyGraph": {
|
|
5587
|
+
"ic-page-header": [
|
|
5588
|
+
"ic-section-container",
|
|
5589
|
+
"ic-typography",
|
|
5590
|
+
"ic-horizontal-scroll"
|
|
5591
|
+
],
|
|
5592
|
+
"ic-horizontal-scroll": [
|
|
5593
|
+
"ic-button"
|
|
5594
|
+
],
|
|
5595
|
+
"ic-button": [
|
|
5596
|
+
"ic-loading-indicator",
|
|
5597
|
+
"ic-tooltip"
|
|
5598
|
+
],
|
|
5599
|
+
"ic-loading-indicator": [
|
|
5600
|
+
"ic-typography"
|
|
5601
|
+
],
|
|
5602
|
+
"ic-tooltip": [
|
|
5603
|
+
"ic-typography"
|
|
5604
|
+
]
|
|
5605
|
+
}
|
|
5606
|
+
},
|
|
5607
|
+
{
|
|
5608
|
+
"filePath": "./src/components/ic-pagination/ic-pagination.tsx",
|
|
5609
|
+
"encapsulation": "shadow",
|
|
5610
|
+
"tag": "ic-pagination",
|
|
5611
|
+
"readme": "# ic-pagination\n\n\n",
|
|
5612
|
+
"docs": "",
|
|
5613
|
+
"docsTags": [],
|
|
5614
|
+
"usage": {},
|
|
5615
|
+
"props": [
|
|
5616
|
+
{
|
|
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\"",
|
|
5636
|
+
"mutable": false,
|
|
5637
|
+
"attr": "appearance",
|
|
5638
|
+
"reflectToAttr": false,
|
|
5639
|
+
"docs": "The appearance of the pagination, e.g. dark, light or the default.",
|
|
5640
|
+
"docsTags": [],
|
|
5641
|
+
"default": "\"default\"",
|
|
5642
|
+
"values": [
|
|
5643
|
+
{
|
|
5644
|
+
"value": "dark",
|
|
5645
|
+
"type": "string"
|
|
5646
|
+
},
|
|
5647
|
+
{
|
|
5648
|
+
"value": "default",
|
|
5649
|
+
"type": "string"
|
|
5650
|
+
},
|
|
5651
|
+
{
|
|
5652
|
+
"value": "light",
|
|
5653
|
+
"type": "string"
|
|
5654
|
+
}
|
|
5655
|
+
],
|
|
5656
|
+
"optional": false,
|
|
5657
|
+
"required": false
|
|
5658
|
+
},
|
|
5659
|
+
{
|
|
5660
|
+
"name": "boundaryCount",
|
|
5661
|
+
"type": "number",
|
|
5662
|
+
"mutable": true,
|
|
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.",
|
|
5666
|
+
"docsTags": [],
|
|
5667
|
+
"default": "1",
|
|
5668
|
+
"values": [
|
|
5669
|
+
{
|
|
5670
|
+
"type": "number"
|
|
5671
|
+
}
|
|
5672
|
+
],
|
|
5673
|
+
"optional": false,
|
|
5674
|
+
"required": false
|
|
5675
|
+
},
|
|
5676
|
+
{
|
|
5677
|
+
"name": "defaultPage",
|
|
5678
|
+
"type": "number",
|
|
5679
|
+
"mutable": false,
|
|
5680
|
+
"attr": "default-page",
|
|
5681
|
+
"reflectToAttr": false,
|
|
5682
|
+
"docs": "The default page to display.",
|
|
5683
|
+
"docsTags": [],
|
|
5684
|
+
"default": "1",
|
|
5685
|
+
"values": [
|
|
5686
|
+
{
|
|
5687
|
+
"type": "number"
|
|
5688
|
+
}
|
|
5689
|
+
],
|
|
5690
|
+
"optional": false,
|
|
5691
|
+
"required": false
|
|
5692
|
+
},
|
|
5693
|
+
{
|
|
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
|
|
5709
|
+
},
|
|
5710
|
+
{
|
|
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
|
|
5726
|
+
},
|
|
5727
|
+
{
|
|
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
|
|
5743
|
+
},
|
|
5744
|
+
{
|
|
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",
|
|
5455
5951
|
"mutable": false,
|
|
5456
|
-
"attr": "
|
|
5952
|
+
"attr": "pages",
|
|
5457
5953
|
"reflectToAttr": false,
|
|
5458
|
-
"docs": "
|
|
5954
|
+
"docs": "The total number of pages.",
|
|
5459
5955
|
"docsTags": [],
|
|
5460
|
-
"default": "false",
|
|
5461
5956
|
"values": [
|
|
5462
5957
|
{
|
|
5463
|
-
"type": "
|
|
5958
|
+
"type": "number"
|
|
5464
5959
|
}
|
|
5465
5960
|
],
|
|
5466
|
-
"optional":
|
|
5961
|
+
"optional": false,
|
|
5467
5962
|
"required": false
|
|
5468
5963
|
},
|
|
5469
5964
|
{
|
|
5470
|
-
"name": "
|
|
5965
|
+
"name": "selected",
|
|
5471
5966
|
"type": "boolean",
|
|
5472
5967
|
"mutable": false,
|
|
5473
|
-
"attr": "
|
|
5968
|
+
"attr": "selected",
|
|
5474
5969
|
"reflectToAttr": false,
|
|
5475
|
-
"docs": "If `true`, the
|
|
5970
|
+
"docs": "If `true`, the pagination item will be selected.",
|
|
5476
5971
|
"docsTags": [],
|
|
5477
5972
|
"default": "false",
|
|
5478
5973
|
"values": [
|
|
@@ -5480,95 +5975,53 @@
|
|
|
5480
5975
|
"type": "boolean"
|
|
5481
5976
|
}
|
|
5482
5977
|
],
|
|
5483
|
-
"optional":
|
|
5978
|
+
"optional": false,
|
|
5484
5979
|
"required": false
|
|
5485
5980
|
},
|
|
5486
5981
|
{
|
|
5487
|
-
"name": "
|
|
5488
|
-
"type": "
|
|
5982
|
+
"name": "type",
|
|
5983
|
+
"type": "\"ellipsis\" | \"page\" | \"simple-current\"",
|
|
5489
5984
|
"mutable": false,
|
|
5490
|
-
"attr": "
|
|
5985
|
+
"attr": "type",
|
|
5491
5986
|
"reflectToAttr": false,
|
|
5492
|
-
"docs": "The
|
|
5987
|
+
"docs": "The type of pagination item - 'page' or 'ellipsis'.",
|
|
5493
5988
|
"docsTags": [],
|
|
5494
5989
|
"values": [
|
|
5495
5990
|
{
|
|
5991
|
+
"value": "ellipsis",
|
|
5992
|
+
"type": "string"
|
|
5993
|
+
},
|
|
5994
|
+
{
|
|
5995
|
+
"value": "page",
|
|
5996
|
+
"type": "string"
|
|
5997
|
+
},
|
|
5998
|
+
{
|
|
5999
|
+
"value": "simple-current",
|
|
5496
6000
|
"type": "string"
|
|
5497
6001
|
}
|
|
5498
6002
|
],
|
|
5499
|
-
"optional":
|
|
6003
|
+
"optional": false,
|
|
5500
6004
|
"required": false
|
|
5501
6005
|
}
|
|
5502
6006
|
],
|
|
5503
6007
|
"methods": [],
|
|
5504
6008
|
"events": [],
|
|
5505
6009
|
"listeners": [],
|
|
5506
|
-
"styles": [
|
|
5507
|
-
|
|
5508
|
-
"name": "--ic-z-index-page-header",
|
|
5509
|
-
"annotation": "prop",
|
|
5510
|
-
"docs": "z-index of page-header"
|
|
5511
|
-
}
|
|
5512
|
-
],
|
|
5513
|
-
"slots": [
|
|
5514
|
-
{
|
|
5515
|
-
"name": "actions",
|
|
5516
|
-
"docs": "Content will be rendered in the action area, adjacent to the title area."
|
|
5517
|
-
},
|
|
5518
|
-
{
|
|
5519
|
-
"name": "breadcrumbs",
|
|
5520
|
-
"docs": "Content will be rendered in the breadcrumb area, above the title and action areas."
|
|
5521
|
-
},
|
|
5522
|
-
{
|
|
5523
|
-
"name": "heading",
|
|
5524
|
-
"docs": "Content will be rendered in the title area, in place of the heading."
|
|
5525
|
-
},
|
|
5526
|
-
{
|
|
5527
|
-
"name": "heading-adornment",
|
|
5528
|
-
"docs": "Content will be rendered in the title area, adjacent to the heading."
|
|
5529
|
-
},
|
|
5530
|
-
{
|
|
5531
|
-
"name": "input",
|
|
5532
|
-
"docs": "Content will be rendered in the input area, below the title area and adjacent to the action area."
|
|
5533
|
-
},
|
|
5534
|
-
{
|
|
5535
|
-
"name": "stepper",
|
|
5536
|
-
"docs": "Content will be rendered in the navigation area, below the title and action areas. Note: stepper slot cannot be used when the tabs slot is being used."
|
|
5537
|
-
},
|
|
5538
|
-
{
|
|
5539
|
-
"name": "subheading",
|
|
5540
|
-
"docs": "Content will be rendered in the title area, in place of the subheading."
|
|
5541
|
-
},
|
|
5542
|
-
{
|
|
5543
|
-
"name": "tabs",
|
|
5544
|
-
"docs": "Content will be rendered in the navigation area, below the title and action areas. Note: the stepper slot cannot be used when the tabs slot is being used."
|
|
5545
|
-
}
|
|
5546
|
-
],
|
|
6010
|
+
"styles": [],
|
|
6011
|
+
"slots": [],
|
|
5547
6012
|
"parts": [],
|
|
5548
|
-
"dependents": [
|
|
6013
|
+
"dependents": [
|
|
6014
|
+
"ic-pagination"
|
|
6015
|
+
],
|
|
5549
6016
|
"dependencies": [
|
|
5550
|
-
"ic-
|
|
5551
|
-
"ic-typography",
|
|
5552
|
-
"ic-horizontal-scroll"
|
|
6017
|
+
"ic-typography"
|
|
5553
6018
|
],
|
|
5554
6019
|
"dependencyGraph": {
|
|
5555
|
-
"ic-
|
|
5556
|
-
"ic-section-container",
|
|
5557
|
-
"ic-typography",
|
|
5558
|
-
"ic-horizontal-scroll"
|
|
5559
|
-
],
|
|
5560
|
-
"ic-horizontal-scroll": [
|
|
5561
|
-
"ic-button"
|
|
5562
|
-
],
|
|
5563
|
-
"ic-button": [
|
|
5564
|
-
"ic-loading-indicator",
|
|
5565
|
-
"ic-tooltip"
|
|
5566
|
-
],
|
|
5567
|
-
"ic-loading-indicator": [
|
|
6020
|
+
"ic-pagination-item": [
|
|
5568
6021
|
"ic-typography"
|
|
5569
6022
|
],
|
|
5570
|
-
"ic-
|
|
5571
|
-
"ic-
|
|
6023
|
+
"ic-pagination": [
|
|
6024
|
+
"ic-pagination-item"
|
|
5572
6025
|
]
|
|
5573
6026
|
}
|
|
5574
6027
|
},
|
|
@@ -6623,6 +7076,57 @@
|
|
|
6623
7076
|
"optional": false,
|
|
6624
7077
|
"required": true
|
|
6625
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
|
+
},
|
|
6626
7130
|
{
|
|
6627
7131
|
"name": "name",
|
|
6628
7132
|
"type": "string",
|
|
@@ -6741,6 +7245,22 @@
|
|
|
6741
7245
|
"optional": false,
|
|
6742
7246
|
"required": false
|
|
6743
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
|
+
},
|
|
6744
7264
|
{
|
|
6745
7265
|
"name": "value",
|
|
6746
7266
|
"type": "string",
|
|
@@ -6848,6 +7368,15 @@
|
|
|
6848
7368
|
"docs": "Emitted when option is highlighted within the menu",
|
|
6849
7369
|
"docsTags": []
|
|
6850
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
|
+
},
|
|
6851
7380
|
{
|
|
6852
7381
|
"event": "icSearchBarBlur",
|
|
6853
7382
|
"detail": "IcSearchBarBlurEventDetail",
|
|
@@ -6933,7 +7462,9 @@
|
|
|
6933
7462
|
"ic-typography"
|
|
6934
7463
|
],
|
|
6935
7464
|
"ic-menu": [
|
|
6936
|
-
"ic-
|
|
7465
|
+
"ic-loading-indicator",
|
|
7466
|
+
"ic-typography",
|
|
7467
|
+
"ic-button"
|
|
6937
7468
|
]
|
|
6938
7469
|
}
|
|
6939
7470
|
},
|
|
@@ -7223,6 +7754,57 @@
|
|
|
7223
7754
|
"optional": false,
|
|
7224
7755
|
"required": true
|
|
7225
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
|
+
},
|
|
7226
7808
|
{
|
|
7227
7809
|
"name": "name",
|
|
7228
7810
|
"type": "string",
|
|
@@ -7380,6 +7962,22 @@
|
|
|
7380
7962
|
"optional": true,
|
|
7381
7963
|
"required": false
|
|
7382
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
|
+
},
|
|
7383
7981
|
{
|
|
7384
7982
|
"name": "validationStatus",
|
|
7385
7983
|
"type": "\"\" | \"error\" | \"success\" | \"warning\"",
|
|
@@ -7510,6 +8108,15 @@
|
|
|
7510
8108
|
"composed": true,
|
|
7511
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.",
|
|
7512
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": []
|
|
7513
8120
|
}
|
|
7514
8121
|
],
|
|
7515
8122
|
"listeners": [],
|
|
@@ -7561,7 +8168,9 @@
|
|
|
7561
8168
|
"ic-typography"
|
|
7562
8169
|
],
|
|
7563
8170
|
"ic-menu": [
|
|
7564
|
-
"ic-
|
|
8171
|
+
"ic-loading-indicator",
|
|
8172
|
+
"ic-typography",
|
|
8173
|
+
"ic-button"
|
|
7565
8174
|
],
|
|
7566
8175
|
"ic-input-validation": [
|
|
7567
8176
|
"ic-typography"
|
|
@@ -9231,7 +9840,7 @@
|
|
|
9231
9840
|
},
|
|
9232
9841
|
{
|
|
9233
9842
|
"name": "max",
|
|
9234
|
-
"type": "number",
|
|
9843
|
+
"type": "number | string",
|
|
9235
9844
|
"mutable": false,
|
|
9236
9845
|
"attr": "max",
|
|
9237
9846
|
"reflectToAttr": false,
|
|
@@ -9241,6 +9850,9 @@
|
|
|
9241
9850
|
"values": [
|
|
9242
9851
|
{
|
|
9243
9852
|
"type": "number"
|
|
9853
|
+
},
|
|
9854
|
+
{
|
|
9855
|
+
"type": "string"
|
|
9244
9856
|
}
|
|
9245
9857
|
],
|
|
9246
9858
|
"optional": false,
|
|
@@ -9265,7 +9877,7 @@
|
|
|
9265
9877
|
},
|
|
9266
9878
|
{
|
|
9267
9879
|
"name": "min",
|
|
9268
|
-
"type": "number",
|
|
9880
|
+
"type": "number | string",
|
|
9269
9881
|
"mutable": false,
|
|
9270
9882
|
"attr": "min",
|
|
9271
9883
|
"reflectToAttr": false,
|
|
@@ -9275,6 +9887,9 @@
|
|
|
9275
9887
|
"values": [
|
|
9276
9888
|
{
|
|
9277
9889
|
"type": "number"
|
|
9890
|
+
},
|
|
9891
|
+
{
|
|
9892
|
+
"type": "string"
|
|
9278
9893
|
}
|
|
9279
9894
|
],
|
|
9280
9895
|
"optional": false,
|
|
@@ -10099,7 +10714,28 @@
|
|
|
10099
10714
|
"required": false
|
|
10100
10715
|
}
|
|
10101
10716
|
],
|
|
10102
|
-
"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
|
+
],
|
|
10103
10739
|
"events": [],
|
|
10104
10740
|
"listeners": [],
|
|
10105
10741
|
"styles": [
|
|
@@ -10492,6 +11128,7 @@
|
|
|
10492
11128
|
"ic-navigation-item",
|
|
10493
11129
|
"ic-navigation-menu",
|
|
10494
11130
|
"ic-page-header",
|
|
11131
|
+
"ic-pagination-item",
|
|
10495
11132
|
"ic-popover-menu",
|
|
10496
11133
|
"ic-radio-option",
|
|
10497
11134
|
"ic-select",
|
|
@@ -10570,6 +11207,9 @@
|
|
|
10570
11207
|
"ic-page-header": [
|
|
10571
11208
|
"ic-typography"
|
|
10572
11209
|
],
|
|
11210
|
+
"ic-pagination-item": [
|
|
11211
|
+
"ic-typography"
|
|
11212
|
+
],
|
|
10573
11213
|
"ic-popover-menu": [
|
|
10574
11214
|
"ic-typography"
|
|
10575
11215
|
],
|
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.14",
|
|
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": "8f9840e88d891fddd076a0ccee7e26ed02b4ac4b"
|
|
13
13
|
}
|