@ukic/canary-docs 2.0.0-canary.21 → 2.0.0-canary.22

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 +38 -5
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -3468,6 +3468,28 @@
3468
3468
  "optional": true,
3469
3469
  "required": false
3470
3470
  },
3471
+ {
3472
+ "name": "currentPage",
3473
+ "type": "number",
3474
+ "complexType": {
3475
+ "original": "number",
3476
+ "resolved": "number",
3477
+ "references": {}
3478
+ },
3479
+ "mutable": false,
3480
+ "attr": "current-page",
3481
+ "reflectToAttr": false,
3482
+ "docs": "The current page number to be displayed on the pagination bar.",
3483
+ "docsTags": [],
3484
+ "default": "1",
3485
+ "values": [
3486
+ {
3487
+ "type": "number"
3488
+ }
3489
+ ],
3490
+ "optional": true,
3491
+ "required": false
3492
+ },
3471
3493
  {
3472
3494
  "name": "hideRangeLabel",
3473
3495
  "type": "boolean",
@@ -3704,16 +3726,22 @@
3704
3726
  },
3705
3727
  {
3706
3728
  "event": "icPageChange",
3707
- "detail": "{ value: number; }",
3729
+ "detail": "IcPageChangeEventDetail",
3708
3730
  "bubbles": true,
3709
3731
  "complexType": {
3710
- "original": "{ value: number }",
3711
- "resolved": "{ value: number; }",
3712
- "references": {}
3732
+ "original": "IcPageChangeEventDetail",
3733
+ "resolved": "IcPageChangeEventDetail",
3734
+ "references": {
3735
+ "IcPageChangeEventDetail": {
3736
+ "location": "import",
3737
+ "path": "./ic-pagination-bar.types",
3738
+ "id": "src/components/ic-pagination-bar/ic-pagination-bar.types.ts::IcPageChangeEventDetail"
3739
+ }
3740
+ }
3713
3741
  },
3714
3742
  "cancelable": true,
3715
3743
  "composed": true,
3716
- "docs": "Emitted when a page is navigated to via the 'go to' input.",
3744
+ "docs": "Emitted when a page is navigated to via the 'go to' input.\nThe `detail` property contains `value` (i.e. the page number) and a `fromItemsPerPage` flag to indicate if the event was triggered by the `icItemsPerPageChange` event also occurring.",
3717
3745
  "docsTags": []
3718
3746
  }
3719
3747
  ],
@@ -5407,6 +5435,11 @@
5407
5435
  "docstring": "",
5408
5436
  "path": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts"
5409
5437
  },
5438
+ "src/components/ic-pagination-bar/ic-pagination-bar.types.ts::IcPageChangeEventDetail": {
5439
+ "declaration": "export interface IcPageChangeEventDetail {\n value: number;\n fromItemsPerPage?: boolean;\n}",
5440
+ "docstring": "",
5441
+ "path": "src/components/ic-pagination-bar/ic-pagination-bar.types.ts"
5442
+ },
5410
5443
  "src/components/ic-data-table/ic-data-table.types.tsx::IcDensityUpdateEventDetail": {
5411
5444
  "declaration": "export interface IcDensityUpdateEventDetail {\n value: IcDataTableDensityOptions;\n}",
5412
5445
  "docstring": "",
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.21",
4
+ "version": "2.0.0-canary.22",
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": "9c268801ebc8da41901291fe13ff157a6211fbbd"
21
+ "gitHead": "3722eb9496a95846172a9a41c70055d75265cdd6"
22
22
  }