@ukic/docs 2.4.1 → 2.5.0
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 +400 -12
- package/package.json +11 -2
package/docs.json
CHANGED
|
@@ -1,11 +1,387 @@
|
|
|
1
1
|
{
|
|
2
|
-
"timestamp": "2023-09-
|
|
2
|
+
"timestamp": "2023-09-21T15:01:39",
|
|
3
3
|
"compiler": {
|
|
4
4
|
"name": "@stencil/core",
|
|
5
|
-
"version": "4.
|
|
5
|
+
"version": "4.3.0",
|
|
6
6
|
"typescriptVersion": "5.1.6"
|
|
7
7
|
},
|
|
8
8
|
"components": [
|
|
9
|
+
{
|
|
10
|
+
"filePath": "src/components/ic-accordion/ic-accordion.tsx",
|
|
11
|
+
"encapsulation": "shadow",
|
|
12
|
+
"tag": "ic-accordion",
|
|
13
|
+
"readme": "# ic-accordion\n\n\n",
|
|
14
|
+
"docs": "",
|
|
15
|
+
"docsTags": [
|
|
16
|
+
{
|
|
17
|
+
"name": "slot",
|
|
18
|
+
"text": "heading - Content is placed as the accordion heading."
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"name": "slot",
|
|
22
|
+
"text": "icon - Content is placed to the left of the heading."
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
"usage": {},
|
|
26
|
+
"props": [
|
|
27
|
+
{
|
|
28
|
+
"name": "disabled",
|
|
29
|
+
"type": "boolean",
|
|
30
|
+
"complexType": {
|
|
31
|
+
"original": "boolean",
|
|
32
|
+
"resolved": "boolean",
|
|
33
|
+
"references": {}
|
|
34
|
+
},
|
|
35
|
+
"mutable": false,
|
|
36
|
+
"attr": "disabled",
|
|
37
|
+
"reflectToAttr": false,
|
|
38
|
+
"docs": "If `true`, the accordion will be disabled.",
|
|
39
|
+
"docsTags": [],
|
|
40
|
+
"default": "false",
|
|
41
|
+
"values": [
|
|
42
|
+
{
|
|
43
|
+
"type": "boolean"
|
|
44
|
+
}
|
|
45
|
+
],
|
|
46
|
+
"optional": true,
|
|
47
|
+
"required": false
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"name": "expanded",
|
|
51
|
+
"type": "boolean",
|
|
52
|
+
"complexType": {
|
|
53
|
+
"original": "boolean",
|
|
54
|
+
"resolved": "boolean",
|
|
55
|
+
"references": {}
|
|
56
|
+
},
|
|
57
|
+
"mutable": true,
|
|
58
|
+
"attr": "expanded",
|
|
59
|
+
"reflectToAttr": false,
|
|
60
|
+
"docs": "If `true`, the accordion appears expanded.",
|
|
61
|
+
"docsTags": [],
|
|
62
|
+
"default": "false",
|
|
63
|
+
"values": [
|
|
64
|
+
{
|
|
65
|
+
"type": "boolean"
|
|
66
|
+
}
|
|
67
|
+
],
|
|
68
|
+
"optional": false,
|
|
69
|
+
"required": false
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "heading",
|
|
73
|
+
"type": "string",
|
|
74
|
+
"complexType": {
|
|
75
|
+
"original": "string",
|
|
76
|
+
"resolved": "string",
|
|
77
|
+
"references": {}
|
|
78
|
+
},
|
|
79
|
+
"mutable": false,
|
|
80
|
+
"attr": "heading",
|
|
81
|
+
"reflectToAttr": false,
|
|
82
|
+
"docs": "The section header outlining section content.",
|
|
83
|
+
"docsTags": [],
|
|
84
|
+
"default": "\"\"",
|
|
85
|
+
"values": [
|
|
86
|
+
{
|
|
87
|
+
"type": "string"
|
|
88
|
+
}
|
|
89
|
+
],
|
|
90
|
+
"optional": true,
|
|
91
|
+
"required": false
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "message",
|
|
95
|
+
"type": "string",
|
|
96
|
+
"complexType": {
|
|
97
|
+
"original": "string",
|
|
98
|
+
"resolved": "string",
|
|
99
|
+
"references": {}
|
|
100
|
+
},
|
|
101
|
+
"mutable": false,
|
|
102
|
+
"attr": "message",
|
|
103
|
+
"reflectToAttr": false,
|
|
104
|
+
"docs": "The main body message of the accordion.",
|
|
105
|
+
"docsTags": [],
|
|
106
|
+
"default": "\"\"",
|
|
107
|
+
"values": [
|
|
108
|
+
{
|
|
109
|
+
"type": "string"
|
|
110
|
+
}
|
|
111
|
+
],
|
|
112
|
+
"optional": true,
|
|
113
|
+
"required": false
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "size",
|
|
117
|
+
"type": "\"default\" | \"large\" | \"small\"",
|
|
118
|
+
"complexType": {
|
|
119
|
+
"original": "IcSizes",
|
|
120
|
+
"resolved": "\"default\" | \"large\" | \"small\"",
|
|
121
|
+
"references": {
|
|
122
|
+
"IcSizes": {
|
|
123
|
+
"location": "import",
|
|
124
|
+
"path": "../../utils/types",
|
|
125
|
+
"id": "src/utils/types.ts::IcSizes"
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
},
|
|
129
|
+
"mutable": false,
|
|
130
|
+
"attr": "size",
|
|
131
|
+
"reflectToAttr": false,
|
|
132
|
+
"docs": "The size of the accordion.",
|
|
133
|
+
"docsTags": [],
|
|
134
|
+
"default": "\"default\"",
|
|
135
|
+
"values": [
|
|
136
|
+
{
|
|
137
|
+
"value": "default",
|
|
138
|
+
"type": "string"
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"value": "large",
|
|
142
|
+
"type": "string"
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"value": "small",
|
|
146
|
+
"type": "string"
|
|
147
|
+
}
|
|
148
|
+
],
|
|
149
|
+
"optional": true,
|
|
150
|
+
"required": false
|
|
151
|
+
}
|
|
152
|
+
],
|
|
153
|
+
"methods": [
|
|
154
|
+
{
|
|
155
|
+
"name": "setFocus",
|
|
156
|
+
"returns": {
|
|
157
|
+
"type": "Promise<void>",
|
|
158
|
+
"docs": ""
|
|
159
|
+
},
|
|
160
|
+
"complexType": {
|
|
161
|
+
"signature": "() => Promise<void>",
|
|
162
|
+
"parameters": [],
|
|
163
|
+
"references": {
|
|
164
|
+
"Promise": {
|
|
165
|
+
"location": "global",
|
|
166
|
+
"id": "global::Promise"
|
|
167
|
+
}
|
|
168
|
+
},
|
|
169
|
+
"return": "Promise<void>"
|
|
170
|
+
},
|
|
171
|
+
"signature": "setFocus() => Promise<void>",
|
|
172
|
+
"parameters": [],
|
|
173
|
+
"docs": "Sets focus on accordion heading.",
|
|
174
|
+
"docsTags": []
|
|
175
|
+
}
|
|
176
|
+
],
|
|
177
|
+
"events": [],
|
|
178
|
+
"listeners": [],
|
|
179
|
+
"styles": [],
|
|
180
|
+
"slots": [
|
|
181
|
+
{
|
|
182
|
+
"name": "heading",
|
|
183
|
+
"docs": "Content is placed as the accordion heading."
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"name": "icon",
|
|
187
|
+
"docs": "Content is placed to the left of the heading."
|
|
188
|
+
}
|
|
189
|
+
],
|
|
190
|
+
"parts": [],
|
|
191
|
+
"dependents": [],
|
|
192
|
+
"dependencies": [
|
|
193
|
+
"ic-typography"
|
|
194
|
+
],
|
|
195
|
+
"dependencyGraph": {
|
|
196
|
+
"ic-accordion": [
|
|
197
|
+
"ic-typography"
|
|
198
|
+
]
|
|
199
|
+
}
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
"filePath": "src/components/ic-accordion-group/ic-accordion-group.tsx",
|
|
203
|
+
"encapsulation": "shadow",
|
|
204
|
+
"tag": "ic-accordion-group",
|
|
205
|
+
"readme": "# ic-accordion-title\n\n\n",
|
|
206
|
+
"docs": "",
|
|
207
|
+
"docsTags": [],
|
|
208
|
+
"usage": {},
|
|
209
|
+
"props": [
|
|
210
|
+
{
|
|
211
|
+
"name": "appearance",
|
|
212
|
+
"type": "\"dark\" | \"default\" | \"light\"",
|
|
213
|
+
"complexType": {
|
|
214
|
+
"original": "IcThemeForeground",
|
|
215
|
+
"resolved": "\"dark\" | \"default\" | \"light\"",
|
|
216
|
+
"references": {
|
|
217
|
+
"IcThemeForeground": {
|
|
218
|
+
"location": "import",
|
|
219
|
+
"path": "../../utils/types",
|
|
220
|
+
"id": "src/utils/types.ts::IcThemeForeground"
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
},
|
|
224
|
+
"mutable": false,
|
|
225
|
+
"attr": "appearance",
|
|
226
|
+
"reflectToAttr": false,
|
|
227
|
+
"docs": "The appearance of the accordion group, e.g dark, or light.",
|
|
228
|
+
"docsTags": [],
|
|
229
|
+
"default": "\"default\"",
|
|
230
|
+
"values": [
|
|
231
|
+
{
|
|
232
|
+
"value": "dark",
|
|
233
|
+
"type": "string"
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"value": "default",
|
|
237
|
+
"type": "string"
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"value": "light",
|
|
241
|
+
"type": "string"
|
|
242
|
+
}
|
|
243
|
+
],
|
|
244
|
+
"optional": false,
|
|
245
|
+
"required": false
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
"name": "expanded",
|
|
249
|
+
"type": "boolean",
|
|
250
|
+
"complexType": {
|
|
251
|
+
"original": "boolean",
|
|
252
|
+
"resolved": "boolean",
|
|
253
|
+
"references": {}
|
|
254
|
+
},
|
|
255
|
+
"mutable": true,
|
|
256
|
+
"attr": "expanded",
|
|
257
|
+
"reflectToAttr": false,
|
|
258
|
+
"docs": "If `true`, the accordion will load in an expanded state.",
|
|
259
|
+
"docsTags": [],
|
|
260
|
+
"default": "false",
|
|
261
|
+
"values": [
|
|
262
|
+
{
|
|
263
|
+
"type": "boolean"
|
|
264
|
+
}
|
|
265
|
+
],
|
|
266
|
+
"optional": false,
|
|
267
|
+
"required": false
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"name": "groupTitle",
|
|
271
|
+
"type": "string",
|
|
272
|
+
"complexType": {
|
|
273
|
+
"original": "string",
|
|
274
|
+
"resolved": "string",
|
|
275
|
+
"references": {}
|
|
276
|
+
},
|
|
277
|
+
"mutable": false,
|
|
278
|
+
"attr": "group-title",
|
|
279
|
+
"reflectToAttr": false,
|
|
280
|
+
"docs": "The header for the accordion group.",
|
|
281
|
+
"docsTags": [],
|
|
282
|
+
"default": "\"\"",
|
|
283
|
+
"values": [
|
|
284
|
+
{
|
|
285
|
+
"type": "string"
|
|
286
|
+
}
|
|
287
|
+
],
|
|
288
|
+
"optional": false,
|
|
289
|
+
"required": false
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"name": "singleExpansion",
|
|
293
|
+
"type": "boolean",
|
|
294
|
+
"complexType": {
|
|
295
|
+
"original": "boolean",
|
|
296
|
+
"resolved": "boolean",
|
|
297
|
+
"references": {}
|
|
298
|
+
},
|
|
299
|
+
"mutable": false,
|
|
300
|
+
"attr": "single-expansion",
|
|
301
|
+
"reflectToAttr": false,
|
|
302
|
+
"docs": "If `true`, only one accordion will open at a time.",
|
|
303
|
+
"docsTags": [],
|
|
304
|
+
"default": "false",
|
|
305
|
+
"values": [
|
|
306
|
+
{
|
|
307
|
+
"type": "boolean"
|
|
308
|
+
}
|
|
309
|
+
],
|
|
310
|
+
"optional": false,
|
|
311
|
+
"required": false
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "size",
|
|
315
|
+
"type": "\"default\" | \"large\" | \"small\"",
|
|
316
|
+
"complexType": {
|
|
317
|
+
"original": "IcSizes",
|
|
318
|
+
"resolved": "\"default\" | \"large\" | \"small\"",
|
|
319
|
+
"references": {
|
|
320
|
+
"IcSizes": {
|
|
321
|
+
"location": "import",
|
|
322
|
+
"path": "../../utils/types",
|
|
323
|
+
"id": "src/utils/types.ts::IcSizes"
|
|
324
|
+
}
|
|
325
|
+
}
|
|
326
|
+
},
|
|
327
|
+
"mutable": false,
|
|
328
|
+
"attr": "size",
|
|
329
|
+
"reflectToAttr": false,
|
|
330
|
+
"docs": "The size of the accordion.",
|
|
331
|
+
"docsTags": [],
|
|
332
|
+
"default": "\"default\"",
|
|
333
|
+
"values": [
|
|
334
|
+
{
|
|
335
|
+
"value": "default",
|
|
336
|
+
"type": "string"
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"value": "large",
|
|
340
|
+
"type": "string"
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"value": "small",
|
|
344
|
+
"type": "string"
|
|
345
|
+
}
|
|
346
|
+
],
|
|
347
|
+
"optional": true,
|
|
348
|
+
"required": false
|
|
349
|
+
}
|
|
350
|
+
],
|
|
351
|
+
"methods": [],
|
|
352
|
+
"events": [],
|
|
353
|
+
"listeners": [
|
|
354
|
+
{
|
|
355
|
+
"event": "accordionClicked",
|
|
356
|
+
"capture": false,
|
|
357
|
+
"passive": false
|
|
358
|
+
}
|
|
359
|
+
],
|
|
360
|
+
"styles": [],
|
|
361
|
+
"slots": [],
|
|
362
|
+
"parts": [],
|
|
363
|
+
"dependents": [],
|
|
364
|
+
"dependencies": [
|
|
365
|
+
"ic-typography",
|
|
366
|
+
"ic-button"
|
|
367
|
+
],
|
|
368
|
+
"dependencyGraph": {
|
|
369
|
+
"ic-accordion-group": [
|
|
370
|
+
"ic-typography",
|
|
371
|
+
"ic-button"
|
|
372
|
+
],
|
|
373
|
+
"ic-button": [
|
|
374
|
+
"ic-loading-indicator",
|
|
375
|
+
"ic-tooltip"
|
|
376
|
+
],
|
|
377
|
+
"ic-loading-indicator": [
|
|
378
|
+
"ic-typography"
|
|
379
|
+
],
|
|
380
|
+
"ic-tooltip": [
|
|
381
|
+
"ic-typography"
|
|
382
|
+
]
|
|
383
|
+
}
|
|
384
|
+
},
|
|
9
385
|
{
|
|
10
386
|
"filePath": "src/components/ic-alert/ic-alert.tsx",
|
|
11
387
|
"encapsulation": "shadow",
|
|
@@ -1212,6 +1588,7 @@
|
|
|
1212
1588
|
],
|
|
1213
1589
|
"parts": [],
|
|
1214
1590
|
"dependents": [
|
|
1591
|
+
"ic-accordion-group",
|
|
1215
1592
|
"ic-alert",
|
|
1216
1593
|
"ic-card",
|
|
1217
1594
|
"ic-dialog",
|
|
@@ -1242,6 +1619,9 @@
|
|
|
1242
1619
|
"ic-tooltip": [
|
|
1243
1620
|
"ic-typography"
|
|
1244
1621
|
],
|
|
1622
|
+
"ic-accordion-group": [
|
|
1623
|
+
"ic-button"
|
|
1624
|
+
],
|
|
1245
1625
|
"ic-alert": [
|
|
1246
1626
|
"ic-button"
|
|
1247
1627
|
],
|
|
@@ -15225,6 +15605,8 @@
|
|
|
15225
15605
|
"slots": [],
|
|
15226
15606
|
"parts": [],
|
|
15227
15607
|
"dependents": [
|
|
15608
|
+
"ic-accordion",
|
|
15609
|
+
"ic-accordion-group",
|
|
15228
15610
|
"ic-alert",
|
|
15229
15611
|
"ic-back-to-top",
|
|
15230
15612
|
"ic-card",
|
|
@@ -15264,6 +15646,12 @@
|
|
|
15264
15646
|
],
|
|
15265
15647
|
"dependencies": [],
|
|
15266
15648
|
"dependencyGraph": {
|
|
15649
|
+
"ic-accordion": [
|
|
15650
|
+
"ic-typography"
|
|
15651
|
+
],
|
|
15652
|
+
"ic-accordion-group": [
|
|
15653
|
+
"ic-typography"
|
|
15654
|
+
],
|
|
15267
15655
|
"ic-alert": [
|
|
15268
15656
|
"ic-typography"
|
|
15269
15657
|
],
|
|
@@ -15376,6 +15764,16 @@
|
|
|
15376
15764
|
}
|
|
15377
15765
|
],
|
|
15378
15766
|
"typeLibrary": {
|
|
15767
|
+
"src/utils/types.ts::IcThemeForeground": {
|
|
15768
|
+
"declaration": "export type IcThemeForeground = \"default\" | \"dark\" | \"light\";",
|
|
15769
|
+
"docstring": "",
|
|
15770
|
+
"path": "src/utils/types.ts"
|
|
15771
|
+
},
|
|
15772
|
+
"src/utils/types.ts::IcSizes": {
|
|
15773
|
+
"declaration": "export type IcSizes = \"default\" | \"large\" | \"small\";",
|
|
15774
|
+
"docstring": "",
|
|
15775
|
+
"path": "src/utils/types.ts"
|
|
15776
|
+
},
|
|
15379
15777
|
"src/utils/types.ts::IcStatusVariants": {
|
|
15380
15778
|
"declaration": "export type IcStatusVariants =\n | \"neutral\"\n | \"info\"\n | \"warning\"\n | \"error\"\n | \"success\";",
|
|
15381
15779
|
"docstring": "",
|
|
@@ -15396,16 +15794,6 @@
|
|
|
15396
15794
|
"docstring": "",
|
|
15397
15795
|
"path": "src/components/ic-footer/ic-footer.types.tsx"
|
|
15398
15796
|
},
|
|
15399
|
-
"src/utils/types.ts::IcThemeForeground": {
|
|
15400
|
-
"declaration": "export type IcThemeForeground = \"default\" | \"dark\" | \"light\";",
|
|
15401
|
-
"docstring": "",
|
|
15402
|
-
"path": "src/utils/types.ts"
|
|
15403
|
-
},
|
|
15404
|
-
"src/utils/types.ts::IcSizes": {
|
|
15405
|
-
"declaration": "export type IcSizes = \"default\" | \"large\" | \"small\";",
|
|
15406
|
-
"docstring": "",
|
|
15407
|
-
"path": "src/utils/types.ts"
|
|
15408
|
-
},
|
|
15409
15797
|
"src/components/ic-button/ic-button.types.ts::IcButtonTooltipPlacement": {
|
|
15410
15798
|
"declaration": "export type IcButtonTooltipPlacement = \"top\" | \"right\" | \"bottom\" | \"left\";",
|
|
15411
15799
|
"docstring": "",
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
|
+
"author": "mi6",
|
|
2
3
|
"name": "@ukic/docs",
|
|
3
|
-
"version": "2.
|
|
4
|
+
"version": "2.5.0",
|
|
4
5
|
"description": "API documentation for @ukic components",
|
|
5
6
|
"main": "docs.json",
|
|
6
7
|
"types": "docs.d.ts",
|
|
@@ -8,6 +9,14 @@
|
|
|
8
9
|
"docs.json",
|
|
9
10
|
"docs.d.ts"
|
|
10
11
|
],
|
|
12
|
+
"repository": {
|
|
13
|
+
"url": "https://github.com/mi6/ic-ui-kit",
|
|
14
|
+
"directory": "packages/docs"
|
|
15
|
+
},
|
|
16
|
+
"bugs": {
|
|
17
|
+
"url": "https://github.com/mi6/ic-ui-kit",
|
|
18
|
+
"email": "icds@gchq.gov.uk"
|
|
19
|
+
},
|
|
11
20
|
"license": "MIT",
|
|
12
|
-
"gitHead": "
|
|
21
|
+
"gitHead": "04d8710aa3328b6e04d874deb6bb613489cfdcdd"
|
|
13
22
|
}
|