@iress-oss/ids-mcp-server 6.0.0-alpha.0 → 6.0.0-alpha.1-canary-20251204014525-3f0dce4

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 (108) hide show
  1. package/dist/searchHandlers.test.js +8 -2
  2. package/dist/toolHandler.test.js +9 -9
  3. package/dist/utils.test.js +6 -2
  4. package/package.json +32 -30
  5. package/generated/docs/components-alert-docs.md +0 -702
  6. package/generated/docs/components-autocomplete-docs.md +0 -1433
  7. package/generated/docs/components-autocomplete-recipes-docs.md +0 -104
  8. package/generated/docs/components-badge-docs.md +0 -531
  9. package/generated/docs/components-button-docs.md +0 -1442
  10. package/generated/docs/components-buttongroup-docs.md +0 -748
  11. package/generated/docs/components-card-docs.md +0 -944
  12. package/generated/docs/components-checkbox-docs.md +0 -694
  13. package/generated/docs/components-checkboxgroup-docs.md +0 -1087
  14. package/generated/docs/components-checkboxgroup-recipes-docs.md +0 -119
  15. package/generated/docs/components-col-docs.md +0 -881
  16. package/generated/docs/components-container-docs.md +0 -123
  17. package/generated/docs/components-divider-docs.md +0 -576
  18. package/generated/docs/components-expander-docs.md +0 -594
  19. package/generated/docs/components-field-docs.md +0 -2007
  20. package/generated/docs/components-filter-docs.md +0 -1322
  21. package/generated/docs/components-hide-docs.md +0 -702
  22. package/generated/docs/components-icon-docs.md +0 -816
  23. package/generated/docs/components-image-docs.md +0 -493
  24. package/generated/docs/components-inline-docs.md +0 -2003
  25. package/generated/docs/components-input-docs.md +0 -867
  26. package/generated/docs/components-input-recipes-docs.md +0 -140
  27. package/generated/docs/components-inputcurrency-docs.md +0 -689
  28. package/generated/docs/components-inputcurrency-recipes-docs.md +0 -115
  29. package/generated/docs/components-introduction-docs.md +0 -450
  30. package/generated/docs/components-label-docs.md +0 -562
  31. package/generated/docs/components-link-docs.md +0 -586
  32. package/generated/docs/components-menu-docs.md +0 -1146
  33. package/generated/docs/components-menu-menuitem-docs.md +0 -739
  34. package/generated/docs/components-modal-docs.md +0 -1346
  35. package/generated/docs/components-panel-docs.md +0 -600
  36. package/generated/docs/components-placeholder-docs.md +0 -446
  37. package/generated/docs/components-popover-docs.md +0 -1529
  38. package/generated/docs/components-popover-recipes-docs.md +0 -211
  39. package/generated/docs/components-progress-docs.md +0 -568
  40. package/generated/docs/components-provider-docs.md +0 -160
  41. package/generated/docs/components-radio-docs.md +0 -563
  42. package/generated/docs/components-radiogroup-docs.md +0 -1153
  43. package/generated/docs/components-readonly-docs.md +0 -535
  44. package/generated/docs/components-richselect-docs.md +0 -5836
  45. package/generated/docs/components-row-docs.md +0 -2354
  46. package/generated/docs/components-select-docs.md +0 -940
  47. package/generated/docs/components-skeleton-docs.md +0 -597
  48. package/generated/docs/components-skeleton-recipes-docs.md +0 -76
  49. package/generated/docs/components-skiplink-docs.md +0 -587
  50. package/generated/docs/components-slideout-docs.md +0 -1036
  51. package/generated/docs/components-slider-docs.md +0 -828
  52. package/generated/docs/components-spinner-docs.md +0 -450
  53. package/generated/docs/components-stack-docs.md +0 -923
  54. package/generated/docs/components-table-ag-grid-docs.md +0 -1444
  55. package/generated/docs/components-table-docs.md +0 -2327
  56. package/generated/docs/components-tabset-docs.md +0 -768
  57. package/generated/docs/components-tabset-tab-docs.md +0 -550
  58. package/generated/docs/components-tag-docs.md +0 -548
  59. package/generated/docs/components-text-docs.md +0 -585
  60. package/generated/docs/components-toaster-docs.md +0 -755
  61. package/generated/docs/components-toggle-docs.md +0 -614
  62. package/generated/docs/components-tooltip-docs.md +0 -747
  63. package/generated/docs/components-validationmessage-docs.md +0 -1161
  64. package/generated/docs/contact-us-docs.md +0 -27
  65. package/generated/docs/extensions-editor-docs.md +0 -1181
  66. package/generated/docs/extensions-editor-recipes-docs.md +0 -89
  67. package/generated/docs/foundations-accessibility-docs.md +0 -40
  68. package/generated/docs/foundations-consistency-docs.md +0 -52
  69. package/generated/docs/foundations-content-docs.md +0 -23
  70. package/generated/docs/foundations-grid-docs.md +0 -74
  71. package/generated/docs/foundations-introduction-docs.md +0 -19
  72. package/generated/docs/foundations-principles-docs.md +0 -70
  73. package/generated/docs/foundations-responsive-breakpoints-docs.md +0 -193
  74. package/generated/docs/foundations-tokens-colour-docs.md +0 -564
  75. package/generated/docs/foundations-tokens-elevation-docs.md +0 -155
  76. package/generated/docs/foundations-tokens-introduction-docs.md +0 -190
  77. package/generated/docs/foundations-tokens-radius-docs.md +0 -71
  78. package/generated/docs/foundations-tokens-spacing-docs.md +0 -89
  79. package/generated/docs/foundations-tokens-typography-docs.md +0 -322
  80. package/generated/docs/foundations-user-experience-docs.md +0 -63
  81. package/generated/docs/foundations-visual-design-docs.md +0 -46
  82. package/generated/docs/foundations-z-index-stacking-docs.md +0 -31
  83. package/generated/docs/frequently-asked-questions-docs.md +0 -53
  84. package/generated/docs/get-started-develop-docs.md +0 -209
  85. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  86. package/generated/docs/guidelines.md +0 -2054
  87. package/generated/docs/introduction-docs.md +0 -87
  88. package/generated/docs/news-version-6-docs.md +0 -93
  89. package/generated/docs/patterns-form-docs.md +0 -3902
  90. package/generated/docs/patterns-form-recipes-docs.md +0 -1370
  91. package/generated/docs/patterns-introduction-docs.md +0 -24
  92. package/generated/docs/patterns-loading-docs.md +0 -4043
  93. package/generated/docs/resources-code-katas-docs.md +0 -29
  94. package/generated/docs/resources-introduction-docs.md +0 -38
  95. package/generated/docs/resources-mcp-server-docs.md +0 -27
  96. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  97. package/generated/docs/styling-props-colour-docs.md +0 -172
  98. package/generated/docs/styling-props-elevation-docs.md +0 -88
  99. package/generated/docs/styling-props-radius-docs.md +0 -86
  100. package/generated/docs/styling-props-reference-docs.md +0 -160
  101. package/generated/docs/styling-props-screen-readers-docs.md +0 -71
  102. package/generated/docs/styling-props-sizing-docs.md +0 -627
  103. package/generated/docs/styling-props-spacing-docs.md +0 -2282
  104. package/generated/docs/styling-props-typography-docs.md +0 -121
  105. package/generated/docs/themes-available-themes-docs.md +0 -66
  106. package/generated/docs/themes-introduction-docs.md +0 -121
  107. package/generated/docs/versions-docs.md +0 -17
  108. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,923 +0,0 @@
