@ukic/canary-docs 3.0.0-canary.4 → 3.0.0-canary.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 +203 -54
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -9,7 +9,7 @@
9
9
  "filePath": "src/components/ic-card-horizontal/ic-card-horizontal.tsx",
10
10
  "encapsulation": "shadow",
11
11
  "tag": "ic-card-horizontal",
12
- "readme": "# ic-horizontal-card\r\n\r\n\r\n\r",
12
+ "readme": "# ic-horizontal-card\n\n\n",
13
13
  "docs": "",
14
14
  "docsTags": [
15
15
  {
@@ -376,7 +376,7 @@
376
376
  "passive": false
377
377
  },
378
378
  {
379
- "event": "themeChange",
379
+ "event": "brandChange",
380
380
  "target": "document",
381
381
  "capture": false,
382
382
  "passive": false
@@ -426,7 +426,7 @@
426
426
  "filePath": "src/components/ic-data-table/ic-data-table.tsx",
427
427
  "encapsulation": "shadow",
428
428
  "tag": "ic-data-table",
429
- "readme": "# ic-data-table\r\n\r\n\r\n\r",
429
+ "readme": "# ic-data-table\n\n\n",
430
430
  "docs": "",
431
431
  "docsTags": [
432
432
  {
@@ -544,7 +544,7 @@
544
544
  "type": "IcDataTableDataType[]"
545
545
  }
546
546
  ],
547
- "optional": false,
547
+ "optional": true,
548
548
  "required": false
549
549
  },
550
550
  {
@@ -705,17 +705,11 @@
705
705
  },
706
706
  {
707
707
  "name": "loadingOptions",
708
- "type": "{ appearance?: IcThemeForegroundNoDefault; description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }",
708
+ "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }",
709
709
  "complexType": {
710
- "original": "{\n appearance?: IcThemeForegroundNoDefault;\n description?: string;\n label?: string;\n labelDuration?: number;\n max?: number;\n min?: number;\n progress?: number;\n showBackground?: boolean;\n monochrome?: boolean;\n }",
711
- "resolved": "{ appearance?: IcThemeForegroundNoDefault; description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }",
712
- "references": {
713
- "IcThemeForegroundNoDefault": {
714
- "location": "import",
715
- "path": "@ukic/web-components/dist/types/utils/types",
716
- "id": "../web-components/dist/types/utils/types.d.ts::IcThemeForegroundNoDefault"
717
- }
718
- }
710
+ "original": "{\n description?: string;\n label?: string;\n labelDuration?: number;\n max?: number;\n min?: number;\n progress?: number;\n showBackground?: boolean;\n monochrome?: boolean;\n }",
711
+ "resolved": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }",
712
+ "references": {}
719
713
  },
720
714
  "mutable": false,
721
715
  "reflectToAttr": false,
@@ -723,7 +717,7 @@
723
717
  "docsTags": [],
724
718
  "values": [
725
719
  {
726
- "type": "{ appearance?: IcThemeForegroundNoDefault; description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }"
720
+ "type": "{ description?: string; label?: string; labelDuration?: number; max?: number; min?: number; progress?: number; showBackground?: boolean; monochrome?: boolean; }"
727
721
  }
728
722
  ],
729
723
  "optional": true,
@@ -811,7 +805,7 @@
811
805
  "reflectToAttr": false,
812
806
  "docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
813
807
  "docsTags": [],
814
- "default": "{\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n rangeLabelType: \"page\",\n type: \"simple\",\n showItemsPerPageControl: true,\n showGoToPageControl: true,\n alignment: \"right\",\n itemLabel: \"Item\",\n pageLabel: \"Page\",\n hideRangeLabel: false,\n hideAllFromItemsPerPage: false,\n theme: \"inherit\",\n monochrome: false,\n }",
808
+ "default": "{\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n rangeLabelType: \"page\",\n type: \"simple\",\n showItemsPerPageControl: true,\n showGoToPageControl: true,\n alignment: \"right\",\n itemLabel: \"Item\",\n pageLabel: \"Page\",\n hideRangeLabel: false,\n hideAllFromItemsPerPage: false,\n monochrome: false,\n }",
815
809
  "values": [
816
810
  {
817
811
  "type": "IcPaginationBarOptions"
@@ -962,6 +956,43 @@
962
956
  "optional": true,
963
957
  "required": false
964
958
  },
959
+ {
960
+ "name": "theme",
961
+ "type": "\"dark\" | \"inherit\" | \"light\"",
962
+ "complexType": {
963
+ "original": "IcThemeMode",
964
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
965
+ "references": {
966
+ "IcThemeMode": {
967
+ "location": "import",
968
+ "path": "../../utils/types",
969
+ "id": "src/utils/types.ts::IcThemeMode"
970
+ }
971
+ }
972
+ },
973
+ "mutable": false,
974
+ "attr": "theme",
975
+ "reflectToAttr": false,
976
+ "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.",
977
+ "docsTags": [],
978
+ "default": "\"inherit\"",
979
+ "values": [
980
+ {
981
+ "value": "dark",
982
+ "type": "string"
983
+ },
984
+ {
985
+ "value": "inherit",
986
+ "type": "string"
987
+ },
988
+ {
989
+ "value": "light",
990
+ "type": "string"
991
+ }
992
+ ],
993
+ "optional": true,
994
+ "required": false
995
+ },
965
996
  {
966
997
  "name": "truncationPattern",
967
998
  "type": "\"show-hide\" | \"tooltip\"",
@@ -1018,17 +1049,11 @@
1018
1049
  },
1019
1050
  {
1020
1051
  "name": "updatingOptions",
1021
- "type": "{ appearance?: IcThemeForegroundNoDefault; description?: string; max?: number; min?: number; progress?: number; monochrome?: boolean; }",
1052
+ "type": "{ description?: string; max?: number; min?: number; progress?: number; monochrome?: boolean; }",
1022
1053
  "complexType": {
1023
- "original": "{\n appearance?: IcThemeForegroundNoDefault;\n description?: string;\n max?: number;\n min?: number;\n progress?: number;\n monochrome?: boolean;\n }",
1024
- "resolved": "{ appearance?: IcThemeForegroundNoDefault; description?: string; max?: number; min?: number; progress?: number; monochrome?: boolean; }",
1025
- "references": {
1026
- "IcThemeForegroundNoDefault": {
1027
- "location": "import",
1028
- "path": "@ukic/web-components/dist/types/utils/types",
1029
- "id": "../web-components/dist/types/utils/types.d.ts::IcThemeForegroundNoDefault"
1030
- }
1031
- }
1054
+ "original": "{\n description?: string;\n max?: number;\n min?: number;\n progress?: number;\n monochrome?: boolean;\n }",
1055
+ "resolved": "{ description?: string; max?: number; min?: number; progress?: number; monochrome?: boolean; }",
1056
+ "references": {}
1032
1057
  },
1033
1058
  "mutable": false,
1034
1059
  "reflectToAttr": false,
@@ -1036,7 +1061,7 @@
1036
1061
  "docsTags": [],
1037
1062
  "values": [
1038
1063
  {
1039
- "type": "{ appearance?: IcThemeForegroundNoDefault; description?: string; max?: number; min?: number; progress?: number; monochrome?: boolean; }"
1064
+ "type": "{ description?: string; max?: number; min?: number; progress?: number; monochrome?: boolean; }"
1040
1065
  }
1041
1066
  ],
1042
1067
  "optional": true,
@@ -1295,7 +1320,7 @@
1295
1320
  "filePath": "src/components/ic-data-table-title-bar/ic-data-table-title-bar.tsx",
1296
1321
  "encapsulation": "shadow",
1297
1322
  "tag": "ic-data-table-title-bar",
1298
- "readme": "# ic-data-table-title-bar\r\n\r\n\r\n\r",
1323
+ "readme": "# ic-data-table-title-bar\n\n\n",
1299
1324
  "docs": "",
1300
1325
  "docsTags": [
1301
1326
  {
@@ -1494,7 +1519,7 @@
1494
1519
  "filePath": "src/components/ic-date-input/ic-date-input.tsx",
1495
1520
  "encapsulation": "shadow",
1496
1521
  "tag": "ic-date-input",
1497
- "readme": "# ic-date-input\r\n\r\n\r\n\r",
1522
+ "readme": "# ic-date-input\n\n\n",
1498
1523
  "docs": "",
1499
1524
  "docsTags": [],
1500
1525
  "usage": {},
@@ -1988,6 +2013,43 @@
1988
2013
  "optional": true,
1989
2014
  "required": false
1990
2015
  },
2016
+ {
2017
+ "name": "theme",
2018
+ "type": "\"dark\" | \"inherit\" | \"light\"",
2019
+ "complexType": {
2020
+ "original": "IcThemeMode",
2021
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
2022
+ "references": {
2023
+ "IcThemeMode": {
2024
+ "location": "import",
2025
+ "path": "../../utils/types",
2026
+ "id": "src/utils/types.ts::IcThemeMode"
2027
+ }
2028
+ }
2029
+ },
2030
+ "mutable": false,
2031
+ "attr": "theme",
2032
+ "reflectToAttr": false,
2033
+ "docs": "Sets the date picker to the dark or light theme colors. \"inherit\" will set the color based on the system settings or ic-theme component.",
2034
+ "docsTags": [],
2035
+ "default": "\"inherit\"",
2036
+ "values": [
2037
+ {
2038
+ "value": "dark",
2039
+ "type": "string"
2040
+ },
2041
+ {
2042
+ "value": "inherit",
2043
+ "type": "string"
2044
+ },
2045
+ {
2046
+ "value": "light",
2047
+ "type": "string"
2048
+ }
2049
+ ],
2050
+ "optional": true,
2051
+ "required": false
2052
+ },
1991
2053
  {
1992
2054
  "name": "validationStatus",
1993
2055
  "type": "\"\" | \"error\" | \"success\" | \"warning\"",
@@ -2220,7 +2282,7 @@
2220
2282
  "filePath": "src/components/ic-date-picker/ic-date-picker.tsx",
2221
2283
  "encapsulation": "shadow",
2222
2284
  "tag": "ic-date-picker",
2223
- "readme": "# ic-date-picker\r\n\r\n\r\n\r",
2285
+ "readme": "# ic-date-picker\n\n\n",
2224
2286
  "docs": "",
2225
2287
  "docsTags": [],
2226
2288
  "usage": {},
@@ -2832,6 +2894,43 @@
2832
2894
  "optional": true,
2833
2895
  "required": false
2834
2896
  },
2897
+ {
2898
+ "name": "theme",
2899
+ "type": "\"dark\" | \"inherit\" | \"light\"",
2900
+ "complexType": {
2901
+ "original": "IcThemeMode",
2902
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
2903
+ "references": {
2904
+ "IcThemeMode": {
2905
+ "location": "import",
2906
+ "path": "../../utils/types",
2907
+ "id": "src/utils/types.ts::IcThemeMode"
2908
+ }
2909
+ }
2910
+ },
2911
+ "mutable": false,
2912
+ "attr": "theme",
2913
+ "reflectToAttr": false,
2914
+ "docs": "Sets the date picker to the dark or light theme colors. \"inherit\" will set the color based on the system settings or ic-theme component.",
2915
+ "docsTags": [],
2916
+ "default": "\"inherit\"",
2917
+ "values": [
2918
+ {
2919
+ "value": "dark",
2920
+ "type": "string"
2921
+ },
2922
+ {
2923
+ "value": "inherit",
2924
+ "type": "string"
2925
+ },
2926
+ {
2927
+ "value": "light",
2928
+ "type": "string"
2929
+ }
2930
+ ],
2931
+ "optional": true,
2932
+ "required": false
2933
+ },
2835
2934
  {
2836
2935
  "name": "validationStatus",
2837
2936
  "type": "\"\" | \"error\" | \"success\" | \"warning\"",
@@ -3015,7 +3114,7 @@
3015
3114
  "filePath": "src/components/ic-pagination-bar/ic-pagination-bar.tsx",
3016
3115
  "encapsulation": "shadow",
3017
3116
  "tag": "ic-pagination-bar",
3018
- "readme": "# ic-pagination-bar\r\n\r\n\r\n\r",
3117
+ "readme": "# ic-pagination-bar\n\n\n",
3019
3118
  "docs": "",
3020
3119
  "docsTags": [],
3021
3120
  "usage": {},
@@ -3295,8 +3394,8 @@
3295
3394
  "references": {
3296
3395
  "IcThemeMode": {
3297
3396
  "location": "import",
3298
- "path": "@ukic/web-components/dist/types/interface",
3299
- "id": "../web-components/dist/types/interface.d.ts::IcThemeMode"
3397
+ "path": "../../utils/types",
3398
+ "id": "src/utils/types.ts::IcThemeMode"
3300
3399
  }
3301
3400
  }
3302
3401
  },
@@ -3498,7 +3597,7 @@
3498
3597
  "filePath": "src/components/ic-tree-item/ic-tree-item.tsx",
3499
3598
  "encapsulation": "shadow",
3500
3599
  "tag": "ic-tree-item",
3501
- "readme": "# ic-tree-item\r\n\r\n\r\n\r",
3600
+ "readme": "# ic-tree-item\n\n\n",
3502
3601
  "docs": "",
3503
3602
  "docsTags": [
3504
3603
  {
@@ -3756,8 +3855,8 @@
3756
3855
  "references": {
3757
3856
  "IcThemeMode": {
3758
3857
  "location": "import",
3759
- "path": "@ukic/web-components",
3760
- "id": "../web-components/dist/types/interface.d.ts::IcThemeMode"
3858
+ "path": "../../utils/types",
3859
+ "id": "src/utils/types.ts::IcThemeMode"
3761
3860
  }
3762
3861
  }
3763
3862
  },
@@ -3783,6 +3882,27 @@
3783
3882
  ],
3784
3883
  "optional": true,
3785
3884
  "required": false
3885
+ },
3886
+ {
3887
+ "name": "truncateTreeItem",
3888
+ "type": "boolean",
3889
+ "complexType": {
3890
+ "original": "boolean",
3891
+ "resolved": "boolean",
3892
+ "references": {}
3893
+ },
3894
+ "mutable": false,
3895
+ "attr": "truncate-tree-item",
3896
+ "reflectToAttr": false,
3897
+ "docs": "If `true`, the tree item label will be truncated instead of text wrapping.",
3898
+ "docsTags": [],
3899
+ "values": [
3900
+ {
3901
+ "type": "boolean"
3902
+ }
3903
+ ],
3904
+ "optional": true,
3905
+ "required": false
3786
3906
  }
3787
3907
  ],
3788
3908
  "methods": [
@@ -3867,7 +3987,7 @@
3867
3987
  "filePath": "src/components/ic-tree-view/ic-tree-view.tsx",
3868
3988
  "encapsulation": "shadow",
3869
3989
  "tag": "ic-tree-view",
3870
- "readme": "# ic-tree-view\r\n\r\n\r\n\r",
3990
+ "readme": "# ic-tree-view\n\n\n",
3871
3991
  "docs": "",
3872
3992
  "docsTags": [
3873
3993
  {
@@ -3971,8 +4091,8 @@
3971
4091
  "references": {
3972
4092
  "IcThemeMode": {
3973
4093
  "location": "import",
3974
- "path": "@ukic/web-components",
3975
- "id": "../web-components/dist/types/interface.d.ts::IcThemeMode"
4094
+ "path": "../../utils/types",
4095
+ "id": "src/utils/types.ts::IcThemeMode"
3976
4096
  }
3977
4097
  }
3978
4098
  },
@@ -3998,6 +4118,50 @@
3998
4118
  ],
3999
4119
  "optional": true,
4000
4120
  "required": false
4121
+ },
4122
+ {
4123
+ "name": "truncateHeading",
4124
+ "type": "boolean",
4125
+ "complexType": {
4126
+ "original": "boolean",
4127
+ "resolved": "boolean",
4128
+ "references": {}
4129
+ },
4130
+ "mutable": false,
4131
+ "attr": "truncate-heading",
4132
+ "reflectToAttr": false,
4133
+ "docs": "If `true`, the tree view heading will be truncated instead of text wrapping.",
4134
+ "docsTags": [],
4135
+ "default": "false",
4136
+ "values": [
4137
+ {
4138
+ "type": "boolean"
4139
+ }
4140
+ ],
4141
+ "optional": true,
4142
+ "required": false
4143
+ },
4144
+ {
4145
+ "name": "truncateTreeItems",
4146
+ "type": "boolean",
4147
+ "complexType": {
4148
+ "original": "boolean",
4149
+ "resolved": "boolean",
4150
+ "references": {}
4151
+ },
4152
+ "mutable": false,
4153
+ "attr": "truncate-tree-items",
4154
+ "reflectToAttr": false,
4155
+ "docs": "If `true`, tree items will be truncated, unless they are individually overridden.",
4156
+ "docsTags": [],
4157
+ "default": "false",
4158
+ "values": [
4159
+ {
4160
+ "type": "boolean"
4161
+ }
4162
+ ],
4163
+ "optional": true,
4164
+ "required": false
4001
4165
  }
4002
4166
  ],
4003
4167
  "methods": [],
@@ -4074,11 +4238,6 @@
4074
4238
  "docstring": "",
4075
4239
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
4076
4240
  },
