@ukic/canary-docs 3.0.0-canary.6 → 3.0.0-canary.8

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 +107 -6
  2. package/package.json +3 -2
package/docs.json CHANGED
@@ -584,6 +584,28 @@
584
584
  "optional": true,
585
585
  "required": false
586
586
  },
587
+ {
588
+ "name": "disableAutoSort",
589
+ "type": "boolean",
590
+ "complexType": {
591
+ "original": "boolean",
592
+ "resolved": "boolean",
593
+ "references": {}
594
+ },
595
+ "mutable": false,
596
+ "attr": "disable-auto-sort",
597
+ "reflectToAttr": false,
598
+ "docs": "If `true`, the built in sort functionality will be disabled. For example, if rows will already be sorted from an external source.",
599
+ "docsTags": [],
600
+ "default": "false",
601
+ "values": [
602
+ {
603
+ "type": "boolean"
604
+ }
605
+ ],
606
+ "optional": true,
607
+ "required": false
608
+ },
587
609
  {
588
610
  "name": "embedded",
589
611
  "type": "boolean",
@@ -681,6 +703,28 @@
681
703
  "optional": true,
682
704
  "required": false
683
705
  },
706
+ {
707
+ "name": "highlightSelectedRow",
708
+ "type": "boolean",
709
+ "complexType": {
710
+ "original": "boolean",
711
+ "resolved": "boolean",
712
+ "references": {}
713
+ },
714
+ "mutable": false,
715
+ "attr": "highlight-selected-row",
716
+ "reflectToAttr": false,
717
+ "docs": "If `true`, the selected row is highlighted using a background colour.",
718
+ "docsTags": [],
719
+ "default": "true",
720
+ "values": [
721
+ {
722
+ "type": "boolean"
723
+ }
724
+ ],
725
+ "optional": true,
726
+ "required": false
727
+ },
684
728
  {
685
729
  "name": "loading",
686
730
  "type": "boolean",
@@ -705,10 +749,10 @@
705
749
  },
706
750
  {
707
751
  "name": "loadingOptions",
708
- "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }",
752
+ "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; overlay?: boolean; }",
709
753
  "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; }",
754
+ "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 }",
755
+ "resolved": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; overlay?: boolean; }",
712
756
  "references": {}
713
757
  },
714
758
  "mutable": false,
@@ -717,7 +761,7 @@
717
761
  "docsTags": [],
718
762
  "values": [
719
763
  {
720
- "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }"
764
+ "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; overlay?: boolean; }"
721
765
  }
722
766
  ],
723
767
  "optional": true,
@@ -805,7 +849,7 @@
805
849
  "reflectToAttr": false,
806
850
  "docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
807
851
  "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 }",
852
+ "default": "{\n alignment: \"right\",\n hideAllFromItemsPerPage: false,\n hideRangeLabel: false,\n itemLabel: \"Item\",\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n monochrome: false,\n pageLabel: \"Page\",\n rangeLabelType: \"page\",\n selectedItemsPerPage: 10,\n setToFirstPageOnPaginationChange: false,\n showGoToPageControl: true,\n showItemsPerPageControl: true,\n type: \"simple\",\n }",
809
853
  "values": [
810
854
  {
811
855
  "type": "IcPaginationBarOptions"
@@ -1166,6 +1210,20 @@
1166
1210
  "docs": "Emitted when the `globalRowHeight` or `variableRowHeight` properties change in the data table.",
1167
1211
  "docsTags": []
1168
1212
  },
1213
+ {
1214
+ "event": "icSelectedRowChange",
1215
+ "detail": "object",
1216
+ "bubbles": true,
1217
+ "complexType": {
1218
+ "original": "object",
1219
+ "resolved": "object",
1220
+ "references": {}
1221
+ },
1222
+ "cancelable": true,
1223
+ "composed": true,
1224
+ "docs": "Emitted when the selected row changes in the data table.",
1225
+ "docsTags": []
1226
+ },
1169
1227
  {
1170
1228
  "event": "icSortChange",
1171
1229
  "detail": "IcSortEventDetail",
@@ -3341,6 +3399,49 @@
3341
3399
  "optional": true,
3342
3400
  "required": false
3343
3401
  },
3402
+ {
3403
+ "name": "selectedItemsPerPage",
3404
+ "type": "number",
3405
+ "complexType": {
3406
+ "original": "number",
3407
+ "resolved": "number",
3408
+ "references": {}
3409
+ },
3410
+ "mutable": false,
3411
+ "attr": "selected-items-per-page",
3412
+ "reflectToAttr": false,
3413
+ "docs": "The items per page option to be selected.",
3414
+ "docsTags": [],
3415
+ "values": [
3416
+ {
3417
+ "type": "number"
3418
+ }
3419
+ ],
3420
+ "optional": true,
3421
+ "required": false
3422
+ },
3423
+ {
3424
+ "name": "setToFirstPageOnPaginationChange",
3425
+ "type": "boolean",
3426
+ "complexType": {
3427
+ "original": "boolean",
3428
+ "resolved": "boolean",
3429
+ "references": {}
3430
+ },
3431
+ "mutable": false,
3432
+ "attr": "set-to-first-page-on-pagination-change",
3433
+ "reflectToAttr": false,
3434
+ "docs": "If `true`, the pagination bar is set to the first page when the 'items per page' changes",
3435
+ "docsTags": [],
3436
+ "default": "false",
3437
+ "values": [
3438
+ {
3439
+ "type": "boolean"
3440
+ }
3441
+ ],
3442
+ "optional": true,
3443
+ "required": false
3444
+ },
3344
3445
  {
3345
3446
  "name": "showGoToPageControl",
3346
3447
  "type": "boolean",
@@ -4239,7 +4340,7 @@
4239
4340
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
4240
4341
  },
4241
4342
  "src/utils/types.ts::IcPaginationBarOptions": {
4242
- "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}",
4343
+ "declaration": "export interface IcPaginationBarOptions {\n alignment?: IcPaginationAlignmentOptions;\n hideAllFromItemsPerPage?: boolean;\n hideRangeLabel?: boolean;\n itemLabel?: string;\n itemsPerPageOptions?: { label: string; value: string }[];\n monochrome?: boolean;\n pageLabel?: string;\n rangeLabelType?: IcPaginationLabelTypes;\n selectedItemsPerPage?: number;\n setToFirstPageOnPaginationChange?: boolean;\n showGoToPageControl?: boolean;\n showItemsPerPageControl?: boolean;\n theme?: IcThemeMode;\n type?: IcPaginationTypes;\n}",
4243
4344
  "docstring": "",
4244
4345
  "path": "src/utils/types.ts"
4245
4346
  },
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.6",
4
+ "version": "3.0.0-canary.8",
5
5
  "description": "API documentation for @ukic canary components",
6
6
  "main": "docs.json",
7
7
  "types": "./docs.d.ts",
@@ -18,5 +18,6 @@
18
18
  "email": "icds@gchq.gov.uk"
19
19
  },
20
20
  "license": "MIT",
21
- "gitHead": "d12d44ce767e650601d380df6d5ce1b0d8fb78fb"
21
+ "packageManager": "^npm@10.9.2",
22
+ "gitHead": "4ac17d545cf8f4d59d4a954943a4510659c5e619"
22
23
  }