@ukic/docs 2.10.0 → 2.10.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 +76 -3
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "timestamp": "2024-03-18T10:40:36",
2
+ "timestamp": "2024-04-15T11:49:34",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
5
  "version": "4.10.0",
@@ -370,7 +370,30 @@
370
370
  "required": false
371
371
  }
372
372
  ],
373
- "methods": [],
373
+ "methods": [
374
+ {
375
+ "name": "setFocus",
376
+ "returns": {
377
+ "type": "Promise<void>",
378
+ "docs": ""
379
+ },
380
+ "complexType": {
381
+ "signature": "() => Promise<void>",
382
+ "parameters": [],
383
+ "references": {
384
+ "Promise": {
385
+ "location": "global",
386
+ "id": "global::Promise"
387
+ }
388
+ },
389
+ "return": "Promise<void>"
390
+ },
391
+ "signature": "setFocus() => Promise<void>",
392
+ "parameters": [],
393
+ "docs": "Sets the focus on first focusable element in the accordion group. If the \"See/Hide all\" button is present, it will be focused.\nOtherwise, the first accordion will be focused.",
394
+ "docsTags": []
395
+ }
396
+ ],
374
397
  "events": [],
375
398
  "listeners": [
376
399
  {
@@ -17979,6 +18002,51 @@
17979
18002
  "optional": false,
17980
18003
  "required": false
17981
18004
  },
18005
+ {
18006
+ "name": "customMobileBreakpoint",
18007
+ "type": "0 | 1200 | 576 | 768 | 992",
18008
+ "complexType": {
18009
+ "original": "IcDeviceSizes",
18010
+ "resolved": "0 | 1200 | 576 | 768 | 992",
18011
+ "references": {
18012
+ "IcDeviceSizes": {
18013
+ "location": "import",
18014
+ "path": "../../utils/types",
18015
+ "id": "src/utils/types.ts::IcDeviceSizes"
18016
+ }
18017
+ }
18018
+ },
18019
+ "mutable": false,
18020
+ "attr": "custom-mobile-breakpoint",
18021
+ "reflectToAttr": false,
18022
+ "docs": "Can set a custom breakpoint for the top navigation to switch to mobile mode.\nMust be one of our specified breakpoints in px: `0`, `576`, `768`, `992`, `1200`.",
18023
+ "docsTags": [],
18024
+ "default": "DEVICE_SIZES.L",
18025
+ "values": [
18026
+ {
18027
+ "value": "0",
18028
+ "type": "number"
18029
+ },
18030
+ {
18031
+ "value": "1200",
18032
+ "type": "number"
18033
+ },
18034
+ {
18035
+ "value": "576",
18036
+ "type": "number"
18037
+ },
18038
+ {
18039
+ "value": "768",
18040
+ "type": "number"
18041
+ },
18042
+ {
18043
+ "value": "992",
18044
+ "type": "number"
18045
+ }
18046
+ ],
18047
+ "optional": false,
18048
+ "required": false
18049
+ },
17982
18050
  {
17983
18051
  "name": "href",
17984
18052
  "type": "string",
@@ -18807,6 +18875,11 @@
18807
18875
  "docstring": "",
18808
18876
  "path": "src/components/ic-side-navigation/ic-side-navigation.types.ts"
18809
18877
  },
18878
+ "src/utils/types.ts::IcDeviceSizes": {
18879
+ "declaration": "export type IcDeviceSizes = 0 | 576 | 768 | 992 | 1200;",
18880
+ "docstring": "",
18881
+ "path": "src/utils/types.ts"
18882
+ },
18810
18883
  "src/components/ic-pagination/ic-pagination.types.ts::IcPaginationTypes": {
18811
18884
  "declaration": "export type IcPaginationTypes = \"simple\" | \"complex\";",
18812
18885
  "docstring": "",
@@ -18888,7 +18961,7 @@
18888
18961
  "path": "src/components/ic-switch/ic-switch.types.ts"
18889
18962
  },
18890
18963
  "src/components/ic-tab/ic-tab.types.ts::IcTabSelectEventDetail": {
18891
- "declaration": "export interface IcTabSelectEventDetail {\n tabIndex: number;\n}",
18964
+ "declaration": "export interface IcTabSelectEventDetail {\n tabIndex: number;\n tabLabel: string;\n}",
18892
18965
  "docstring": "",
18893
18966
  "path": "src/components/ic-tab/ic-tab.types.ts"
18894
18967
  },
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "mi6",
3
3
  "name": "@ukic/docs",
4
- "version": "2.10.0",
4
+ "version": "2.10.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": "58d6040e80a2fe1ca1feeca8e203130e2c59ff29"
21
+ "gitHead": "5e148cca2bd199859c1627c4cef0d070014891b9"
22
22
  }