1
- [](#stack)Stack
2
- ===============
3
-
4
- Overview
5
- --------
6
-
7
- Use `IressStack` to control vertical spacing between content with consistent present values.
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
-
17
- Hide code
18
-
19
- \[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; }
20
-
21
- <IressStack gap\="spacing.100"\>
22
- <IressPlaceholder height\="50" />
23
- <IressPlaceholder height\="50" />
24
- <IressPlaceholder height\="50" />
25
- <IressPlaceholder height\="50" />
26
- <IressPlaceholder height\="50" />
27
- </IressStack\>
28
-
29
- Copy
30
-
31
- [](#props)Props
32
- ---------------
33
-
34
- | Name | Description | Default | Control |
35
- | --- | --- | --- | --- |
36
- | bg |
37
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
38
-
39
- We recommend using the following token values for best background contrast:
40
-
41
- * `colour.primary.fill` for primary backgrounds that need to stand out
42
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
43
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
44
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
45
- * `colour.system.danger.fill` for error backgrounds that need to stand out
46
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
47
- * `colour.system.success.fill` for success backgrounds that need to stand out
48
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
49
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
50
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
51
- * `colour.system.info.fill` for info backgrounds that need to stand out
52
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
53
-
54
- ResponsiveProp<ColorToken> | undefined
55
-
56
- | \- | Set object |
57
- | borderRadius |
58
-
59
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
60
-
61
- | Chrome | Firefox | Safari | Edge | IE |
62
- | --- | --- | --- | --- | --- |
63
- | **4** | **4** | **5** | **12** | **9** |
64
- | 1 _\-x-_ | | 3 _\-x-_ | | |
65
-
66
- ResponsiveProp<RadiusToken> | undefined
67
-
68
- | \- | Set object |
69
- | children |
70
-
71
- string
72
-
73
-
74
-
75
- | \- | Choose option...eveninlineChildrenlist |
76
- | color |
77
-
78
- 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`.
79
-
80
- We recommend using the following token values for best color contrast:
81
-
82
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
83
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
84
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
85
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
86
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
87
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
88
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
89
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
90
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
91
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
92
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
93
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
94
-
95
- ResponsiveProp<ColorToken> | undefined
96
-
97
- | \- | Set object |
98
- | element |
99
-
100
- The HTML element that should be rendered.
101
-
102
- keyof IntrinsicElementsundefined
103
-
104
-
105
-
106
- |
107
-
108
- 'div'
109
-
110
- | Set object |
111
- | focusable |
112
-
113
- 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.
114
-
115
- "true""within"undefined
116
-
117
-
118
-
119
- | \- | Set object |
120
- | gap |
121
-
122
- Sets the gap between direct children.
123
-
124
- 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
125
-
126
- | \- |
127
-
128
- "spacing.100"
129
-
130
- |
131
- | hide |
132
-
133
- 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.
134
-
135
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
136
-
137
- Notes:
138
-
139
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
140
- * Consider if you can conditionally render the element instead of hiding it.
141
-
142
- ResponsiveProp<boolean> | undefined
143
-
144
- | \- | Set object |
145
- | horizontalAlign |
146
-
147
- Sets the horizontal alignment of the stack content.
148
-
149
- "center""left""right""around""between""evenly"undefined
150
-
151
-
152
-
153
- | \- | Set object |
154
- | layerStyle |
155
-
156
- 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.
157
-
158
- * `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.
159
- * `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.
160
- * `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.
161
-
162
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
163
-
164
- | \- | Set object |
165
- | m |
166
-
167
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
168
-
169
- 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.
170
-
171
- | Chrome | Firefox | Safari | Edge | IE |
172
- | --- | --- | --- | --- | --- |
173
- | **1** | **1** | **1** | **12** | **3** |
174
-
175
- ResponsiveProp<SpacingToken | "auto"> | undefined
176
-
177
- | \- | Set object |
178
- | maxWidth |
179
-
180
- 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`.
181
-
182
- | Chrome | Firefox | Safari | Edge | IE |
183
- | --- | --- | --- | --- | --- |
184
- | **1** | **1** | **1** | **12** | **7** |
185
-
186
- 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
187
-
188
- | \- | Set object |
189
- | mb |
190
-
191
- 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.
192
-
193
- It uses the spacing tokens in the design system.
194
-
195
- | Chrome | Firefox | Safari | Edge | IE |
196
- | --- | --- | --- | --- | --- |
197
- | **1** | **1** | **1** | **12** | **3** |
198
-
199
- ResponsiveProp<SpacingToken | "auto"> | undefined
200
-
201
- | \- | Set object |
202
- | ml |
203
-
204
- 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.
205
-
206
- It uses the spacing tokens in the design system.
207
-
208
- | Chrome | Firefox | Safari | Edge | IE |
209
- | --- | --- | --- | --- | --- |
210
- | **1** | **1** | **1** | **12** | **3** |
211
-
212
- ResponsiveProp<SpacingToken | "auto"> | undefined
213
-
214
- | \- | Set object |
215
- | mr |
216
-
217
- 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.
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
- | mt |
229
-
230
- 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.
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
- | mx |
242
-
243
- 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.
244
-
245
- 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.
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
- | my |
255
-
256
- 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.
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
- | noGutter |
268
-
269
- 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.
270
-
271
- booleanundefined
272
-
273
-
274
-
275
- | \- | Set object |
276
- | p |
277
-
278
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
279
-
280
- 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.
281
-
282
- | Chrome | Firefox | Safari | Edge | IE |
283
- | --- | --- | --- | --- | --- |
284
- | **1** | **1** | **1** | **12** | **3** |
285
-
286
- 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
287
-
288
- | \- | Set object |
289
- | pb |
290
-
291
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
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
- | pl |
303
-
304
- The **`pl`** property is short for `padding-left` and sets the padding area on the left 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
- | pr |
316
-
317
- The **`pr`** property is short for `padding-right` and sets the padding area on the right 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
- | pt |
329
-
330
- The **`pt`** property is short for `padding-top` and sets the padding area on the top 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
- | px |
342
-
343
- 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.
344
-
345
- 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.
346
-
347
- | Chrome | Firefox | Safari | Edge | IE |
348
- | --- | --- | --- | --- | --- |
349
- | **1** | **1** | **1** | **12** | **3** |
350
-
351
- 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
352
-
353
- | \- | Set object |
354
- | py |
355
-
356
- 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.
357
-
358
- 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.
359
-
360
- | Chrome | Firefox | Safari | Edge | IE |
361
- | --- | --- | --- | --- | --- |
362
- | **1** | **1** | **1** | **12** | **3** |
363
-
364
- 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
365
-
366
- | \- | Set object |
367
- | rowGap |
368
-
369
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
370
-
371
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
372
-
373
- | Chrome | Firefox | Safari | Edge | IE |
374
- | --- | --- | --- | --- | --- |
375
- | **47** | **52** | **10.1** | **16** | No |
376
-
377
- 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
378
-
379
- | \- | Set object |
380
- | srOnly |
381
-
382
- 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.
383
-
384
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
385
-
386
- ResponsiveProp<boolean> | undefined
387
-
388
- | \- | Set object |
389
- | stretch |
390
-
391
- 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.
392
-
393
- booleanundefined
394
-
395
-
396
-
397
- | \- | Set object |
398
- | textAlign |
399
-
400
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
401
-
402
- | Chrome | Firefox | Safari | Edge | IE |
403
- | --- | --- | --- | --- | --- |
404
- | **1** | **1** | **1** | **12** | **3** |
405
-
406
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
407
-
408
- | \- | Set object |
409
- | textStyle |
410
-
411
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
412
-
413
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
414
- * `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.
415
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
416
- * `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.
417
- * `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.
418
- * `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.
419
- * `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.
420
- * `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.
421
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
422
-
423
- 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
424
-
425
- | \- | Set object |
426
- | width |
427
-
428
- 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.
429
-
430
- 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.
431
-
432
- | Chrome | Firefox | Safari | Edge | IE |
433
- | --- | --- | --- | --- | --- |
434
- | **1** | **1** | **1** | **12** | **4** |
435
-
436
- 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
437
-
438
- | \- | Set object |
439
-
440
- [](#examples)Examples
441
- ---------------------
442
-
443
- ### [](#gap)Gap
444
-
445
- Vertical spacing is applied to the direct children of the `IressStack` component. The amount of spacing is controlled by the gap prop which accepts from `spacing.000` to `spacing.1200`.
446
-
447
- #### [](#what-happened-to-gutter)What happened to `gutter`?
448
-
449
- The previous `gutter` prop has been replaced by `gap`, which uses the latest set of spacing tokens. In terms of how it is used to space items inside the `IressStack` component, it is now directly mapped to the [CSS gap property](https://developer.mozilla.org/en-US/docs/Web/CSS/gap), which may change how your application is spaced. For most cases, there should be no change.
450
-
451
- Here is the mapping of previous `gutter` scale and current `gap` value:
452
-
453
- | Deprecated Gutter Scale | New Gap Value |
454
- | --- | --- |
455
- | none | spacing.000 |
456
- | xs | spacing.100 |
457
- | sm | spacing.200 |
458
- | md | spacing.400 |
459
- | lg | spacing.700 |
460
- | xl | spacing.1200 |
461
-
462
- spacing.000
463
- -----------
464
-
465
- spacing.050
466
- -----------
467
-
468
- spacing.100
469
- -----------
470
-
471
- spacing.150
472
- -----------
473
-
474
- spacing.200
475
- -----------
476
-
477
- spacing.250
478
- -----------
479
-
480
- spacing.300
481
- -----------
482
-
483
- spacing.350
484
- -----------
485
-
486
- spacing.400
487
- -----------
488
-
489
- spacing.500
490
- -----------
491
-
492
- spacing.600
493
- -----------
494
-
495
- spacing.700
496
- -----------
497
-
498
- spacing.800
499
- -----------
500
-
501
- spacing.900
502
- -----------
503
-
504
- spacing.1000
505
- ------------
506
-
507
- spacing.1200
508
- ------------
509
-
510
- none
511
- ----
512
-
513
- xs
514
- --
515
-
516
- sm
517
- --
518
-
519
- md
520
- --
521
-
522
- lg
523
- --
524
-
525
- xl
526
- --
527
-
528
- field.footer
529
- ------------
530
-
531
- slider.tick
532
- -----------
533
-
534
- Hide code
535
-
536
- \[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; }
537
-
538
- <IressStack gap\="spacing.400"\>
539
- <IressText\>
540
- <h2\>
541
- spacing.000 </h2\>
542
- <IressStack gap\="spacing.000"\>
543
- <IressPlaceholder height\="50" />
544
- <IressPlaceholder height\="50" />
545
- <IressPlaceholder height\="50" />
546
- <IressPlaceholder height\="50" />
547
- <IressPlaceholder height\="50" />
548
- </IressStack\>
549
- </IressText\>
550
- <IressText\>
551
- <h2\>
552
- spacing.050 </h2\>
553
- <IressStack gap\="spacing.050"\>
554
- <IressPlaceholder height\="50" />
555
- <IressPlaceholder height\="50" />
556
- <IressPlaceholder height\="50" />
557
- <IressPlaceholder height\="50" />
558
- <IressPlaceholder height\="50" />
559
- </IressStack\>
560
- </IressText\>
561
- <IressText\>
562
- <h2\>
563
- spacing.100 </h2\>
564
- <IressStack gap\="spacing.100"\>
565
- <IressPlaceholder height\="50" />
566
- <IressPlaceholder height\="50" />
567
- <IressPlaceholder height\="50" />
568
- <IressPlaceholder height\="50" />
569
- <IressPlaceholder height\="50" />
570
- </IressStack\>
571
- </IressText\>
572
- <IressText\>
573
- <h2\>
574
- spacing.150 </h2\>
575
- <IressStack gap\="spacing.150"\>
576
- <IressPlaceholder height\="50" />
577
- <IressPlaceholder height\="50" />
578
- <IressPlaceholder height\="50" />
579
- <IressPlaceholder height\="50" />
580
- <IressPlaceholder height\="50" />
581
- </IressStack\>
582
- </IressText\>
583
- <IressText\>
584
- <h2\>
585
- spacing.200 </h2\>
586
- <IressStack gap\="spacing.200"\>
587
- <IressPlaceholder height\="50" />
588
- <IressPlaceholder height\="50" />
589
- <IressPlaceholder height\="50" />
590
- <IressPlaceholder height\="50" />
591
- <IressPlaceholder height\="50" />
592
- </IressStack\>
593
- </IressText\>
594
- <IressText\>
595
- <h2\>
596
- spacing.250 </h2\>
597
- <IressStack gap\="spacing.250"\>
598
- <IressPlaceholder height\="50" />
599
- <IressPlaceholder height\="50" />
600
- <IressPlaceholder height\="50" />
601
- <IressPlaceholder height\="50" />
602
- <IressPlaceholder height\="50" />
603
- </IressStack\>
604
- </IressText\>
605
- <IressText\>
606
- <h2\>
607
- spacing.300 </h2\>
608
- <IressStack gap\="spacing.300"\>
609
- <IressPlaceholder height\="50" />
610
- <IressPlaceholder height\="50" />
611
- <IressPlaceholder height\="50" />
612
- <IressPlaceholder height\="50" />
613
- <IressPlaceholder height\="50" />
614
- </IressStack\>
615
- </IressText\>
616
- <IressText\>
617
- <h2\>
618
- spacing.350 </h2\>
619
- <IressStack gap\="spacing.350"\>
620
- <IressPlaceholder height\="50" />
621
- <IressPlaceholder height\="50" />
622
- <IressPlaceholder height\="50" />
623
- <IressPlaceholder height\="50" />
624
- <IressPlaceholder height\="50" />
625
- </IressStack\>
626
- </IressText\>
627
- <IressText\>
628
- <h2\>
629
- spacing.400 </h2\>
630
- <IressStack gap\="spacing.400"\>
631
- <IressPlaceholder height\="50" />
632
- <IressPlaceholder height\="50" />
633
- <IressPlaceholder height\="50" />
634
- <IressPlaceholder height\="50" />
635
- <IressPlaceholder height\="50" />
636
- </IressStack\>
637
- </IressText\>
638
- <IressText\>
639
- <h2\>
640
- spacing.500 </h2\>
641
- <IressStack gap\="spacing.500"\>
642
- <IressPlaceholder height\="50" />
643
- <IressPlaceholder height\="50" />
644
- <IressPlaceholder height\="50" />
645
- <IressPlaceholder height\="50" />
646
- <IressPlaceholder height\="50" />
647
- </IressStack\>
648
- </IressText\>
649
- <IressText\>
650
- <h2\>
651
- spacing.600 </h2\>
652
- <IressStack gap\="spacing.600"\>
653
- <IressPlaceholder height\="50" />
654
- <IressPlaceholder height\="50" />
655
- <IressPlaceholder height\="50" />
656
- <IressPlaceholder height\="50" />
657
- <IressPlaceholder height\="50" />
658
- </IressStack\>
659
- </IressText\>
660
- <IressText\>
661
- <h2\>
662
- spacing.700 </h2\>
663
- <IressStack gap\="spacing.700"\>
664
- <IressPlaceholder height\="50" />
665
- <IressPlaceholder height\="50" />
666
- <IressPlaceholder height\="50" />
667
- <IressPlaceholder height\="50" />
668
- <IressPlaceholder height\="50" />
669
- </IressStack\>
670
- </IressText\>
671
- <IressText\>
672
- <h2\>
673
- spacing.800 </h2\>
674
- <IressStack gap\="spacing.800"\>
675
- <IressPlaceholder height\="50" />
676
- <IressPlaceholder height\="50" />
677
- <IressPlaceholder height\="50" />
678
- <IressPlaceholder height\="50" />
679
- <IressPlaceholder height\="50" />
680
- </IressStack\>
681
- </IressText\>
682
- <IressText\>
683
- <h2\>
684
- spacing.900 </h2\>
685
- <IressStack gap\="spacing.900"\>
686
- <IressPlaceholder height\="50" />
687
- <IressPlaceholder height\="50" />
688
- <IressPlaceholder height\="50" />
689
- <IressPlaceholder height\="50" />
690
- <IressPlaceholder height\="50" />
691
- </IressStack\>
692
- </IressText\>
693
- <IressText\>
694
- <h2\>
695
- spacing.1000 </h2\>
696
- <IressStack gap\="spacing.1000"\>
697
- <IressPlaceholder height\="50" />
698
- <IressPlaceholder height\="50" />
699
- <IressPlaceholder height\="50" />
700
- <IressPlaceholder height\="50" />
701
- <IressPlaceholder height\="50" />
702
- </IressStack\>
703
- </IressText\>
704
- <IressText\>
705
- <h2\>
706
- spacing.1200 </h2\>
707
- <IressStack gap\="spacing.1200"\>
708
- <IressPlaceholder height\="50" />
709
- <IressPlaceholder height\="50" />
710
- <IressPlaceholder height\="50" />
711
- <IressPlaceholder height\="50" />
712
- <IressPlaceholder height\="50" />
713
- </IressStack\>
714
- </IressText\>
715
- <IressText\>
716
- <h2\>
717
- none </h2\>
718
- <IressStack gap\="none"\>
719
- <IressPlaceholder height\="50" />
720
- <IressPlaceholder height\="50" />
721
- <IressPlaceholder height\="50" />
722
- <IressPlaceholder height\="50" />
723
- <IressPlaceholder height\="50" />
724
- </IressStack\>
725
- </IressText\>
726
- <IressText\>
727
- <h2\>
728
- xs </h2\>
729
- <IressStack gap\="xs"\>
730
- <IressPlaceholder height\="50" />
731
- <IressPlaceholder height\="50" />
732
- <IressPlaceholder height\="50" />
733
- <IressPlaceholder height\="50" />
734
- <IressPlaceholder height\="50" />
735
- </IressStack\>
736
- </IressText\>
737
- <IressText\>
738
- <h2\>
739
- sm </h2\>
740
- <IressStack gap\="sm"\>
741
- <IressPlaceholder height\="50" />
742
- <IressPlaceholder height\="50" />
743
- <IressPlaceholder height\="50" />
744
- <IressPlaceholder height\="50" />
745
- <IressPlaceholder height\="50" />
746
- </IressStack\>
747
- </IressText\>
748
- <IressText\>
749
- <h2\>
750
- md </h2\>
751
- <IressStack gap\="md"\>
752
- <IressPlaceholder height\="50" />
753
- <IressPlaceholder height\="50" />
754
- <IressPlaceholder height\="50" />
755
- <IressPlaceholder height\="50" />
756
- <IressPlaceholder height\="50" />
757
- </IressStack\>
758
- </IressText\>
759
- <IressText\>
760
- <h2\>
761
- lg </h2\>
762
- <IressStack gap\="lg"\>
763
- <IressPlaceholder height\="50" />
764
- <IressPlaceholder height\="50" />
765
- <IressPlaceholder height\="50" />
766
- <IressPlaceholder height\="50" />
767
- <IressPlaceholder height\="50" />
768
- </IressStack\>
769
- </IressText\>
770
- <IressText\>
771
- <h2\>
772
- xl </h2\>
773
- <IressStack gap\="xl"\>
774
- <IressPlaceholder height\="50" />
775
- <IressPlaceholder height\="50" />
776
- <IressPlaceholder height\="50" />
777
- <IressPlaceholder height\="50" />
778
- <IressPlaceholder height\="50" />
779
- </IressStack\>
780
- </IressText\>
781
- <IressText\>
782
- <h2\>
783
- field.footer </h2\>
784
- <IressStack gap\="field.footer"\>
785
- <IressPlaceholder height\="50" />
786
- <IressPlaceholder height\="50" />
787
- <IressPlaceholder height\="50" />
788
- <IressPlaceholder height\="50" />
789
- <IressPlaceholder height\="50" />
790
- </IressStack\>
791
- </IressText\>
792
- <IressText\>
793
- <h2\>
794
- slider.tick </h2\>
795
- <IressStack gap\="slider.tick"\>
796
- <IressPlaceholder height\="50" />
797
- <IressPlaceholder height\="50" />
798
- <IressPlaceholder height\="50" />
799
- <IressPlaceholder height\="50" />
800
- <IressPlaceholder height\="50" />
801
- </IressStack\>
802
- </IressText\>
803
- </IressStack\>
804
-
805
- Copy
806
-
807
- ### [](#responsive-gap)Responsive gap
808
-
809
- The `gap` prop can take an object that takes five key/value pairs that correlate with the IDS breakpoints.
810
-
811
- Current breakpoint: **xl** breakpoint (1200px - 1499px).
812
-
813
- `gap={{"xs":"spacing.100","sm":"spacing.200","md":"spacing.400"}}`
814
-
815
- Hide code
816
-
817
- \[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; }
818
-
819
- <IressStack gap\="spacing.400"\>
820
- <IressPanel\>
821
- <p\>
822
- Current breakpoint:{' '}
823
- <CurrentBreakpoint />
824
- . </p\>
825
- <p\>
826
- <code\>
827
- {\`gap={{"xs":"spacing.100","sm":"spacing.200","md":"spacing.400"}}\`}
828
- </code\>
829
- </p\>
830
- </IressPanel\>
831
- <IressStack
832
- gap\={{
833
- md: 'spacing.400',
834
- sm: 'spacing.200',
835
- xs: 'spacing.100'
836
- }}
837
- \>
838
- <IressPlaceholder height\="50" />
839
- <IressPlaceholder height\="50" />
840
- <IressPlaceholder height\="50" />
841
- <IressPlaceholder height\="50" />
842
- <IressPlaceholder height\="50" />
843
- </IressStack\>
844
- </IressStack\>
845
-
846
- Copy
847
-
848
- ### [](#inline-children)Inline children
849
-
850
- The stack component will treat the direct children as a block element. If you want to wrap some items to display them inline, wrap them with `IressInline`.
851
-
852
- In the example below: `IressButton` are inline because of wrapped by `IressInline`.
853
-
854
- Panel 1 (block)
855
-
856
- I am a block span with the same margin
857
-
858
- Panel 2 (block)
859
-
860
- Button 1Button 2Button 3
861
-
862
- Panel 3 (block)
863
-
864
- Hide code
865
-
866
- \[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; }
867
-
868
- <IressStack gap\="spacing.400"\>
869
- <IressPanel bg\="alt"\>
870
- Panel 1 (block) </IressPanel\>
871
- <span\>
872
- I am a block span with the same margin </span\>
873
- <IressPanel bg\="alt"\>
874
- Panel 2 (block) </IressPanel\>
875
- <IressInline\>
876
- <IressButton\>
877
- Button 1 </IressButton\>
878
- <IressButton\>
879
- Button 2 </IressButton\>
880
- <IressButton\>
881
- Button 3 </IressButton\>
882
- </IressInline\>
883
- <IressPanel bg\="alt"\>
884
- Panel 3 (block) </IressPanel\>
885
- </IressStack\>
886
-
887
- Copy
888
-
889
- ### [](#lists)Lists
890
-
891
- `IressStack` can also apply gap between the list items by using the new `element` (e.g. `ul`) prop.
892
-
893
- * List item 1
894
- * List item 2
895
- * List item 3
896
-
897
- Hide code
898
-
899
- \[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; }
900
-
901
- <IressStack
902
- element\="ul"
903
- gap\="spacing.700"
904
- \>
905
- <li\>
906
- List item 1 </li\>
907
- <li\>
908
- List item 2 </li\>
909
- <li\>
910
- List item 3 </li\>
911
- </IressStack\>
912
-
913
- Copy
914
-
915
- On this page
916
-
917
- * [Overview](#overview)
918
- * [Props](#props)
919
- * [Examples](#examples)
920
- * [Gap](#gap)
921
- * [Responsive gap](#responsive-gap)
922
- * [Inline children](#inline-children)
923
- * [Lists](#lists)