@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
@@ -54,7 +54,7 @@ export const AutocompleteSearchTable \= () \=> {
54
54
  \];
55
55
  }, \[debouncedQuery\]);
56
56
  return (
57
- <IressStack gutter\="md"\>
57
+ <IressStack gap\="md"\>
58
58
  <IressInput
59
59
  value\={query}
60
60
  onChange\={(e) \=> setQuery(e.target.value)}
@@ -6,18 +6,441 @@ Overview
6
6
 
7
7
  Badges are used to highlight an item's status for quick recognition
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
  badge
10
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; }
14
22
 
15
- <IressBadge mode\="background-default"\>
23
+ <IressBadge mode\="neutral"\>
16
24
  badge
17
25
  </IressBadge\>
18
26
 
19
27
  Copy
20
28
 
29
+ [](#props)Props
30
+ ---------------
31
+
32
+ | Name | Description | Default | Control |
33
+ | --- | --- | --- | --- |
34
+ | bg |
35
+ **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
36
+
37
+ We recommend using the following token values for best background contrast:
38
+
39
+ * `colour.primary.fill` for primary backgrounds that need to stand out
40
+ * `colour.primary.surface` for primary backgrounds that need to be less prominent
41
+ * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
42
+ * `colour.neutral.20` for a slightly darker background color, used in neutral state components
43
+ * `colour.system.danger.fill` for error backgrounds that need to stand out
44
+ * `colour.system.danger.surface` for error backgrounds that need to be less prominent
45
+ * `colour.system.success.fill` for success backgrounds that need to stand out
46
+ * `colour.system.success.surface` for success backgrounds that need to be less prominent
47
+ * `colour.system.warning.fill` for warning backgrounds that need to stand out
48
+ * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
49
+ * `colour.system.info.fill` for info backgrounds that need to stand out
50
+ * `colour.system.info.surface` for info backgrounds that need to be less prominent
51
+
52
+ ResponsiveProp<ColorToken> | undefined
53
+
54
+ | \- | Set object |
55
+ | borderRadius |
56
+
57
+ The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
58
+
59
+ | Chrome | Firefox | Safari | Edge | IE |
60
+ | --- | --- | --- | --- | --- |
61
+ | **4** | **4** | **5** | **12** | **9** |
62
+ | 1 _\-x-_ | | 3 _\-x-_ | | |
63
+
64
+ ResponsiveProp<RadiusToken> | undefined
65
+
66
+ | \- | Set object |
67
+ | children |
68
+
69
+ Content of the badge.
70
+
71
+ ReactNode
72
+
73
+
74
+
75
+ | \- |
76
+
77
+ "badge"
78
+
79
+ |
80
+ | color |
81
+
82
+ 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`.
83
+
84
+ We recommend using the following token values for best color contrast:
85
+
86
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
87
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
88
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
89
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
90
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
91
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
92
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
93
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
94
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
95
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
96
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
97
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
98
+
99
+ ResponsiveProp<ColorToken> | undefined
100
+
101
+ | \- | Set object |
102
+ | focusable |
103
+
104
+ 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.
105
+
106
+ "true""within"undefined
107
+
108
+
109
+
110
+ | \- | Set object |
111
+ | hide |
112
+
113
+ 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.
114
+
115
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
116
+
117
+ Notes:
118
+
119
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
120
+ * Consider if you can conditionally render the element instead of hiding it.
121
+
122
+ ResponsiveProp<boolean> | undefined
123
+
124
+ | \- | Set object |
125
+ | host |
126
+
127
+ Element to attach the badge to.
128
+
129
+ ReactElement<any, string | JSXElementConstructor<any>> | undefined
130
+
131
+ | \- | Set object |
132
+ | layerStyle |
133
+
134
+ 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.
135
+
136
+ * `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.
137
+ * `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.
138
+ * `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.
139
+
140
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
141
+
142
+ | \- | Set object |
143
+ | m |
144
+
145
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
146
+
147
+ 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.
148
+
149
+ | Chrome | Firefox | Safari | Edge | IE |
150
+ | --- | --- | --- | --- | --- |
151
+ | **1** | **1** | **1** | **12** | **3** |
152
+
153
+ ResponsiveProp<SpacingToken | "auto"> | undefined
154
+
155
+ | \- | Set object |
156
+ | maxWidth |
157
+
158
+ 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`.
159
+
160
+ | Chrome | Firefox | Safari | Edge | IE |
161
+ | --- | --- | --- | --- | --- |
162
+ | **1** | **1** | **1** | **12** | **7** |
163
+
164
+ 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
165
+
166
+ | \- | Set object |
167
+ | mb |
168
+
169
+ 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.
170
+
171
+ It uses the spacing tokens in the design system.
172
+
173
+ | Chrome | Firefox | Safari | Edge | IE |
174
+ | --- | --- | --- | --- | --- |
175
+ | **1** | **1** | **1** | **12** | **3** |
176
+
177
+ ResponsiveProp<SpacingToken | "auto"> | undefined
178
+
179
+ | \- | Set object |
180
+ | ml |
181
+
182
+ 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.
183
+
184
+ It uses the spacing tokens in the design system.
185
+
186
+ | Chrome | Firefox | Safari | Edge | IE |
187
+ | --- | --- | --- | --- | --- |
188
+ | **1** | **1** | **1** | **12** | **3** |
189
+
190
+ ResponsiveProp<SpacingToken | "auto"> | undefined
191
+
192
+ | \- | Set object |
193
+ | mode |
194
+
195
+ Style of the badge.
196
+
197
+ "danger""info""success""warning""neutral""primary"undefined
198
+
199
+
200
+
201
+ |
202
+
203
+ neutral
204
+
205
+ |
206
+
207
+ "neutral"
208
+
209
+ |
210
+ | mr |
211
+
212
+ 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.
213
+
214
+ It uses the spacing tokens in the design system.
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
+ | mt |
224
+
225
+ 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.
226
+
227
+ It uses the spacing tokens in the design system.
228
+
229
+ | Chrome | Firefox | Safari | Edge | IE |
230
+ | --- | --- | --- | --- | --- |
231
+ | **1** | **1** | **1** | **12** | **3** |
232
+
233
+ ResponsiveProp<SpacingToken | "auto"> | undefined
234
+
235
+ | \- | Set object |
236
+ | mx |
237
+
238
+ 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.
239
+
240
+ 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.
241
+
242
+ | Chrome | Firefox | Safari | Edge | IE |
243
+ | --- | --- | --- | --- | --- |
244
+ | **1** | **1** | **1** | **12** | **3** |
245
+
246
+ ResponsiveProp<SpacingToken | "auto"> | undefined
247
+
248
+ | \- | Set object |
249
+ | my |
250
+
251
+ 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.
252
+
253
+ 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.
254
+
255
+ | Chrome | Firefox | Safari | Edge | IE |
256
+ | --- | --- | --- | --- | --- |
257
+ | **1** | **1** | **1** | **12** | **3** |
258
+
259
+ ResponsiveProp<SpacingToken | "auto"> | undefined
260
+
261
+ | \- | Set object |
262
+ | noGutter |
263
+
264
+ 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.
265
+
266
+ booleanundefined
267
+
268
+
269
+
270
+ | \- | Set object |
271
+ | p |
272
+
273
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
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
+ | pb |
285
+
286
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom 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
+ | pill |
298
+
299
+ Whether the Badge should be styled as a pill.
300
+
301
+ booleanundefined
302
+
303
+
304
+
305
+ | \- | Set object |
306
+ | pl |
307
+
308
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
309
+
310
+ 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.
311
+
312
+ | Chrome | Firefox | Safari | Edge | IE |
313
+ | --- | --- | --- | --- | --- |
314
+ | **1** | **1** | **1** | **12** | **3** |
315
+
316
+ 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
317
+
318
+ | \- | Set object |
319
+ | pr |
320
+
321
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
322
+
323
+ 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.
324
+
325
+ | Chrome | Firefox | Safari | Edge | IE |
326
+ | --- | --- | --- | --- | --- |
327
+ | **1** | **1** | **1** | **12** | **3** |
328
+
329
+ 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
330
+
331
+ | \- | Set object |
332
+ | pt |
333
+
334
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
335
+
336
+ 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.
337
+
338
+ | Chrome | Firefox | Safari | Edge | IE |
339
+ | --- | --- | --- | --- | --- |
340
+ | **1** | **1** | **1** | **12** | **3** |
341
+
342
+ 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
343
+
344
+ | \- | Set object |
345
+ | px |
346
+
347
+ 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.
348
+
349
+ 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.
350
+
351
+ | Chrome | Firefox | Safari | Edge | IE |
352
+ | --- | --- | --- | --- | --- |
353
+ | **1** | **1** | **1** | **12** | **3** |
354
+
355
+ 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
356
+
357
+ | \- | Set object |
358
+ | py |
359
+
360
+ 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.
361
+
362
+ 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.
363
+
364
+ | Chrome | Firefox | Safari | Edge | IE |
365
+ | --- | --- | --- | --- | --- |
366
+ | **1** | **1** | **1** | **12** | **3** |
367
+
368
+ 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
369
+
370
+ | \- | Set object |
371
+ | rowGap |
372
+
373
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
374
+
375
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
376
+
377
+ | Chrome | Firefox | Safari | Edge | IE |
378
+ | --- | --- | --- | --- | --- |
379
+ | **47** | **52** | **10.1** | **16** | No |
380
+
381
+ 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
382
+
383
+ | \- | Set object |
384
+ | srOnly |
385
+
386
+ 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.
387
+
388
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
389
+
390
+ ResponsiveProp<boolean> | undefined
391
+
392
+ | \- | Set object |
393
+ | stretch |
394
+
395
+ 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.
396
+
397
+ booleanundefined
398
+
399
+
400
+
401
+ | \- | Set object |
402
+ | textAlign |
403
+
404
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
405
+
406
+ | Chrome | Firefox | Safari | Edge | IE |
407
+ | --- | --- | --- | --- | --- |
408
+ | **1** | **1** | **1** | **12** | **3** |
409
+
410
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
411
+
412
+ | \- | Set object |
413
+ | textStyle |
414
+
415
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
416
+
417
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
418
+ * `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.
419
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
420
+ * `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.
421
+ * `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.
422
+ * `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.
423
+ * `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.
424
+ * `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.
425
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
426
+
427
+ 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
428
+
429
+ | \- | Set object |
430
+ | width |
431
+
432
+ 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.
433
+
434
+ 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.
435
+
436
+ | Chrome | Firefox | Safari | Edge | IE |
437
+ | --- | --- | --- | --- | --- |
438
+ | **1** | **1** | **1** | **12** | **4** |
439
+
440
+ 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
441
+
442
+ | \- | Set object |
443
+
21
444
  [](#examples)Examples
22
445
  ---------------------
23
446
 
@@ -25,29 +448,25 @@ Copy
25
448
 
26
449
  The `mode` prop controls the colour scheme of the badge. There are a range of options, including system and brand colours.
27
450
 
28
- successwarningdangerinfopositivenegativebackground-altbackground-default
451
+ primarydangerinfosuccesswarningneutral
29
452
 
30
453
  Hide code
31
454
 
32
455
  \[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; }
33
456
 
34
- <IressInline gutter\="sm"\>
35
- <IressBadge mode\="success"\>
36
- success </IressBadge\>
37
- <IressBadge mode\="warning"\>
38
- warning </IressBadge\>
457
+ <IressInline gap\="sm"\>
458
+ <IressBadge mode\="primary"\>
459
+ primary </IressBadge\>
39
460
  <IressBadge mode\="danger"\>
40
461
  danger </IressBadge\>
41
462
  <IressBadge mode\="info"\>
42
463
  info </IressBadge\>
43
- <IressBadge mode\="positive"\>
44
- positive </IressBadge\>
45
- <IressBadge mode\="negative"\>
46
- negative </IressBadge\>
47
- <IressBadge mode\="background-alt"\>
48
- background-alt </IressBadge\>
49
- <IressBadge mode\="background-default"\>
50
- background-default </IressBadge\>
464
+ <IressBadge mode\="success"\>
465
+ success </IressBadge\>
466
+ <IressBadge mode\="warning"\>
467
+ warning </IressBadge\>
468
+ <IressBadge mode\="neutral"\>
469
+ neutral </IressBadge\>
51
470
  </IressInline\>
52
471
 
53
472
  Copy
@@ -56,54 +475,18 @@ Copy
56
475
 
57
476
  Setting the `pill` prop will render the badge with rounded corners. Often used for displaying numbers.
58
477
 
59
- successwarningdangerinfopositivenegativebackground-altbackground-default
478
+ 99+
60
479
 
61
480
  Hide code
62
481
 
63
482
  \[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; }
64
483
 
65
- <IressInline gutter\="sm"\>
66
- <IressBadge
67
- mode\="success"
68
- pill
69
- \>
70
- success </IressBadge\>
71
- <IressBadge
72
- mode\="warning"
73
- pill
74
- \>
75
- warning </IressBadge\>
76
- <IressBadge
77
- mode\="danger"
78
- pill
79
- \>
80
- danger </IressBadge\>
81
- <IressBadge
82
- mode\="info"
83
- pill
84
- \>
85
- info </IressBadge\>
86
- <IressBadge
87
- mode\="positive"
88
- pill
89
- \>
90
- positive </IressBadge\>
91
- <IressBadge
92
- mode\="negative"
93
- pill
94
- \>
95
- negative </IressBadge\>
96
- <IressBadge
97
- mode\="background-alt"
98
- pill
99
- \>
100
- background-alt </IressBadge\>
101
- <IressBadge
102
- mode\="background-default"
103
- pill
104
- \>
105
- background-default </IressBadge\>
106
- </IressInline\>
484
+ <IressBadge
485
+ mode\="primary"
486
+ pill
487
+ \>
488
+ 99+
489
+ </IressBadge\>
107
490
 
108
491
  Copy
109
492
 
@@ -121,7 +504,7 @@ Hide code
121
504
 
122
505
  \[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; }
123
506
 
124
- <IressInline gutter\="lg"\>
507
+ <IressInline gap\="lg"\>
125
508
  <IressBadge
126
509
  host\={<IressButton\>Host button</IressButton\>}
127
510
  mode\="success"