@iress-oss/ids-mcp-server 6.0.0-alpha.1-canary-20251204032753-fe18cab → 6.0.0-alpha.1-canary-20251204040305-3639454

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 (99) hide show
  1. package/generated/docs/components_components-alert-docs.md +1054 -0
  2. package/generated/docs/components_components-autocomplete-docs.md +3304 -0
  3. package/generated/docs/components_components-autocomplete-recipes-docs.md +98 -0
  4. package/generated/docs/components_components-badge-docs.md +312 -0
  5. package/generated/docs/components_components-button-docs.md +2339 -0
  6. package/generated/docs/components_components-buttongroup-docs.md +980 -0
  7. package/generated/docs/components_components-card-docs.md +1970 -0
  8. package/generated/docs/components_components-checkbox-docs.md +1083 -0
  9. package/generated/docs/components_components-checkboxgroup-docs.md +1597 -0
  10. package/generated/docs/components_components-checkboxgroup-recipes-docs.md +209 -0
  11. package/generated/docs/components_components-col-docs.md +755 -0
  12. package/generated/docs/components_components-container-docs.md +172 -0
  13. package/generated/docs/components_components-divider-docs.md +235 -0
  14. package/generated/docs/components_components-expander-docs.md +428 -0
  15. package/generated/docs/components_components-field-docs.md +3345 -0
  16. package/generated/docs/components_components-filter-docs.md +4091 -0
  17. package/generated/docs/components_components-hide-docs.md +450 -0
  18. package/generated/docs/components_components-icon-docs.md +1017 -0
  19. package/generated/docs/components_components-image-docs.md +168 -0
  20. package/generated/docs/components_components-inline-docs.md +1962 -0
  21. package/generated/docs/components_components-input-docs.md +1388 -0
  22. package/generated/docs/components_components-input-recipes-docs.md +349 -0
  23. package/generated/docs/components_components-inputcurrency-docs.md +636 -0
  24. package/generated/docs/components_components-inputcurrency-recipes-docs.md +208 -0
  25. package/generated/docs/components_components-introduction-docs.md +448 -0
  26. package/generated/docs/components_components-label-docs.md +229 -0
  27. package/generated/docs/components_components-link-docs.md +454 -0
  28. package/generated/docs/components_components-menu-docs.md +2219 -0
  29. package/generated/docs/components_components-menu-menuitem-docs.md +1455 -0
  30. package/generated/docs/components_components-modal-docs.md +2002 -0
  31. package/generated/docs/components_components-panel-docs.md +342 -0
  32. package/generated/docs/components_components-placeholder-docs.md +98 -0
  33. package/generated/docs/components_components-popover-docs.md +1631 -0
  34. package/generated/docs/components_components-popover-recipes-docs.md +537 -0
  35. package/generated/docs/components_components-progress-docs.md +128 -0
  36. package/generated/docs/components_components-provider-docs.md +123 -0
  37. package/generated/docs/components_components-radio-docs.md +499 -0
  38. package/generated/docs/components_components-radiogroup-docs.md +1573 -0
  39. package/generated/docs/components_components-readonly-docs.md +277 -0
  40. package/generated/docs/components_components-richselect-docs.md +6101 -0
  41. package/generated/docs/components_components-row-docs.md +2172 -0
  42. package/generated/docs/components_components-select-docs.md +1110 -0
  43. package/generated/docs/components_components-skeleton-docs.md +467 -0
  44. package/generated/docs/components_components-skeleton-recipes-docs.md +110 -0
  45. package/generated/docs/components_components-skiplink-docs.md +220 -0
  46. package/generated/docs/components_components-slideout-docs.md +1910 -0
  47. package/generated/docs/components_components-slider-docs.md +1284 -0
  48. package/generated/docs/components_components-spinner-docs.md +90 -0
  49. package/generated/docs/components_components-stack-docs.md +730 -0
  50. package/generated/docs/components_components-table-docs.md +4038 -0
  51. package/generated/docs/components_components-tabset-docs.md +955 -0
  52. package/generated/docs/components_components-tabset-tab-docs.md +342 -0
  53. package/generated/docs/components_components-tag-docs.md +410 -0
  54. package/generated/docs/components_components-text-docs.md +593 -0
  55. package/generated/docs/components_components-toaster-docs.md +451 -0
  56. package/generated/docs/components_components-toggle-docs.md +513 -0
  57. package/generated/docs/components_components-tooltip-docs.md +564 -0
  58. package/generated/docs/components_components-validationmessage-docs.md +608 -0
  59. package/generated/docs/components_contact-us-docs.md +9 -0
  60. package/generated/docs/components_foundations-accessibility-docs.md +33 -0
  61. package/generated/docs/components_foundations-consistency-docs.md +44 -0
  62. package/generated/docs/components_foundations-content-docs.md +18 -0
  63. package/generated/docs/components_foundations-introduction-docs.md +17 -0
  64. package/generated/docs/components_foundations-principles-docs.md +60 -0
  65. package/generated/docs/components_foundations-responsive-layout-docs.md +2692 -0
  66. package/generated/docs/components_foundations-user-experience-docs.md +53 -0
  67. package/generated/docs/components_foundations-visual-design-docs.md +39 -0
  68. package/generated/docs/components_foundations-z-index-stacking-docs.md +288 -0
  69. package/generated/docs/components_frequently-asked-questions-docs.md +44 -0
  70. package/generated/docs/components_get-started-develop-docs.md +47 -0
  71. package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
  72. package/generated/docs/components_introduction-docs.md +85 -0
  73. package/generated/docs/components_patterns-form-docs.md +2469 -0
  74. package/generated/docs/components_patterns-form-recipes-docs.md +1597 -0
  75. package/generated/docs/components_patterns-introduction-docs.md +31 -0
  76. package/generated/docs/components_patterns-loading-docs.md +1908 -0
  77. package/generated/docs/components_patterns-shadow-docs.md +195 -0
  78. package/generated/docs/components_resources-code-katas-docs.md +25 -0
  79. package/generated/docs/components_resources-introduction-docs.md +28 -0
  80. package/generated/docs/components_resources-mcp-server-docs.md +23 -0
  81. package/generated/docs/components_resources-migration-guides-from-v4-to-v5-docs.md +142 -0
  82. package/generated/docs/components_styling-props-colour-docs.md +91 -0
  83. package/generated/docs/components_styling-props-elevation-docs.md +69 -0
  84. package/generated/docs/components_styling-props-radius-docs.md +63 -0
  85. package/generated/docs/components_styling-props-reference-docs.md +160 -0
  86. package/generated/docs/components_styling-props-screen-readers-docs.md +66 -0
  87. package/generated/docs/components_styling-props-sizing-docs.md +217 -0
  88. package/generated/docs/components_styling-props-spacing-docs.md +545 -0
  89. package/generated/docs/components_styling-props-typography-docs.md +66 -0
  90. package/generated/docs/components_versions-docs.md +14 -0
  91. package/generated/docs/guidelines.md +3083 -0
  92. package/generated/docs/introduction-docs.md +37 -0
  93. package/generated/docs/tokens_colour-docs.md +479 -0
  94. package/generated/docs/tokens_elevation-docs.md +39 -0
  95. package/generated/docs/tokens_introduction-docs.md +150 -0
  96. package/generated/docs/tokens_radius-docs.md +67 -0
  97. package/generated/docs/tokens_spacing-docs.md +87 -0
  98. package/generated/docs/tokens_typography-docs.md +305 -0
  99. package/package.json +2 -2
