@iress-oss/ids-mcp-server 5.15.0 → 6.0.0-alpha.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.
Files changed (104) hide show
  1. package/generated/docs/components-alert-docs.md +579 -7
  2. package/generated/docs/components-autocomplete-docs.md +694 -15
  3. package/generated/docs/components-autocomplete-recipes-docs.md +1 -1
  4. package/generated/docs/components-badge-docs.md +442 -59
  5. package/generated/docs/components-button-docs.md +1150 -70
  6. package/generated/docs/components-buttongroup-docs.md +441 -3
  7. package/generated/docs/components-card-docs.md +487 -37
  8. package/generated/docs/components-checkbox-docs.md +506 -5
  9. package/generated/docs/components-checkboxgroup-docs.md +586 -191
  10. package/generated/docs/components-checkboxgroup-recipes-docs.md +3 -3
  11. package/generated/docs/components-col-docs.md +451 -36
  12. package/generated/docs/components-container-docs.md +32 -0
  13. package/generated/docs/components-divider-docs.md +427 -27
  14. package/generated/docs/components-expander-docs.md +487 -108
  15. package/generated/docs/components-field-docs.md +1400 -68
  16. package/generated/docs/components-filter-docs.md +268 -55
  17. package/generated/docs/components-hide-docs.md +447 -10
  18. package/generated/docs/components-icon-docs.md +522 -259
  19. package/generated/docs/components-image-docs.md +493 -0
  20. package/generated/docs/components-inline-docs.md +1179 -44
  21. package/generated/docs/components-input-docs.md +544 -12
  22. package/generated/docs/components-input-recipes-docs.md +4 -4
  23. package/generated/docs/components-inputcurrency-docs.md +532 -0
  24. package/generated/docs/components-inputcurrency-recipes-docs.md +4 -5
  25. package/generated/docs/components-introduction-docs.md +450 -0
  26. package/generated/docs/components-label-docs.md +454 -27
  27. package/generated/docs/components-link-docs.md +586 -0
  28. package/generated/docs/components-menu-docs.md +531 -89
  29. package/generated/docs/components-menu-menuitem-docs.md +556 -10
  30. package/generated/docs/components-modal-docs.md +814 -55
  31. package/generated/docs/components-panel-docs.md +418 -198
  32. package/generated/docs/components-placeholder-docs.md +420 -1
  33. package/generated/docs/components-popover-docs.md +1097 -32
  34. package/generated/docs/components-popover-recipes-docs.md +39 -73
  35. package/generated/docs/components-progress-docs.md +464 -0
  36. package/generated/docs/components-provider-docs.md +57 -2
  37. package/generated/docs/components-radio-docs.md +460 -4
  38. package/generated/docs/components-radiogroup-docs.md +586 -116
  39. package/generated/docs/components-readonly-docs.md +450 -4
  40. package/generated/docs/components-richselect-docs.md +4660 -1257
  41. package/generated/docs/components-row-docs.md +2065 -588
  42. package/generated/docs/components-select-docs.md +489 -5
  43. package/generated/docs/components-skeleton-docs.md +399 -16
  44. package/generated/docs/components-skeleton-recipes-docs.md +7 -7
  45. package/generated/docs/components-skiplink-docs.md +548 -27
  46. package/generated/docs/components-slideout-docs.md +648 -150
  47. package/generated/docs/components-slider-docs.md +515 -33
  48. package/generated/docs/components-spinner-docs.md +393 -2
  49. package/generated/docs/components-stack-docs.md +732 -74
  50. package/generated/docs/components-table-ag-grid-docs.md +497 -127
  51. package/generated/docs/components-table-docs.md +1049 -27
  52. package/generated/docs/components-tabset-docs.md +454 -27
  53. package/generated/docs/components-tabset-tab-docs.md +464 -0
  54. package/generated/docs/components-tag-docs.md +452 -19
  55. package/generated/docs/components-text-docs.md +322 -131
  56. package/generated/docs/components-toaster-docs.md +463 -53
  57. package/generated/docs/components-toggle-docs.md +476 -20
  58. package/generated/docs/components-tooltip-docs.md +443 -7
  59. package/generated/docs/components-validationmessage-docs.md +933 -13
  60. package/generated/docs/extensions-editor-docs.md +906 -13
  61. package/generated/docs/extensions-editor-recipes-docs.md +51 -1
  62. package/generated/docs/foundations-accessibility-docs.md +1 -23
  63. package/generated/docs/foundations-grid-docs.md +74 -0
  64. package/generated/docs/foundations-introduction-docs.md +6 -4
  65. package/generated/docs/foundations-responsive-breakpoints-docs.md +193 -0
  66. package/generated/docs/foundations-tokens-colour-docs.md +564 -0
  67. package/generated/docs/foundations-tokens-elevation-docs.md +155 -0
  68. package/generated/docs/foundations-tokens-introduction-docs.md +190 -0
  69. package/generated/docs/foundations-tokens-radius-docs.md +71 -0
  70. package/generated/docs/foundations-tokens-spacing-docs.md +89 -0
  71. package/generated/docs/foundations-tokens-typography-docs.md +322 -0
  72. package/generated/docs/foundations-z-index-stacking-docs.md +31 -0
  73. package/generated/docs/guidelines.md +1537 -295
  74. package/generated/docs/introduction-docs.md +65 -21
  75. package/generated/docs/news-version-6-docs.md +93 -0
  76. package/generated/docs/patterns-form-docs.md +3902 -0
  77. package/generated/docs/patterns-form-recipes-docs.md +1370 -0
  78. package/generated/docs/patterns-introduction-docs.md +24 -0
  79. package/generated/docs/patterns-loading-docs.md +2940 -201
  80. package/generated/docs/resources-introduction-docs.md +38 -0
  81. package/generated/docs/resources-mcp-server-docs.md +27 -0
  82. package/generated/docs/styling-props-colour-docs.md +172 -0
  83. package/generated/docs/styling-props-elevation-docs.md +88 -0
  84. package/generated/docs/styling-props-radius-docs.md +86 -0
  85. package/generated/docs/styling-props-reference-docs.md +160 -0
  86. package/generated/docs/styling-props-screen-readers-docs.md +71 -0
  87. package/generated/docs/styling-props-sizing-docs.md +627 -0
  88. package/generated/docs/styling-props-spacing-docs.md +2282 -0
  89. package/generated/docs/styling-props-typography-docs.md +121 -0
  90. package/generated/docs/themes-available-themes-docs.md +29 -29
  91. package/generated/docs/themes-introduction-docs.md +1 -1
  92. package/package.json +3 -22
  93. package/generated/docs/components-button-recipes-docs.md +0 -76
  94. package/generated/docs/components-card-recipes-docs.md +0 -89
  95. package/generated/docs/components-combobox-docs.md +0 -1016
  96. package/generated/docs/components-form-docs.md +0 -2410
  97. package/generated/docs/components-form-recipes-docs.md +0 -886
  98. package/generated/docs/components-navbar-docs.md +0 -291
  99. package/generated/docs/components-navbar-recipes-docs.md +0 -413
  100. package/generated/docs/components-toaster-toast-docs.md +0 -157
  101. package/generated/docs/foundations-colours-docs.md +0 -257
  102. package/generated/docs/foundations-typography-docs.md +0 -191
  103. package/generated/docs/resources-changelog-docs.md +0 -6
  104. package/generated/docs/themes-tokens-docs.md +0 -1200
