@ukic/canary-docs 3.0.0-canary.7 → 3.0.0-canary.9

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 +50 -7
  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",
@@ -727,10 +749,10 @@
727
749
  },
728
750
  {
729
751
  "name": "loadingOptions",
730
- "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; overlay?: boolean; }",
752
+ "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; monochrome?: boolean; overlay?: boolean; }",
731
753
  "complexType": {
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; }",
754
+ "original": "{\n description?: string;\n label?: string;\n labelDuration?: number;\n max?: number;\n min?: number;\n progress?: number;\n monochrome?: boolean;\n overlay?: boolean;\n }",
755
+ "resolved": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; monochrome?: boolean; overlay?: boolean; }",
734
756
  "references": {}
735
757
  },
736
758
  "mutable": false,
@@ -739,7 +761,7 @@
739
761
  "docsTags": [],
740
762
  "values": [
741
763
  {
742
- "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; overlay?: boolean; }"
764
+ "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; monochrome?: boolean; overlay?: boolean; }"
743
765
  }
744
766
  ],
745
767
  "optional": true,
@@ -827,7 +849,7 @@
827
849
  "reflectToAttr": false,
828
850
  "docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
829
851
  "docsTags": [],
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 }",
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 }",
831
853
  "values": [
832
854
  {
833
855
  "type": "IcPaginationBarOptions"
@@ -3377,6 +3399,27 @@
3377
3399
  "optional": true,
3378
3400
  "required": false
3379
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
+ },
3380
3423
  {
3381
3424
  "name": "setToFirstPageOnPaginationChange",
3382
3425
  "type": "boolean",
@@ -4277,7 +4320,7 @@
4277
4320
  "path": "src/utils/types.ts"
4278
4321
  },
4279
4322
  "src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableColumnObject": {
4280
- "declaration": "{\n key: string;\n title: string;\n dataType: IcDataTableColumnDataTypes;\n columnAlignment?: {\n horizontal?: string;\n vertical?: string;\n };\n rowOptions?: {\n textWrap: boolean;\n };\n columnWidth?: string | IcDataTableColumnWidthTypes;\n textWrap?: boolean;\n cellAlignment?: string;\n emphasis?: string;\n colspan?: number;\n icon?: {\n icon: string;\n onAllCells?: boolean;\n hideOnHeader?: boolean;\n };\n}",
4323
+ "declaration": "{\n key: string;\n title: string;\n dataType: IcDataTableColumnDataTypes;\n columnAlignment?: {\n horizontal?: string;\n vertical?: string;\n };\n rowOptions?: {\n textWrap: boolean;\n };\n columnWidth?: string | IcDataTableColumnWidthTypes;\n textWrap?: boolean;\n cellAlignment?: string;\n emphasis?: string;\n colspan?: number;\n icon?: {\n icon: string;\n onAllCells?: boolean;\n hideOnHeader?: boolean;\n };\n excludeColumnFromSort?: boolean;\n}",
4281
4324
  "docstring": "",
4282
4325
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
4283
4326
  },
@@ -4297,7 +4340,7 @@
4297
4340
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
4298
4341
  },
4299
4342
  "src/utils/types.ts::IcPaginationBarOptions": {
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}",
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}",
4301
4344
  "docstring": "",
4302
4345
  "path": "src/utils/types.ts"
4303
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.7",
4
+ "version": "3.0.0-canary.9",
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": "0a552da91d9f65e72b19d4518fb54efcf018d7bf"
21
+ "packageManager": "^npm@10.9.2",
22
+ "gitHead": "c5829148aff4e18ae2c9923eddf8c08ff0455085"
22
23
  }