@ukic/docs 2.15.1 → 2.15.3
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 +63 -36
- package/package.json +3 -2
package/docs.json
CHANGED
|
@@ -917,7 +917,7 @@
|
|
|
917
917
|
}
|
|
918
918
|
}
|
|
919
919
|
},
|
|
920
|
-
"mutable":
|
|
920
|
+
"mutable": true,
|
|
921
921
|
"attr": "position",
|
|
922
922
|
"reflectToAttr": false,
|
|
923
923
|
"docs": "The positioning of the badge in reference to the parent element.",
|
|
@@ -11364,6 +11364,11 @@
|
|
|
11364
11364
|
}
|
|
11365
11365
|
],
|
|
11366
11366
|
"listeners": [
|
|
11367
|
+
{
|
|
11368
|
+
"event": "icCheck",
|
|
11369
|
+
"capture": false,
|
|
11370
|
+
"passive": false
|
|
11371
|
+
},
|
|
11367
11372
|
{
|
|
11368
11373
|
"event": "icChange",
|
|
11369
11374
|
"capture": false,
|
|
@@ -18034,6 +18039,28 @@
|
|
|
18034
18039
|
"docsTags": [],
|
|
18035
18040
|
"usage": {},
|
|
18036
18041
|
"props": [
|
|
18042
|
+
{
|
|
18043
|
+
"name": "disableClick",
|
|
18044
|
+
"type": "boolean",
|
|
18045
|
+
"complexType": {
|
|
18046
|
+
"original": "boolean",
|
|
18047
|
+
"resolved": "boolean",
|
|
18048
|
+
"references": {}
|
|
18049
|
+
},
|
|
18050
|
+
"mutable": false,
|
|
18051
|
+
"attr": "disable-click",
|
|
18052
|
+
"reflectToAttr": false,
|
|
18053
|
+
"docs": "If `true`, the tooltip will not be displayed on click, it will require hover or using the display method.",
|
|
18054
|
+
"docsTags": [],
|
|
18055
|
+
"default": "false",
|
|
18056
|
+
"values": [
|
|
18057
|
+
{
|
|
18058
|
+
"type": "boolean"
|
|
18059
|
+
}
|
|
18060
|
+
],
|
|
18061
|
+
"optional": true,
|
|
18062
|
+
"required": false
|
|
18063
|
+
},
|
|
18037
18064
|
{
|
|
18038
18065
|
"name": "disableHover",
|
|
18039
18066
|
"type": "boolean",
|
|
@@ -19139,6 +19166,11 @@
|
|
|
19139
19166
|
"docstring": "",
|
|
19140
19167
|
"path": "src/components/ic-tab/ic-tab.types.ts"
|
|
19141
19168
|
},
|
|
19169
|
+
"src/utils/types.ts::IcDeviceSizes": {
|
|
19170
|
+
"declaration": "export type IcDeviceSizes = 0 | 576 | 768 | 992 | 1200;",
|
|
19171
|
+
"docstring": "",
|
|
19172
|
+
"path": "src/utils/types.ts"
|
|
19173
|
+
},
|
|
19142
19174
|
"src/components/ic-tooltip/ic-tooltip.types.ts::IcTooltipPlacements": {
|
|
19143
19175
|
"declaration": "export type IcTooltipPlacements =\n | \"top-start\"\n | \"top\"\n | \"top-end\"\n | \"right-start\"\n | \"right\"\n | \"right-end\"\n | \"bottom-end\"\n | \"bottom\"\n | \"bottom-start\"\n | \"left-end\"\n | \"left\"\n | \"left-start\";",
|
|
19144
19176
|
"docstring": "",
|
|
@@ -19194,6 +19226,36 @@
|
|
|
19194
19226
|
"docstring": "",
|
|
19195
19227
|
"path": "src/utils/types.ts"
|
|
19196
19228
|
},
|
|
19229
|
+
"src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarSearchModes": {
|
|
19230
|
+
"declaration": "export type IcSearchBarSearchModes = \"navigation\" | \"query\";",
|
|
19231
|
+
"docstring": "",
|
|
19232
|
+
"path": "src/components/ic-search-bar/ic-search-bar.types.ts"
|
|
19233
|
+
},
|
|
19234
|
+
"src/utils/types.ts::IcMenuOption": {
|
|
19235
|
+
"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}",
|
|
19236
|
+
"docstring": "",
|
|
19237
|
+
"path": "src/utils/types.ts"
|
|
19238
|
+
},
|
|
19239
|
+
"src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarBlurEventDetail": {
|
|
19240
|
+
"declaration": "export interface IcSearchBarBlurEventDetail extends IcValueEventDetail {\n relatedTarget: IcRelatedTarget;\n}",
|
|
19241
|
+
"docstring": "",
|
|
19242
|
+
"path": "src/components/ic-search-bar/ic-search-bar.types.ts"
|
|
19243
|
+
},
|
|
19244
|
+
"src/components/ic-menu/ic-menu.types.ts::IcOptionSelectEventDetail": {
|
|
19245
|
+
"declaration": "export interface IcOptionSelectEventDetail {\n value: string;\n label?: string;\n optionId?: string;\n}",
|
|
19246
|
+
"docstring": "",
|
|
19247
|
+
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19248
|
+
},
|
|
19249
|
+
"src/components/ic-menu/ic-menu.types.ts::IcMenuChangeEventDetail": {
|
|
19250
|
+
"declaration": "export interface IcMenuChangeEventDetail {\n open: boolean;\n focusInput?: boolean;\n}",
|
|
19251
|
+
"docstring": "",
|
|
19252
|
+
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19253
|
+
},
|
|
19254
|
+
"src/utils/types.ts::IcBlurEventDetail": {
|
|
19255
|
+
"declaration": "export interface IcBlurEventDetail {\n relatedTarget: IcRelatedTarget;\n}",
|
|
19256
|
+
"docstring": "",
|
|
19257
|
+
"path": "src/utils/types.ts"
|
|
19258
|
+
},
|
|
19197
19259
|
"src/components/ic-empty-state/ic-empty-state.types.ts::IcEmptyStateAlignment": {
|
|
19198
19260
|
"declaration": "export type IcEmptyStateAlignment = \"left\" | \"center\" | \"right\";",
|
|
19199
19261
|
"docstring": "",
|
|
@@ -19229,31 +19291,11 @@
|
|
|
19229
19291
|
"docstring": "",
|
|
19230
19292
|
"path": "src/utils/types.ts"
|
|
19231
19293
|
},
|
|
19232
|
-
"src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarSearchModes": {
|
|
19233
|
-
"declaration": "export type IcSearchBarSearchModes = \"navigation\" | \"query\";",
|
|
19234
|
-
"docstring": "",
|
|
19235
|
-
"path": "src/components/ic-search-bar/ic-search-bar.types.ts"
|
|
19236
|
-
},
|
|
19237
|
-
"src/utils/types.ts::IcMenuOption": {
|
|
19238
|
-
"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}",
|
|
19239
|
-
"docstring": "",
|
|
19240
|
-
"path": "src/utils/types.ts"
|
|
19241
|
-
},
|
|
19242
19294
|
"src/components/ic-menu/ic-menu.types.ts::IcMenuOptionIdEventDetail": {
|
|
19243
19295
|
"declaration": "export interface IcMenuOptionIdEventDetail {\n optionId: string | undefined;\n}",
|
|
19244
19296
|
"docstring": "",
|
|
19245
19297
|
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19246
19298
|
},
|
|
19247
|
-
"src/components/ic-menu/ic-menu.types.ts::IcOptionSelectEventDetail": {
|
|
19248
|
-
"declaration": "export interface IcOptionSelectEventDetail {\n value: string;\n label?: string;\n optionId?: string;\n}",
|
|
19249
|
-
"docstring": "",
|
|
19250
|
-
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19251
|
-
},
|
|
19252
|
-
"src/components/ic-menu/ic-menu.types.ts::IcMenuChangeEventDetail": {
|
|
19253
|
-
"declaration": "export interface IcMenuChangeEventDetail {\n open: boolean;\n focusInput?: boolean;\n}",
|
|
19254
|
-
"docstring": "",
|
|
19255
|
-
"path": "src/components/ic-menu/ic-menu.types.ts"
|
|
19256
|
-
},
|
|
19257
19299
|
"src/components/ic-menu-item/ic-menu-item.types.ts::IcMenuItemVariants": {
|
|
19258
19300
|
"declaration": "export type IcMenuItemVariants = \"toggle\" | \"destructive\" | \"default\";",
|
|
19259
19301
|
"docstring": "",
|
|
@@ -19264,11 +19306,6 @@
|
|
|
19264
19306
|
"docstring": "",
|
|
19265
19307
|
"path": "src/components/ic-side-navigation/ic-side-navigation.types.ts"
|
|
19266
19308
|
},
|
|
19267
|
-
"src/utils/types.ts::IcDeviceSizes": {
|
|
19268
|
-
"declaration": "export type IcDeviceSizes = 0 | 576 | 768 | 992 | 1200;",
|
|
19269
|
-
"docstring": "",
|
|
19270
|
-
"path": "src/utils/types.ts"
|
|
19271
|
-
},
|
|
19272
19309
|
"src/components/ic-pagination/ic-pagination.types.ts::IcPaginationTypes": {
|
|
19273
19310
|
"declaration": "export type IcPaginationTypes = \"simple\" | \"complex\";",
|
|
19274
19311
|
"docstring": "",
|
|
@@ -19294,16 +19331,6 @@
|
|
|
19294
19331
|
"docstring": "",
|
|
19295
19332
|
"path": "src/components/ic-radio-group/ic-radio-group.types.ts"
|
|
19296
19333
|
},
|
|
19297
|
-
"src/components/ic-search-bar/ic-search-bar.types.ts::IcSearchBarBlurEventDetail": {
|
|
19298
|
-
"declaration": "export interface IcSearchBarBlurEventDetail extends IcValueEventDetail {\n relatedTarget: IcRelatedTarget;\n}",
|
|
19299
|
-
"docstring": "",
|
|
19300
|
-
"path": "src/components/ic-search-bar/ic-search-bar.types.ts"
|
|
19301
|
-
},
|
|
19302
|
-
"src/utils/types.ts::IcBlurEventDetail": {
|
|
19303
|
-
"declaration": "export interface IcBlurEventDetail {\n relatedTarget: IcRelatedTarget;\n}",
|
|
19304
|
-
"docstring": "",
|
|
19305
|
-
"path": "src/utils/types.ts"
|
|
19306
|
-
},
|
|
19307
19334
|
"src/utils/types.ts::IcSearchMatchPositions": {
|
|
19308
19335
|
"declaration": "export type IcSearchMatchPositions = \"start\" | \"anywhere\";",
|
|
19309
19336
|
"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.3",
|
|
5
5
|
"description": "API documentation for @ukic components",
|
|
6
6
|
"main": "docs.json",
|
|
7
7
|
"types": "docs.d.ts",
|
|
@@ -18,5 +18,6 @@
|
|
|
18
18
|
"email": "icds@gchq.gov.uk"
|
|
19
19
|
},
|
|
20
20
|
"license": "MIT",
|
|
21
|
-
"
|
|
21
|
+
"packageManager": "^npm@10.9.2",
|
|
22
|
+
"gitHead": "aa7be8a4e4bd951dd72dabce7a7a7303d889ec7e"
|
|
22
23
|
}
|