@ukic/docs 3.0.0-alpha.1 → 3.0.0-alpha.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 +213 -141
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -9,7 +9,7 @@
9
9
  "filePath": "src/components/ic-accordion/ic-accordion.tsx",
10
10
  "encapsulation": "shadow",
11
11
  "tag": "ic-accordion",
12
- "readme": "# ic-accordion\n\n\n",
12
+ "readme": "# ic-accordion\r\n\r\n\r\n\r",
13
13
  "docs": "",
14
14
  "docsTags": [
15
15
  {
@@ -201,7 +201,7 @@
201
201
  "filePath": "src/components/ic-accordion-group/ic-accordion-group.tsx",
202
202
  "encapsulation": "shadow",
203
203
  "tag": "ic-accordion-group",
204
- "readme": "# ic-accordion-title\n\n\n",
204
+ "readme": "# ic-accordion-title\r\n\r\n\r\n\r",
205
205
  "docs": "",
206
206
  "docsTags": [
207
207
  {
@@ -440,7 +440,7 @@
440
440
  "filePath": "src/components/ic-alert/ic-alert.tsx",
441
441
  "encapsulation": "shadow",
442
442
  "tag": "ic-alert",
443
- "readme": "# ic-alert\n\n\n",
443
+ "readme": "# ic-alert\r\n\r\n\r\n\r",
444
444
  "docs": "",
445
445
  "docsTags": [
446
446
  {
@@ -701,7 +701,7 @@
701
701
  "filePath": "src/components/ic-back-to-top/ic-back-to-top.tsx",
702
702
  "encapsulation": "shadow",
703
703
  "tag": "ic-back-to-top",
704
- "readme": "# ic-back-to-top\n\n\n",
704
+ "readme": "# ic-back-to-top\r\n\r\n\r\n\r",
705
705
  "docs": "",
706
706
  "docsTags": [],
707
707
  "usage": {},
@@ -797,7 +797,7 @@
797
797
  "filePath": "src/components/ic-badge/ic-badge.tsx",
798
798
  "encapsulation": "shadow",
799
799
  "tag": "ic-badge",
800
- "readme": "# ic-badge\n\n\n",
800
+ "readme": "# ic-badge\r\n\r\n\r\n\r",
801
801
  "docs": "",
802
802
  "docsTags": [
803
803
  {
@@ -1153,7 +1153,7 @@
1153
1153
  "filePath": "src/components/ic-breadcrumb/ic-breadcrumb.tsx",
1154
1154
  "encapsulation": "shadow",
1155
1155
  "tag": "ic-breadcrumb",
1156
- "readme": "# ic-breadcrumb\n\n\n",
1156
+ "readme": "# ic-breadcrumb\r\n\r\n\r\n\r",
1157
1157
  "docs": "",
1158
1158
  "docsTags": [
1159
1159
  {
@@ -1281,7 +1281,7 @@
1281
1281
  "filePath": "src/components/ic-breadcrumb-group/ic-breadcrumb-group.tsx",
1282
1282
  "encapsulation": "shadow",
1283
1283
  "tag": "ic-breadcrumb-group",
1284
- "readme": "# ic-breadcrumb-group\n\n\n",
1284
+ "readme": "# ic-breadcrumb-group\r\n\r\n\r\n\r",
1285
1285
  "docs": "",
1286
1286
  "docsTags": [],
1287
1287
  "usage": {},
@@ -1413,7 +1413,7 @@
1413
1413
  "filePath": "src/components/ic-button/ic-button.tsx",
1414
1414
  "encapsulation": "shadow",
1415
1415
  "tag": "ic-button",
1416
- "readme": "# ic-button\n",
1416
+ "readme": "# ic-button\r\n\r",
1417
1417
  "docs": "",
1418
1418
  "docsTags": [
1419
1419
  {
@@ -2421,7 +2421,7 @@
2421
2421
  "filePath": "src/components/ic-card-vertical/ic-card-vertical.tsx",
2422
2422
  "encapsulation": "shadow",
2423
2423
  "tag": "ic-card-vertical",
2424
- "readme": "# ic-card-vertical\n\n\n",
2424
+ "readme": "# ic-card-vertical\r\n\r\n\r\n\r",
2425
2425
  "docs": "",
2426
2426
  "docsTags": [
2427
2427
  {
@@ -2872,7 +2872,7 @@
2872
2872
  "filePath": "src/components/ic-checkbox/ic-checkbox.tsx",
2873
2873
  "encapsulation": "shadow",
2874
2874
  "tag": "ic-checkbox",
2875
- "readme": "# ic-checkbox\n\n\n",
2875
+ "readme": "# ic-checkbox\r\n\r\n\r\n\r",
2876
2876
  "docs": "",
2877
2877
  "docsTags": [
2878
2878
  {
@@ -3256,7 +3256,7 @@
3256
3256
  "filePath": "src/components/ic-checkbox-group/ic-checkbox-group.tsx",
3257
3257
  "encapsulation": "shadow",
3258
3258
  "tag": "ic-checkbox-group",
3259
- "readme": "# ic-checkbox-group\n\n\n",
3259
+ "readme": "# ic-checkbox-group\r\n\r\n\r\n\r",
3260
3260
  "docs": "",
3261
3261
  "docsTags": [],
3262
3262
  "usage": {},
@@ -3551,7 +3551,7 @@
3551
3551
  "filePath": "src/components/ic-chip/ic-chip.tsx",
3552
3552
  "encapsulation": "shadow",
3553
3553
  "tag": "ic-chip",
3554
- "readme": "# ic-chip\n\n\n",
3554
+ "readme": "# ic-chip\r\n\r\n\r\n\r",
3555
3555
  "docs": "",
3556
3556
  "docsTags": [
3557
3557
  {
@@ -3582,7 +3582,7 @@
3582
3582
  "mutable": false,
3583
3583
  "attr": "custom-color",
3584
3584
  "reflectToAttr": false,
3585
- "docs": "The custom chip colour. This prop will be applied to the chip component if `dismissible` is set to `false`.\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
3585
+ "docs": "The custom chip colour. This will override the theme colour.\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
3586
3586
  "docsTags": [],
3587
3587
  "default": "null",
3588
3588
  "values": [
@@ -3701,6 +3701,37 @@
3701
3701
  "optional": true,
3702
3702
  "required": false
3703
3703
  },
3704
+ {
3705
+ "name": "theme",
3706
+ "type": "\"dark\" | \"inherit\" | \"light\"",
3707
+ "complexType": {
3708
+ "original": "\"dark\" | \"light\" | \"inherit\"",
3709
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
3710
+ "references": {}
3711
+ },
3712
+ "mutable": false,
3713
+ "attr": "theme",
3714
+ "reflectToAttr": false,
3715
+ "docs": "Sets the chip to the dark or light theme colors. \"inherit\" will set the color based on the system settings or ic-theme component.\nSetting the \"customColor\" prop will override this.",
3716
+ "docsTags": [],
3717
+ "default": "\"inherit\"",
3718
+ "values": [
3719
+ {
3720
+ "value": "dark",
3721
+ "type": "string"
3722
+ },
3723
+ {
3724
+ "value": "inherit",
3725
+ "type": "string"
3726
+ },
3727
+ {
3728
+ "value": "light",
3729
+ "type": "string"
3730
+ }
3731
+ ],
3732
+ "optional": true,
3733
+ "required": false
3734
+ },
3704
3735
  {
3705
3736
  "name": "transparentBackground",
3706
3737
  "type": "boolean",
@@ -3712,7 +3743,7 @@
3712
3743
  "mutable": false,
3713
3744
  "attr": "transparent-background",
3714
3745
  "reflectToAttr": false,
3715
- "docs": "If `true`, the outlined variant of chip will have a transparent background rather than white.",
3746
+ "docs": "If `true`, the outlined variant of chip will have a transparent background rather than the theme defined color.",
3716
3747
  "docsTags": [],
3717
3748
  "default": "true",
3718
3749
  "values": [
@@ -3835,7 +3866,7 @@
3835
3866
  "filePath": "src/components/ic-classification-banner/ic-classification-banner.tsx",
3836
3867
  "encapsulation": "shadow",
3837
3868
  "tag": "ic-classification-banner",
3838
- "readme": "# ic-classification-banner\n\n\n",
3869
+ "readme": "# ic-classification-banner\r\n\r\n\r\n\r",
3839
3870
  "docs": "",
3840
3871
  "docsTags": [],
3841
3872
  "usage": {},
@@ -4000,7 +4031,7 @@
4000
4031
  "filePath": "src/components/ic-data-list/ic-data-list.tsx",
4001
4032
  "encapsulation": "shadow",
4002
4033
  "tag": "ic-data-list",
4003
- "readme": "# ic-data-list\n\n\n",
4034
+ "readme": "# ic-data-list\r\n\r\n\r\n\r",
4004
4035
  "docs": "",
4005
4036
  "docsTags": [
4006
4037
  {
@@ -4127,7 +4158,7 @@
4127
4158
  "filePath": "src/components/ic-data-row/ic-data-row.tsx",
4128
4159
  "encapsulation": "shadow",
4129
4160
  "tag": "ic-data-row",
4130
- "readme": "# ic-data-row\n\n\n",
4161
+ "readme": "# ic-data-row\r\n\r\n\r\n\r",
4131
4162
  "docs": "",
4132
4163
  "docsTags": [
4133
4164
  {
@@ -4291,7 +4322,7 @@
4291
4322
  "filePath": "src/components/ic-dialog/ic-dialog.tsx",
4292
4323
  "encapsulation": "shadow",
4293
4324
  "tag": "ic-dialog",
4294
- "readme": "# ic-dialog\n\n\n",
4325
+ "readme": "# ic-dialog\r\n\r\n\r\n\r",
4295
4326
  "docs": "",
4296
4327
  "docsTags": [
4297
4328
  {
@@ -4732,7 +4763,7 @@
4732
4763
  "filePath": "src/components/ic-divider/ic-divider.tsx",
4733
4764
  "encapsulation": "scoped",
4734
4765
  "tag": "ic-divider",
4735
- "readme": "# ic-divider\n\n\n",
4766
+ "readme": "# ic-divider\r\n\r\n\r\n\r",
4736
4767
  "docs": "",
4737
4768
  "docsTags": [],
4738
4769
  "usage": {},
@@ -4764,7 +4795,7 @@
4764
4795
  "filePath": "src/components/ic-empty-state/ic-empty-state.tsx",
4765
4796
  "encapsulation": "shadow",
4766
4797
  "tag": "ic-empty-state",
4767
- "readme": "# ic-empty-state\n\n\n",
4798
+ "readme": "# ic-empty-state\r\n\r\n\r\n\r",
4768
4799
  "docs": "",
4769
4800
  "docsTags": [
4770
4801
  {
@@ -4990,7 +5021,7 @@
4990
5021
  "filePath": "src/components/ic-footer/ic-footer.tsx",
4991
5022
  "encapsulation": "shadow",
4992
5023
  "tag": "ic-footer",
4993
- "readme": "# ic-footer\n\n\n",
5024
+ "readme": "# ic-footer\r\n\r\n\r\n\r",
4994
5025
  "docs": "",
4995
5026
  "docsTags": [
4996
5027
  {
@@ -5227,7 +5258,7 @@
5227
5258
  "filePath": "src/components/ic-footer-link/ic-footer-link.tsx",
5228
5259
  "encapsulation": "shadow",
5229
5260
  "tag": "ic-footer-link",
5230
- "readme": "# ic-footer-link\n\n\n",
5261
+ "readme": "# ic-footer-link\r\n\r\n\r\n\r",
5231
5262
  "docs": "",
5232
5263
  "docsTags": [],
5233
5264
  "usage": {},
@@ -5434,7 +5465,7 @@
5434
5465
  "filePath": "src/components/ic-footer-link-group/ic-footer-link-group.tsx",
5435
5466
  "encapsulation": "shadow",
5436
5467
  "tag": "ic-footer-link-group",
5437
- "readme": "# ic-footer-link-group\n\n\n",
5468
+ "readme": "# ic-footer-link-group\r\n\r\n\r\n\r",
5438
5469
  "docs": "",
5439
5470
  "docsTags": [],
5440
5471
  "usage": {},
@@ -5496,7 +5527,7 @@
5496
5527
  "filePath": "src/components/ic-hero/ic-hero.tsx",
5497
5528
  "encapsulation": "shadow",
5498
5529
  "tag": "ic-hero",
5499
- "readme": "# ic-hero\n\n\n",
5530
+ "readme": "# ic-hero\r\n\r\n\r\n\r",
5500
5531
  "docs": "",
5501
5532
  "docsTags": [
5502
5533
  {
@@ -5801,7 +5832,7 @@
5801
5832
  "filePath": "src/components/ic-horizontal-scroll/ic-horizontal-scroll.tsx",
5802
5833
  "encapsulation": "shadow",
5803
5834
  "tag": "ic-horizontal-scroll",
5804
- "readme": "# ic-horizontal-scroll\n\n\n",
5835
+ "readme": "# ic-horizontal-scroll\r\n\r\n\r\n\r",
5805
5836
  "docs": "",
5806
5837
  "docsTags": [],
5807
5838
  "usage": {},
@@ -5887,7 +5918,7 @@
5887
5918
  "filePath": "src/components/ic-input-component-container/ic-input-component-container.tsx",
5888
5919
  "encapsulation": "none",
5889
5920
  "tag": "ic-input-component-container",
5890
- "readme": "# ic-input-container\n\n\n",
5921
+ "readme": "# ic-input-container\r\n\r\n\r\n\r",
5891
5922
  "docs": "",
5892
5923
  "docsTags": [
5893
5924
  {
@@ -6147,7 +6178,7 @@
6147
6178
  "filePath": "src/components/ic-input-container/ic-input-container.tsx",
6148
6179
  "encapsulation": "none",
6149
6180
  "tag": "ic-input-container",
6150
- "readme": "# ic-input-container\n\n\n",
6181
+ "readme": "# ic-input-container\r\n\r\n\r\n\r",
6151
6182
  "docs": "",
6152
6183
  "docsTags": [],
6153
6184
  "usage": {},
@@ -6221,7 +6252,7 @@
6221
6252
  "filePath": "src/components/ic-input-label/ic-input-label.tsx",
6222
6253
  "encapsulation": "none",
6223
6254
  "tag": "ic-input-label",
6224
- "readme": "# ic-input-label\n\n\n",
6255
+ "readme": "# ic-input-label\r\n\r\n\r\n\r",
6225
6256
  "docs": "",
6226
6257
  "docsTags": [],
6227
6258
  "usage": {},
@@ -6451,7 +6482,7 @@
6451
6482
  "filePath": "src/components/ic-input-validation/ic-input-validation.tsx",
6452
6483
  "encapsulation": "none",
6453
6484
  "tag": "ic-input-validation",
6454
- "readme": "# ic-input-validation\n\n\n",
6485
+ "readme": "# ic-input-validation\r\n\r\n\r\n\r",
6455
6486
  "docs": "",
6456
6487
  "docsTags": [
6457
6488
  {
@@ -6641,7 +6672,7 @@
6641
6672
  "filePath": "src/components/ic-link/ic-link.tsx",
6642
6673
  "encapsulation": "shadow",
6643
6674
  "tag": "ic-link",
6644
- "readme": "# ic-link\n\n\n",
6675
+ "readme": "# ic-link\r\n\r\n\r\n\r",
6645
6676
  "docs": "",
6646
6677
  "docsTags": [
6647
6678
  {
@@ -6938,44 +6969,11 @@
6938
6969
  "filePath": "src/components/ic-loading-indicator/ic-loading-indicator.tsx",
6939
6970
  "encapsulation": "shadow",
6940
6971
  "tag": "ic-loading-indicator",
6941
- "readme": "# ic-loading\n\n\n",
6972
+ "readme": "# ic-loading\r\n\r\n\r\n\r",
6942
6973
  "docs": "",
6943
6974
  "docsTags": [],
6944
6975
  "usage": {},
6945
6976
  "props": [
6946
- {
6947
- "name": "appearance",
6948
- "type": "\"dark\" | \"light\"",
6949
- "complexType": {
6950
- "original": "IcThemeForegroundNoDefault",
6951
- "resolved": "\"dark\" | \"light\"",
6952
- "references": {
6953
- "IcThemeForegroundNoDefault": {
6954
- "location": "import",
6955
- "path": "../../utils/types",
6956
- "id": "src/utils/types.ts::IcThemeForegroundNoDefault"
6957
- }
6958
- }
6959
- },
6960
- "mutable": false,
6961
- "attr": "appearance",
6962
- "reflectToAttr": false,
6963
- "docs": "The appearance of the loading indicator, e.g. dark or light.",
6964
- "docsTags": [],
6965
- "default": "\"dark\"",
6966
- "values": [
6967
- {
6968
- "value": "dark",
6969
- "type": "string"
6970
- },
6971
- {
6972
- "value": "light",
6973
- "type": "string"
6974
- }
6975
- ],
6976
- "optional": true,
6977
- "required": false
6978
- },
6979
6977
  {
6980
6978
  "name": "description",
6981
6979
  "type": "string",
@@ -7110,6 +7108,28 @@
7110
7108
  "optional": true,
7111
7109
  "required": false
7112
7110
  },
7111
+ {
7112
+ "name": "monochrome",
7113
+ "type": "boolean",
7114
+ "complexType": {
7115
+ "original": "boolean",
7116
+ "resolved": "boolean",
7117
+ "references": {}
7118
+ },
7119
+ "mutable": false,
7120
+ "attr": "monochrome",
7121
+ "reflectToAttr": false,
7122
+ "docs": "If `true`, the element will display as black and white.",
7123
+ "docsTags": [],
7124
+ "default": "false",
7125
+ "values": [
7126
+ {
7127
+ "type": "boolean"
7128
+ }
7129
+ ],
7130
+ "optional": true,
7131
+ "required": false
7132
+ },
7113
7133
  {
7114
7134
  "name": "progress",
7115
7135
  "type": "number",
@@ -7172,6 +7192,43 @@
7172
7192
  "optional": true,
7173
7193
  "required": false
7174
7194
  },
7195
+ {
7196
+ "name": "theme",
7197
+ "type": "\"dark\" | \"inherit\" | \"light\"",
7198
+ "complexType": {
7199
+ "original": "IcThemeMode",
7200
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
7201
+ "references": {
7202
+ "IcThemeMode": {
7203
+ "location": "import",
7204
+ "path": "../../utils/types",
7205
+ "id": "src/utils/types.ts::IcThemeMode"
7206
+ }
7207
+ }
7208
+ },
7209
+ "mutable": false,
7210
+ "attr": "theme",
7211
+ "reflectToAttr": false,
7212
+ "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
7213
+ "docsTags": [],
7214
+ "default": "\"inherit\"",
7215
+ "values": [
7216
+ {
7217
+ "value": "dark",
7218
+ "type": "string"
7219
+ },
7220
+ {
7221
+ "value": "inherit",
7222
+ "type": "string"
7223
+ },
7224
+ {
7225
+ "value": "light",
7226
+ "type": "string"
7227
+ }
7228
+ ],
7229
+ "optional": false,
7230
+ "required": false
7231
+ },
7175
7232
  {
7176
7233
  "name": "type",
7177
7234
  "type": "\"circular\" | \"linear\"",
@@ -7254,7 +7311,7 @@
7254
7311
  "filePath": "src/components/ic-menu/ic-menu.tsx",
7255
7312
  "encapsulation": "scoped",
7256
7313
  "tag": "ic-menu",
7257
- "readme": "# ic-menu\n\n\n",
7314
+ "readme": "# ic-menu\r\n\r\n\r\n\r",
7258
7315
  "docs": "",
7259
7316
  "docsTags": [],
7260
7317
  "usage": {},
@@ -7682,7 +7739,7 @@
7682
7739
  "filePath": "src/components/ic-menu-group/ic-menu-group.tsx",
7683
7740
  "encapsulation": "shadow",
7684
7741
  "tag": "ic-menu-group",
7685
- "readme": "# ic-menu-group\n\n\n",
7742
+ "readme": "# ic-menu-group\r\n\r\n\r\n\r",
7686
7743
  "docs": "",
7687
7744
  "docsTags": [],
7688
7745
  "usage": {},
@@ -7729,7 +7786,7 @@
7729
7786
  "filePath": "src/components/ic-menu-item/ic-menu-item.tsx",
7730
7787
  "encapsulation": "shadow",
7731
7788
  "tag": "ic-menu-item",
7732
- "readme": "# ic-menu-item\n\n\n",
7789
+ "readme": "# ic-menu-item\r\n\r\n\r\n\r",
7733
7790
  "docs": "",
7734
7791
  "docsTags": [
7735
7792
  {
@@ -8073,7 +8130,7 @@
8073
8130
  "filePath": "src/components/ic-navigation-button/ic-navigation-button.tsx",
8074
8131
  "encapsulation": "shadow",
8075
8132
  "tag": "ic-navigation-button",
8076
- "readme": "# ic-navigation-button\n\n\n",
8133
+ "readme": "# ic-navigation-button\r\n\r\n\r\n\r",
8077
8134
  "docs": "",
8078
8135
  "docsTags": [
8079
8136
  {
@@ -8357,7 +8414,7 @@
8357
8414
  "filePath": "src/components/ic-navigation-group/ic-navigation-group.tsx",
8358
8415
  "encapsulation": "shadow",
8359
8416
  "tag": "ic-navigation-group",
8360
- "readme": "# ic-navigation-group\n\n\n",
8417
+ "readme": "# ic-navigation-group\r\n\r\n\r\n\r",
8361
8418
  "docs": "",
8362
8419
  "docsTags": [],
8363
8420
  "usage": {},
@@ -8472,7 +8529,7 @@
8472
8529
  "filePath": "src/components/ic-navigation-item/ic-navigation-item.tsx",
8473
8530
  "encapsulation": "shadow",
8474
8531
  "tag": "ic-navigation-item",
8475
- "readme": "# ic-navigation-item\n\n\n",
8532
+ "readme": "# ic-navigation-item\r\n\r\n\r\n\r",
8476
8533
  "docs": "",
8477
8534
  "docsTags": [
8478
8535
  {
@@ -8777,7 +8834,7 @@
8777
8834
  "filePath": "src/components/ic-navigation-menu/ic-navigation-menu.tsx",
8778
8835
  "encapsulation": "shadow",
8779
8836
  "tag": "ic-navigation-menu",
8780
- "readme": "# ic-navigation-menu\n\n\n",
8837
+ "readme": "# ic-navigation-menu\r\n\r\n\r\n\r",
8781
8838
  "docs": "",
8782
8839
  "docsTags": [
8783
8840
  {
@@ -8900,7 +8957,7 @@
8900
8957
  "filePath": "src/components/ic-page-header/ic-page-header.tsx",
8901
8958
  "encapsulation": "shadow",
8902
8959
  "tag": "ic-page-header",
8903
- "readme": "# ic-page-header\n\n\n",
8960
+ "readme": "# ic-page-header\r\n\r\n\r\n\r",
8904
8961
  "docs": "",
8905
8962
  "docsTags": [
8906
8963
  {
@@ -9215,7 +9272,7 @@
9215
9272
  "filePath": "src/components/ic-pagination/ic-pagination.tsx",
9216
9273
  "encapsulation": "shadow",
9217
9274
  "tag": "ic-pagination",
9218
- "readme": "# ic-pagination\n\n\n",
9275
+ "readme": "# ic-pagination\r\n\r\n\r\n\r",
9219
9276
  "docs": "",
9220
9277
  "docsTags": [],
9221
9278
  "usage": {},
@@ -9590,7 +9647,7 @@
9590
9647
  "filePath": "src/components/ic-pagination-item/ic-pagination-item.tsx",
9591
9648
  "encapsulation": "shadow",
9592
9649
  "tag": "ic-pagination-item",
9593
- "readme": "# ic-pagination-item\n\n\n",
9650
+ "readme": "# ic-pagination-item\r\n\r\n\r\n\r",
9594
9651
  "docs": "",
9595
9652
  "docsTags": [],
9596
9653
  "usage": {},
@@ -9781,7 +9838,7 @@
9781
9838
  "filePath": "src/components/ic-popover-menu/ic-popover-menu.tsx",
9782
9839
  "encapsulation": "shadow",
9783
9840
  "tag": "ic-popover-menu",
9784
- "readme": "# ic-popover-menu\n\nThis is a wrapper component to be placed around one or more ic-menu-item components.\n",
9841
+ "readme": "# ic-popover-menu\r\n\r\nThis is a wrapper component to be placed around one or more ic-menu-item components.\r\n\r",
9785
9842
  "docs": "This is a wrapper component to be placed around one or more ic-menu-item components.",
9786
9843
  "docsTags": [],
9787
9844
  "usage": {},
@@ -9940,7 +9997,7 @@
9940
9997
  "filePath": "src/components/ic-radio-group/ic-radio-group.tsx",
9941
9998
  "encapsulation": "shadow",
9942
9999
  "tag": "ic-radio-group",
9943
- "readme": "# ic-radio-group\n\n\n",
10000
+ "readme": "# ic-radio-group\r\n\r\n\r\n\r",
9944
10001
  "docs": "",
9945
10002
  "docsTags": [],
9946
10003
  "usage": {},
@@ -10263,7 +10320,7 @@
10263
10320
  "filePath": "src/components/ic-radio-option/ic-radio-option.tsx",
10264
10321
  "encapsulation": "none",
10265
10322
  "tag": "ic-radio-option",
10266
- "readme": "# ic-radio-option\n\n\n",
10323
+ "readme": "# ic-radio-option\r\n\r\n\r\n\r",
10267
10324
  "docs": "",
10268
10325
  "docsTags": [
10269
10326
  {
@@ -10567,7 +10624,7 @@
10567
10624
  "filePath": "src/components/ic-search-bar/ic-search-bar.tsx",
10568
10625
  "encapsulation": "shadow",
10569
10626
  "tag": "ic-search-bar",
10570
- "readme": "# ic-search-bar\n\n\n",
10627
+ "readme": "# ic-search-bar\r\n\r\n\r\n\r",
10571
10628
  "docs": "",
10572
10629
  "docsTags": [],
10573
10630
  "usage": {},
@@ -11755,7 +11812,7 @@
11755
11812
  "filePath": "src/components/ic-section-container/ic-section-container.tsx",
11756
11813
  "encapsulation": "shadow",
11757
11814
  "tag": "ic-section-container",
11758
- "readme": "# ic-section-container\n\n\n",
11815
+ "readme": "# ic-section-container\r\n\r\n\r\n\r",
11759
11816
  "docs": "",
11760
11817
  "docsTags": [],
11761
11818
  "usage": {},
@@ -11856,7 +11913,7 @@
11856
11913
  "filePath": "src/components/ic-select/ic-select.tsx",
11857
11914
  "encapsulation": "shadow",
11858
11915
  "tag": "ic-select",
11859
- "readme": "# ic-select\n\n\n",
11916
+ "readme": "# ic-select\r\n\r\n\r\n\r",
11860
11917
  "docs": "",
11861
11918
  "docsTags": [
11862
11919
  {
@@ -12771,7 +12828,7 @@
12771
12828
  "filePath": "src/components/ic-side-navigation/ic-side-navigation.tsx",
12772
12829
  "encapsulation": "shadow",
12773
12830
  "tag": "ic-side-navigation",
12774
- "readme": "# ic-side-navigation\n\n\n",
12831
+ "readme": "# ic-side-navigation\r\n\r\n\r\n\r",
12775
12832
  "docs": "",
12776
12833
  "docsTags": [
12777
12834
  {
@@ -13096,28 +13153,38 @@
13096
13153
  "filePath": "src/components/ic-skeleton/ic-skeleton.tsx",
13097
13154
  "encapsulation": "shadow",
13098
13155
  "tag": "ic-skeleton",
13099
- "readme": "# ic-skeleton\n\nWhen using the skeleton component, an aria-live level should be applied to the parent element of the skeleton and the element that it is\nrepresenting so that any changes, such as the real element replacing the skeleton placeholder, are announced to assistive technology like screen readers. The recommendation is to use aria-live=\"polite\" over aria-live=\"recommended\" unless changes are critically important. \n",
13100
- "docs": "When using the skeleton component, an aria-live level should be applied to the parent element of the skeleton and the element that it is\nrepresenting so that any changes, such as the real element replacing the skeleton placeholder, are announced to assistive technology like screen readers. The recommendation is to use aria-live=\"polite\" over aria-live=\"recommended\" unless changes are critically important.",
13156
+ "readme": "# ic-skeleton\r\n\r\nWhen using the skeleton component, an aria-live level should be applied to the parent element of the skeleton and the element that it is\r\nrepresenting so that any changes, such as the real element replacing the skeleton placeholder, are announced to assistive technology like screen readers. The recommendation is to use aria-live=\"polite\" over aria-live=\"recommended\" unless changes are critically important. \r\n\r",
13157
+ "docs": "When using the skeleton component, an aria-live level should be applied to the parent element of the skeleton and the element that it is\r\nrepresenting so that any changes, such as the real element replacing the skeleton placeholder, are announced to assistive technology like screen readers. The recommendation is to use aria-live=\"polite\" over aria-live=\"recommended\" unless changes are critically important.",
13101
13158
  "docsTags": [],
13102
13159
  "usage": {},
13103
13160
  "props": [
13104
13161
  {
13105
- "name": "appearance",
13106
- "type": "\"default\" | \"light\"",
13162
+ "name": "theme",
13163
+ "type": "\"dark\" | \"inherit\" | \"light\"",
13107
13164
  "complexType": {
13108
- "original": "\"light\" | \"default\"",
13109
- "resolved": "\"default\" | \"light\"",
13110
- "references": {}
13165
+ "original": "IcThemeMode",
13166
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
13167
+ "references": {
13168
+ "IcThemeMode": {
13169
+ "location": "import",
13170
+ "path": "../../utils/types",
13171
+ "id": "src/utils/types.ts::IcThemeMode"
13172
+ }
13173
+ }
13111
13174
  },
13112
13175
  "mutable": false,
13113
- "attr": "appearance",
13176
+ "attr": "theme",
13114
13177
  "reflectToAttr": false,
13115
- "docs": "The appearance of the skeleton.",
13178
+ "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
13116
13179
  "docsTags": [],
13117
- "default": "\"default\"",
13180
+ "default": "\"inherit\"",
13118
13181
  "values": [
13119
13182
  {
13120
- "value": "default",
13183
+ "value": "dark",
13184
+ "type": "string"
13185
+ },
13186
+ {
13187
+ "value": "inherit",
13121
13188
  "type": "string"
13122
13189
  },
13123
13190
  {
@@ -13180,7 +13247,7 @@
13180
13247
  "filePath": "src/components/ic-status-tag/ic-status-tag.tsx",
13181
13248
  "encapsulation": "shadow",
13182
13249
  "tag": "ic-status-tag",
13183
- "readme": "# ic-status-tag\n\n\n",
13250
+ "readme": "# ic-status-tag\r\n\r\n\r\n\r",
13184
13251
  "docs": "",
13185
13252
  "docsTags": [],
13186
13253
  "usage": {},
@@ -13391,7 +13458,7 @@
13391
13458
  "filePath": "src/components/ic-step/ic-step.tsx",
13392
13459
  "encapsulation": "shadow",
13393
13460
  "tag": "ic-step",
13394
- "readme": "# ic-step\n\n\n",
13461
+ "readme": "# ic-step\r\n\r\n\r\n\r",
13395
13462
  "docs": "",
13396
13463
  "docsTags": [],
13397
13464
  "usage": {},
@@ -13537,7 +13604,7 @@
13537
13604
  "filePath": "src/components/ic-stepper/ic-stepper.tsx",
13538
13605
  "encapsulation": "shadow",
13539
13606
  "tag": "ic-stepper",
13540
- "readme": "# ic-stepper\n\nThis is a wrapper component to be placed around one or more ic-step components\n",
13607
+ "readme": "# ic-stepper\r\n\r\nThis is a wrapper component to be placed around one or more ic-step components\r\n\r",
13541
13608
  "docs": "This is a wrapper component to be placed around one or more ic-step components",
13542
13609
  "docsTags": [],
13543
13610
  "usage": {},
@@ -13575,33 +13642,6 @@
13575
13642
  "optional": true,
13576
13643
  "required": false
13577
13644
  },
13578
- {
13579
- "name": "appearance",
13580
- "type": "\"default\" | \"light\"",
13581
- "complexType": {
13582
- "original": "\"light\" | \"default\"",
13583
- "resolved": "\"default\" | \"light\"",
13584
- "references": {}
13585
- },
13586
- "mutable": false,
13587
- "attr": "appearance",
13588
- "reflectToAttr": false,
13589
- "docs": "The appearance of the stepper.",
13590
- "docsTags": [],
13591
- "default": "\"default\"",
13592
- "values": [
13593
- {
13594
- "value": "default",
13595
- "type": "string"
13596
- },
13597
- {
13598
- "value": "light",
13599
- "type": "string"
13600
- }
13601
- ],
13602
- "optional": true,
13603
- "required": false
13604
- },
13605
13645
  {
13606
13646
  "name": "connectorWidth",
13607
13647
  "type": "number",
@@ -13646,6 +13686,43 @@
13646
13686
  "optional": true,
13647
13687
  "required": false
13648
13688
  },
13689
+ {
13690
+ "name": "theme",
13691
+ "type": "\"dark\" | \"inherit\" | \"light\"",
13692
+ "complexType": {
13693
+ "original": "IcThemeMode",
13694
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
13695
+ "references": {
13696
+ "IcThemeMode": {
13697
+ "location": "import",
13698
+ "path": "../../utils/types",
13699
+ "id": "src/utils/types.ts::IcThemeMode"
13700
+ }
13701
+ }
13702
+ },
13703
+ "mutable": false,
13704
+ "attr": "theme",
13705
+ "reflectToAttr": false,
13706
+ "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
13707
+ "docsTags": [],
13708
+ "default": "\"inherit\"",
13709
+ "values": [
13710
+ {
13711
+ "value": "dark",
13712
+ "type": "string"
13713
+ },
13714
+ {
13715
+ "value": "inherit",
13716
+ "type": "string"
13717
+ },
13718
+ {
13719
+ "value": "light",
13720
+ "type": "string"
13721
+ }
13722
+ ],
13723
+ "optional": true,
13724
+ "required": false
13725
+ },
13649
13726
  {
13650
13727
  "name": "variant",
13651
13728
  "type": "\"compact\" | \"default\"",
@@ -13694,7 +13771,7 @@
13694
13771
  "filePath": "src/components/ic-switch/ic-switch.tsx",
13695
13772
  "encapsulation": "shadow",
13696
13773
  "tag": "ic-switch",
13697
- "readme": "# ic-switch\n\n\n",
13774
+ "readme": "# ic-switch\r\n\r\n\r\n\r",
13698
13775
  "docs": "",
13699
13776
  "docsTags": [
13700
13777
  {
@@ -14015,7 +14092,7 @@
14015
14092
  "filePath": "src/components/ic-tab/ic-tab.tsx",
14016
14093
  "encapsulation": "shadow",
14017
14094
  "tag": "ic-tab",
14018
- "readme": "# ic-tab\n\n\n",
14095
+ "readme": "# ic-tab\r\n\r\n\r\n\r",
14019
14096
  "docs": "",
14020
14097
  "docsTags": [
14021
14098
  {
@@ -14104,7 +14181,7 @@
14104
14181
  "filePath": "src/components/ic-tab-context/ic-tab-context.tsx",
14105
14182
  "encapsulation": "none",
14106
14183
  "tag": "ic-tab-context",
14107
- "readme": "# ic-tab-context\n\n\n",
14184
+ "readme": "# ic-tab-context\r\n\r\n\r\n\r",
14108
14185
  "docs": "",
14109
14186
  "docsTags": [],
14110
14187
  "usage": {},
@@ -14301,7 +14378,7 @@
14301
14378
  "filePath": "src/components/ic-tab-group/ic-tab-group.tsx",
14302
14379
  "encapsulation": "shadow",
14303
14380
  "tag": "ic-tab-group",
14304
- "readme": "# ic-tab-group\n\n\n",
14381
+ "readme": "# ic-tab-group\r\n\r\n\r\n\r",
14305
14382
  "docs": "",
14306
14383
  "docsTags": [],
14307
14384
  "usage": {},
@@ -14383,7 +14460,7 @@
14383
14460
  "filePath": "src/components/ic-tab-panel/ic-tab-panel.tsx",
14384
14461
  "encapsulation": "shadow",
14385
14462
  "tag": "ic-tab-panel",
14386
- "readme": "# ic-tab-panel\n\n\n",
14463
+ "readme": "# ic-tab-panel\r\n\r\n\r\n\r",
14387
14464
  "docs": "",
14388
14465
  "docsTags": [],
14389
14466
  "usage": {},
@@ -14402,7 +14479,7 @@
14402
14479
  "filePath": "src/components/ic-text-field/ic-text-field.tsx",
14403
14480
  "encapsulation": "shadow",
14404
14481
  "tag": "ic-text-field",
14405
- "readme": "# ic-textfield\n\n\n",
14482
+ "readme": "# ic-textfield\r\n\r\n\r\n\r",
14406
14483
  "docs": "",
14407
14484
  "docsTags": [
14408
14485
  {
@@ -15582,7 +15659,7 @@
15582
15659
  "filePath": "src/components/ic-theme/ic-theme.tsx",
15583
15660
  "encapsulation": "none",
15584
15661
  "tag": "ic-theme",
15585
- "readme": "# ic-theme\n\n\n",
15662
+ "readme": "# ic-theme\r\n\r\n\r\n\r",
15586
15663
  "docs": "",
15587
15664
  "docsTags": [],
15588
15665
  "usage": {},
@@ -15667,7 +15744,7 @@
15667
15744
  "filePath": "src/components/ic-toast/ic-toast.tsx",
15668
15745
  "encapsulation": "shadow",
15669
15746
  "tag": "ic-toast",
15670
- "readme": "# ic-toast\n\n\n",
15747
+ "readme": "# ic-toast\r\n\r\n\r\n\r",
15671
15748
  "docs": "",
15672
15749
  "docsTags": [
15673
15750
  {
@@ -15952,7 +16029,7 @@
15952
16029
  "filePath": "src/components/ic-toast-region/ic-toast-region.tsx",
15953
16030
  "encapsulation": "none",
15954
16031
  "tag": "ic-toast-region",
15955
- "readme": "# ic-toast-region\n\n\n",
16032
+ "readme": "# ic-toast-region\r\n\r\n\r\n\r",
15956
16033
  "docs": "",
15957
16034
  "docsTags": [],
15958
16035
  "usage": {},
@@ -16003,7 +16080,7 @@
16003
16080
  "filePath": "src/components/ic-toggle-button/ic-toggle-button.tsx",
16004
16081
  "encapsulation": "shadow",
16005
16082
  "tag": "ic-toggle-button",
16006
- "readme": "# ic-toggle-button\n\n\n",
16083
+ "readme": "# ic-toggle-button\r\n\r\n\r\n\r",
16007
16084
  "docs": "",
16008
16085
  "docsTags": [
16009
16086
  {
@@ -16339,7 +16416,7 @@
16339
16416
  "filePath": "src/components/ic-toggle-button-group/ic-toggle-button-group.tsx",
16340
16417
  "encapsulation": "shadow",
16341
16418
  "tag": "ic-toggle-button-group",
16342
- "readme": "# ic-toggle-button-group\n\n\n",
16419
+ "readme": "# ic-toggle-button-group\r\n\r\n\r\n\r",
16343
16420
  "docs": "",
16344
16421
  "docsTags": [],
16345
16422
  "usage": {},
@@ -16671,7 +16748,7 @@
16671
16748
  "filePath": "src/components/ic-tooltip/ic-tooltip.tsx",
16672
16749
  "encapsulation": "shadow",
16673
16750
  "tag": "ic-tooltip",
16674
- "readme": "# ic-tooltip\n\n\n",
16751
+ "readme": "# ic-tooltip\r\n\r\n\r\n\r",
16675
16752
  "docs": "",
16676
16753
  "docsTags": [],
16677
16754
  "usage": {},
@@ -16969,7 +17046,7 @@
16969
17046
  "filePath": "src/components/ic-top-navigation/ic-top-navigation.tsx",
16970
17047
  "encapsulation": "shadow",
16971
17048
  "tag": "ic-top-navigation",
16972
- "readme": "# ic-top-navigation\n\n\n",
17049
+ "readme": "# ic-top-navigation\r\n\r\n\r\n\r",
16973
17050
  "docs": "",
16974
17051
  "docsTags": [
16975
17052
  {
@@ -17328,7 +17405,7 @@
17328
17405
  "filePath": "src/components/ic-typography/ic-typography.tsx",
17329
17406
  "encapsulation": "shadow",
17330
17407
  "tag": "ic-typography",
17331
- "readme": "# ic-typography\n\n\n",
17408
+ "readme": "# ic-typography\r\n\r\n\r\n\r",
17332
17409
  "docs": "",
17333
17410
  "docsTags": [],
17334
17411
  "usage": {},
@@ -17917,11 +17994,6 @@
17917
17994
  "docstring": "",
17918
17995
  "path": "src/components/ic-input-validation/ic-input-validation.types.tsx"
17919
17996
  },
17920
- "src/utils/types.ts::IcThemeForegroundNoDefault": {
17921
- "declaration": "export type IcThemeForegroundNoDefault = \"dark\" | \"light\";",
17922
- "docstring": "",
17923
- "path": "src/utils/types.ts"
17924
- },
17925
17997
  "src/components/ic-loading-indicator/ic-loading-indicator.types.tsx::IcLoadingSizes": {
17926
17998
  "declaration": "export type IcLoadingSizes = \"medium\" | \"small\" | \"large\" | \"icon\";",
17927
17999
  "docstring": "",
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.1",
4
+ "version": "3.0.0-alpha.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": "1c5671823f89c50f5e16d4f40e1bc15ae2310518"
21
+ "gitHead": "59d0e036de6def6644421e17bf1c5591eac0e34a"
22
22
  }