@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,881 +0,0 @@
1
- [](#col)Col
2
- ===========
3
-
4
- Overview
5
- --------
6
-
7
- Used in conjunction with the `IressRow` component to layout page content
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
- Column 1
18
-
19
- Column 2
20
-
21
- Hide code
22
-
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; }
24
-
25
- <IressRow gutter\="spacing.400"\>
26
- <IressCol\>
27
- <IressPlaceholder\>
28
- Column 1 </IressPlaceholder\>
29
- </IressCol\>
30
- <IressCol\>
31
- <IressPlaceholder\>
32
- Column 2 </IressPlaceholder\>
33
- </IressCol\>
34
- </IressRow\>
35
-
36
- Copy
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
-
444
- [](#examples)Examples
445
- ---------------------
446
-
447
- ### [](#auto-sized)Auto-sized
448
-
449
- When no column widths are specified the `IressCol` component will render equal width columns.
450
-
451
- 1 of 2
452
-
453
- 2 of 2
454
-
455
- 1 of 3
456
-
457
- 2 of 3
458
-
459
- 3 of 3
460
-
461
- Hide code
462
-
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; }
464
-
465
- <IressStack gap\="spacing.400"\>
466
- <IressRow gutter\="spacing.400"\>
467
- <IressCol\>
468
- <IressPlaceholder\>
469
- 1 of 2 </IressPlaceholder\>
470
- </IressCol\>
471
- <IressCol\>
472
- <IressPlaceholder\>
473
- 2 of 2 </IressPlaceholder\>
474
- </IressCol\>
475
- </IressRow\>
476
- <IressRow gutter\="spacing.400"\>
477
- <IressCol\>
478
- <IressPlaceholder\>
479
- 1 of 3 </IressPlaceholder\>
480
- </IressCol\>
481
- <IressCol\>
482
- <IressPlaceholder\>
483
- 2 of 3 </IressPlaceholder\>
484
- </IressCol\>
485
- <IressCol\>
486
- <IressPlaceholder\>
487
- 3 of 3 </IressPlaceholder\>
488
- </IressCol\>
489
- </IressRow\>
490
- </IressStack\>
491
-
492
- Copy
493
-
494
- ### [](#span)Span
495
-
496
- The `span` prop controls the number of grid columns the component should span.
497
-
498
- If no `span` is provided it will default to `auto` which will make the column either fill the remaining space in the row (when used with a col number) or size evenly when used with other columns set to auto sizing.
499
-
500
- 12
501
-
502
- 1
503
-
504
- 11
505
-
506
- 2
507
-
508
- 10
509
-
510
- 3
511
-
512
- 9
513
-
514
- 4
515
-
516
- 8
517
-
518
- 5
519
-
520
- 7
521
-
522
- 6
523
-
524
- 6
525
-
526
- Hide code
527
-
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; }
529
-
530
- <IressStack gap\="spacing.400"\>
531
- <IressRow gutter\="spacing.400"\>
532
- <IressCol span\="12"\>
533
- <IressPlaceholder\>
534
- 12 </IressPlaceholder\>
535
- </IressCol\>
536
- </IressRow\>
537
- <IressRow gutter\="spacing.400"\>
538
- <IressCol span\="1"\>
539
- <IressPlaceholder\>
540
- 1 </IressPlaceholder\>
541
- </IressCol\>
542
- <IressCol\>
543
- <IressPlaceholder\>
544
- 11 </IressPlaceholder\>
545
- </IressCol\>
546
- </IressRow\>
547
- <IressRow gutter\="spacing.400"\>
548
- <IressCol span\="2"\>
549
- <IressPlaceholder\>
550
- 2 </IressPlaceholder\>
551
- </IressCol\>
552
- <IressCol\>
553
- <IressPlaceholder\>
554
- 10 </IressPlaceholder\>
555
- </IressCol\>
556
- </IressRow\>
557
- <IressRow gutter\="spacing.400"\>
558
- <IressCol span\="3"\>
559
- <IressPlaceholder\>
560
- 3 </IressPlaceholder\>
561
- </IressCol\>
562
- <IressCol\>
563
- <IressPlaceholder\>
564
- 9 </IressPlaceholder\>
565
- </IressCol\>
566
- </IressRow\>
567
- <IressRow gutter\="spacing.400"\>
568
- <IressCol span\="4"\>
569
- <IressPlaceholder\>
570
- 4 </IressPlaceholder\>
571
- </IressCol\>
572
- <IressCol\>
573
- <IressPlaceholder\>
574
- 8 </IressPlaceholder\>
575
- </IressCol\>
576
- </IressRow\>
577
- <IressRow gutter\="spacing.400"\>
578
- <IressCol span\="5"\>
579
- <IressPlaceholder\>
580
- 5 </IressPlaceholder\>
581
- </IressCol\>
582
- <IressCol\>
583
- <IressPlaceholder\>
584
- 7 </IressPlaceholder\>
585
- </IressCol\>
586
- </IressRow\>
587
- <IressRow gutter\="spacing.400"\>
588
- <IressCol span\="6"\>
589
- <IressPlaceholder\>
590
- 6 </IressPlaceholder\>
591
- </IressCol\>
592
- <IressCol\>
593
- <IressPlaceholder\>
594
- 6 </IressPlaceholder\>
595
- </IressCol\>
596
- </IressRow\>
597
- </IressStack\>
598
-
599
- Copy
600
-
601
- ### [](#responsive-span)Responsive span
602
-
603
- The `span` prop can take an object that takes five key/value pairs that correlate with the IDS breakpoints. Any missing keys will fall back to the value defined for the next smallest key.
604
-
605
- **Note:** If a `span` prop is provided an object but no value is given for `xs` it will default to `12`. This means that columns will be full width on screen sizes below the sizes you've specified.
606
-
607
- Current breakpoint: **xl** breakpoint (1200px - 1499px).
608
-
609
- Column 1
610
- {"xs":12,"md":3}
611
-
612
- Column 2
613
- {"xs":12,"md":9}
614
-
615
- Hide code
616
-
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; }
618
-
619
- <IressStack gap\="spacing.400"\>
620
- <IressPanel\>
621
- Current breakpoint:{' '}
622
- <CurrentBreakpoint />
623
- . </IressPanel\>
624
- <IressRow gutter\="spacing.400"\>
625
- <IressCol
626
- span\={{
627
- md: 3,
628
- xs: 12
629
- }}
630
- \>
631
- <IressPlaceholder\>
632
- <IressText textAlign\="center"\>
633
- Column 1 <br />
634
- {\`{"xs":12,"md":3}\`}
635
- </IressText\>
636
- </IressPlaceholder\>
637
- </IressCol\>
638
- <IressCol
639
- span\={{
640
- md: 9,
641
- xs: 12
642
- }}
643
- \>
644
- <IressPlaceholder\>
645
- <IressText textAlign\="center"\>
646
- Column 2 <br />
647
- {\`{"xs":12,"md":9}\`}
648
- </IressText\>
649
- </IressPlaceholder\>
650
- </IressCol\>
651
- </IressRow\>
652
- </IressStack\>
653
-
654
- Copy
655
-
656
- ### [](#offset)Offset
657
-
658
- The `offset` prop controls the amount of grid columns to offset.
659
-
660
- 1
661
-
662
- 2
663
-
664
- 3
665
-
666
- 4
667
-
668
- 5
669
-
670
- 6
671
-
672
- 7
673
-
674
- 8
675
-
676
- 9
677
-
678
- 10
679
-
680
- 11
681
-
682
- Hide code
683
-
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; }
685
-
686
- <IressStack gap\="spacing.400"\>
687
- <IressRow gutter\="spacing.400"\>
688
- <IressCol
689
- offset\="1"
690
- span\="1"
691
- \>
692
- <IressPlaceholder\>
693
- 1 </IressPlaceholder\>
694
- </IressCol\>
695
- </IressRow\>
696
- <IressRow gutter\="spacing.400"\>
697
- <IressCol
698
- offset\="2"
699
- span\="1"
700
- \>
701
- <IressPlaceholder\>
702
- 2 </IressPlaceholder\>
703
- </IressCol\>
704
- </IressRow\>
705
- <IressRow gutter\="spacing.400"\>
706
- <IressCol
707
- offset\="3"
708
- span\="1"
709
- \>
710
- <IressPlaceholder\>
711
- 3 </IressPlaceholder\>
712
- </IressCol\>
713
- </IressRow\>
714
- <IressRow gutter\="spacing.400"\>
715
- <IressCol
716
- offset\="4"
717
- span\="1"
718
- \>
719
- <IressPlaceholder\>
720
- 4 </IressPlaceholder\>
721
- </IressCol\>
722
- </IressRow\>
723
- <IressRow gutter\="spacing.400"\>
724
- <IressCol
725
- offset\="5"
726
- span\="1"
727
- \>
728
- <IressPlaceholder\>
729
- 5 </IressPlaceholder\>
730
- </IressCol\>
731
- </IressRow\>
732
- <IressRow gutter\="spacing.400"\>
733
- <IressCol
734
- offset\="6"
735
- span\="1"
736
- \>
737
- <IressPlaceholder\>
738
- 6 </IressPlaceholder\>
739
- </IressCol\>
740
- </IressRow\>
741
- <IressRow gutter\="spacing.400"\>
742
- <IressCol
743
- offset\="7"
744
- span\="1"
745
- \>
746
- <IressPlaceholder\>
747
- 7 </IressPlaceholder\>
748
- </IressCol\>
749
- </IressRow\>
750
- <IressRow gutter\="spacing.400"\>
751
- <IressCol
752
- offset\="8"
753
- span\="1"
754
- \>
755
- <IressPlaceholder\>
756
- 8 </IressPlaceholder\>
757
- </IressCol\>
758
- </IressRow\>
759
- <IressRow gutter\="spacing.400"\>
760
- <IressCol
761
- offset\="9"
762
- span\="1"
763
- \>
764
- <IressPlaceholder\>
765
- 9 </IressPlaceholder\>
766
- </IressCol\>
767
- </IressRow\>
768
- <IressRow gutter\="spacing.400"\>
769
- <IressCol
770
- offset\="10"
771
- span\="1"
772
- \>
773
- <IressPlaceholder\>
774
- 10 </IressPlaceholder\>
775
- </IressCol\>
776
- </IressRow\>
777
- <IressRow gutter\="spacing.400"\>
778
- <IressCol
779
- offset\="11"
780
- span\="1"
781
- \>
782
- <IressPlaceholder\>
783
- 11 </IressPlaceholder\>
784
- </IressCol\>
785
- </IressRow\>
786
- </IressStack\>
787
-
788
- Copy
789
-
790
- ### [](#responsive-offset)Responsive offset
791
-
792
- When a `ResponsiveSizing` object is passed into the `offset` prop, the offset will change at the specified breakpoints. It will apply to all breakpoints above the specified breakpoint.
793
-
794
- For example, if you specify an offset for `md`, it will apply to `lg`, `xl` and `xxl` as well. If you want to change the offset at a specific breakpoint, you can pass in an object with the breakpoint as the key and the offset as the value.
795
-
796
- Current breakpoint: **xl** breakpoint (1200px - 1499px).
797
-
798
- Column 1
799
- {"md":5,"lg":2}
800
-
801
- Hide code
802
-
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; }
804
-
805
- <IressStack gap\="spacing.400"\>
806
- <IressPanel\>
807
- Current breakpoint:{' '}
808
- <CurrentBreakpoint />
809
- . </IressPanel\>
810
- <IressRow gutter\="spacing.400"\>
811
- <IressCol
812
- offset\={{
813
- lg: 2,
814
- md: 5
815
- }}
816
- \>
817
- <IressPlaceholder\>
818
- <IressText textAlign\="center"\>
819
- Column 1 <br />
820
- {\`{"md":5,"lg":2}\`}
821
- </IressText\>
822
- </IressPlaceholder\>
823
- </IressCol\>
824
- </IressRow\>
825
- </IressStack\>
826
-
827
- Copy
828
-
829
- ### [](#align-self)Align self
830
-
831
- The `alignSelf` prop controls the vertical alignment of the column (use if column alignment needs to differ from other columns in the row).
832
-
833
- Start
834
-
835
- Center
836
-
837
- End
838
-
839
- Stretch
840
-
841
- Hide code
842
-
843
- \[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; }
844
-
845
- <IressContainer\>
846
- <IressRow
847
- className\="\_setHeight\_1d00u\_60"
848
- gutter\="spacing.400"
849
- \>
850
- <IressCol alignSelf\="start"\>
851
- <IressPlaceholder\>
852
- Start </IressPlaceholder\>
853
- </IressCol\>
854
- <IressCol alignSelf\="center"\>
855
- <IressPlaceholder\>
856
- Center </IressPlaceholder\>
857
- </IressCol\>
858
- <IressCol alignSelf\="end"\>
859
- <IressPlaceholder\>
860
- End </IressPlaceholder\>
861
- </IressCol\>
862
- <IressCol alignSelf\="stretch"\>
863
- <IressPlaceholder stretch\>
864
- Stretch </IressPlaceholder\>
865
- </IressCol\>
866
- </IressRow\>
867
- </IressContainer\>
868
-
869
- Copy
870
-
871
- On this page
872
-
873
- * [Overview](#overview)
874
- * [Props](#props)
875
- * [Examples](#examples)
876
- * [Auto-sized](#auto-sized)
877
- * [Span](#span)
878
- * [Responsive span](#responsive-span)
879
- * [Offset](#offset)
880
- * [Responsive offset](#responsive-offset)
881
- * [Align self](#align-self)