@iress-oss/ids-mcp-server 5.15.0 → 6.0.0-alpha.1

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 (91) hide show
  1. package/package.json +28 -46
  2. package/generated/docs/components-alert-docs.md +0 -130
  3. package/generated/docs/components-autocomplete-docs.md +0 -754
  4. package/generated/docs/components-autocomplete-recipes-docs.md +0 -104
  5. package/generated/docs/components-badge-docs.md +0 -148
  6. package/generated/docs/components-button-docs.md +0 -362
  7. package/generated/docs/components-button-recipes-docs.md +0 -76
  8. package/generated/docs/components-buttongroup-docs.md +0 -310
  9. package/generated/docs/components-card-docs.md +0 -494
  10. package/generated/docs/components-card-recipes-docs.md +0 -89
  11. package/generated/docs/components-checkbox-docs.md +0 -193
  12. package/generated/docs/components-checkboxgroup-docs.md +0 -692
  13. package/generated/docs/components-checkboxgroup-recipes-docs.md +0 -119
  14. package/generated/docs/components-col-docs.md +0 -466
  15. package/generated/docs/components-combobox-docs.md +0 -1016
  16. package/generated/docs/components-container-docs.md +0 -91
  17. package/generated/docs/components-divider-docs.md +0 -176
  18. package/generated/docs/components-expander-docs.md +0 -215
  19. package/generated/docs/components-field-docs.md +0 -675
  20. package/generated/docs/components-filter-docs.md +0 -1109
  21. package/generated/docs/components-form-docs.md +0 -2410
  22. package/generated/docs/components-form-recipes-docs.md +0 -886
  23. package/generated/docs/components-hide-docs.md +0 -265
  24. package/generated/docs/components-icon-docs.md +0 -553
  25. package/generated/docs/components-inline-docs.md +0 -868
  26. package/generated/docs/components-input-docs.md +0 -335
  27. package/generated/docs/components-input-recipes-docs.md +0 -140
  28. package/generated/docs/components-inputcurrency-docs.md +0 -157
  29. package/generated/docs/components-inputcurrency-recipes-docs.md +0 -116
  30. package/generated/docs/components-label-docs.md +0 -135
  31. package/generated/docs/components-menu-docs.md +0 -704
  32. package/generated/docs/components-menu-menuitem-docs.md +0 -193
  33. package/generated/docs/components-modal-docs.md +0 -587
  34. package/generated/docs/components-navbar-docs.md +0 -291
  35. package/generated/docs/components-navbar-recipes-docs.md +0 -413
  36. package/generated/docs/components-panel-docs.md +0 -380
  37. package/generated/docs/components-placeholder-docs.md +0 -27
  38. package/generated/docs/components-popover-docs.md +0 -464
  39. package/generated/docs/components-popover-recipes-docs.md +0 -245
  40. package/generated/docs/components-progress-docs.md +0 -104
  41. package/generated/docs/components-provider-docs.md +0 -105
  42. package/generated/docs/components-radio-docs.md +0 -107
  43. package/generated/docs/components-radiogroup-docs.md +0 -683
  44. package/generated/docs/components-readonly-docs.md +0 -89
  45. package/generated/docs/components-richselect-docs.md +0 -2433
  46. package/generated/docs/components-row-docs.md +0 -877
  47. package/generated/docs/components-select-docs.md +0 -456
  48. package/generated/docs/components-skeleton-docs.md +0 -214
  49. package/generated/docs/components-skeleton-recipes-docs.md +0 -76
  50. package/generated/docs/components-skiplink-docs.md +0 -66
  51. package/generated/docs/components-slideout-docs.md +0 -538
  52. package/generated/docs/components-slider-docs.md +0 -346
  53. package/generated/docs/components-spinner-docs.md +0 -59
  54. package/generated/docs/components-stack-docs.md +0 -265
  55. package/generated/docs/components-table-ag-grid-docs.md +0 -1074
  56. package/generated/docs/components-table-docs.md +0 -1305
  57. package/generated/docs/components-tabset-docs.md +0 -341
  58. package/generated/docs/components-tabset-tab-docs.md +0 -86
  59. package/generated/docs/components-tag-docs.md +0 -115
  60. package/generated/docs/components-text-docs.md +0 -394
  61. package/generated/docs/components-toaster-docs.md +0 -345
  62. package/generated/docs/components-toaster-toast-docs.md +0 -157
  63. package/generated/docs/components-toggle-docs.md +0 -158
  64. package/generated/docs/components-tooltip-docs.md +0 -311
  65. package/generated/docs/components-validationmessage-docs.md +0 -241
  66. package/generated/docs/contact-us-docs.md +0 -27
  67. package/generated/docs/extensions-editor-docs.md +0 -288
  68. package/generated/docs/extensions-editor-recipes-docs.md +0 -39
  69. package/generated/docs/foundations-accessibility-docs.md +0 -62
  70. package/generated/docs/foundations-colours-docs.md +0 -257
  71. package/generated/docs/foundations-consistency-docs.md +0 -52
  72. package/generated/docs/foundations-content-docs.md +0 -23
  73. package/generated/docs/foundations-introduction-docs.md +0 -17
  74. package/generated/docs/foundations-principles-docs.md +0 -70
  75. package/generated/docs/foundations-typography-docs.md +0 -191
  76. package/generated/docs/foundations-user-experience-docs.md +0 -63
  77. package/generated/docs/foundations-visual-design-docs.md +0 -46
  78. package/generated/docs/frequently-asked-questions-docs.md +0 -53
  79. package/generated/docs/get-started-develop-docs.md +0 -209
  80. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  81. package/generated/docs/guidelines.md +0 -812
  82. package/generated/docs/introduction-docs.md +0 -43
  83. package/generated/docs/patterns-loading-docs.md +0 -1304
  84. package/generated/docs/resources-changelog-docs.md +0 -6
  85. package/generated/docs/resources-code-katas-docs.md +0 -29
  86. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  87. package/generated/docs/themes-available-themes-docs.md +0 -66
  88. package/generated/docs/themes-introduction-docs.md +0 -121
  89. package/generated/docs/themes-tokens-docs.md +0 -1200
  90. package/generated/docs/versions-docs.md +0 -17
  91. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,553 +0,0 @@
