@ukic/canary-docs 3.0.0-canary.6 → 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.
Files changed (2) hide show
  1. package/docs.json +64 -6
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -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",
@@ -4239,7 +4297,7 @@
4239
4297
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
4240
4298
  },
4241
4299
  "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}",
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}",
4243
4301
  "docstring": "",
4244
4302
  "path": "src/utils/types.ts"
4245
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.6",
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": "d12d44ce767e650601d380df6d5ce1b0d8fb78fb"
21
+ "gitHead": "0a552da91d9f65e72b19d4518fb54efcf018d7bf"
22
22
  }