@@ -6,6 +6,14 @@ Overview
6
6
 
7
7
  Cards are used to group small, related pieces of information into one digestible unit.
8
8
 
9
+ * * *
10
+
11
+ Updated
12
+
13
+ **Recently updated**
14
+
15
+ This component has been recently updated with new props. The props have been marked as beta. Please tell us if there are any issues.
16
+
9
17
  Read more
10
18
 
11
19
  A single card will typically include a few different types of media, such as an image, a title, a synopsis, a call-to-action button or sub actions buttons - all associated with the same concept.
@@ -24,6 +32,451 @@ Hide code
24
32
 
25
33
  Copy
26
34
 
35
+ [](#props)Props
36
+ ---------------
37
+
38
+ | Name | Description | Default | Control |
39
+ | --- | --- | --- | --- |
40
+ | bg |
41
+ **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
42
+
43
+ We recommend using the following token values for best background contrast:
44
+
45
+ * `colour.primary.fill` for primary backgrounds that need to stand out
46
+ * `colour.primary.surface` for primary backgrounds that need to be less prominent
47
+ * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
48
+ * `colour.neutral.20` for a slightly darker background color, used in neutral state components
49
+ * `colour.system.danger.fill` for error backgrounds that need to stand out
50
+ * `colour.system.danger.surface` for error backgrounds that need to be less prominent
51
+ * `colour.system.success.fill` for success backgrounds that need to stand out
52
+ * `colour.system.success.surface` for success backgrounds that need to be less prominent
53
+ * `colour.system.warning.fill` for warning backgrounds that need to stand out
54
+ * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
55
+ * `colour.system.info.fill` for info backgrounds that need to stand out
56
+ * `colour.system.info.surface` for info backgrounds that need to be less prominent
57
+
58
+ ResponsiveProp<ColorToken> | undefined
59
+
60
+ | \- | Set object |
61
+ | borderRadius |
62
+
63
+ The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
64
+
65
+ | Chrome | Firefox | Safari | Edge | IE |
66
+ | --- | --- | --- | --- | --- |
67
+ | **4** | **4** | **5** | **12** | **9** |
68
+ | 1 _\-x-_ | | 3 _\-x-_ | | |
69
+
70
+ ResponsiveProp<RadiusToken> | undefined
71
+
72
+ | \- | Set object |
73
+ | children |
74
+
75
+ Main body of the card
76
+
77
+ ReactNode
78
+
79
+
80
+
81
+ | \- |
82
+
83
+ "I'm a card"
84
+
85
+ |
86
+ | color |
87
+
88
+ The **`color`** CSS property sets the foreground color value of an element's text and text decorations using the colour tokens from the design system. It also sets the `currentcolor` value. `currentcolor` may be used as an indirect value on _other_ properties and is the default for other color properties, such as `border-color`.
89
+
90
+ We recommend using the following token values for best color contrast:
91
+
92
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
93
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
94
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
95
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
96
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
97
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
98
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
99
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
100
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
101
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
102
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
103
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
104
+
105
+ ResponsiveProp<ColorToken> | undefined
106
+
107
+ | \- | Set object |
108
+ | element |
109
+
110
+ Element type to render the Card as.
111
+
112
+ ElementTypeundefined
113
+
114
+
115
+
116
+ | \- | Set object |
117
+ | focusable |
118
+
119
+ The `focusable` prop is used to apply the focus elevation when focused. It can be set to `true` to apply focus styles on focus, or `'within'` to apply focus styles when the element or any of its children are focused.
120
+
121
+ "true""within"undefined
122
+
123
+
124
+
125
+ | \- | Set object |
126
+ | footer |
127
+
128
+ Section that sticks to the bottom of the card
129
+
130
+ ReactNode
131
+
132
+
133
+
134
+ | \- | Set object |
135
+ | heading |
136
+
137
+ Heading slot. Often used for a title or description.
138
+
139
+ ReactNode
140
+
141
+
142
+
143
+ | \- | Set object |
144
+ | hide |
145
+
146
+ Set **`hide`** to hide an element completely using `display: none`. It can also be set to an object of breakpoints to hide the element at specific breakpoints.
147
+
148
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
149
+
150
+ Notes:
151
+
152
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
153
+ * Consider if you can conditionally render the element instead of hiding it.
154
+
155
+ ResponsiveProp<boolean> | undefined
156
+
157
+ | \- | Set object |
158
+ | layerStyle |
159
+
160
+ Elevate a layer by using a **`layerStyle`**. These are connected to the elevation tokens in the design system. They can be combined to create hierarchy and structure.
161
+
162
+ * `elevation.raised`: Raised elevations sit slightly higher than other content. They are reserved for cards that can be moved, such as Jira issue cards and Trello cards. In special circumstances, they can be used for cards as a way to provide additional heirarchy or emphasis.
163
+ * `elevation.floating`: Floating is the highest elevation available. It is reserved for a UI that sits over another UI, such as modals, dialogs, dropdown menus, floating toolbars, and floating single-action buttons.
164
+ * `elevation.overflow`: Overflow is a shadow indicating content has scrolled outside a view. It can be used for vertical or horizontal scroll. An example of overflow shadows is the horizontal scroll in tables on a Confluence page.
165
+
166
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
167
+
168
+ | \- | Set object |
169
+ | m |
170
+
171
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
172
+
173
+ It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
174
+
175
+ | Chrome | Firefox | Safari | Edge | IE |
176
+ | --- | --- | --- | --- | --- |
177
+ | **1** | **1** | **1** | **12** | **3** |
178
+
179
+ ResponsiveProp<SpacingToken | "auto"> | undefined
180
+
181
+ | \- | Set object |
182
+ | maxWidth |
183
+
184
+ The **`max-width`** CSS property sets the maximum width of an element. It prevents the used value of the `width` property from becoming larger than the value specified by `max-width`.
185
+
186
+ | Chrome | Firefox | Safari | Edge | IE |
187
+ | --- | --- | --- | --- | --- |
188
+ | **1** | **1** | **1** | **12** | **7** |
189
+
190
+ ResponsiveProp<"auto" | SizeToken | "screen" | "1/2" | "1/3" | "2/3" | "1/4" | "2/4" | "3/4" | "1/5" | "2/5" | "3/5" | "4/5" | "1/6" | "2/6" | "3/6" | "4/6" | "5/6" | "1/12" | "2/12" | ... 8 more ... | "11/12"> | undefined
191
+
192
+ | \- | Set object |
193
+ | mb |
194
+
195
+ The **`mb`** property is short for `margin-bottom` and sets the margin area on the bottom side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
196
+
197
+ It uses the spacing tokens in the design system.
198
+
199
+ | Chrome | Firefox | Safari | Edge | IE |
200
+ | --- | --- | --- | --- | --- |
201
+ | **1** | **1** | **1** | **12** | **3** |
202
+
203
+ ResponsiveProp<SpacingToken | "auto"> | undefined
204
+
205
+ | \- | Set object |
206
+ | media |
207
+
208
+ Section (often for an image, table or chart) that appears before the heading
209
+
210
+ ReactNode
211
+
212
+
213
+
214
+ | \- | Set object |
215
+ | ml |
216
+
217
+ The **`ml`** property is short for `margin-left` and sets the margin area on the left side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
218
+
219
+ It uses the spacing tokens in the design system.
220
+
221
+ | Chrome | Firefox | Safari | Edge | IE |
222
+ | --- | --- | --- | --- | --- |
223
+ | **1** | **1** | **1** | **12** | **3** |
224
+
225
+ ResponsiveProp<SpacingToken | "auto"> | undefined
226
+
227
+ | \- | Set object |
228
+ | mr |
229
+
230
+ The **`mr`** property is short for `margin-right` and sets the margin area on the right side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
231
+
232
+ It uses the spacing tokens in the design system.
233
+
234
+ | Chrome | Firefox | Safari | Edge | IE |
235
+ | --- | --- | --- | --- | --- |
236
+ | **1** | **1** | **1** | **12** | **3** |
237
+
238
+ ResponsiveProp<SpacingToken | "auto"> | undefined
239
+
240
+ | \- | Set object |
241
+ | mt |
242
+
243
+ The **`mt`** property is short for `margin-top` and sets the margin area on the top side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
244
+
245
+ It uses the spacing tokens in the design system.
246
+
247
+ | Chrome | Firefox | Safari | Edge | IE |
248
+ | --- | --- | --- | --- | --- |
249
+ | **1** | **1** | **1** | **12** | **3** |
250
+
251
+ ResponsiveProp<SpacingToken | "auto"> | undefined
252
+
253
+ | \- | Set object |
254
+ | mx |
255
+
256
+ The **`mx`** property is short for `margin-inline`. It is a shorthand property that defines both the logical inline start and end margins of an element, which maps to physical margins depending on the element's writing mode, directionality, and text orientation.
257
+
258
+ It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
259
+
260
+ | Chrome | Firefox | Safari | Edge | IE |
261
+ | --- | --- | --- | --- | --- |
262
+ | **1** | **1** | **1** | **12** | **3** |
263
+
264
+ ResponsiveProp<SpacingToken | "auto"> | undefined
265
+
266
+ | \- | Set object |
267
+ | my |
268
+
269
+ The **`my`** property is short for `margin-block`. It defines the logical block start and end margins of an element, which maps to physical margins depending on the element's writing mode, directionality, and text orientation.
270
+
271
+ It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
272
+
273
+ | Chrome | Firefox | Safari | Edge | IE |
274
+ | --- | --- | --- | --- | --- |
275
+ | **1** | **1** | **1** | **12** | **3** |
276
+
277
+ ResponsiveProp<SpacingToken | "auto"> | undefined
278
+
279
+ | \- | Set object |
280
+ | noGutter |
281
+
282
+ The **`noGutter`** property is used to remove the bottom margin from the last child of a component. This is useful when you want to avoid extra spacing at the end of a layout.
283
+
284
+ booleanundefined
285
+
286
+
287
+
288
+ | \- | Set object |
289
+ | p |
290
+
291
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
292
+
293
+ It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
294
+
295
+ | Chrome | Firefox | Safari | Edge | IE |
296
+ | --- | --- | --- | --- | --- |
297
+ | **1** | **1** | **1** | **12** | **3** |
298
+
299
+ ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
300
+
301
+ | \- | Set object |
302
+ | pb |
303
+
304
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
305
+
306
+ It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
307
+
308
+ | Chrome | Firefox | Safari | Edge | IE |
309
+ | --- | --- | --- | --- | --- |
310
+ | **1** | **1** | **1** | **12** | **3** |
311
+
312
+ ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
313
+
314
+ | \- | Set object |
315
+ | pl |
316
+
317
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
318
+
319
+ It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
320
+
321
+ | Chrome | Firefox | Safari | Edge | IE |
322
+ | --- | --- | --- | --- | --- |
323
+ | **1** | **1** | **1** | **12** | **3** |
324
+
325
+ ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
326
+
327
+ | \- | Set object |
328
+ | pr |
329
+
330
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
331
+
332
+ It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
333
+
334
+ | Chrome | Firefox | Safari | Edge | IE |
335
+ | --- | --- | --- | --- | --- |
336
+ | **1** | **1** | **1** | **12** | **3** |
337
+
338
+ ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
339
+
340
+ | \- | Set object |
341
+ | prepend |
342
+
343
+ Slot to the left of card content.
344
+
345
+ ReactNode
346
+
347
+
348
+
349
+ | \- | Set object |
350
+ | pt |
351
+
352
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
353
+
354
+ It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
355
+
356
+ | Chrome | Firefox | Safari | Edge | IE |
357
+ | --- | --- | --- | --- | --- |
358
+ | **1** | **1** | **1** | **12** | **3** |
359
+
360
+ ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
361
+
362
+ | \- | Set object |
363
+ | px |
364
+
365
+ The **`px`** property is short for `padding-inline`. It is a shorthand property that defines both the logical inline start and end paddings of an element, which maps to physical paddings depending on the element's writing mode, directionality, and text orientation.
366
+
367
+ It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
368
+
369
+ | Chrome | Firefox | Safari | Edge | IE |
370
+ | --- | --- | --- | --- | --- |
371
+ | **1** | **1** | **1** | **12** | **3** |
372
+
373
+ ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
374
+
375
+ | \- | Set object |
376
+ | py |
377
+
378
+ The **`py`** property is short for `padding-block`. It defines the logical block start and end paddings of an element, which maps to physical paddings depending on the element's writing mode, directionality, and text orientation.
379
+
380
+ It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
381
+
382
+ | Chrome | Firefox | Safari | Edge | IE |
383
+ | --- | --- | --- | --- | --- |
384
+ | **1** | **1** | **1** | **12** | **3** |
385
+
386
+ ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
387
+
388
+ | \- | Set object |
389
+ | rowGap |
390
+
391
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
392
+
393
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
394
+
395
+ | Chrome | Firefox | Safari | Edge | IE |
396
+ | --- | --- | --- | --- | --- |
397
+ | **47** | **52** | **10.1** | **16** | No |
398
+
399
+ ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
400
+
401
+ | \- | Set object |
402
+ | selected |
403
+
404
+ When set to true, card appears selected.
405
+
406
+ booleanundefined
407
+
408
+
409
+
410
+ | \- | Set object |
411
+ | srOnly |
412
+
413
+ Set **`srOnly`** to hide an element visually but still make it accessible to screen readers. It can also be set to an object of breakpoints to hide the element at specific breakpoints.
414
+
415
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
416
+
417
+ ResponsiveProp<boolean> | undefined
418
+
419
+ | \- | Set object |
420
+ | stretch |
421
+
422
+ The **`stretch`** property is used to stretch an element to fill the available space in its parent container. It sets the `height` property to `100%` and `alignSelf` to `stretch`, allowing the element to expand and contract based on the size of its parent.
423
+
424
+ booleanundefined
425
+
426
+
427
+
428
+ | \- | Set object |
429
+ | textAlign |
430
+
431
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
432
+
433
+ | Chrome | Firefox | Safari | Edge | IE |
434
+ | --- | --- | --- | --- | --- |
435
+ | **1** | **1** | **1** | **12** | **3** |
436
+
437
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
438
+
439
+ | \- | Set object |
440
+ | textStyle |
441
+
442
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
443
+
444
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
445
+ * `typography.body.md` - The most commonly used body text size, used for most text content in the product and the default state of all components in the design system.
446
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
447
+ * `typography.heading.1` - Use for the main page title to establish a clear hierarchy. There is typically only one H1 per screen, emphasising the primary purpose or context of the page.
448
+ * `typography.heading.2` - Use for primary section headings within a page to organise content and guide the user through key areas. Also suitable for large components—such as modals—where space allows and where it pairs well with body.md or body.lg.
449
+ * `typography.heading.3` - Use for sub-sections under H2s to further structure content and maintain a clear visual hierarchy. Ideal for breaking down complex sections into manageable parts.
450
+ * `typography.heading.4` - Use for supporting headings within content blocks or small components where space is limited—such as table headers, cards, or side panels. Provides structure without overwhelming the layout.
451
+ * `typography.heading.5` - Use for minor labels or titles in compact UI elements, such as cards, sidebars, or inline labels. Best used to emphasise supplementary information without drawing too much attention. Works well with body.sm and is ideal for subtle content like fine print. Use sparingly to preserve typographic hierarchy.
452
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
453
+
454
+ ResponsiveProp<"typography.heading.1" | "typography.heading.2" | "typography.heading.3" | "typography.heading.4" | "typography.heading.5" | "typography.body.sm" | "typography.body.sm.regular" | ... 10 more ... | "typography.code"> | undefined
455
+
456
+ | \- | Set object |
457
+ | topRight |
458
+
459
+ Slot positioned to the top right of the card, often used for an icon or action menu
460
+
461
+ ReactNode
462
+
463
+
464
+
465
+ | \- | Set object |
466
+ | width |
467
+
468
+ The **`width`** CSS property sets an element's width. By default, it sets the width of the content area, but if `box-sizing` is set to `border-box`, it sets the width of the border area.
469
+
470
+ This prop only allows widths available throughout the component library. To use a custom width, you need to use the `style` prop, or add a custom class to the element and use CSS.
471
+
472
+ | Chrome | Firefox | Safari | Edge | IE |
473
+ | --- | --- | --- | --- | --- |
474
+ | **1** | **1** | **1** | **12** | **4** |
475
+
476
+ ResponsiveProp<"auto" | SizeToken | "screen" | "1/2" | "1/3" | "2/3" | "1/4" | "2/4" | "3/4" | "1/5" | "2/5" | "3/5" | "4/5" | "1/6" | "2/6" | "3/6" | "4/6" | "5/6" | "1/12" | "2/12" | ... 8 more ... | "11/12"> | undefined
477
+
478
+ | \- | Set object |
479
+
27
480
  [](#examples)Examples
28
481
  ---------------------
29
482
 
@@ -59,16 +512,16 @@ Hide code
59
512
 
60
513
  \[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; }
61
514
 
62
- <div className\="iress-u-stack iress--gutter--md"\>
63
- <IressCard padding\="none"\>
515
+ <IressStack gap\="md"\>
516
+ <IressCard p\="none"\>
64
517
  I’m a card with none padding </IressCard\>
65
- <IressCard padding\="sm"\>
518
+ <IressCard p\="sm"\>
66
519
  I’m a card with sm padding </IressCard\>
67
- <IressCard padding\="md"\>
520
+ <IressCard p\="md"\>
68
521
  I’m a card with md padding </IressCard\>
69
- <IressCard padding\="lg"\>
522
+ <IressCard p\="lg"\>
70
523
  I’m a card with lg padding </IressCard\>
71
- </div\>
524
+ </IressStack\>
72
525
 
73
526
  Copy
74
527
 
@@ -151,7 +604,7 @@ Hide code
151
604
 
152
605
  \[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; }
153
606
 
154
- <IressCard topRight\={<IressPopover activator\={<IressButton\><IressIcon name\="ellipsis-v" size\="lg"/></IressButton\>} align\="bottom-end"\><IressPanel\>More actions in here</IressPanel\></IressPopover\>}\>
607
+ <IressCard topRight\={<IressPopover activator\={<IressButton mode\="tertiary" textStyle\="typography.body.lg"\><IressIcon name\="ellipsis-v" /></IressButton\>} align\="bottom-end"\><IressPanel\>More actions in here</IressPanel\></IressPopover\>}\>
155
608
  I'm a card using the topRight render prop
156
609
  </IressCard\>
157
610
 
@@ -163,7 +616,8 @@ Use the `heading` prop to add a header to the card. The header can be any compon
163
616
 
164
617
  **Note:** `headingText` and `headingLevel` props have been replaced with the `heading` render prop to give you more control over the heading element and its content. To use the previous behaviour, you can pass a string which will automatically create a `h2` element, or pass a `h*` element with the text as a child.
165
618
 
166
- ### Welcome to Iress!
619
+ Welcome to Iress!
620
+ -----------------
167
621
 
168
622
  I'm a card using the heading render prop
169
623
 
@@ -171,7 +625,7 @@ Hide code
171
625
 
172
626
  \[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; }
173
627
 
174
- <IressCard heading\={<h3\>Welcome to Iress!</h3\>}\>
628
+ <IressCard heading\={<h2\>Welcome to Iress!</h2\>}\>
175
629
  I'm a card using the heading render prop
176
630
  </IressCard\>
177
631
 
@@ -199,8 +653,7 @@ Copy
199
653
 
200
654
  Use the `content` prop to add content to the card. The content can be any component you like, but it is designed to support simple text based elements.
201
655
 
202
- Find out all the onboarding material you need
203
- [with this easy guide](https://iress.com).
656
+ Find out all the onboarding material you need [with this easy guide](https://iress.com).
204
657
 
205
658
  Hide code
206
659
 
@@ -209,7 +662,6 @@ Hide code
209
662
  <IressCard\>
210
663
  <IressText\>
211
664
  Find out all the onboarding material you need{' '}
212
- <br />
213
665
  <a href\="https://iress.com"\>
214
666
  with this easy guide </a\>
215
667
  . </IressText\>
@@ -231,7 +683,7 @@ Hide code
231
683
 
232
684
  \[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; }
233
685
 
234
- <IressCard footer\={<IressInline gutter\="sm" horizontalAlign\="between"\><IressInline gutter\="sm"\><IressBadge mode\="background-default" pill\>#new-starter</IressBadge\><IressBadge mode\="background-default" pill\>#first-day</IressBadge\></IressInline\><IressBadge mode\="positive"\>NEW</IressBadge\></IressInline\>}\>
686
+ <IressCard footer\={<IressInline gap\="sm" horizontalAlign\="between"\><IressInline gap\="sm"\><IressBadge pill\>#new-starter</IressBadge\><IressBadge pill\>#first-day</IressBadge\></IressInline\><IressBadge mode\="success"\>NEW</IressBadge\></IressInline\>}\>
235
687
  I'm a card using the footer render prop
236
688
  </IressCard\>
237
689
 
@@ -259,10 +711,10 @@ More actions in here
259
711
 
260
712
  ![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
261
713
 
262
- ### Welcome to Iress!
714
+ Welcome to Iress!
715
+ -----------------
263
716
 
264
- Find out all the onboarding material you need
265
- [with this easy guide](https://iress.com).
717
+ Find out all the onboarding material you need [with this easy guide](https://iress.com).
266
718
 
267
719
  #new-starter#first-day
268
720
 
@@ -272,10 +724,10 @@ More actions in here
272
724
 
273
725
  ![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
274
726
 
275
- ### Welcome to Iress!
727
+ Welcome to Iress!
728
+ -----------------
276
729
 
277
- Find out all the onboarding material you need
278
- [with this easy guide](https://iress.com).
730
+ Find out all the onboarding material you need [with this easy guide](https://iress.com).
279
731
 
280
732
  #new-starter#first-day
281
733
 
@@ -285,10 +737,10 @@ More actions in here
285
737
 
286
738
  ![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
287
739
 
288
- ### Welcome to Iress!
740
+ Welcome to Iress!
741
+ -----------------
289
742
 
290
- Find out all the onboarding material you need
291
- [with this easy guide](https://iress.com).
743
+ Find out all the onboarding material you need [with this easy guide](https://iress.com).
292
744
 
293
745
  #new-starter#first-day
294
746
 
@@ -307,13 +759,13 @@ const supportedCardSlots \= {
307
759
  alt\="A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground"
308
760
  />
309
761
  ),
310
- heading: <h3\>Welcome to Iress!</h3\>,
762
+ heading: <h2\>Welcome to Iress!</h2\>,
311
763
  topRight: (
312
764
  <IressPopover
313
765
  align\="bottom-end"
314
766
  activator\={
315
- <IressButton\>
316
- <IressIcon name\="ellipsis-v" size\="lg" />
767
+ <IressButton mode\="tertiary" textStyle\="typography.body.lg"\>
768
+ <IressIcon name\="ellipsis-v" />
317
769
  </IressButton\>
318
770
  }
319
771
  \>
@@ -322,19 +774,17 @@ const supportedCardSlots \= {
322
774
  ),
323
775
  children: (
324
776
  <IressText\>
325
- Find out all the onboarding material you need <br />
777
+ Find out all the onboarding material you need{' '}
326
778
  <a href\="https://iress.com"\>with this easy guide</a\>.
327
779
  </IressText\>
328
780
  ),
329
781
  footer: (
330
- <IressInline gutter\="sm" horizontalAlign\="between"\>
331
- <IressInline gutter\="sm"\>
332
- <IressBadge pill mode\="background-default"\>
333
- #new-starter </IressBadge\>
334
- <IressBadge pill mode\="background-default"\>
335
- #first-day </IressBadge\>
782
+ <IressInline gap\="sm" horizontalAlign\="between"\>
783
+ <IressInline gap\="sm"\>
784
+ <IressBadge pill\>#new-starter</IressBadge\>
785
+ <IressBadge pill\>#first-day</IressBadge\>
336
786
  </IressInline\>
337
- <IressBadge mode\="positive"\>NEW</IressBadge\>
787
+ <IressBadge mode\="success"\>NEW</IressBadge\>
338
788
  </IressInline\>
339
789
  ),
340
790
  };
@@ -356,8 +806,8 @@ export const CardAllSlots \= () \=> {
356
806
  ),
357
807
  );
358
808
  return (
359
- <IressContainer\>
360
- <IressInline gutter\="md"\>
809
+ <IressStack maxWidth\="container.lg" gap\="md" mx\="auto"\>
810
+ <IressInline gap\="md"\>
361
811
  {SUPPORTED\_CARD\_SLOTS.map((slot) \=> (
362
812
  <IressToggle
363
813
  key\={slot}
@@ -370,7 +820,7 @@ export const CardAllSlots \= () \=> {
370
820
  </IressToggle\>
371
821
  ))}
372
822
  </IressInline\>
373
- <hr />
823
+ <IressDivider />
374
824
  <IressRow gutter\="md"\>
375
825
  <IressCol\>
376
826
  <IressCard {...filteredArgs} />
@@ -382,7 +832,7 @@ export const CardAllSlots \= () \=> {
382
832
  <IressCard {...filteredArgs} />
383
833
  </IressCol\>
384
834
  </IressRow\>
385
- </IressContainer\>
835
+ </IressStack\>
386
836
  );
387
837
  };
388
838