@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
  Used in conjunction with the `IressRow` component to layout page content
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
  Column 1
10
18
 
11
19
  Column 2
@@ -14,7 +22,7 @@ Hide code
14
22
 
15
23
  \[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; }
16
24
 
17
- <IressRow gutter\="md"\>
25
+ <IressRow gutter\="spacing.400"\>
18
26
  <IressCol\>
19
27
  <IressPlaceholder\>
20
28
  Column 1 </IressPlaceholder\>
@@ -27,6 +35,412 @@ Hide code
27
35
 
28
36
  Copy
29
37
 
38
+ [](#props)Props
39
+ ---------------
40
+
41
+ | Name | Description | Default | Control |
42
+ | --- | --- | --- | --- |
43
+ | alignSelf |
44
+ Individual alignment of column
45
+
46
+ "stretch""center""end""start"undefined
47
+
48
+
49
+
50
+ | \- | Set object |
51
+ | bg |
52
+
53
+ **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
54
+
55
+ We recommend using the following token values for best background contrast:
56
+
57
+ * `colour.primary.fill` for primary backgrounds that need to stand out
58
+ * `colour.primary.surface` for primary backgrounds that need to be less prominent
59
+ * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
60
+ * `colour.neutral.20` for a slightly darker background color, used in neutral state components
61
+ * `colour.system.danger.fill` for error backgrounds that need to stand out
62
+ * `colour.system.danger.surface` for error backgrounds that need to be less prominent
63
+ * `colour.system.success.fill` for success backgrounds that need to stand out
64
+ * `colour.system.success.surface` for success backgrounds that need to be less prominent
65
+ * `colour.system.warning.fill` for warning backgrounds that need to stand out
66
+ * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
67
+ * `colour.system.info.fill` for info backgrounds that need to stand out
68
+ * `colour.system.info.surface` for info backgrounds that need to be less prominent
69
+
70
+ ResponsiveProp<ColorToken> | undefined
71
+
72
+ | \- | Set object |
73
+ | borderRadius |
74
+
75
+ The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
76
+
77
+ | Chrome | Firefox | Safari | Edge | IE |
78
+ | --- | --- | --- | --- | --- |
79
+ | **4** | **4** | **5** | **12** | **9** |
80
+ | 1 _\-x-_ | | 3 _\-x-_ | | |
81
+
82
+ ResponsiveProp<RadiusToken> | undefined
83
+
84
+ | \- | Set object |
85
+ | children |
86
+
87
+ Any content you would like to be contained in a column.
88
+
89
+ ReactNode
90
+
91
+
92
+
93
+ | \- | \- |
94
+ | color |
95
+
96
+ 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`.
97
+
98
+ We recommend using the following token values for best color contrast:
99
+
100
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
101
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
102
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
103
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
104
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
105
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
106
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
107
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
108
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
109
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
110
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
111
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
112
+
113
+ ResponsiveProp<ColorToken> | undefined
114
+
115
+ | \- | Set object |
116
+ | focusable |
117
+
118
+ 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.
119
+
120
+ "true""within"undefined
121
+
122
+
123
+
124
+ | \- | Set object |
125
+ | hide |
126
+
127
+ 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.
128
+
129
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
130
+
131
+ Notes:
132
+
133
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
134
+ * Consider if you can conditionally render the element instead of hiding it.
135
+
136
+ ResponsiveProp<boolean> | undefined
137
+
138
+ | \- | Set object |
139
+ | layerStyle |
140
+
141
+ 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.
142
+
143
+ * `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.
144
+ * `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.
145
+ * `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.
146
+
147
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
148
+
149
+ | \- | Set object |
150
+ | m |
151
+
152
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
153
+
154
+ 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.
155
+
156
+ | Chrome | Firefox | Safari | Edge | IE |
157
+ | --- | --- | --- | --- | --- |
158
+ | **1** | **1** | **1** | **12** | **3** |
159
+
160
+ ResponsiveProp<SpacingToken | "auto"> | undefined
161
+
162
+ | \- | Set object |
163
+ | maxWidth |
164
+
165
+ 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`.
166
+
167
+ | Chrome | Firefox | Safari | Edge | IE |
168
+ | --- | --- | --- | --- | --- |
169
+ | **1** | **1** | **1** | **12** | **7** |
170
+
171
+ 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
172
+
173
+ | \- | Set object |
174
+ | mb |
175
+
176
+ 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.
177
+
178
+ It uses the spacing tokens in the design system.
179
+
180
+ | Chrome | Firefox | Safari | Edge | IE |
181
+ | --- | --- | --- | --- | --- |
182
+ | **1** | **1** | **1** | **12** | **3** |
183
+
184
+ ResponsiveProp<SpacingToken | "auto"> | undefined
185
+
186
+ | \- | Set object |
187
+ | ml |
188
+
189
+ 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.
190
+
191
+ It uses the spacing tokens in the design system.
192
+
193
+ | Chrome | Firefox | Safari | Edge | IE |
194
+ | --- | --- | --- | --- | --- |
195
+ | **1** | **1** | **1** | **12** | **3** |
196
+
197
+ ResponsiveProp<SpacingToken | "auto"> | undefined
198
+
199
+ | \- | Set object |
200
+ | mr |
201
+
202
+ 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.
203
+
204
+ It uses the spacing tokens in the design system.
205
+
206
+ | Chrome | Firefox | Safari | Edge | IE |
207
+ | --- | --- | --- | --- | --- |
208
+ | **1** | **1** | **1** | **12** | **3** |
209
+
210
+ ResponsiveProp<SpacingToken | "auto"> | undefined
211
+
212
+ | \- | Set object |
213
+ | mt |
214
+
215
+ 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.
216
+
217
+ It uses the spacing tokens in the design system.
218
+
219
+ | Chrome | Firefox | Safari | Edge | IE |
220
+ | --- | --- | --- | --- | --- |
221
+ | **1** | **1** | **1** | **12** | **3** |
222
+
223
+ ResponsiveProp<SpacingToken | "auto"> | undefined
224
+
225
+ | \- | Set object |
226
+ | mx |
227
+
228
+ 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.
229
+
230
+ 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.
231
+
232
+ | Chrome | Firefox | Safari | Edge | IE |
233
+ | --- | --- | --- | --- | --- |
234
+ | **1** | **1** | **1** | **12** | **3** |
235
+
236
+ ResponsiveProp<SpacingToken | "auto"> | undefined
237
+
238
+ | \- | Set object |
239
+ | my |
240
+
241
+ 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.
242
+
243
+ 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.
244
+
245
+ | Chrome | Firefox | Safari | Edge | IE |
246
+ | --- | --- | --- | --- | --- |
247
+ | **1** | **1** | **1** | **12** | **3** |
248
+
249
+ ResponsiveProp<SpacingToken | "auto"> | undefined
250
+
251
+ | \- | Set object |
252
+ | noGutter |
253
+
254
+ 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.
255
+
256
+ booleanundefined
257
+
258
+
259
+
260
+ | \- | Set object |
261
+ | offset |
262
+
263
+ Number of columns to offset.
264
+
265
+ ResponsiveProp<0 | 4 | 1 | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | 6 | 2 | "8" | "9" | "10" | "11" | 3 | 5 | 7 | 10 | 8 | 11 | 9> | undefined
266
+
267
+ | \- | Set object |
268
+ | p |
269
+
270
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
271
+
272
+ 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.
273
+
274
+ | Chrome | Firefox | Safari | Edge | IE |
275
+ | --- | --- | --- | --- | --- |
276
+ | **1** | **1** | **1** | **12** | **3** |
277
+
278
+ 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
279
+
280
+ | \- | Set object |
281
+ | pb |
282
+
283
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
284
+
285
+ 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.
286
+
287
+ | Chrome | Firefox | Safari | Edge | IE |
288
+ | --- | --- | --- | --- | --- |
289
+ | **1** | **1** | **1** | **12** | **3** |
290
+
291
+ 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
292
+
293
+ | \- | Set object |
294
+ | pl |
295
+
296
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
297
+
298
+ 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.
299
+
300
+ | Chrome | Firefox | Safari | Edge | IE |
301
+ | --- | --- | --- | --- | --- |
302
+ | **1** | **1** | **1** | **12** | **3** |
303
+
304
+ 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
305
+
306
+ | \- | Set object |
307
+ | pr |
308
+
309
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
310
+
311
+ 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.
312
+
313
+ | Chrome | Firefox | Safari | Edge | IE |
314
+ | --- | --- | --- | --- | --- |
315
+ | **1** | **1** | **1** | **12** | **3** |
316
+
317
+ 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
318
+
319
+ | \- | Set object |
320
+ | pt |
321
+
322
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
323
+
324
+ 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.
325
+
326
+ | Chrome | Firefox | Safari | Edge | IE |
327
+ | --- | --- | --- | --- | --- |
328
+ | **1** | **1** | **1** | **12** | **3** |
329
+
330
+ 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
331
+
332
+ | \- | Set object |
333
+ | px |
334
+
335
+ 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.
336
+
337
+ 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.
338
+
339
+ | Chrome | Firefox | Safari | Edge | IE |
340
+ | --- | --- | --- | --- | --- |
341
+ | **1** | **1** | **1** | **12** | **3** |
342
+
343
+ 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
344
+
345
+ | \- | Set object |
346
+ | py |
347
+
348
+ 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.
349
+
350
+ 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.
351
+
352
+ | Chrome | Firefox | Safari | Edge | IE |
353
+ | --- | --- | --- | --- | --- |
354
+ | **1** | **1** | **1** | **12** | **3** |
355
+
356
+ 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
357
+
358
+ | \- | Set object |
359
+ | rowGap |
360
+
361
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
362
+
363
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
364
+
365
+ | Chrome | Firefox | Safari | Edge | IE |
366
+ | --- | --- | --- | --- | --- |
367
+ | **47** | **52** | **10.1** | **16** | No |
368
+
369
+ 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
370
+
371
+ | \- | Set object |
372
+ | span |
373
+
374
+ Number of columns to span.
375
+
376
+ ResponsiveProp<4 | 1 | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "auto" | 12 | 6 | 2 | "8" | "9" | "10" | "11" | "12" | 3 | 5 | 7 | 10 | 8 | 11 | 9> | undefined
377
+
378
+ |
379
+
380
+ auto
381
+
382
+ | Set object |
383
+ | srOnly |
384
+
385
+ 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.
386
+
387
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
388
+
389
+ ResponsiveProp<boolean> | undefined
390
+
391
+ | \- | Set object |
392
+ | stretch |
393
+
394
+ 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.
395
+
396
+ booleanundefined
397
+
398
+
399
+
400
+ | \- | Set object |
401
+ | textAlign |
402
+
403
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
404
+
405
+ | Chrome | Firefox | Safari | Edge | IE |
406
+ | --- | --- | --- | --- | --- |
407
+ | **1** | **1** | **1** | **12** | **3** |
408
+
409
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
410
+
411
+ | \- | Set object |
412
+ | textStyle |
413
+
414
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
415
+
416
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
417
+ * `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.
418
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
419
+ * `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.
420
+ * `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.
421
+ * `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.
422
+ * `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.
423
+ * `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.
424
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
425
+
426
+ 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
427
+
428
+ | \- | Set object |
429
+ | width |
430
+
431
+ 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.
432
+
433
+ 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.
434
+
435
+ | Chrome | Firefox | Safari | Edge | IE |
436
+ | --- | --- | --- | --- | --- |
437
+ | **1** | **1** | **1** | **12** | **4** |
438
+
439
+ 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
440
+
441
+ | \- | Set object |
442
+ | Show Storybook only itemsStorybook only | Show Storybook only items |
443
+
30
444
  [](#examples)Examples
31
445
  ---------------------
32
446
 
@@ -48,8 +462,8 @@ Hide code
48
462
 
49
463
  \[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; }
50
464
 
51
- <IressStack gutter\="md"\>
52
- <IressRow gutter\="md"\>
465
+ <IressStack gap\="spacing.400"\>
466
+ <IressRow gutter\="spacing.400"\>
53
467
  <IressCol\>
54
468
  <IressPlaceholder\>
55
469
  1 of 2 </IressPlaceholder\>
@@ -59,7 +473,7 @@ Hide code
59
473
  2 of 2 </IressPlaceholder\>
60
474
  </IressCol\>
61
475
  </IressRow\>
62
- <IressRow gutter\="md"\>
476
+ <IressRow gutter\="spacing.400"\>
63
477
  <IressCol\>
64
478
  <IressPlaceholder\>
65
479
  1 of 3 </IressPlaceholder\>
@@ -113,14 +527,14 @@ Hide code
113
527
 
114
528
  \[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; }
115
529
 
116
- <IressStack gutter\="md"\>
117
- <IressRow gutter\="md"\>
530
+ <IressStack gap\="spacing.400"\>
531
+ <IressRow gutter\="spacing.400"\>
118
532
  <IressCol span\="12"\>
119
533
  <IressPlaceholder\>
120
534
  12 </IressPlaceholder\>
121
535
  </IressCol\>
122
536
  </IressRow\>
123
- <IressRow gutter\="md"\>
537
+ <IressRow gutter\="spacing.400"\>
124
538
  <IressCol span\="1"\>
125
539
  <IressPlaceholder\>
126
540
  1 </IressPlaceholder\>
@@ -130,7 +544,7 @@ Hide code
130
544
  11 </IressPlaceholder\>
131
545
  </IressCol\>
132
546
  </IressRow\>
133
- <IressRow gutter\="md"\>
547
+ <IressRow gutter\="spacing.400"\>
134
548
  <IressCol span\="2"\>
135
549
  <IressPlaceholder\>
136
550
  2 </IressPlaceholder\>
@@ -140,7 +554,7 @@ Hide code
140
554
  10 </IressPlaceholder\>
141
555
  </IressCol\>
142
556
  </IressRow\>
143
- <IressRow gutter\="md"\>
557
+ <IressRow gutter\="spacing.400"\>
144
558
  <IressCol span\="3"\>
145
559
  <IressPlaceholder\>
146
560
  3 </IressPlaceholder\>
@@ -150,7 +564,7 @@ Hide code
150
564
  9 </IressPlaceholder\>
151
565
  </IressCol\>
152
566
  </IressRow\>
153
- <IressRow gutter\="md"\>
567
+ <IressRow gutter\="spacing.400"\>
154
568
  <IressCol span\="4"\>
155
569
  <IressPlaceholder\>
156
570
  4 </IressPlaceholder\>
@@ -160,7 +574,7 @@ Hide code
160
574
  8 </IressPlaceholder\>
161
575
  </IressCol\>
162
576
  </IressRow\>
163
- <IressRow gutter\="md"\>
577
+ <IressRow gutter\="spacing.400"\>
164
578
  <IressCol span\="5"\>
165
579
  <IressPlaceholder\>
166
580
  5 </IressPlaceholder\>
@@ -170,7 +584,7 @@ Hide code
170
584
  7 </IressPlaceholder\>
171
585
  </IressCol\>
172
586
  </IressRow\>
173
- <IressRow gutter\="md"\>
587
+ <IressRow gutter\="spacing.400"\>
174
588
  <IressCol span\="6"\>
175
589
  <IressPlaceholder\>
176
590
  6 </IressPlaceholder\>
@@ -202,12 +616,12 @@ Hide code
202
616
 
203
617
  \[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; }
204
618
 
205
- <IressStack gutter\="md"\>
619
+ <IressStack gap\="spacing.400"\>
206
620
  <IressPanel\>
207
621
  Current breakpoint:{' '}
208
622
  <CurrentBreakpoint />
209
623
  . </IressPanel\>
210
- <IressRow gutter\="md"\>
624
+ <IressRow gutter\="spacing.400"\>
211
625
  <IressCol
212
626
  span\={{
213
627
  md: 3,
@@ -215,7 +629,7 @@ Hide code
215
629
  }}
216
630
  \>
217
631
  <IressPlaceholder\>
218
- <IressText align\="center"\>
632
+ <IressText textAlign\="center"\>
219
633
  Column 1 <br />
220
634
  {\`{"xs":12,"md":3}\`}
221
635
  </IressText\>
@@ -228,7 +642,7 @@ Hide code
228
642
  }}
229
643
  \>
230
644
  <IressPlaceholder\>
231
- <IressText align\="center"\>
645
+ <IressText textAlign\="center"\>
232
646
  Column 2 <br />
233
647
  {\`{"xs":12,"md":9}\`}
234
648
  </IressText\>
@@ -269,8 +683,8 @@ Hide code
269
683
 
270
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; }
271
685
 
272
- <IressStack gutter\="md"\>
273
- <IressRow gutter\="md"\>
686
+ <IressStack gap\="spacing.400"\>
687
+ <IressRow gutter\="spacing.400"\>
274
688
  <IressCol
275
689
  offset\="1"
276
690
  span\="1"
@@ -279,7 +693,7 @@ Hide code
279
693
  1 </IressPlaceholder\>
280
694
  </IressCol\>
281
695
  </IressRow\>
282
- <IressRow gutter\="md"\>
696
+ <IressRow gutter\="spacing.400"\>
283
697
  <IressCol
284
698
  offset\="2"
285
699
  span\="1"
@@ -288,7 +702,7 @@ Hide code
288
702
  2 </IressPlaceholder\>
289
703
  </IressCol\>
290
704
  </IressRow\>
291
- <IressRow gutter\="md"\>
705
+ <IressRow gutter\="spacing.400"\>
292
706
  <IressCol
293
707
  offset\="3"
294
708
  span\="1"
@@ -297,7 +711,7 @@ Hide code
297
711
  3 </IressPlaceholder\>
298
712
  </IressCol\>
299
713
  </IressRow\>
300
- <IressRow gutter\="md"\>
714
+ <IressRow gutter\="spacing.400"\>
301
715
  <IressCol
302
716
  offset\="4"
303
717
  span\="1"
@@ -306,7 +720,7 @@ Hide code
306
720
  4 </IressPlaceholder\>
307
721
  </IressCol\>
308
722
  </IressRow\>
309
- <IressRow gutter\="md"\>
723
+ <IressRow gutter\="spacing.400"\>
310
724
  <IressCol
311
725
  offset\="5"
312
726
  span\="1"
@@ -315,7 +729,7 @@ Hide code
315
729
  5 </IressPlaceholder\>
316
730
  </IressCol\>
317
731
  </IressRow\>
318
- <IressRow gutter\="md"\>
732
+ <IressRow gutter\="spacing.400"\>
319
733
  <IressCol
320
734
  offset\="6"
321
735
  span\="1"
@@ -324,7 +738,7 @@ Hide code
324
738
  6 </IressPlaceholder\>
325
739
  </IressCol\>
326
740
  </IressRow\>
327
- <IressRow gutter\="md"\>
741
+ <IressRow gutter\="spacing.400"\>
328
742
  <IressCol
329
743
  offset\="7"
330
744
  span\="1"
@@ -333,7 +747,7 @@ Hide code
333
747
  7 </IressPlaceholder\>
334
748
  </IressCol\>
335
749
  </IressRow\>
336
- <IressRow gutter\="md"\>
750
+ <IressRow gutter\="spacing.400"\>
337
751
  <IressCol
338
752
  offset\="8"
339
753
  span\="1"
@@ -342,7 +756,7 @@ Hide code
342
756
  8 </IressPlaceholder\>
343
757
  </IressCol\>
344
758
  </IressRow\>
345
- <IressRow gutter\="md"\>
759
+ <IressRow gutter\="spacing.400"\>
346
760
  <IressCol
347
761
  offset\="9"
348
762
  span\="1"
@@ -351,7 +765,7 @@ Hide code
351
765
  9 </IressPlaceholder\>
352
766
  </IressCol\>
353
767
  </IressRow\>
354
- <IressRow gutter\="md"\>
768
+ <IressRow gutter\="spacing.400"\>
355
769
  <IressCol
356
770
  offset\="10"
357
771
  span\="1"
@@ -360,7 +774,7 @@ Hide code
360
774
  10 </IressPlaceholder\>
361
775
  </IressCol\>
362
776
  </IressRow\>
363
- <IressRow gutter\="md"\>
777
+ <IressRow gutter\="spacing.400"\>
364
778
  <IressCol
365
779
  offset\="11"
366
780
  span\="1"
@@ -382,27 +796,28 @@ For example, if you specify an offset for `md`, it will apply to `lg`, `xl` and
382
796
  Current breakpoint: **xl** breakpoint (1200px - 1499px).
383
797
 
384
798
  Column 1
385
- {"lg":2}
799
+ {"md":5,"lg":2}
386
800
 
387
801
  Hide code
388
802
 
389
803
  \[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; }
390
804
 
391
- <IressStack gutter\="md"\>
805
+ <IressStack gap\="spacing.400"\>
392
806
  <IressPanel\>
393
807
  Current breakpoint:{' '}
394
808
  <CurrentBreakpoint />
395
809
  . </IressPanel\>
396
- <IressRow gutter\="md"\>
810
+ <IressRow gutter\="spacing.400"\>
397
811
  <IressCol
398
812
  offset\={{
399
- lg: 2
813
+ lg: 2,
814
+ md: 5
400
815
  }}
401
816
  \>
402
817
  <IressPlaceholder\>
403
- <IressText align\="center"\>
818
+ <IressText textAlign\="center"\>
404
819
  Column 1 <br />
405
- {\`{"lg":2}\`}
820
+ {\`{"md":5,"lg":2}\`}
406
821
  </IressText\>
407
822
  </IressPlaceholder\>
408
823
  </IressCol\>
@@ -429,8 +844,8 @@ Hide code
429
844
 
430
845
  <IressContainer\>
431
846
  <IressRow
432
- className\="ids-styles--set-height-v5150"
433
- gutter\="md"
847
+ className\="\_setHeight\_1d00u\_60"
848
+ gutter\="spacing.400"
434
849
  \>
435
850
  <IressCol alignSelf\="start"\>
436
851
  <IressPlaceholder\>