@@ -0,0 +1,545 @@
1
+ Spacing
2
+ =======
3
+
4
+ These are all styling props related to changing the spacing of a component.
5
+
6
+ Padding
7
+ -------
8
+
9
+ There are seven props you can use to customise the padding of any component. It accepts the entire spacing token spectrum.
10
+
11
+ * `p`: Change the padding on all axes
12
+ * `px`: Change the padding on the left and right of a component
13
+ * `py`: Change the padding on the top and bottom of a component
14
+ * `pl`: Change the padding on the left of a component
15
+ * `pr`: Change the padding on the right of a component
16
+ * `pt`: Change the padding on the top of a component
17
+ * `pb`: Change the padding on the bottom of a component
18
+
19
+ [](./iframe.html?id=styling-props-spacing--padding)
20
+
21
+ A panel that has extra large padding on all sides.
22
+
23
+ ```
24
+
25
+ <IressPanel
26
+ bg\="alt"
27
+ p\="xl"
28
+ \>
29
+ A panel that has extra large padding on all sides.
30
+ </IressPanel\>
31
+
32
+ ```
33
+
34
+ #### Props
35
+
36
+ | Name | Description | Default | Control |
37
+ | --- | --- | --- | --- |
38
+ | p |
39
+ string
40
+
41
+
42
+
43
+ | \- | xl |
44
+
45
+ [](./iframe.html?id=styling-props-spacing--button)
46
+
47
+ Submit
48
+
49
+ ```
50
+
51
+ <IressButton
52
+ mode\="primary"
53
+ px\="xl"
54
+ \>
55
+ Submit
56
+ </IressButton\>
57
+
58
+ ```
59
+
60
+ #### Props
61
+
62
+ | Name | Description | Default | Control |
63
+ | --- | --- | --- | --- |
64
+ | px |
65
+ string
66
+
67
+
68
+
69
+ | \- | xl |
70
+
71
+ [](./iframe.html?id=styling-props-spacing--variable-padding)
72
+
73
+ A panel that has different padding on each side.
74
+
75
+ ```
76
+
77
+ <IressPanel
78
+ bg\="alt"
79
+ pb\="xl"
80
+ pl\="md"
81
+ pr\="spacing.600"
82
+ pt\="spacing.050"
83
+ \>
84
+ A panel that has different padding on each side.
85
+ </IressPanel\>
86
+
87
+ ```
88
+
89
+ #### Props
90
+
91
+ | Name | Description | Default | Control |
92
+ | --- | --- | --- | --- |
93
+ | pb |
94
+ string
95
+
96
+
97
+
98
+ | \- | xl |
99
+ | pl |
100
+
101
+ string
102
+
103
+
104
+
105
+ | \- | md |
106
+ | pr |
107
+
108
+ string
109
+
110
+
111
+
112
+ | \- | spacing.600 |
113
+ | pt |
114
+
115
+ string
116
+
117
+
118
+
119
+ | \- | spacing.050 |
120
+
121
+ ### Responsive padding
122
+
123
+ All padding props are responsive and can be changed according to different screen sizes.
124
+
125
+ [](./iframe.html?id=styling-props-spacing--responsive-padding)
126
+
127
+ A panel that has extra large padding on small screens and no padding on large screens.
128
+
129
+ ```
130
+
131
+ <IressPanel
132
+ bg\="alt"
133
+ p\={{
134
+ base: 'xl',
135
+ lg: 'none'
136
+ }}
137
+ \>
138
+ A panel that has extra large padding on small screens and no padding on large screens.
139
+ </IressPanel\>
140
+
141
+ ```
142
+
143
+ #### Props
144
+
145
+ | Name | Description | Default | Control |
146
+ | --- | --- | --- | --- |
147
+ | p |
148
+ object
149
+
150
+
151
+
152
+ | \- |
153
+
154
+ RAW
155
+
156
+ p :
157
+
158
+ {
159
+
160
+ * base : "xl"
161
+ * lg : "none"
162
+
163
+ }
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ |
172
+
173
+ [](./iframe.html?id=styling-props-spacing--responsive-variable-padding)
174
+
175
+ A panel that has responsive padding on the vertical and horizontal axes.
176
+
177
+ ```
178
+
179
+ <IressPanel
180
+ bg\="alt"
181
+ px\={{
182
+ base: 'none',
183
+ lg: 'xl'
184
+ }}
185
+ py\={{
186
+ base: 'xl',
187
+ lg: 'none'
188
+ }}
189
+ \>
190
+ A panel that has responsive padding on the vertical and horizontal axes.
191
+ </IressPanel\>
192
+
193
+ ```
194
+
195
+ #### Props
196
+
197
+ | Name | Description | Default | Control |
198
+ | --- | --- | --- | --- |
199
+ | px |
200
+ object
201
+
202
+
203
+
204
+ | \- |
205
+
206
+ RAW
207
+
208
+ px :
209
+
210
+ {
211
+
212
+ * base : "none"
213
+ * lg : "xl"
214
+
215
+ }
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ |
224
+ | py |
225
+
226
+ object
227
+
228
+
229
+
230
+ | \- |
231
+
232
+ RAW
233
+
234
+ py :
235
+
236
+ {
237
+
238
+ * base : "xl"
239
+ * lg : "none"
240
+
241
+ }
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ |
250
+
251
+ ### Migrating from version 5
252
+
253
+ Responsive padding worked differently in version 5. The `p` prop no longer accepts a nested object of axes to change the padding, you must change every prop based on the breakpoint.
254
+
255
+ <table class="css-1n5o7vh-diff-container"><tbody><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text">&lt;IressPanel p={{ t: 'xl', b: 'xl' }} /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text">&lt;IressPanel pt="xl" pb="xl" /&gt;</pre></td></tr></tbody></table>
256
+
257
+ Margin
258
+ ------
259
+
260
+ There are seven props you can use to customise the margin of any component. It accepts the entire spacing token spectrum, `auto` and negative values of the spacing token spectrum.
261
+
262
+ * `m`: Change the margin on all axes
263
+ * `mx`: Change the margin on the left and right of a component
264
+ * `my`: Change the margin on the top and bottom of a component
265
+ * `ml`: Change the margin on the left of a component
266
+ * `mr`: Change the margin on the right of a component
267
+ * `mt`: Change the margin on the top of a component
268
+ * `mb`: Change the margin on the bottom of a component
269
+
270
+ [](./iframe.html?id=styling-props-spacing--margin)
271
+
272
+ A panel that has the same margin on all sides.
273
+
274
+ ```
275
+
276
+ <IressPanel
277
+ bg\="alt"
278
+ m\="xl"
279
+ \>
280
+ A panel that has the same margin on all sides.
281
+ </IressPanel\>
282
+
283
+ ```
284
+
285
+ #### Props
286
+
287
+ | Name | Description | Default | Control |
288
+ | --- | --- | --- | --- |
289
+ | m |
290
+ string
291
+
292
+
293
+
294
+ | \- | xl |
295
+
296
+ [](./iframe.html?id=styling-props-spacing--variable-margin)
297
+
298
+ A panel that has different margin on each side.
299
+
300
+ ```
301
+
302
+ <IressPanel
303
+ bg\="alt"
304
+ mb\="xl"
305
+ ml\="md"
306
+ mr\="spacing.600"
307
+ mt\="spacing.050"
308
+ \>
309
+ A panel that has different margin on each side.
310
+ </IressPanel\>
311
+
312
+ ```
313
+
314
+ #### Props
315
+
316
+ | Name | Description | Default | Control |
317
+ | --- | --- | --- | --- |
318
+ | mb |
319
+ string
320
+
321
+
322
+
323
+ | \- | xl |
324
+ | ml |
325
+
326
+ string
327
+
328
+
329
+
330
+ | \- | md |
331
+ | mr |
332
+
333
+ string
334
+
335
+
336
+
337
+ | \- | spacing.600 |
338
+ | mt |
339
+
340
+ string
341
+
342
+
343
+
344
+ | \- | spacing.050 |
345
+
346
+ ### Responsive margin
347
+
348
+ All margin props are responsive and can be changed according to different screen sizes.
349
+
350
+ [](./iframe.html?id=styling-props-spacing--responsive-margin)
351
+
352
+ A panel that has extra large margin on small screens and no margin on large screens.
353
+
354
+ ```
355
+
356
+ <IressPanel
357
+ bg\="alt"
358
+ m\={{
359
+ base: 'xl',
360
+ lg: 'none'
361
+ }}
362
+ \>
363
+ A panel that has extra large margin on small screens and no margin on large screens.
364
+ </IressPanel\>
365
+
366
+ ```
367
+
368
+ #### Props
369
+
370
+ | Name | Description | Default | Control |
371
+ | --- | --- | --- | --- |
372
+ | m |
373
+ object
374
+
375
+
376
+
377
+ | \- |
378
+
379
+ RAW
380
+
381
+ m :
382
+
383
+ {
384
+
385
+ * base : "xl"
386
+ * lg : "none"
387
+
388
+ }
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+ |
397
+
398
+ [](./iframe.html?id=styling-props-spacing--responsive-variable-margin)
399
+
400
+ A panel that has responsive margin on the vertical and horizontal axes.
401
+
402
+ ```
403
+
404
+ <IressPanel
405
+ bg\="alt"
406
+ mx\={{
407
+ base: 'none',
408
+ lg: 'xl'
409
+ }}
410
+ my\={{
411
+ base: 'xl',
412
+ lg: 'none'
413
+ }}
414
+ \>
415
+ A panel that has responsive margin on the vertical and horizontal axes.
416
+ </IressPanel\>
417
+
418
+ ```
419
+
420
+ #### Props
421
+
422
+ | Name | Description | Default | Control |
423
+ | --- | --- | --- | --- |
424
+ | mx |
425
+ object
426
+
427
+
428
+
429
+ | \- |
430
+
431
+ RAW
432
+
433
+ mx :
434
+
435
+ {
436
+
437
+ * base : "none"
438
+ * lg : "xl"
439
+
440
+ }
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+ |
449
+ | my |
450
+
451
+ object
452
+
453
+
454
+
455
+ | \- |
456
+
457
+ RAW
458
+
459
+ my :
460
+
461
+ {
462
+
463
+ * base : "xl"
464
+ * lg : "none"
465
+
466
+ }
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+ |
475
+
476
+ ### Negative margin
477
+
478
+ Negative margin is supported in the same way as positive margin. You can use the same props to set negative margin.
479
+
480
+ [](./iframe.html?id=styling-props-spacing--negative-margin)
481
+
482
+ A panel that has negative margin and escapes its parent container
483
+
484
+ ```
485
+
486
+ <IressPanel
487
+ layerStyle\="elevation.raised"
488
+ maxWidth\="container.sm"
489
+ mx\="auto"
490
+ \>
491
+ <IressPanel
492
+ bg\="alt"
493
+ mx\="\-xl"
494
+ \>
495
+ A panel that has negative margin and escapes its parent container </IressPanel\>
496
+ </IressPanel\>
497
+
498
+ ```
499
+
500
+ #### Props
501
+
502
+ | Name | Description | Default | Control |
503
+ | --- | --- | --- | --- |
504
+ | mx |
505
+ string
506
+
507
+
508
+
509
+ | \- | \-xl |
510
+
511
+ `noGutter`
512
+ ----------
513
+
514
+ The `noGutter` prop removes the bottom margin of the last direct child of a component. This is useful when you have nested content inside a component with padding, such as `IressPanel` or `IressCard`, to remove unnecessary spacing in your layout.
515
+
516
+ [](./iframe.html?id=styling-props-spacing--no-gutter)
517
+
518
+ * Margin is removed due to `noGutter`
519
+
520
+ ```
521
+
522
+ <IressPanel
523
+ bg\="alt"
524
+ noGutter
525
+ \>
526
+ <ul\>
527
+ <li\>
528
+ <React.Fragment key\=".0"\>
529
+ Margin is removed due to{' '}
530
+ <code\>
531
+ noGutter </code\>
532
+ </React.Fragment\>
533
+ </li\>
534
+ </ul\>
535
+ </IressPanel\>
536
+
537
+ ```
538
+
539
+ #### Props
540
+
541
+ Args table with interactive controls couldn't be auto-generated
542
+
543
+ Controls give you an easy to use interface to test your components. Set your story args and you'll see controls appearing here automatically.
544
+
545
+ [Learn how to set that up](https://storybook.js.org/docs/essentials/controls?ref=ui)
@@ -0,0 +1,66 @@
1
+ Typography
2
+ ==========
3
+
4
+ These are all styling props related to changing the typography of a component.
5
+
6
+ `textStyle`
7
+ -----------
8
+
9
+ The `textStyle` prop allows you to change the default text style of a component. For more control and nested element styling, it is recommended to use `IressText` instead.
10
+
11
+ [](./iframe.html?id=styling-props-typography--text-style)
12
+
13
+ A panel with large text
14
+
15
+ ```
16
+
17
+ <IressPanel
18
+ bg\="alt"
19
+ textStyle\="typography.body.lg"
20
+ \>
21
+ A panel with large text
22
+ </IressPanel\>
23
+
24
+ ```
25
+
26
+ #### Props
27
+
28
+ | Name | Description | Default | Control |
29
+ | --- | --- | --- | --- |
30
+ | textStyle |
31
+ string
32
+
33
+
34
+
35
+ | \- | typography.body.lg |
36
+
37
+ `textAlign`
38
+ -----------
39
+
40
+ The `textAlign` prop allows you to change the alignment of text inside a component. For more control, it is recommended to use `IressText` instead.
41
+
42
+ [](./iframe.html?id=styling-props-typography--text-align)
43
+
44
+ A panel with centered text
45
+
46
+ ```
47
+
48
+ <IressPanel
49
+ bg\="alt"
50
+ textAlign\="center"
51
+ \>
52
+ A panel with centered text
53
+ </IressPanel\>
54
+
55
+ ```
56
+
57
+ #### Props
58
+
59
+ | Name | Description | Default | Control |
60
+ | --- | --- | --- | --- |
61
+ | textAlign |
62
+ string
63
+
64
+
65
+
66
+ | \- | center |
@@ -0,0 +1,14 @@
1
+ Versions
2
+ ========
3
+
4
+ Version 5 is the latest release of the library and recommended for new development.
5
+
6
+ List
7
+ ----
8
+
9
+ | Version | Links |
10
+ | --- | --- |
11
+ | v6 | [Documentation](https://6x.design.wm.iress.com) |
12
+ | v5 | [Documentation](https://design.wm.iress.com) |
13
+ | v4 | [Documentation](https://archive.design.aws-wmcore-production-au.iress.online/index.html) |
14
+ | OneUI | No longer available |