4077
- "../web-components/dist/types/utils/types.d.ts::IcThemeForegroundNoDefault": {
4078
- "declaration": "export type IcThemeForegroundNoDefault = \"dark\" | \"light\";",
4079
- "docstring": "",
4080
- "path": "../web-components/dist/types/utils/types.d.ts"
4081
- },
4082
4241
  "src/utils/types.ts::IcPaginationBarOptions": {
4083
4242
  "declaration": "export interface IcPaginationBarOptions {\n itemsPerPageOptions?: { label: string; value: string }[];\n rangeLabelType?: IcPaginationLabelTypes;\n type?: IcPaginationTypes;\n showItemsPerPageControl?: boolean;\n showGoToPageControl?: boolean;\n alignment?: IcPaginationAlignmentOptions;\n itemLabel?: string;\n pageLabel?: string;\n hideRangeLabel?: boolean;\n hideAllFromItemsPerPage?: boolean;\n theme?: IcThemeMode;\n monochrome?: boolean;\n}",
4084
4243
  "docstring": "",
@@ -4104,11 +4263,6 @@
4104
4263
  "docstring": "",
4105
4264
  "path": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts"
4106
4265
  },
4107
- "../web-components/dist/types/interface.d.ts::IcThemeMode": {
4108
- "declaration": "any",
4109
- "docstring": "",
4110
- "path": "../web-components/dist/types/interface.d.ts"
4111
- },
4112
4266
  "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationTypes": {
4113
4267
  "declaration": "export type IcPaginationTypes = \"simple\" | \"complex\";",
4114
4268
  "docstring": "",
@@ -4148,11 +4302,6 @@
4148
4302
  "declaration": "export type IcInformationStatusOrEmpty = \"warning\" | \"error\" | \"success\" | \"\";",
4149
4303
  "docstring": "",
4150
4304
  "path": "src/utils/types.ts"
4151
- },
4152
- "../web-components/dist/types/interface.d.ts::IcThemeMode": {
4153
- "declaration": "any",
4154
- "docstring": "",
4155
- "path": "../web-components/dist/types/interface.d.ts"
4156
4305
  }
4157
4306
  }
4158
4307
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "mi6",
3
3
  "name": "@ukic/canary-docs",
4
- "version": "3.0.0-canary.4",
4
+ "version": "3.0.0-canary.6",
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": "c83a1397b30a5eb7cb844ac6c1bf037de3b7a94a"
21
+ "gitHead": "d12d44ce767e650601d380df6d5ce1b0d8fb78fb"
22
22
  }