1
- [](#icon)Icon
2
- =============
3
-
4
- Overview
5
- --------
6
-
7
- Icons enhance experiences by visually communicating meaning, actions, status, and feedback.
8
-
9
- Hide code
10
-
11
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
12
-
13
- <IressIcon name\="home" />
14
-
15
- Copy
16
-
17
- [](#installation)Installation
18
- -----------------------------
19
-
20
- If you are planning to include the `<IressIcon />` component in your application, you need to include the Font Awesome CSS.
21
-
22
- The easiest way to import the Font Awesome CSS is to use the `combined.css` file and add it to the `<head />` if your application. This file includes both the [Pro Light](https://fontawesome.com/v5/search?o=r&s=light) and [Brand](https://fontawesome.com/v5/search?o=r&f=brands) icon sets.
23
-
24
- Microfrontends
25
- --------------
26
-
27
- If you are using a Microfrontend, you need to include the Font Awesome CSS in the parent application as well as the Microfrontend. This is because `@font-face` declarations are not supported inside the Shadow DOM.
28
-
29
- \[data-radix-scroll-area-viewport\] {
30
- scrollbar-width: none;
31
- -ms-overflow-style: none;
32
- -webkit-overflow-scrolling: touch;
33
- }
34
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
35
- display: none;
36
- }
37
- :where(\[data-radix-scroll-area-viewport\]) {
38
- display: flex;
39
- flex-direction: column;
40
- align-items: stretch;
41
- }
42
- :where(\[data-radix-scroll-area-content\]) {
43
- flex-grow: 1;
44
- }
45
-
46
- <link
47
- href\="https://cdn.iress.com/icons/5.15.4/css/combined.min.css"
48
- rel\="stylesheet"
49
- />
50
-
51
- Copy
52
-
53
- [](#supported-library-sets-and-names)Supported library sets and names
54
- ---------------------------------------------------------------------
55
-
56
- `IressIcon` currently supports Font Awesome (V5) [Light](https://fontawesome.com/v5/search?o=r&s=light) and [Brand](https://fontawesome.com/v5/search?o=r&f=brands) sets. The library sets are controlled by the `set` prop and it defaults to the Light set (`fal`).
57
-
58
- The `name` prop controls which icon is shown, and needs to match the icon name exactly as displayed on the [Font Awesome website](https://fontawesome.com/v5/search). Icon names should be lower case, and separated by hyphens where required; for example `home-alt` or `check-circle.` Icon names should not include the `fa-` prefix.
59
-
60
- [](#behaviour)Behaviour
61
- -----------------------
62
-
63
- ### [](#screen-reader-text)Screen Reader Text
64
-
65
- By default icons are hidden from screen readers. The `screenreaderText` prop makes icons visible to screen readers users, providing a description of the icon.
66
-
67
- If you use an icon to improve the visual appeal of content, for example by replacing the default list icons with tick marks when listing product features, you don't need to add any screen reader text.
68
-
69
- If you use an icon to convey meaning, for example using an icon as the only content inside a button, you do need to supply a value for the `screenreaderText`; if you don't the button meaning will be completely lost for screen reader users.
70
-
71
- Hide code
72
-
73
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
74
-
75
- <IressIcon
76
- name\="home"
77
- screenreaderText\="Home"
78
- />
79
-
80
- Copy
81
-
82
- ### [](#size)Size
83
-
84
- The `size` prop can be used to control sizing of the icon.
85
-
86
- xs
87
-
88
- sm
89
-
90
- lg
91
-
92
- 2x
93
-
94
- 3x
95
-
96
- 5x
97
-
98
- 7x
99
-
100
- 10x
101
-
102
- Hide code
103
-
104
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
105
-
106
- <IressInline
107
- gutter\="md"
108
- verticalAlign\="bottom"
109
- \>
110
- <div\>
111
- <IressIcon
112
- name\="home"
113
- size\="xs"
114
- />
115
- <IressText align\="center"\>
116
- xs </IressText\>
117
- </div\>
118
- <div\>
119
- <IressIcon
120
- name\="home"
121
- size\="sm"
122
- />
123
- <IressText align\="center"\>
124
- sm </IressText\>
125
- </div\>
126
- <div\>
127
- <IressIcon
128
- name\="home"
129
- size\="lg"
130
- />
131
- <IressText align\="center"\>
132
- lg </IressText\>
133
- </div\>
134
- <div\>
135
- <IressIcon
136
- name\="home"
137
- size\="2x"
138
- />
139
- <IressText align\="center"\>
140
- 2x </IressText\>
141
- </div\>
142
- <div\>
143
- <IressIcon
144
- name\="home"
145
- size\="3x"
146
- />
147
- <IressText align\="center"\>
148
- 3x </IressText\>
149
- </div\>
150
- <div\>
151
- <IressIcon
152
- name\="home"
153
- size\="5x"
154
- />
155
- <IressText align\="center"\>
156
- 5x </IressText\>
157
- </div\>
158
- <div\>
159
- <IressIcon
160
- name\="home"
161
- size\="7x"
162
- />
163
- <IressText align\="center"\>
164
- 7x </IressText\>
165
- </div\>
166
- <div\>
167
- <IressIcon
168
- name\="home"
169
- size\="10x"
170
- />
171
- <IressText align\="center"\>
172
- 10x </IressText\>
173
- </div\>
174
- </IressInline\>
175
-
176
- Copy
177
-
178
- ### [](#mode)Mode
179
-
180
- The `mode` prop can be used to set the colour of the icon to these predefined mode colours: Body, Muted, Primary, Info, Success, Warning, Danger, Positive and Negative.
181
-
182
- danger
183
-
184
- info
185
-
186
- muted
187
-
188
- primary
189
-
190
- success
191
-
192
- warning
193
-
194
- positive
195
-
196
- negative
197
-
198
- Hide code
199
-
200
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
201
-
202
- <IressInline gutter\="md"\>
203
- <div\>
204
- <IressIcon
205
- mode\="danger"
206
- name\="home"
207
- size\="5x"
208
- />
209
- <IressText align\="center"\>
210
- danger </IressText\>
211
- </div\>
212
- <div\>
213
- <IressIcon
214
- mode\="info"
215
- name\="home"
216
- size\="5x"
217
- />
218
- <IressText align\="center"\>
219
- info </IressText\>
220
- </div\>
221
- <div\>
222
- <IressIcon
223
- mode\="muted"
224
- name\="home"
225
- size\="5x"
226
- />
227
- <IressText align\="center"\>
228
- muted </IressText\>
229
- </div\>
230
- <div\>
231
- <IressIcon
232
- mode\="primary"
233
- name\="home"
234
- size\="5x"
235
- />
236
- <IressText align\="center"\>
237
- primary </IressText\>
238
- </div\>
239
- <div\>
240
- <IressIcon
241
- mode\="success"
242
- name\="home"
243
- size\="5x"
244
- />
245
- <IressText align\="center"\>
246
- success </IressText\>
247
- </div\>
248
- <div\>
249
- <IressIcon
250
- mode\="warning"
251
- name\="home"
252
- size\="5x"
253
- />
254
- <IressText align\="center"\>
255
- warning </IressText\>
256
- </div\>
257
- <div\>
258
- <IressIcon
259
- mode\="positive"
260
- name\="home"
261
- size\="5x"
262
- />
263
- <IressText align\="center"\>
264
- positive </IressText\>
265
- </div\>
266
- <div\>
267
- <IressIcon
268
- mode\="negative"
269
- name\="home"
270
- size\="5x"
271
- />
272
- <IressText align\="center"\>
273
- negative </IressText\>
274
- </div\>
275
- </IressInline\>
276
-
277
- Copy
278
-
279
- ### [](#flip)Flip
280
-
281
- The `flip` prop can be set to horizontal, vertical or both.
282
-
283
- original
284
-
285
- horizontal
286
-
287
- vertical
288
-
289
- both
290
-
291
- Hide code
292
-
293
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
294
-
295
- <IressInline gutter\="md"\>
296
- <div\>
297
- <IressIcon
298
- name\="home"
299
- size\="5x"
300
- />
301
- <IressText align\="center"\>
302
- original </IressText\>
303
- </div\>
304
- <div\>
305
- <IressIcon
306
- flip\="horizontal"
307
- name\="home"
308
- size\="5x"
309
- />
310
- <IressText align\="center"\>
311
- horizontal </IressText\>
312
- </div\>
313
- <div\>
314
- <IressIcon
315
- flip\="vertical"
316
- name\="home"
317
- size\="5x"
318
- />
319
- <IressText align\="center"\>
320
- vertical </IressText\>
321
- </div\>
322
- <div\>
323
- <IressIcon
324
- flip\="both"
325
- name\="home"
326
- size\="5x"
327
- />
328
- <IressText align\="center"\>
329
- both </IressText\>
330
- </div\>
331
- </IressInline\>
332
-
333
- Copy
334
-
335
- ### [](#rotate)Rotate
336
-
337
- The `rotate` prop can be set to 90, 180 or 270 degrees.
338
-
339
- original
340
-
341
- 90
342
-
343
- 180
344
-
345
- 270
346
-
347
- Hide code
348
-
349
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
350
-
351
- <IressInline gutter\="md"\>
352
- <div\>
353
- <IressIcon
354
- name\="home"
355
- size\="5x"
356
- />
357
- <IressText align\="center"\>
358
- original </IressText\>
359
- </div\>
360
- <div\>
361
- <IressIcon
362
- name\="home"
363
- rotate\="90"
364
- size\="5x"
365
- />
366
- <IressText align\="center"\>
367
- 90 </IressText\>
368
- </div\>
369
- <div\>
370
- <IressIcon
371
- name\="home"
372
- rotate\="180"
373
- size\="5x"
374
- />
375
- <IressText align\="center"\>
376
- 180 </IressText\>
377
- </div\>
378
- <div\>
379
- <IressIcon
380
- name\="home"
381
- rotate\="270"
382
- size\="5x"
383
- />
384
- <IressText align\="center"\>
385
- 270 </IressText\>
386
- </div\>
387
- </IressInline\>
388
-
389
- Copy
390
-
391
- ### [](#spin)Spin
392
-
393
- The `spin` prop can be set to half (fastest), 1, 2 or 3 (slowest) to control the speed of the icon spin animation, useful for loading spinners.
394
-
395
- half
396
-
397
- 1
398
-
399
- 2
400
-
401
- 3
402
-
403
- Hide code
404
-
405
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
406
-
407
- <IressInline gutter\="md"\>
408
- <IressText\>
409
- <IressIcon
410
- name\="spinner"
411
- screenreaderText\="Loading..."
412
- spin\="half"
413
- />
414
- {' '}half
415
- </IressText\>
416
- <IressText\>
417
- <IressIcon
418
- name\="spinner"
419
- screenreaderText\="Loading..."
420
- spin\="1"
421
- />
422
- {' '}1
423
- </IressText\>
424
- <IressText\>
425
- <IressIcon
426
- name\="spinner"
427
- screenreaderText\="Loading..."
428
- spin\="2"
429
- />
430
- {' '}2
431
- </IressText\>
432
- <IressText\>
433
- <IressIcon
434
- name\="spinner"
435
- screenreaderText\="Loading..."
436
- spin\="3"
437
- />
438
- {' '}3
439
- </IressText\>
440
- </IressInline\>
441
-
442
- Copy
443
-
444
- ### [](#fixed-width)Fixed Width
445
-
446
- Because of the wide variety of Font Awesome icons, not every icon is the same size. This can cause alignment issued when the icons stack vertically, so you can use the `fixedWidth` prop to ensure each icon is the same width. Very useful when using icons in menus.
447
-
448
- Default width
449
- -------------
450
-
451
-
452
-
453
- Fixed width
454
- -----------
455
-
456
-
457
-
458
- Hide code
459
-
460
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
461
-
462
- <IressInline gutter\="md"\>
463
- <div\>
464
- <IressText
465
- element\="h2"
466
- variant\="h5"
467
- \>
468
- Default width </IressText\>
469
- <IressIcon
470
- className\="ids-styles--alt-background-v5150"
471
- name\="space-shuttle"
472
- size\="3x"
473
- />
474
- <br />
475
- <IressIcon
476
- className\="ids-styles--alt-background-v5150"
477
- name\="wine-glass-alt"
478
- size\="3x"
479
- />
480
- </div\>
481
- <div\>
482
- <IressText
483
- element\="h2"
484
- variant\="h5"
485
- \>
486
- Fixed width </IressText\>
487
- <IressIcon
488
- className\="ids-styles--alt-background-v5150"
489
- fixedWidth
490
- name\="space-shuttle"
491
- size\="3x"
492
- />
493
- <br />
494
- <IressIcon
495
- className\="ids-styles--alt-background-v5150"
496
- fixedWidth
497
- name\="wine-glass-alt"
498
- size\="3x"
499
- />
500
- </div\>
501
- </IressInline\>
502
-
503
- Copy
504
-
505
- [](#examples)Examples
506
- ---------------------
507
-
508
- ### [](#external-link)External link
509
-
510
- Version 4 of IDS included some bespoke styles to make an "external link" icon in an `IressText` component look nice. We've removed these in V5 as we found they were having unintended side effects. If you still wish to style your external link icons, you can use either some custom CSS (like below) or simply make the icon size `xs`:
511
-
512
- [Go to this link:](https://www.iress.com/)
513
-
514
- Hide code
515
-
516
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
517
-
518
- <IressText\>
519
- <a
520
- href\="https://www.iress.com/"
521
- rel\="noreferrer"
522
- target\="\_blank"
523
- \>
524
- Go to this link: <IressIcon
525
- name\="external-link"
526
- size\="xs"
527
- style\={{
528
- 'inset-block-start': '-0.25em',
529
- 'margin-inline-start': 'var(--iress-g-spacing-xs, var(--iress-default-spacing-xs))',
530
- position: 'relative'
531
- }}
532
- />
533
- </a\>
534
- </IressText\>
535
-
536
- Copy
537
-
538
- On this page
539
-
540
- * [Overview](#overview)
541
- * [Props](#props)
542
- * [Installation](#installation)
543
- * [Supported library sets and names](#supported-library-sets-and-names)
544
- * [Behaviour](#behaviour)
545
- * [Screen Reader Text](#screen-reader-text)
546
- * [Size](#size)
547
- * [Mode](#mode)
548
- * [Flip](#flip)
549
- * [Rotate](#rotate)
550
- * [Spin](#spin)
551
- * [Fixed Width](#fixed-width)
552
- * [Examples](#examples)
553
- * [External link](#external-link)