@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
  `IressContainer` provides a means to center and horizontally pad your site’s contents.
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
  IressContainer improves the scannability and visual hierarchy of a user interface by snapping the layout to fixed max widths at different breakpoints.
10
18
 
11
19
  Try resizing the screen to see the difference.
@@ -31,6 +39,30 @@ Hide code
31
39
 
32
40
  Copy
33
41
 
42
+ [](#props)Props
43
+ ---------------
44
+
45
+ | Name | Description | Default | Control |
46
+ | --- | --- | --- | --- |
47
+ | children |
48
+ The content of the container.
49
+
50
+ ReactNode
51
+
52
+
53
+
54
+ | \- | \- |
55
+ | fluid |
56
+
57
+ Container stretches to fill the width of the browser window if true.
58
+
59
+ booleanundefined
60
+
61
+
62
+
63
+ | \- | Set object |
64
+ | Show Theme (Beta) itemsTheme (Beta) | Show Theme (Beta) items |
65
+
34
66
  [](#behaviour)Behaviour
35
67
  -----------------------
36
68
 
@@ -8,6 +8,14 @@ A divider is a UI element that separates content in lists and layouts.
8
8
 
9
9
  * * *
10
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
+ * * *
18
+
11
19
  Hide code
12
20
 
13
21
  \[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,6 +24,384 @@ Hide code
16
24
 
17
25
  Copy
18
26
 
27
+ [](#props)Props
28
+ ---------------
29
+
30
+ | Name | Description | Default | Control |
31
+ | --- | --- | --- | --- |
32
+ | bg |
33
+ **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
34
+
35
+ We recommend using the following token values for best background contrast:
36
+
37
+ * `colour.primary.fill` for primary backgrounds that need to stand out
38
+ * `colour.primary.surface` for primary backgrounds that need to be less prominent
39
+ * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
40
+ * `colour.neutral.20` for a slightly darker background color, used in neutral state components
41
+ * `colour.system.danger.fill` for error backgrounds that need to stand out
42
+ * `colour.system.danger.surface` for error backgrounds that need to be less prominent
43
+ * `colour.system.success.fill` for success backgrounds that need to stand out
44
+ * `colour.system.success.surface` for success backgrounds that need to be less prominent
45
+ * `colour.system.warning.fill` for warning backgrounds that need to stand out
46
+ * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
47
+ * `colour.system.info.fill` for info backgrounds that need to stand out
48
+ * `colour.system.info.surface` for info backgrounds that need to be less prominent
49
+
50
+ ResponsiveProp<ColorToken> | undefined
51
+
52
+ | \- | Set object |
53
+ | borderRadius |
54
+
55
+ The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
56
+
57
+ | Chrome | Firefox | Safari | Edge | IE |
58
+ | --- | --- | --- | --- | --- |
59
+ | **4** | **4** | **5** | **12** | **9** |
60
+ | 1 _\-x-_ | | 3 _\-x-_ | | |
61
+
62
+ ResponsiveProp<RadiusToken> | undefined
63
+
64
+ | \- | Set object |
65
+ | color |
66
+
67
+ 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`.
68
+
69
+ We recommend using the following token values for best color contrast:
70
+
71
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
72
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
73
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
74
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
75
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
76
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
77
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
78
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
79
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
80
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
81
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
82
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
83
+
84
+ ResponsiveProp<ColorToken> | undefined
85
+
86
+ | \- | Set object |
87
+ | focusable |
88
+
89
+ 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.
90
+
91
+ "true""within"undefined
92
+
93
+
94
+
95
+ | \- | Set object |
96
+ | hide |
97
+
98
+ 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.
99
+
100
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
101
+
102
+ Notes:
103
+
104
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
105
+ * Consider if you can conditionally render the element instead of hiding it.
106
+
107
+ ResponsiveProp<boolean> | undefined
108
+
109
+ | \- | Set object |
110
+ | layerStyle |
111
+
112
+ 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.
113
+
114
+ * `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.
115
+ * `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.
116
+ * `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.
117
+
118
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
119
+
120
+ | \- | Set object |
121
+ | m |
122
+
123
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
124
+
125
+ 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.
126
+
127
+ | Chrome | Firefox | Safari | Edge | IE |
128
+ | --- | --- | --- | --- | --- |
129
+ | **1** | **1** | **1** | **12** | **3** |
130
+
131
+ ResponsiveProp<SpacingToken | "auto"> | undefined
132
+
133
+ | \- | Set object |
134
+ | maxWidth |
135
+
136
+ 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`.
137
+
138
+ | Chrome | Firefox | Safari | Edge | IE |
139
+ | --- | --- | --- | --- | --- |
140
+ | **1** | **1** | **1** | **12** | **7** |
141
+
142
+ 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
143
+
144
+ | \- | Set object |
145
+ | mb |
146
+
147
+ 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.
148
+
149
+ It uses the spacing tokens in the design system.
150
+
151
+ | Chrome | Firefox | Safari | Edge | IE |
152
+ | --- | --- | --- | --- | --- |
153
+ | **1** | **1** | **1** | **12** | **3** |
154
+
155
+ ResponsiveProp<SpacingToken | "auto"> | undefined
156
+
157
+ | \- | Set object |
158
+ | ml |
159
+
160
+ 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.
161
+
162
+ It uses the spacing tokens in the design system.
163
+
164
+ | Chrome | Firefox | Safari | Edge | IE |
165
+ | --- | --- | --- | --- | --- |
166
+ | **1** | **1** | **1** | **12** | **3** |
167
+
168
+ ResponsiveProp<SpacingToken | "auto"> | undefined
169
+
170
+ | \- | Set object |
171
+ | mr |
172
+
173
+ 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.
174
+
175
+ It uses the spacing tokens in the design system.
176
+
177
+ | Chrome | Firefox | Safari | Edge | IE |
178
+ | --- | --- | --- | --- | --- |
179
+ | **1** | **1** | **1** | **12** | **3** |
180
+
181
+ ResponsiveProp<SpacingToken | "auto"> | undefined
182
+
183
+ | \- | Set object |
184
+ | mt |
185
+
186
+ 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.
187
+
188
+ It uses the spacing tokens in the design system.
189
+
190
+ | Chrome | Firefox | Safari | Edge | IE |
191
+ | --- | --- | --- | --- | --- |
192
+ | **1** | **1** | **1** | **12** | **3** |
193
+
194
+ ResponsiveProp<SpacingToken | "auto"> | undefined
195
+
196
+ | \- | Set object |
197
+ | mx |
198
+
199
+ 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.
200
+
201
+ 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.
202
+
203
+ | Chrome | Firefox | Safari | Edge | IE |
204
+ | --- | --- | --- | --- | --- |
205
+ | **1** | **1** | **1** | **12** | **3** |
206
+
207
+ ResponsiveProp<SpacingToken | "auto"> | undefined
208
+
209
+ | \- | Set object |
210
+ | my |
211
+
212
+ 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.
213
+
214
+ 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.
215
+
216
+ | Chrome | Firefox | Safari | Edge | IE |
217
+ | --- | --- | --- | --- | --- |
218
+ | **1** | **1** | **1** | **12** | **3** |
219
+
220
+ ResponsiveProp<SpacingToken | "auto"> | undefined
221
+
222
+ | \- | Set object |
223
+ | noGutter |
224
+
225
+ 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.
226
+
227
+ booleanundefined
228
+
229
+
230
+
231
+ | \- | Set object |
232
+ | p |
233
+
234
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
235
+
236
+ 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.
237
+
238
+ | Chrome | Firefox | Safari | Edge | IE |
239
+ | --- | --- | --- | --- | --- |
240
+ | **1** | **1** | **1** | **12** | **3** |
241
+
242
+ 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
243
+
244
+ | \- | Set object |
245
+ | pb |
246
+
247
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
248
+
249
+ 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.
250
+
251
+ | Chrome | Firefox | Safari | Edge | IE |
252
+ | --- | --- | --- | --- | --- |
253
+ | **1** | **1** | **1** | **12** | **3** |
254
+
255
+ 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
256
+
257
+ | \- | Set object |
258
+ | pl |
259
+
260
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
261
+
262
+ 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.
263
+
264
+ | Chrome | Firefox | Safari | Edge | IE |
265
+ | --- | --- | --- | --- | --- |
266
+ | **1** | **1** | **1** | **12** | **3** |
267
+
268
+ 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
269
+
270
+ | \- | Set object |
271
+ | pr |
272
+
273
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
274
+
275
+ 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.
276
+
277
+ | Chrome | Firefox | Safari | Edge | IE |
278
+ | --- | --- | --- | --- | --- |
279
+ | **1** | **1** | **1** | **12** | **3** |
280
+
281
+ 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
282
+
283
+ | \- | Set object |
284
+ | pt |
285
+
286
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
287
+
288
+ 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.
289
+
290
+ | Chrome | Firefox | Safari | Edge | IE |
291
+ | --- | --- | --- | --- | --- |
292
+ | **1** | **1** | **1** | **12** | **3** |
293
+
294
+ 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
295
+
296
+ | \- | Set object |
297
+ | px |
298
+
299
+ 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.
300
+
301
+ 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.
302
+
303
+ | Chrome | Firefox | Safari | Edge | IE |
304
+ | --- | --- | --- | --- | --- |
305
+ | **1** | **1** | **1** | **12** | **3** |
306
+
307
+ 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
308
+
309
+ | \- | Set object |
310
+ | py |
311
+
312
+ 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.
313
+
314
+ 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.
315
+
316
+ | Chrome | Firefox | Safari | Edge | IE |
317
+ | --- | --- | --- | --- | --- |
318
+ | **1** | **1** | **1** | **12** | **3** |
319
+
320
+ 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
321
+
322
+ | \- | Set object |
323
+ | rowGap |
324
+
325
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
326
+
327
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
328
+
329
+ | Chrome | Firefox | Safari | Edge | IE |
330
+ | --- | --- | --- | --- | --- |
331
+ | **47** | **52** | **10.1** | **16** | No |
332
+
333
+ 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
334
+
335
+ | \- | Set object |
336
+ | srOnly |
337
+
338
+ 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.
339
+
340
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
341
+
342
+ ResponsiveProp<boolean> | undefined
343
+
344
+ | \- | Set object |
345
+ | stretch |
346
+
347
+ 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.
348
+
349
+ booleanundefined
350
+
351
+
352
+
353
+ | \- | Set object |
354
+ | textAlign |
355
+
356
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
357
+
358
+ | Chrome | Firefox | Safari | Edge | IE |
359
+ | --- | --- | --- | --- | --- |
360
+ | **1** | **1** | **1** | **12** | **3** |
361
+
362
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
363
+
364
+ | \- | Set object |
365
+ | textStyle |
366
+
367
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
368
+
369
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
370
+ * `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.
371
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
372
+ * `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.
373
+ * `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.
374
+ * `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.
375
+ * `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.
376
+ * `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.
377
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
378
+
379
+ 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
380
+
381
+ | \- | Set object |
382
+ | vertical |
383
+
384
+ Change to a vertical divider.
385
+
386
+ booleanundefined
387
+
388
+
389
+
390
+ | \- | Set object |
391
+ | width |
392
+
393
+ 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.
394
+
395
+ 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.
396
+
397
+ | Chrome | Firefox | Safari | Edge | IE |
398
+ | --- | --- | --- | --- | --- |
399
+ | **1** | **1** | **1** | **12** | **4** |
400
+
401
+ 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
402
+
403
+ | \- | Set object |
404
+
19
405
  [](#examples)Examples
20
406
  ---------------------
21
407
 
@@ -34,7 +420,7 @@ Hide code
34
420
  \[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; }
35
421
 
36
422
  <IressInline
37
- gutter\="md"
423
+ gap\="spacing.400"
38
424
  verticalAlign\="middle"
39
425
  \>
40
426
  <IressText\>
@@ -48,10 +434,12 @@ Copy
48
434
 
49
435
  ### [](#gutter)Gutter
50
436
 
51
- You can customise the gutter by using the `gutter` prop. By default, the divider uses the theme's default spacing as the gutter.
437
+ You can customise the gutter by using the `my` prop. If the divider is vertical, use the `mx` prop instead.
438
+
439
+ By default, dividers do not have a gutter, allowing them to adapt to `<IressStack>` and `<IressInline>` layouts.
52
440
 
53
- none
54
- ----
441
+ `my="none"`
442
+ -----------
55
443
 
56
444
  Separate
57
445
 
@@ -59,8 +447,8 @@ Separate
59
447
 
60
448
  this
61
449
 
62
- xs
63
- --
450
+ `my="xs"`
451
+ ---------
64
452
 
65
453
  Separate
66
454
 
@@ -68,8 +456,8 @@ Separate
68
456
 
69
457
  this
70
458
 
71
- sm
72
- --
459
+ `my="sm"`
460
+ ---------
73
461
 
74
462
  Separate
75
463
 
@@ -77,8 +465,8 @@ Separate
77
465
 
78
466
  this
79
467
 
80
- md
81
- --
468
+ `my="md"`
469
+ ---------
82
470
 
83
471
  Separate
84
472
 
@@ -86,8 +474,8 @@ Separate
86
474
 
87
475
  this
88
476
 
89
- lg
90
- --
477
+ `my="lg"`
478
+ ---------
91
479
 
92
480
  Separate
93
481
 
@@ -95,8 +483,8 @@ Separate
95
483
 
96
484
  this
97
485
 
98
- xl
99
- --
486
+ `my="xl"`
487
+ ---------
100
488
 
101
489
  Separate
102
490
 
@@ -108,58 +496,70 @@ Hide code
108
496
 
109
497
  \[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; }
110
498
 
111
- <IressInline gutter\="md"\>
499
+ <IressInline gap\="spacing.400"\>
112
500
  <IressPanel\>
113
501
  <IressText element\="h2"\>
114
- none </IressText\>
502
+ <code\>
503
+ my="none" </code\>
504
+ </IressText\>
115
505
  <IressText\>
116
506
  Separate </IressText\>
117
- <IressDivider gutter\="none" />
507
+ <IressDivider my\="none" />
118
508
  <IressText\>
119
509
  this </IressText\>
120
510
  </IressPanel\>
121
511
  <IressPanel\>
122
512
  <IressText element\="h2"\>
123
- xs </IressText\>
513
+ <code\>
514
+ my="xs" </code\>
515
+ </IressText\>
124
516
  <IressText\>
125
517
  Separate </IressText\>
126
- <IressDivider gutter\="xs" />
518
+ <IressDivider my\="xs" />
127
519
  <IressText\>
128
520
  this </IressText\>
129
521
  </IressPanel\>
130
522
  <IressPanel\>
131
523
  <IressText element\="h2"\>
132
- sm </IressText\>
524
+ <code\>
525
+ my="sm" </code\>
526
+ </IressText\>
133
527
  <IressText\>
134
528
  Separate </IressText\>
135
- <IressDivider gutter\="sm" />
529
+ <IressDivider my\="sm" />
136
530
  <IressText\>
137
531
  this </IressText\>
138
532
  </IressPanel\>
139
533
  <IressPanel\>
140
534
  <IressText element\="h2"\>
141
- md </IressText\>
535
+ <code\>
536
+ my="md" </code\>
537
+ </IressText\>
142
538
  <IressText\>
143
539
  Separate </IressText\>
144
- <IressDivider gutter\="md" />
540
+ <IressDivider my\="md" />
145
541
  <IressText\>
146
542
  this </IressText\>
147
543
  </IressPanel\>
148
544
  <IressPanel\>
149
545
  <IressText element\="h2"\>
150
- lg </IressText\>
546
+ <code\>
547
+ my="lg" </code\>
548
+ </IressText\>
151
549
  <IressText\>
152
550
  Separate </IressText\>
153
- <IressDivider gutter\="lg" />
551
+ <IressDivider my\="lg" />
154
552
  <IressText\>
155
553
  this </IressText\>
156
554
  </IressPanel\>
157
555
  <IressPanel\>
158
556
  <IressText element\="h2"\>
159
- xl </IressText\>
557
+ <code\>
558
+ my="xl" </code\>
559
+ </IressText\>
160
560
  <IressText\>
161
561
  Separate </IressText\>
162
- <IressDivider gutter\="xl" />
562
+ <IressDivider my\="xl" />
163
563
  <IressText\>
164
564
  this </IressText\>
165
565
  </IressPanel\>