@ukic/docs 3.0.0-alpha.5 → 3.0.0-alpha.6

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 +70 -48
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -2426,7 +2426,7 @@
2426
2426
  "passive": false
2427
2427
  },
2428
2428
  {
2429
- "event": "themeChange",
2429
+ "event": "brandChange",
2430
2430
  "target": "document",
2431
2431
  "capture": false,
2432
2432
  "passive": false
@@ -2969,7 +2969,7 @@
2969
2969
  "passive": false
2970
2970
  },
2971
2971
  {
2972
- "event": "themeChange",
2972
+ "event": "brandChange",
2973
2973
  "target": "document",
2974
2974
  "capture": false,
2975
2975
  "passive": false
@@ -3865,6 +3865,28 @@
3865
3865
  "optional": true,
3866
3866
  "required": false
3867
3867
  },
3868
+ {
3869
+ "name": "dismissLabel",
3870
+ "type": "string",
3871
+ "complexType": {
3872
+ "original": "string",
3873
+ "resolved": "string",
3874
+ "references": {}
3875
+ },
3876
+ "mutable": false,
3877
+ "attr": "dismiss-label",
3878
+ "reflectToAttr": false,
3879
+ "docs": "The text in the dismiss button tooltip and aria label.",
3880
+ "docsTags": [],
3881
+ "default": "\"Dismiss\"",
3882
+ "values": [
3883
+ {
3884
+ "type": "string"
3885
+ }
3886
+ ],
3887
+ "optional": true,
3888
+ "required": false
3889
+ },
3868
3890
  {
3869
3891
  "name": "dismissible",
3870
3892
  "type": "boolean",
@@ -5207,7 +5229,7 @@
5207
5229
  "name": "theme",
5208
5230
  "type": "\"dark\" | \"default\" | \"inherit\" | \"light\"",
5209
5231
  "complexType": {
5210
- "original": "IcThemeMode | IcThemeForeground",
5232
+ "original": "IcThemeMode | IcBrandForeground",
5211
5233
  "resolved": "\"dark\" | \"default\" | \"inherit\" | \"light\"",
5212
5234
  "references": {
5213
5235
  "IcThemeMode": {
@@ -5215,10 +5237,10 @@
5215
5237
  "path": "../../utils/types",
5216
5238
  "id": "src/utils/types.ts::IcThemeMode"
5217
5239
  },
5218
- "IcThemeForeground": {
5240
+ "IcBrandForeground": {
5219
5241
  "location": "import",
5220
5242
  "path": "../../utils/types",
5221
- "id": "src/utils/types.ts::IcThemeForeground"
5243
+ "id": "src/utils/types.ts::IcBrandForeground"
5222
5244
  }
5223
5245
  }
5224
5246
  },
@@ -5295,7 +5317,7 @@
5295
5317
  "events": [],
5296
5318
  "listeners": [
5297
5319
  {
5298
- "event": "themeChange",
5320
+ "event": "brandChange",
5299
5321
  "target": "document",
5300
5322
  "capture": false,
5301
5323
  "passive": false
@@ -5780,7 +5802,7 @@
5780
5802
  "events": [],
5781
5803
  "listeners": [
5782
5804
  {
5783
- "event": "themeChange",
5805
+ "event": "brandChange",
5784
5806
  "target": "document",
5785
5807
  "capture": false,
5786
5808
  "passive": false
@@ -6006,7 +6028,7 @@
6006
6028
  "passive": false
6007
6029
  },
6008
6030
  {
6009
- "event": "themeChange",
6031
+ "event": "brandChange",
6010
6032
  "target": "document",
6011
6033
  "capture": false,
6012
6034
  "passive": false
@@ -6066,7 +6088,7 @@
6066
6088
  "passive": false
6067
6089
  },
6068
6090
  {
6069
- "event": "themeChange",
6091
+ "event": "brandChange",
6070
6092
  "target": "document",
6071
6093
  "capture": false,
6072
6094
  "passive": false
@@ -6348,7 +6370,7 @@
6348
6370
  "events": [],
6349
6371
  "listeners": [
6350
6372
  {
6351
- "event": "themeChange",
6373
+ "event": "brandChange",
6352
6374
  "target": "document",
6353
6375
  "capture": false,
6354
6376
  "passive": false
@@ -6405,13 +6427,13 @@
6405
6427
  "name": "appearance",
6406
6428
  "type": "\"dark\" | \"default\" | \"light\"",
6407
6429
  "complexType": {
6408
- "original": "IcThemeForeground",
6430
+ "original": "IcBrandForeground",
6409
6431
  "resolved": "\"dark\" | \"default\" | \"light\"",
6410
6432
  "references": {
6411
- "IcThemeForeground": {
6433
+ "IcBrandForeground": {
6412
6434
  "location": "import",
6413
6435
  "path": "../../utils/types",
6414
- "id": "src/utils/types.ts::IcThemeForeground"
6436
+ "id": "src/utils/types.ts::IcBrandForeground"
6415
6437
  }
6416
6438
  }
6417
6439
  },
@@ -7529,7 +7551,7 @@
7529
7551
  "events": [],
7530
7552
  "listeners": [
7531
7553
  {
7532
- "event": "themeChange",
7554
+ "event": "brandChange",
7533
7555
  "target": "document",
7534
7556
  "capture": false,
7535
7557
  "passive": false
@@ -9063,7 +9085,7 @@
9063
9085
  "passive": false
9064
9086
  },
9065
9087
  {
9066
- "event": "themeChange",
9088
+ "event": "brandChange",
9067
9089
  "target": "document",
9068
9090
  "capture": false,
9069
9091
  "passive": false
@@ -9228,7 +9250,7 @@
9228
9250
  "passive": false
9229
9251
  },
9230
9252
  {
9231
- "event": "themeChange",
9253
+ "event": "brandChange",
9232
9254
  "target": "document",
9233
9255
  "capture": false,
9234
9256
  "passive": false
@@ -9551,7 +9573,7 @@
9551
9573
  "events": [],
9552
9574
  "listeners": [
9553
9575
  {
9554
- "event": "themeChange",
9576
+ "event": "brandChange",
9555
9577
  "target": "document",
9556
9578
  "capture": false,
9557
9579
  "passive": false
@@ -14216,7 +14238,7 @@
14216
14238
  ],
14217
14239
  "listeners": [
14218
14240
  {
14219
- "event": "themeChange",
14241
+ "event": "brandChange",
14220
14242
  "target": "document",
14221
14243
  "capture": false,
14222
14244
  "passive": false
@@ -15674,28 +15696,6 @@
15674
15696
  ],
15675
15697
  "usage": {},
15676
15698
  "props": [
15677
- {
15678
- "name": "autoFocus",
15679
- "type": "boolean",
15680
- "complexType": {
15681
- "original": "boolean",
15682
- "resolved": "boolean",
15683
- "references": {}
15684
- },
15685
- "mutable": false,
15686
- "attr": "auto-focus",
15687
- "reflectToAttr": false,
15688
- "docs": "If `true`, the form control will have input focus when the page loads.",
15689
- "docsTags": [],
15690
- "default": "false",
15691
- "values": [
15692
- {
15693
- "type": "boolean"
15694
- }
15695
- ],
15696
- "optional": false,
15697
- "required": false
15698
- },
15699
15699
  {
15700
15700
  "name": "autocapitalize",
15701
15701
  "type": "string",
@@ -15992,6 +15992,28 @@
15992
15992
  "optional": false,
15993
15993
  "required": false
15994
15994
  },
15995
+ {
15996
+ "name": "autofocus",
15997
+ "type": "boolean",
15998
+ "complexType": {
15999
+ "original": "boolean",
16000
+ "resolved": "boolean",
16001
+ "references": {}
16002
+ },
16003
+ "mutable": false,
16004
+ "attr": "autofocus",
16005
+ "reflectToAttr": false,
16006
+ "docs": "If `true`, the form control will have input focus when the page loads.",
16007
+ "docsTags": [],
16008
+ "default": "false",
16009
+ "values": [
16010
+ {
16011
+ "type": "boolean"
16012
+ }
16013
+ ],
16014
+ "optional": false,
16015
+ "required": false
16016
+ },
15995
16017
  {
15996
16018
  "name": "debounce",
15997
16019
  "type": "number",
@@ -16887,7 +16909,7 @@
16887
16909
  "usage": {},
16888
16910
  "props": [
16889
16911
  {
16890
- "name": "color",
16912
+ "name": "brandColor",
16891
16913
  "type": "`#${string}` | `rgb(${string})` | `rgba(${string})`",
16892
16914
  "complexType": {
16893
16915
  "original": "IcColor",
@@ -16901,9 +16923,9 @@
16901
16923
  }
16902
16924
  },
16903
16925
  "mutable": false,
16904
- "attr": "color",
16926
+ "attr": "brand-color",
16905
16927
  "reflectToAttr": false,
16906
- "docs": "The theme colour. Can be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
16928
+ "docs": "The brand colour. Can be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
16907
16929
  "docsTags": [],
16908
16930
  "default": "null",
16909
16931
  "values": [
@@ -18631,7 +18653,7 @@
18631
18653
  "passive": false
18632
18654
  },
18633
18655
  {
18634
- "event": "themeChange",
18656
+ "event": "brandChange",
18635
18657
  "target": "document",
18636
18658
  "capture": false,
18637
18659
  "passive": false
@@ -19291,8 +19313,8 @@
19291
19313
  "docstring": "",
19292
19314
  "path": "src/utils/types.ts"
19293
19315
  },
19294
- "src/utils/types.ts::IcThemeForeground": {
19295
- "declaration": "export type IcThemeForeground = \"default\" | \"dark\" | \"light\";",
19316
+ "src/utils/types.ts::IcBrandForeground": {
19317
+ "declaration": "export type IcBrandForeground = \"default\" | \"dark\" | \"light\";",
19296
19318
  "docstring": "",
19297
19319
  "path": "src/utils/types.ts"
19298
19320
  },
@@ -19451,8 +19473,8 @@
19451
19473
  "docstring": "",
19452
19474
  "path": "src/components/ic-tab/ic-tab.types.ts"
19453
19475
  },
19454
- "src/utils/types.ts::IcTheme": {
19455
- "declaration": "{\n mode: IcThemeForeground;\n color: IcColorRGB;\n}",
19476
+ "src/utils/types.ts::IcBrand": {
19477
+ "declaration": "{\n mode: IcBrandForeground;\n color: IcColorRGB;\n}",
19456
19478
  "docstring": "",
19457
19479
  "path": "src/utils/types.ts"
19458
19480
  },
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "mi6",
3
3
  "name": "@ukic/docs",
4
- "version": "3.0.0-alpha.5",
4
+ "version": "3.0.0-alpha.6",
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": "7204bc78595a8f362dc1e58e830b8622b6085d45"
21
+ "gitHead": "d12d44ce767e650601d380df6d5ce1b0d8fb78fb"
22
22
  }