@ukic/docs 2.15.0 → 2.15.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.
- package/docs.json +116 -34
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -2082,8 +2082,8 @@
|
|
|
2082
2082
|
"references": {
|
|
2083
2083
|
"IcButtonTooltipPlacement": {
|
|
2084
2084
|
"location": "import",
|
|
2085
|
-
"path": "
|
|
2086
|
-
"id": "src/
|
|
2085
|
+
"path": "../../utils/types",
|
|
2086
|
+
"id": "src/utils/types.ts::IcButtonTooltipPlacement"
|
|
2087
2087
|
}
|
|
2088
2088
|
}
|
|
2089
2089
|
},
|
|
@@ -17527,6 +17527,47 @@
|
|
|
17527
17527
|
"optional": false,
|
|
17528
17528
|
"required": false
|
|
17529
17529
|
},
|
|
17530
|
+
{
|
|
17531
|
+
"name": "tooltipPlacement",
|
|
17532
|
+
"type": "\"bottom\" | \"left\" | \"right\" | \"top\"",
|
|
17533
|
+
"complexType": {
|
|
17534
|
+
"original": "IcButtonTooltipPlacement",
|
|
17535
|
+
"resolved": "\"bottom\" | \"left\" | \"right\" | \"top\"",
|
|
17536
|
+
"references": {
|
|
17537
|
+
"IcButtonTooltipPlacement": {
|
|
17538
|
+
"location": "import",
|
|
17539
|
+
"path": "../../utils/types",
|
|
17540
|
+
"id": "src/utils/types.ts::IcButtonTooltipPlacement"
|
|
17541
|
+
}
|
|
17542
|
+
}
|
|
17543
|
+
},
|
|
17544
|
+
"mutable": false,
|
|
17545
|
+
"attr": "tooltip-placement",
|
|
17546
|
+
"reflectToAttr": false,
|
|
17547
|
+
"docs": "The position of the tooltip in relation to the toggle button.",
|
|
17548
|
+
"docsTags": [],
|
|
17549
|
+
"default": "\"bottom\"",
|
|
17550
|
+
"values": [
|
|
17551
|
+
{
|
|
17552
|
+
"value": "bottom",
|
|
17553
|
+
"type": "string"
|
|
17554
|
+
},
|
|
17555
|
+
{
|
|
17556
|
+
"value": "left",
|
|
17557
|
+
"type": "string"
|
|
17558
|
+
},
|
|
17559
|
+
{
|
|
17560
|
+
"value": "right",
|
|
17561
|
+
"type": "string"
|
|
17562
|
+
},
|
|
17563
|
+
{
|
|
17564
|
+
"value": "top",
|
|
17565
|
+
"type": "string"
|
|
17566
|
+
}
|
|
17567
|
+
],
|
|
17568
|
+
"optional": false,
|
|
17569
|
+
"required": false
|
|
17570
|
+
},
|
|
17530
17571
|
{
|
|
17531
17572
|
"name": "variant",
|
|
17532
17573
|
"type": "\"default\" | \"icon\"",
|
|
@@ -17878,6 +17919,47 @@
|
|
|
17878
17919
|
"optional": true,
|
|
17879
17920
|
"required": false
|
|
17880
17921
|
},
|
|
17922
|
+
{
|
|
17923
|
+
"name": "tooltipPlacement",
|
|
17924
|
+
"type": "\"bottom\" | \"left\" | \"right\" | \"top\"",
|
|
17925
|
+
"complexType": {
|
|
17926
|
+
"original": "IcButtonTooltipPlacement",
|
|
17927
|
+
"resolved": "\"bottom\" | \"left\" | \"right\" | \"top\"",
|
|
17928
|
+
"references": {
|
|
17929
|
+
"IcButtonTooltipPlacement": {
|
|
17930
|
+
"location": "import",
|
|
17931
|
+
"path": "../../utils/types",
|
|
17932
|
+
"id": "src/utils/types.ts::IcButtonTooltipPlacement"
|
|
17933
|
+
}
|
|
17934
|
+
}
|
|
17935
|
+
},
|
|
17936
|
+
"mutable": false,
|
|
17937
|
+
"attr": "tooltip-placement",
|
|
17938
|
+
"reflectToAttr": false,
|
|
17939
|
+
"docs": "The position of the tooltip in relation to the toggle buttons.",
|
|
17940
|
+
"docsTags": [],
|
|
17941
|
+
"default": "\"bottom\"",
|
|
17942
|
+
"values": [
|
|
17943
|
+
{
|
|
17944
|
+
"value": "bottom",
|
|
17945
|
+
"type": "string"
|
|
17946
|
+
},
|
|
17947
|
+
{
|
|
17948
|
+
"value": "left",
|
|
17949
|
+
"type": "string"
|
|
17950
|
+
},
|
|
17951
|
+
{
|
|
17952
|
+
"value": "right",
|
|
17953
|
+
"type": "string"
|
|
17954
|
+
},
|
|
17955
|
+
{
|
|
17956
|
+
"value": "top",
|
|
17957
|
+
"type": "string"
|
|
17958
|
+
}
|
|
17959
|
+
],
|
|
17960
|
+
"optional": false,
|
|
17961
|
+
"required": false
|
|
17962
|
+
},
|
|
17881
17963
|
{
|
|
17882
17964
|
"name": "variant",
|
|
17883
17965
|
"type": "\"default\" | \"icon\"",
|
|
@@ -19022,10 +19104,10 @@
|
|
|
19022
19104
|
"docstring": "",
|
|
19023
19105
|
"path": "src/components/ic-badge/ic-badge.types.ts"
|
|
19024
19106
|
},
|
|
19025
|
-
"src/
|
|
19107
|
+
"src/utils/types.ts::IcButtonTooltipPlacement": {
|
|
19026
19108
|
"declaration": "export type IcButtonTooltipPlacement = \"top\" | \"right\" | \"bottom\" | \"left\";",
|
|
19027
19109
|
"docstring": "",
|
|
19028
|
-
"path": "src/
|
|
19110
|
+
"path": "src/utils/types.ts"
|
|
19029
19111
|
},
|
|
19030
19112
|
"src/components/ic-button/ic-button.types.ts::IcButtonTypes": {
|
|
19031
19113
|
"declaration": "export type IcButtonTypes = \"reset\" | \"submit\" | \"button\";",
|
|
@@ -19112,6 +19194,36 @@
|
|
|
19112
19194
|
"docstring": "",
|
|
19113
19195
|
"path": "src/utils/types.ts"
|
|
19114
19196
|
},
|
|
19197
|
+
"src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarSearchModes": {
|
|
19198
|
+
"declaration": "export type IcSearchBarSearchModes = \"navigation\" | \"query\";",
|
|
19199
|
+
"docstring": "",
|
|
19200
|
+
"path": "src/components/ic-search-bar/ic-search-bar.types.ts"
|
|
19201
|
+
},
|
|
19202
|
+
"src/utils/types.ts::IcMenuOption": {
|
|
19203
|
+
"declaration": "export interface IcMenuOption {\n description?: string;\n disabled?: boolean;\n recommended?: boolean;\n children?: IcMenuOption[];\n loading?: boolean;\n timedOut?: boolean;\n [key: string]: any;\n element?: {\n component: any;\n ariaLabel: string;\n };\n icon?: any;\n}",
|
|
19204
|
+
"docstring": "",
|
|
19205
|
+
"path": "src/utils/types.ts"
|
|
19206
|
+
},
|
|
19207
|
+
"src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarBlurEventDetail": {
|
|
19208
|
+
"declaration": "export interface IcSearchBarBlurEventDetail extends IcValueEventDetail {\n relatedTarget: IcRelatedTarget;\n}",
|
|
19209
|
+
"docstring": "",
|
|
19210
|
+
"path": "src/components/ic-search-bar/ic-search-bar.types.ts"
|
|
19211
|
+
},
|
|
19212
|
+
"src/components/ic-menu/ic-menu.types.ts::IcOptionSelectEventDetail": {
|
|
19213
|
+
"declaration": "export interface IcOptionSelectEventDetail {\n value: string;\n label?: string;\n optionId?: string;\n}",
|
|
19214
|
+
"docstring": "",
|
|
19215
|
+
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19216
|
+
},
|
|
19217
|
+
"src/components/ic-menu/ic-menu.types.ts::IcMenuChangeEventDetail": {
|
|
19218
|
+
"declaration": "export interface IcMenuChangeEventDetail {\n open: boolean;\n focusInput?: boolean;\n}",
|
|
19219
|
+
"docstring": "",
|
|
19220
|
+
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19221
|
+
},
|
|
19222
|
+
"src/utils/types.ts::IcBlurEventDetail": {
|
|
19223
|
+
"declaration": "export interface IcBlurEventDetail {\n relatedTarget: IcRelatedTarget;\n}",
|
|
19224
|
+
"docstring": "",
|
|
19225
|
+
"path": "src/utils/types.ts"
|
|
19226
|
+
},
|
|
19115
19227
|
"src/components/ic-empty-state/ic-empty-state.types.ts::IcEmptyStateAlignment": {
|
|
19116
19228
|
"declaration": "export type IcEmptyStateAlignment = \"left\" | \"center\" | \"right\";",
|
|
19117
19229
|
"docstring": "",
|
|
@@ -19147,31 +19259,11 @@
|
|
|
19147
19259
|
"docstring": "",
|
|
19148
19260
|
"path": "src/utils/types.ts"
|
|
19149
19261
|
},
|
|
19150
|
-
"src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarSearchModes": {
|
|
19151
|
-
"declaration": "export type IcSearchBarSearchModes = \"navigation\" | \"query\";",
|
|
19152
|
-
"docstring": "",
|
|
19153
|
-
"path": "src/components/ic-search-bar/ic-search-bar.types.ts"
|
|
19154
|
-
},
|
|
19155
|
-
"src/utils/types.ts::IcMenuOption": {
|
|
19156
|
-
"declaration": "export interface IcMenuOption {\n description?: string;\n disabled?: boolean;\n recommended?: boolean;\n children?: IcMenuOption[];\n loading?: boolean;\n timedOut?: boolean;\n [key: string]: any;\n element?: {\n component: any;\n ariaLabel: string;\n };\n icon?: any;\n}",
|
|
19157
|
-
"docstring": "",
|
|
19158
|
-
"path": "src/utils/types.ts"
|
|
19159
|
-
},
|
|
19160
19262
|
"src/components/ic-menu/ic-menu.types.ts::IcMenuOptionIdEventDetail": {
|
|
19161
19263
|
"declaration": "export interface IcMenuOptionIdEventDetail {\n optionId: string | undefined;\n}",
|
|
19162
19264
|
"docstring": "",
|
|
19163
19265
|
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19164
19266
|
},
|
|
19165
|
-
"src/components/ic-menu/ic-menu.types.ts::IcOptionSelectEventDetail": {
|
|
19166
|
-
"declaration": "export interface IcOptionSelectEventDetail {\n value: string;\n label?: string;\n optionId?: string;\n}",
|
|
19167
|
-
"docstring": "",
|
|
19168
|
-
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19169
|
-
},
|
|
19170
|
-
"src/components/ic-menu/ic-menu.types.ts::IcMenuChangeEventDetail": {
|
|
19171
|
-
"declaration": "export interface IcMenuChangeEventDetail {\n open: boolean;\n focusInput?: boolean;\n}",
|
|
19172
|
-
"docstring": "",
|
|
19173
|
-
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19174
|
-
},
|
|
19175
19267
|
"src/components/ic-menu-item/ic-menu-item.types.ts::IcMenuItemVariants": {
|
|
19176
19268
|
"declaration": "export type IcMenuItemVariants = \"toggle\" | \"destructive\" | \"default\";",
|
|
19177
19269
|
"docstring": "",
|
|
@@ -19212,16 +19304,6 @@
|
|
|
19212
19304
|
"docstring": "",
|
|
19213
19305
|
"path": "src/components/ic-radio-group/ic-radio-group.types.ts"
|
|
19214
19306
|
},
|
|
19215
|
-
"src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarBlurEventDetail": {
|
|
19216
|
-
"declaration": "export interface IcSearchBarBlurEventDetail extends IcValueEventDetail {\n relatedTarget: IcRelatedTarget;\n}",
|
|
19217
|
-
"docstring": "",
|
|
19218
|
-
"path": "src/components/ic-search-bar/ic-search-bar.types.ts"
|
|
19219
|
-
},
|
|
19220
|
-
"src/utils/types.ts::IcBlurEventDetail": {
|
|
19221
|
-
"declaration": "export interface IcBlurEventDetail {\n relatedTarget: IcRelatedTarget;\n}",
|
|
19222
|
-
"docstring": "",
|
|
19223
|
-
"path": "src/utils/types.ts"
|
|
19224
|
-
},
|
|
19225
19307
|
"src/utils/types.ts::IcSearchMatchPositions": {
|
|
19226
19308
|
"declaration": "export type IcSearchMatchPositions = \"start\" | \"anywhere\";",
|
|
19227
19309
|
"docstring": "",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/docs",
|
|
4
|
-
"version": "2.15.
|
|
4
|
+
"version": "2.15.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": "
|
|
21
|
+
"gitHead": "5e9e761daccaba6c1d7984b7ce577731b7a31944"
|
|
22
22
|
}
|