@ukic/canary-docs 2.0.0-canary.22 → 2.0.0-canary.24
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 +118 -8
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -436,6 +436,28 @@
|
|
|
436
436
|
"optional": false,
|
|
437
437
|
"required": true
|
|
438
438
|
},
|
|
439
|
+
{
|
|
440
|
+
"name": "columnHeaderTruncation",
|
|
441
|
+
"type": "boolean",
|
|
442
|
+
"complexType": {
|
|
443
|
+
"original": "boolean",
|
|
444
|
+
"resolved": "boolean",
|
|
445
|
+
"references": {}
|
|
446
|
+
},
|
|
447
|
+
"mutable": false,
|
|
448
|
+
"attr": "column-header-truncation",
|
|
449
|
+
"reflectToAttr": false,
|
|
450
|
+
"docs": "Determines whether the column header should be truncated and display a tooltip. Default is `false`.",
|
|
451
|
+
"docsTags": [],
|
|
452
|
+
"default": "false",
|
|
453
|
+
"values": [
|
|
454
|
+
{
|
|
455
|
+
"type": "boolean"
|
|
456
|
+
}
|
|
457
|
+
],
|
|
458
|
+
"optional": false,
|
|
459
|
+
"required": false
|
|
460
|
+
},
|
|
439
461
|
{
|
|
440
462
|
"name": "columns",
|
|
441
463
|
"type": "IcDataTableColumnObject[]",
|
|
@@ -752,7 +774,7 @@
|
|
|
752
774
|
"reflectToAttr": false,
|
|
753
775
|
"docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
|
|
754
776
|
"docsTags": [],
|
|
755
|
-
"default": "{\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n rangeLabelType: \"page\",\n type: \"simple\",\n showItemsPerPageControl: true,\n showGoToPageControl: true,\n alignment: \"right\",\n appearance: \"default\",\n itemLabel: \"Item\",\n pageLabel: \"Page\",\n hideRangeLabel: false,\n }",
|
|
777
|
+
"default": "{\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n rangeLabelType: \"page\",\n type: \"simple\",\n showItemsPerPageControl: true,\n showGoToPageControl: true,\n alignment: \"right\",\n appearance: \"default\",\n itemLabel: \"Item\",\n pageLabel: \"Page\",\n hideRangeLabel: false,\n hideAllFromItemsPerPage: false,\n }",
|
|
756
778
|
"values": [
|
|
757
779
|
{
|
|
758
780
|
"type": "IcPaginationBarOptions"
|
|
@@ -1160,8 +1182,8 @@
|
|
|
1160
1182
|
"ic-loading-indicator",
|
|
1161
1183
|
"ic-typography",
|
|
1162
1184
|
"ic-link",
|
|
1163
|
-
"ic-button",
|
|
1164
1185
|
"ic-tooltip",
|
|
1186
|
+
"ic-button",
|
|
1165
1187
|
"ic-empty-state",
|
|
1166
1188
|
"ic-pagination-bar"
|
|
1167
1189
|
],
|
|
@@ -1170,21 +1192,21 @@
|
|
|
1170
1192
|
"ic-loading-indicator",
|
|
1171
1193
|
"ic-typography",
|
|
1172
1194
|
"ic-link",
|
|
1173
|
-
"ic-button",
|
|
1174
1195
|
"ic-tooltip",
|
|
1196
|
+
"ic-button",
|
|
1175
1197
|
"ic-empty-state",
|
|
1176
1198
|
"ic-pagination-bar"
|
|
1177
1199
|
],
|
|
1178
1200
|
"ic-loading-indicator": [
|
|
1179
1201
|
"ic-typography"
|
|
1180
1202
|
],
|
|
1203
|
+
"ic-tooltip": [
|
|
1204
|
+
"ic-typography"
|
|
1205
|
+
],
|
|
1181
1206
|
"ic-button": [
|
|
1182
1207
|
"ic-loading-indicator",
|
|
1183
1208
|
"ic-tooltip"
|
|
1184
1209
|
],
|
|
1185
|
-
"ic-tooltip": [
|
|
1186
|
-
"ic-typography"
|
|
1187
|
-
],
|
|
1188
1210
|
"ic-empty-state": [
|
|
1189
1211
|
"ic-typography"
|
|
1190
1212
|
],
|
|
@@ -1679,6 +1701,28 @@
|
|
|
1679
1701
|
"optional": false,
|
|
1680
1702
|
"required": false
|
|
1681
1703
|
},
|
|
1704
|
+
{
|
|
1705
|
+
"name": "hideLabel",
|
|
1706
|
+
"type": "boolean",
|
|
1707
|
+
"complexType": {
|
|
1708
|
+
"original": "boolean",
|
|
1709
|
+
"resolved": "boolean",
|
|
1710
|
+
"references": {}
|
|
1711
|
+
},
|
|
1712
|
+
"mutable": false,
|
|
1713
|
+
"attr": "hide-label",
|
|
1714
|
+
"reflectToAttr": false,
|
|
1715
|
+
"docs": "If `true`, the label will be visually hidden, but will still be read out by screen readers.",
|
|
1716
|
+
"docsTags": [],
|
|
1717
|
+
"default": "false",
|
|
1718
|
+
"values": [
|
|
1719
|
+
{
|
|
1720
|
+
"type": "boolean"
|
|
1721
|
+
}
|
|
1722
|
+
],
|
|
1723
|
+
"optional": true,
|
|
1724
|
+
"required": false
|
|
1725
|
+
},
|
|
1682
1726
|
{
|
|
1683
1727
|
"name": "inputId",
|
|
1684
1728
|
"type": "string",
|
|
@@ -2383,6 +2427,28 @@
|
|
|
2383
2427
|
"optional": false,
|
|
2384
2428
|
"required": false
|
|
2385
2429
|
},
|
|
2430
|
+
{
|
|
2431
|
+
"name": "hideLabel",
|
|
2432
|
+
"type": "boolean",
|
|
2433
|
+
"complexType": {
|
|
2434
|
+
"original": "boolean",
|
|
2435
|
+
"resolved": "boolean",
|
|
2436
|
+
"references": {}
|
|
2437
|
+
},
|
|
2438
|
+
"mutable": false,
|
|
2439
|
+
"attr": "hide-label",
|
|
2440
|
+
"reflectToAttr": false,
|
|
2441
|
+
"docs": "If `true`, the label will be visually hidden, but the required label will still be read out by screen readers.",
|
|
2442
|
+
"docsTags": [],
|
|
2443
|
+
"default": "false",
|
|
2444
|
+
"values": [
|
|
2445
|
+
{
|
|
2446
|
+
"type": "boolean"
|
|
2447
|
+
}
|
|
2448
|
+
],
|
|
2449
|
+
"optional": true,
|
|
2450
|
+
"required": false
|
|
2451
|
+
},
|
|
2386
2452
|
{
|
|
2387
2453
|
"name": "inputId",
|
|
2388
2454
|
"type": "string",
|
|
@@ -3490,6 +3556,28 @@
|
|
|
3490
3556
|
"optional": true,
|
|
3491
3557
|
"required": false
|
|
3492
3558
|
},
|
|
3559
|
+
{
|
|
3560
|
+
"name": "hideAllFromItemsPerPage",
|
|
3561
|
+
"type": "boolean",
|
|
3562
|
+
"complexType": {
|
|
3563
|
+
"original": "boolean",
|
|
3564
|
+
"resolved": "boolean",
|
|
3565
|
+
"references": {}
|
|
3566
|
+
},
|
|
3567
|
+
"mutable": false,
|
|
3568
|
+
"attr": "hide-all-from-items-per-page",
|
|
3569
|
+
"reflectToAttr": false,
|
|
3570
|
+
"docs": "If `true`, the 'All' option will be hidden from the 'items per page' select input.",
|
|
3571
|
+
"docsTags": [],
|
|
3572
|
+
"default": "false",
|
|
3573
|
+
"values": [
|
|
3574
|
+
{
|
|
3575
|
+
"type": "boolean"
|
|
3576
|
+
}
|
|
3577
|
+
],
|
|
3578
|
+
"optional": true,
|
|
3579
|
+
"required": false
|
|
3580
|
+
},
|
|
3493
3581
|
{
|
|
3494
3582
|
"name": "hideRangeLabel",
|
|
3495
3583
|
"type": "boolean",
|
|
@@ -3544,7 +3632,7 @@
|
|
|
3544
3632
|
},
|
|
3545
3633
|
"mutable": false,
|
|
3546
3634
|
"reflectToAttr": false,
|
|
3547
|
-
"docs": "The options which will be displayed for 'items per page' select input.
|
|
3635
|
+
"docs": "The options which will be displayed for 'items per page' select input.",
|
|
3548
3636
|
"docsTags": [],
|
|
3549
3637
|
"values": [
|
|
3550
3638
|
{
|
|
@@ -4944,6 +5032,28 @@
|
|
|
4944
5032
|
"optional": true,
|
|
4945
5033
|
"required": false
|
|
4946
5034
|
},
|
|
5035
|
+
{
|
|
5036
|
+
"name": "expanded",
|
|
5037
|
+
"type": "boolean",
|
|
5038
|
+
"complexType": {
|
|
5039
|
+
"original": "boolean",
|
|
5040
|
+
"resolved": "boolean",
|
|
5041
|
+
"references": {}
|
|
5042
|
+
},
|
|
5043
|
+
"mutable": true,
|
|
5044
|
+
"attr": "expanded",
|
|
5045
|
+
"reflectToAttr": false,
|
|
5046
|
+
"docs": "If `true`, the tree item appears in the expanded state.",
|
|
5047
|
+
"docsTags": [],
|
|
5048
|
+
"default": "false",
|
|
5049
|
+
"values": [
|
|
5050
|
+
{
|
|
5051
|
+
"type": "boolean"
|
|
5052
|
+
}
|
|
5053
|
+
],
|
|
5054
|
+
"optional": false,
|
|
5055
|
+
"required": false
|
|
5056
|
+
},
|
|
4947
5057
|
{
|
|
4948
5058
|
"name": "href",
|
|
4949
5059
|
"type": "string",
|
|
@@ -5396,7 +5506,7 @@
|
|
|
5396
5506
|
"path": "../web-components/dist/types/utils/types.d.ts"
|
|
5397
5507
|
},
|
|
5398
5508
|
"src/utils/types.ts::IcPaginationBarOptions": {
|
|
5399
|
-
"declaration": "export interface IcPaginationBarOptions {\n itemsPerPageOptions?: { label: string; value: string }[];\n rangeLabelType?: IcPaginationLabelTypes;\n type?: IcPaginationTypes;\n showItemsPerPageControl?: boolean;\n showGoToPageControl?: boolean;\n alignment?: IcPaginationAlignmentOptions;\n appearance?: IcThemeForeground;\n itemLabel?: string;\n pageLabel?: string;\n hideRangeLabel?: boolean;\n}",
|
|
5509
|
+
"declaration": "export interface IcPaginationBarOptions {\n itemsPerPageOptions?: { label: string; value: string }[];\n rangeLabelType?: IcPaginationLabelTypes;\n type?: IcPaginationTypes;\n showItemsPerPageControl?: boolean;\n showGoToPageControl?: boolean;\n alignment?: IcPaginationAlignmentOptions;\n appearance?: IcThemeForeground;\n itemLabel?: string;\n pageLabel?: string;\n hideRangeLabel?: boolean;\n hideAllFromItemsPerPage?: boolean;\n}",
|
|
5400
5510
|
"docstring": "",
|
|
5401
5511
|
"path": "src/utils/types.ts"
|
|
5402
5512
|
},
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/canary-docs",
|
|
4
|
-
"version": "2.0.0-canary.
|
|
4
|
+
"version": "2.0.0-canary.24",
|
|
5
5
|
"description": "API documentation for @ukic canary components",
|
|
6
6
|
"main": "docs.json",
|
|
7
7
|
"types": "./docs.d.ts",
|
|
@@ -18,5 +18,5 @@
|
|
|
18
18
|
"email": "icds@gchq.gov.uk"
|
|
19
19
|
},
|
|
20
20
|
"license": "MIT",
|
|
21
|
-
"gitHead": "
|
|
21
|
+
"gitHead": "8f1cf8223eb9c9d871cca4af42fc7c39db4f1b6a"
|
|
22
22
|
}
|