@ukic/docs 2.14.0 → 2.14.2

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 +54 -6
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -2948,7 +2948,7 @@
2948
2948
  "mutable": true,
2949
2949
  "attr": "checked",
2950
2950
  "reflectToAttr": true,
2951
- "docs": "If `true`, the checkbox will be set to the checked state.",
2951
+ "docs": "If `true`, the checkbox will be set to the checked state. This is only the initial state and will be updated to unchecked if the checkbox is clicked.",
2952
2952
  "docsTags": [],
2953
2953
  "default": "false",
2954
2954
  "values": [
@@ -8561,6 +8561,28 @@
8561
8561
  "optional": true,
8562
8562
  "required": false
8563
8563
  },
8564
+ {
8565
+ "name": "toggleChecked",
8566
+ "type": "boolean",
8567
+ "complexType": {
8568
+ "original": "boolean",
8569
+ "resolved": "boolean",
8570
+ "references": {}
8571
+ },
8572
+ "mutable": true,
8573
+ "attr": "toggle-checked",
8574
+ "reflectToAttr": true,
8575
+ "docs": "If `true`, the menu item will be in a checked state. This is only applicable when variant is set to `toggle`.",
8576
+ "docsTags": [],
8577
+ "default": "false",
8578
+ "values": [
8579
+ {
8580
+ "type": "boolean"
8581
+ }
8582
+ ],
8583
+ "optional": false,
8584
+ "required": false
8585
+ },
8564
8586
  {
8565
8587
  "name": "variant",
8566
8588
  "type": "\"default\" | \"destructive\" | \"toggle\"",
@@ -8600,7 +8622,22 @@
8600
8622
  }
8601
8623
  ],
8602
8624
  "methods": [],
8603
- "events": [],
8625
+ "events": [
8626
+ {
8627
+ "event": "icToggleChecked",
8628
+ "detail": "{ checked: boolean; }",
8629
+ "bubbles": true,
8630
+ "complexType": {
8631
+ "original": "{\n checked: boolean;\n }",
8632
+ "resolved": "{ checked: boolean; }",
8633
+ "references": {}
8634
+ },
8635
+ "cancelable": true,
8636
+ "composed": true,
8637
+ "docs": "Emitted when the user clicks a menu item that is set to the toggle variant.",
8638
+ "docsTags": []
8639
+ }
8640
+ ],
8604
8641
  "listeners": [
8605
8642
  {
8606
8643
  "event": "click",
@@ -10457,12 +10494,18 @@
10457
10494
  "events": [
10458
10495
  {
10459
10496
  "event": "icPopoverClosed",
10460
- "detail": "void",
10497
+ "detail": "IcValueEventDetail",
10461
10498
  "bubbles": true,
10462
10499
  "complexType": {
10463
- "original": "void",
10464
- "resolved": "void",
10465
- "references": {}
10500
+ "original": "IcValueEventDetail",
10501
+ "resolved": "IcValueEventDetail",
10502
+ "references": {
10503
+ "IcValueEventDetail": {
10504
+ "location": "import",
10505
+ "path": "../../components",
10506
+ "id": "src/components.d.ts::IcValueEventDetail"
10507
+ }
10508
+ }
10466
10509
  },
10467
10510
  "cancelable": true,
10468
10511
  "composed": true,
@@ -19138,6 +19181,11 @@
19138
19181
  "docstring": "",
19139
19182
  "path": "src/components/ic-pagination-item/ic-pagination-item.types.ts"
19140
19183
  },
19184
+ "src/components.d.ts::IcValueEventDetail": {
19185
+ "declaration": "any",
19186
+ "docstring": "",
19187
+ "path": "src/components.d.ts"
19188
+ },
19141
19189
  "src/utils/types.ts::IcOrientation": {
19142
19190
  "declaration": "export type IcOrientation = \"horizontal\" | \"vertical\";",
19143
19191
  "docstring": "",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "mi6",
3
3
  "name": "@ukic/docs",
4
- "version": "2.14.0",
4
+ "version": "2.14.2",
5
5
  "description": "API documentation for @ukic 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": "895517389cf1b33e002f4b72661792fd74ee4cbb"
21
+ "gitHead": "aff793113e94a59e56cc50e22325beb68593192a"
22
22
  }