@ukic/canary-docs 2.0.0-canary.27 → 2.0.0-canary.29

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 +45 -2
  2. package/package.json +3 -2
package/docs.json CHANGED
@@ -547,6 +547,28 @@
547
547
  "optional": true,
548
548
  "required": false
549
549
  },
550
+ {
551
+ "name": "disableAutoSort",
552
+ "type": "boolean",
553
+ "complexType": {
554
+ "original": "boolean",
555
+ "resolved": "boolean",
556
+ "references": {}
557
+ },
558
+ "mutable": false,
559
+ "attr": "disable-auto-sort",
560
+ "reflectToAttr": false,
561
+ "docs": "If `true`, the built in sort functionality will be disabled. For example, if rows will already be sorted from an external source.",
562
+ "docsTags": [],
563
+ "default": "false",
564
+ "values": [
565
+ {
566
+ "type": "boolean"
567
+ }
568
+ ],
569
+ "optional": true,
570
+ "required": false
571
+ },
550
572
  {
551
573
  "name": "embedded",
552
574
  "type": "boolean",
@@ -796,7 +818,7 @@
796
818
  "reflectToAttr": false,
797
819
  "docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
798
820
  "docsTags": [],
799
- "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 setToFirstPageOnPaginationChange: false,\n }",
821
+ "default": "{\n alignment: \"right\",\n appearance: \"default\",\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 pageLabel: \"Page\",\n rangeLabelType: \"page\",\n selectedItemsPerPage: 10,\n setToFirstPageOnPaginationChange: false,\n showGoToPageControl: true,\n showItemsPerPageControl: true,\n type: \"simple\",\n }",
800
822
  "values": [
801
823
  {
802
824
  "type": "IcPaginationBarOptions"
@@ -3733,6 +3755,27 @@
3733
3755
  "optional": true,
3734
3756
  "required": false
3735
3757
  },
3758
+ {
3759
+ "name": "selectedItemsPerPage",
3760
+ "type": "number",
3761
+ "complexType": {
3762
+ "original": "number",
3763
+ "resolved": "number",
3764
+ "references": {}
3765
+ },
3766
+ "mutable": false,
3767
+ "attr": "selected-items-per-page",
3768
+ "reflectToAttr": false,
3769
+ "docs": "The items per page option to be selected.",
3770
+ "docsTags": [],
3771
+ "values": [
3772
+ {
3773
+ "type": "number"
3774
+ }
3775
+ ],
3776
+ "optional": true,
3777
+ "required": false
3778
+ },
3736
3779
  {
3737
3780
  "name": "setToFirstPageOnPaginationChange",
3738
3781
  "type": "boolean",
@@ -5629,7 +5672,7 @@
5629
5672
  "path": "../web-components/dist/types/utils/types.d.ts"
5630
5673
  },
5631
5674
  "src/utils/types.ts::IcPaginationBarOptions": {
5632
- "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 setToFirstPageOnPaginationChange?: boolean;\n}",
5675
+ "declaration": "export interface IcPaginationBarOptions {\n alignment?: IcPaginationAlignmentOptions;\n appearance?: IcThemeForeground;\n hideAllFromItemsPerPage?: boolean;\n hideRangeLabel?: boolean;\n itemLabel?: string;\n itemsPerPageOptions?: { label: string; value: string }[];\n pageLabel?: string;\n rangeLabelType?: IcPaginationLabelTypes;\n selectedItemsPerPage?: number;\n setToFirstPageOnPaginationChange?: boolean;\n showGoToPageControl?: boolean;\n showItemsPerPageControl?: boolean;\n type?: IcPaginationTypes;\n}",
5633
5676
  "docstring": "",
5634
5677
  "path": "src/utils/types.ts"
5635
5678
  },
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.27",
4
+ "version": "2.0.0-canary.29",
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": "6933256d2e62a911545e88614bf8283471bc0331"
21
+ "packageManager": "^npm@10.9.2",
22
+ "gitHead": "aa7be8a4e4bd951dd72dabce7a7a7303d889ec7e"
22
23
  }