@ukic/canary-docs 3.0.0-canary.5 → 3.0.0-canary.7
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 +130 -7
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -376,7 +376,7 @@
|
|
|
376
376
|
"passive": false
|
|
377
377
|
},
|
|
378
378
|
{
|
|
379
|
-
"event": "
|
|
379
|
+
"event": "brandChange",
|
|
380
380
|
"target": "document",
|
|
381
381
|
"capture": false,
|
|
382
382
|
"passive": false
|
|
@@ -681,6 +681,28 @@
|
|
|
681
681
|
"optional": true,
|
|
682
682
|
"required": false
|
|
683
683
|
},
|
|
684
|
+
{
|
|
685
|
+
"name": "highlightSelectedRow",
|
|
686
|
+
"type": "boolean",
|
|
687
|
+
"complexType": {
|
|
688
|
+
"original": "boolean",
|
|
689
|
+
"resolved": "boolean",
|
|
690
|
+
"references": {}
|
|
691
|
+
},
|
|
692
|
+
"mutable": false,
|
|
693
|
+
"attr": "highlight-selected-row",
|
|
694
|
+
"reflectToAttr": false,
|
|
695
|
+
"docs": "If `true`, the selected row is highlighted using a background colour.",
|
|
696
|
+
"docsTags": [],
|
|
697
|
+
"default": "true",
|
|
698
|
+
"values": [
|
|
699
|
+
{
|
|
700
|
+
"type": "boolean"
|
|
701
|
+
}
|
|
702
|
+
],
|
|
703
|
+
"optional": true,
|
|
704
|
+
"required": false
|
|
705
|
+
},
|
|
684
706
|
{
|
|
685
707
|
"name": "loading",
|
|
686
708
|
"type": "boolean",
|
|
@@ -705,10 +727,10 @@
|
|
|
705
727
|
},
|
|
706
728
|
{
|
|
707
729
|
"name": "loadingOptions",
|
|
708
|
-
"type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }",
|
|
730
|
+
"type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; overlay?: boolean; }",
|
|
709
731
|
"complexType": {
|
|
710
|
-
"original": "{\n description?: string;\n label?: string;\n labelDuration?: number;\n max?: number;\n min?: number;\n progress?: number;\n showBackground?: boolean;\n monochrome?: boolean;\n }",
|
|
711
|
-
"resolved": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }",
|
|
732
|
+
"original": "{\n description?: string;\n label?: string;\n labelDuration?: number;\n max?: number;\n min?: number;\n progress?: number;\n showBackground?: boolean;\n monochrome?: boolean;\n overlay?: boolean;\n }",
|
|
733
|
+
"resolved": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; overlay?: boolean; }",
|
|
712
734
|
"references": {}
|
|
713
735
|
},
|
|
714
736
|
"mutable": false,
|
|
@@ -717,7 +739,7 @@
|
|
|
717
739
|
"docsTags": [],
|
|
718
740
|
"values": [
|
|
719
741
|
{
|
|
720
|
-
"type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }"
|
|
742
|
+
"type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; overlay?: boolean; }"
|
|
721
743
|
}
|
|
722
744
|
],
|
|
723
745
|
"optional": true,
|
|
@@ -805,7 +827,7 @@
|
|
|
805
827
|
"reflectToAttr": false,
|
|
806
828
|
"docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
|
|
807
829
|
"docsTags": [],
|
|
808
|
-
"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 itemLabel: \"Item\",\n pageLabel: \"Page\",\n hideRangeLabel: false,\n hideAllFromItemsPerPage: false,\n monochrome: false,\n }",
|
|
830
|
+
"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 itemLabel: \"Item\",\n pageLabel: \"Page\",\n hideRangeLabel: false,\n hideAllFromItemsPerPage: false,\n monochrome: false,\n setToFirstPageOnPaginationChange: false,\n }",
|
|
809
831
|
"values": [
|
|
810
832
|
{
|
|
811
833
|
"type": "IcPaginationBarOptions"
|
|
@@ -1166,6 +1188,20 @@
|
|
|
1166
1188
|
"docs": "Emitted when the `globalRowHeight` or `variableRowHeight` properties change in the data table.",
|
|
1167
1189
|
"docsTags": []
|
|
1168
1190
|
},
|
|
1191
|
+
{
|
|
1192
|
+
"event": "icSelectedRowChange",
|
|
1193
|
+
"detail": "object",
|
|
1194
|
+
"bubbles": true,
|
|
1195
|
+
"complexType": {
|
|
1196
|
+
"original": "object",
|
|
1197
|
+
"resolved": "object",
|
|
1198
|
+
"references": {}
|
|
1199
|
+
},
|
|
1200
|
+
"cancelable": true,
|
|
1201
|
+
"composed": true,
|
|
1202
|
+
"docs": "Emitted when the selected row changes in the data table.",
|
|
1203
|
+
"docsTags": []
|
|
1204
|
+
},
|
|
1169
1205
|
{
|
|
1170
1206
|
"event": "icSortChange",
|
|
1171
1207
|
"detail": "IcSortEventDetail",
|
|
@@ -3341,6 +3377,28 @@
|
|
|
3341
3377
|
"optional": true,
|
|
3342
3378
|
"required": false
|
|
3343
3379
|
},
|
|
3380
|
+
{
|
|
3381
|
+
"name": "setToFirstPageOnPaginationChange",
|
|
3382
|
+
"type": "boolean",
|
|
3383
|
+
"complexType": {
|
|
3384
|
+
"original": "boolean",
|
|
3385
|
+
"resolved": "boolean",
|
|
3386
|
+
"references": {}
|
|
3387
|
+
},
|
|
3388
|
+
"mutable": false,
|
|
3389
|
+
"attr": "set-to-first-page-on-pagination-change",
|
|
3390
|
+
"reflectToAttr": false,
|
|
3391
|
+
"docs": "If `true`, the pagination bar is set to the first page when the 'items per page' changes",
|
|
3392
|
+
"docsTags": [],
|
|
3393
|
+
"default": "false",
|
|
3394
|
+
"values": [
|
|
3395
|
+
{
|
|
3396
|
+
"type": "boolean"
|
|
3397
|
+
}
|
|
3398
|
+
],
|
|
3399
|
+
"optional": true,
|
|
3400
|
+
"required": false
|
|
3401
|
+
},
|
|
3344
3402
|
{
|
|
3345
3403
|
"name": "showGoToPageControl",
|
|
3346
3404
|
"type": "boolean",
|
|
@@ -3882,6 +3940,27 @@
|
|
|
3882
3940
|
],
|
|
3883
3941
|
"optional": true,
|
|
3884
3942
|
"required": false
|
|
3943
|
+
},
|
|
3944
|
+
{
|
|
3945
|
+
"name": "truncateTreeItem",
|
|
3946
|
+
"type": "boolean",
|
|
3947
|
+
"complexType": {
|
|
3948
|
+
"original": "boolean",
|
|
3949
|
+
"resolved": "boolean",
|
|
3950
|
+
"references": {}
|
|
3951
|
+
},
|
|
3952
|
+
"mutable": false,
|
|
3953
|
+
"attr": "truncate-tree-item",
|
|
3954
|
+
"reflectToAttr": false,
|
|
3955
|
+
"docs": "If `true`, the tree item label will be truncated instead of text wrapping.",
|
|
3956
|
+
"docsTags": [],
|
|
3957
|
+
"values": [
|
|
3958
|
+
{
|
|
3959
|
+
"type": "boolean"
|
|
3960
|
+
}
|
|
3961
|
+
],
|
|
3962
|
+
"optional": true,
|
|
3963
|
+
"required": false
|
|
3885
3964
|
}
|
|
3886
3965
|
],
|
|
3887
3966
|
"methods": [
|
|
@@ -4097,6 +4176,50 @@
|
|
|
4097
4176
|
],
|
|
4098
4177
|
"optional": true,
|
|
4099
4178
|
"required": false
|
|
4179
|
+
},
|
|
4180
|
+
{
|
|
4181
|
+
"name": "truncateHeading",
|
|
4182
|
+
"type": "boolean",
|
|
4183
|
+
"complexType": {
|
|
4184
|
+
"original": "boolean",
|
|
4185
|
+
"resolved": "boolean",
|
|
4186
|
+
"references": {}
|
|
4187
|
+
},
|
|
4188
|
+
"mutable": false,
|
|
4189
|
+
"attr": "truncate-heading",
|
|
4190
|
+
"reflectToAttr": false,
|
|
4191
|
+
"docs": "If `true`, the tree view heading will be truncated instead of text wrapping.",
|
|
4192
|
+
"docsTags": [],
|
|
4193
|
+
"default": "false",
|
|
4194
|
+
"values": [
|
|
4195
|
+
{
|
|
4196
|
+
"type": "boolean"
|
|
4197
|
+
}
|
|
4198
|
+
],
|
|
4199
|
+
"optional": true,
|
|
4200
|
+
"required": false
|
|
4201
|
+
},
|
|
4202
|
+
{
|
|
4203
|
+
"name": "truncateTreeItems",
|
|
4204
|
+
"type": "boolean",
|
|
4205
|
+
"complexType": {
|
|
4206
|
+
"original": "boolean",
|
|
4207
|
+
"resolved": "boolean",
|
|
4208
|
+
"references": {}
|
|
4209
|
+
},
|
|
4210
|
+
"mutable": false,
|
|
4211
|
+
"attr": "truncate-tree-items",
|
|
4212
|
+
"reflectToAttr": false,
|
|
4213
|
+
"docs": "If `true`, tree items will be truncated, unless they are individually overridden.",
|
|
4214
|
+
"docsTags": [],
|
|
4215
|
+
"default": "false",
|
|
4216
|
+
"values": [
|
|
4217
|
+
{
|
|
4218
|
+
"type": "boolean"
|
|
4219
|
+
}
|
|
4220
|
+
],
|
|
4221
|
+
"optional": true,
|
|
4222
|
+
"required": false
|
|
4100
4223
|
}
|
|
4101
4224
|
],
|
|
4102
4225
|
"methods": [],
|
|
@@ -4174,7 +4297,7 @@
|
|
|
4174
4297
|
"path": "src/components/ic-data-table/ic-data-table.types.tsx"
|
|
4175
4298
|
},
|
|
4176
4299
|
"src/utils/types.ts::IcPaginationBarOptions": {
|
|
4177
|
-
"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 itemLabel?: string;\n pageLabel?: string;\n hideRangeLabel?: boolean;\n hideAllFromItemsPerPage?: boolean;\n theme?: IcThemeMode;\n monochrome?: boolean;\n}",
|
|
4300
|
+
"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 itemLabel?: string;\n pageLabel?: string;\n hideRangeLabel?: boolean;\n hideAllFromItemsPerPage?: boolean;\n theme?: IcThemeMode;\n monochrome?: boolean;\n setToFirstPageOnPaginationChange?: boolean;\n}",
|
|
4178
4301
|
"docstring": "",
|
|
4179
4302
|
"path": "src/utils/types.ts"
|
|
4180
4303
|
},
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/canary-docs",
|
|
4
|
-
"version": "3.0.0-canary.
|
|
4
|
+
"version": "3.0.0-canary.7",
|
|
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": "0a552da91d9f65e72b19d4518fb54efcf018d7bf"
|
|
22
22
|
}
|