@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
  Tabs are used to display modular pieces of related data that do not need to be compared or accessed simultaneously.
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
  Address
10
18
 
11
19
  Employment
@@ -29,31 +37,448 @@ Hide code
29
37
 
30
38
  Copy
31
39
 
40
+ [](#props)Props
41
+ ---------------
42
+
43
+ | Name | Description | Default | Control |
44
+ | --- | --- | --- | --- |
45
+ | bg |
46
+ **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
47
+
48
+ We recommend using the following token values for best background contrast:
49
+
50
+ * `colour.primary.fill` for primary backgrounds that need to stand out
51
+ * `colour.primary.surface` for primary backgrounds that need to be less prominent
52
+ * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
53
+ * `colour.neutral.20` for a slightly darker background color, used in neutral state components
54
+ * `colour.system.danger.fill` for error backgrounds that need to stand out
55
+ * `colour.system.danger.surface` for error backgrounds that need to be less prominent
56
+ * `colour.system.success.fill` for success backgrounds that need to stand out
57
+ * `colour.system.success.surface` for success backgrounds that need to be less prominent
58
+ * `colour.system.warning.fill` for warning backgrounds that need to stand out
59
+ * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
60
+ * `colour.system.info.fill` for info backgrounds that need to stand out
61
+ * `colour.system.info.surface` for info backgrounds that need to be less prominent
62
+
63
+ ResponsiveProp<ColorToken> | undefined
64
+
65
+ | \- | Set object |
66
+ | borderRadius |
67
+
68
+ The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
69
+
70
+ | Chrome | Firefox | Safari | Edge | IE |
71
+ | --- | --- | --- | --- | --- |
72
+ | **4** | **4** | **5** | **12** | **9** |
73
+ | 1 _\-x-_ | | 3 _\-x-_ | | |
74
+
75
+ ResponsiveProp<RadiusToken> | undefined
76
+
77
+ | \- | Set object |
78
+ | children |
79
+
80
+ Content to be displayed inside the IressTabs, usually multiple `IressTab`.
81
+
82
+ ReactNode
83
+
84
+
85
+
86
+ | \- | \- |
87
+ | color |
88
+
89
+ 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`.
90
+
91
+ We recommend using the following token values for best color contrast:
92
+
93
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
94
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
95
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
96
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
97
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
98
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
99
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
100
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
101
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
102
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
103
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
104
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
105
+
106
+ ResponsiveProp<ColorToken> | undefined
107
+
108
+ | \- | Set object |
109
+ | defaultSelected |
110
+
111
+ Set the selected tab for uncontrolled tabs. If the `IressTab` does not have a `value` prop, it will match by index.
112
+
113
+ FormControlValueundefined
114
+
115
+
116
+
117
+ | \- | Set object |
118
+ | focusable |
119
+
120
+ 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.
121
+
122
+ "true""within"undefined
123
+
124
+
125
+
126
+ | \- | Set object |
127
+ | hide |
128
+
129
+ 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.
130
+
131
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
132
+
133
+ Notes:
134
+
135
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
136
+ * Consider if you can conditionally render the element instead of hiding it.
137
+
138
+ ResponsiveProp<boolean> | undefined
139
+
140
+ | \- | Set object |
141
+ | layerStyle |
142
+
143
+ 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.
144
+
145
+ * `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.
146
+ * `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.
147
+ * `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.
148
+
149
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
150
+
151
+ | \- | Set object |
152
+ | layout |
153
+
154
+ Layout options for the positioning of tabs.
155
+
156
+ "top-center""top-left""top-right"undefined
157
+
158
+
159
+
160
+ |
161
+
162
+ top-left
163
+
164
+ | Set object |
165
+ | m |
166
+
167
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
168
+
169
+ It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
170
+
171
+ | Chrome | Firefox | Safari | Edge | IE |
172
+ | --- | --- | --- | --- | --- |
173
+ | **1** | **1** | **1** | **12** | **3** |
174
+
175
+ ResponsiveProp<SpacingToken | "auto"> | undefined
176
+
177
+ | \- | Set object |
178
+ | maxWidth |
179
+
180
+ The **`max-width`** CSS property sets the maximum width of an element. It prevents the used value of the `width` property from becoming larger than the value specified by `max-width`.
181
+
182
+ | Chrome | Firefox | Safari | Edge | IE |
183
+ | --- | --- | --- | --- | --- |
184
+ | **1** | **1** | **1** | **12** | **7** |
185
+
186
+ ResponsiveProp<"auto" | SizeToken | "screen" | "1/2" | "1/3" | "2/3" | "1/4" | "2/4" | "3/4" | "1/5" | "2/5" | "3/5" | "4/5" | "1/6" | "2/6" | "3/6" | "4/6" | "5/6" | "1/12" | "2/12" | ... 8 more ... | "11/12"> | undefined
187
+
188
+ | \- | Set object |
189
+ | mb |
190
+
191
+ The **`mb`** property is short for `margin-bottom` and sets the margin area on the bottom side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
192
+
193
+ It uses the spacing tokens in the design system.
194
+
195
+ | Chrome | Firefox | Safari | Edge | IE |
196
+ | --- | --- | --- | --- | --- |
197
+ | **1** | **1** | **1** | **12** | **3** |
198
+
199
+ ResponsiveProp<SpacingToken | "auto"> | undefined
200
+
201
+ | \- | Set object |
202
+ | ml |
203
+
204
+ The **`ml`** property is short for `margin-left` and sets the margin area on the left side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
205
+
206
+ It uses the spacing tokens in the design system.
207
+
208
+ | Chrome | Firefox | Safari | Edge | IE |
209
+ | --- | --- | --- | --- | --- |
210
+ | **1** | **1** | **1** | **12** | **3** |
211
+
212
+ ResponsiveProp<SpacingToken | "auto"> | undefined
213
+
214
+ | \- | Set object |
215
+ | mr |
216
+
217
+ The **`mr`** property is short for `margin-right` and sets the margin area on the right side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
218
+
219
+ It uses the spacing tokens in the design system.
220
+
221
+ | Chrome | Firefox | Safari | Edge | IE |
222
+ | --- | --- | --- | --- | --- |
223
+ | **1** | **1** | **1** | **12** | **3** |
224
+
225
+ ResponsiveProp<SpacingToken | "auto"> | undefined
226
+
227
+ | \- | Set object |
228
+ | mt |
229
+
230
+ The **`mt`** property is short for `margin-top` and sets the margin area on the top side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
231
+
232
+ It uses the spacing tokens in the design system.
233
+
234
+ | Chrome | Firefox | Safari | Edge | IE |
235
+ | --- | --- | --- | --- | --- |
236
+ | **1** | **1** | **1** | **12** | **3** |
237
+
238
+ ResponsiveProp<SpacingToken | "auto"> | undefined
239
+
240
+ | \- | Set object |
241
+ | mx |
242
+
243
+ The **`mx`** property is short for `margin-inline`. It is a shorthand property that defines both the logical inline start and end margins of an element, which maps to physical margins depending on the element's writing mode, directionality, and text orientation.
244
+
245
+ It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
246
+
247
+ | Chrome | Firefox | Safari | Edge | IE |
248
+ | --- | --- | --- | --- | --- |
249
+ | **1** | **1** | **1** | **12** | **3** |
250
+
251
+ ResponsiveProp<SpacingToken | "auto"> | undefined
252
+
253
+ | \- | Set object |
254
+ | my |
255
+
256
+ The **`my`** property is short for `margin-block`. It defines the logical block start and end margins of an element, which maps to physical margins depending on the element's writing mode, directionality, and text orientation.
257
+
258
+ It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
259
+
260
+ | Chrome | Firefox | Safari | Edge | IE |
261
+ | --- | --- | --- | --- | --- |
262
+ | **1** | **1** | **1** | **12** | **3** |
263
+
264
+ ResponsiveProp<SpacingToken | "auto"> | undefined
265
+
266
+ | \- | Set object |
267
+ | noGutter |
268
+
269
+ The **`noGutter`** property is used to remove the bottom margin from the last child of a component. This is useful when you want to avoid extra spacing at the end of a layout.
270
+
271
+ booleanundefined
272
+
273
+
274
+
275
+ | \- | Set object |
276
+ | onChange |
277
+
278
+ Emitted when a tab changes.
279
+
280
+ ((event: TabSetChangedEventDetail) => void) | undefined
281
+
282
+ | \- | \- |
283
+ | p |
284
+
285
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
286
+
287
+ 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.
288
+
289
+ | Chrome | Firefox | Safari | Edge | IE |
290
+ | --- | --- | --- | --- | --- |
291
+ | **1** | **1** | **1** | **12** | **3** |
292
+
293
+ 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
294
+
295
+ | \- | Set object |
296
+ | pb |
297
+
298
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
299
+
300
+ 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.
301
+
302
+ | Chrome | Firefox | Safari | Edge | IE |
303
+ | --- | --- | --- | --- | --- |
304
+ | **1** | **1** | **1** | **12** | **3** |
305
+
306
+ 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
307
+
308
+ | \- | Set object |
309
+ | pl |
310
+
311
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
312
+
313
+ 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.
314
+
315
+ | Chrome | Firefox | Safari | Edge | IE |
316
+ | --- | --- | --- | --- | --- |
317
+ | **1** | **1** | **1** | **12** | **3** |
318
+
319
+ 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
320
+
321
+ | \- | Set object |
322
+ | pr |
323
+
324
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
325
+
326
+ 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.
327
+
328
+ | Chrome | Firefox | Safari | Edge | IE |
329
+ | --- | --- | --- | --- | --- |
330
+ | **1** | **1** | **1** | **12** | **3** |
331
+
332
+ 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
333
+
334
+ | \- | Set object |
335
+ | pt |
336
+
337
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
338
+
339
+ 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.
340
+
341
+ | Chrome | Firefox | Safari | Edge | IE |
342
+ | --- | --- | --- | --- | --- |
343
+ | **1** | **1** | **1** | **12** | **3** |
344
+
345
+ 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
346
+
347
+ | \- | Set object |
348
+ | px |
349
+
350
+ 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.
351
+
352
+ 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.
353
+
354
+ | Chrome | Firefox | Safari | Edge | IE |
355
+ | --- | --- | --- | --- | --- |
356
+ | **1** | **1** | **1** | **12** | **3** |
357
+
358
+ 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
359
+
360
+ | \- | Set object |
361
+ | py |
362
+
363
+ 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.
364
+
365
+ 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.
366
+
367
+ | Chrome | Firefox | Safari | Edge | IE |
368
+ | --- | --- | --- | --- | --- |
369
+ | **1** | **1** | **1** | **12** | **3** |
370
+
371
+ 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
372
+
373
+ | \- | Set object |
374
+ | rowGap |
375
+
376
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
377
+
378
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
379
+
380
+ | Chrome | Firefox | Safari | Edge | IE |
381
+ | --- | --- | --- | --- | --- |
382
+ | **47** | **52** | **10.1** | **16** | No |
383
+
384
+ 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
385
+
386
+ | \- | Set object |
387
+ | selected |
388
+
389
+ Set the selected tab for controlled tabs. If the `IressTab` does not have a `value` prop, it will match by index.
390
+
391
+ FormControlValueundefined
392
+
393
+
394
+
395
+ | \- | Set object |
396
+ | srOnly |
397
+
398
+ 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.
399
+
400
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
401
+
402
+ ResponsiveProp<boolean> | undefined
403
+
404
+ | \- | Set object |
405
+ | stretch |
406
+
407
+ 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.
408
+
409
+ booleanundefined
410
+
411
+
412
+
413
+ | \- | Set object |
414
+ | textAlign |
415
+
416
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
417
+
418
+ | Chrome | Firefox | Safari | Edge | IE |
419
+ | --- | --- | --- | --- | --- |
420
+ | **1** | **1** | **1** | **12** | **3** |
421
+
422
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
423
+
424
+ | \- | Set object |
425
+ | textStyle |
426
+
427
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
428
+
429
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
430
+ * `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.
431
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
432
+ * `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.
433
+ * `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.
434
+ * `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.
435
+ * `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.
436
+ * `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.
437
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
438
+
439
+ 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
440
+
441
+ | \- | Set object |
442
+ | width |
443
+
444
+ 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.
445
+
446
+ 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.
447
+
448
+ | Chrome | Firefox | Safari | Edge | IE |
449
+ | --- | --- | --- | --- | --- |
450
+ | **1** | **1** | **1** | **12** | **4** |
451
+
452
+ 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
453
+
454
+ | \- | Set object |
455
+
32
456
  [](#usage)Usage
33
457
  ---------------
34
458
 
35
459
  The `IressTabSet` is a wrapper for `IressTab` components to make a up a set of tabs.
36
460
 
37
- **Note:** The `mapTabs` helper function, originally used to map tabs to its sub-components, is now deprecated. Instead, you can use `array.map` to map the tabs to `IressTab`.
38
-
39
461
  ### [](#navigation)Navigation
40
462
 
41
463
  You can use the `IressTabSet` component to create tab navigation to control an area of the page, or even navigate between different pages.
42
464
 
43
- Address
465
+ [Iress](https://iress.com)
44
466
 
45
- Employment
46
-
47
- History
467
+ [Google](https://google.com)
48
468
 
49
469
  Hide code
50
470
 
51
471
  \[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; }
52
472
 
53
473
  <IressTabSet\>
54
- <IressTab label\="Address" />
55
- <IressTab label\="Employment" />
56
- <IressTab label\="History" />
474
+ <IressTab
475
+ href\="https://iress.com"
476
+ label\="Iress"
477
+ />
478
+ <IressTab
479
+ href\="https://google.com"
480
+ label\="Google"
481
+ />
57
482
  </IressTabSet\>
58
483
 
59
484
  Copy
@@ -92,20 +517,23 @@ Copy
92
517
 
93
518
  If you would like to set a tab by default, use the `defaultSelected` prop.
94
519
 
95
- Address
520
+ [Iress](https://iress.com)
96
521
 
97
- Employment
98
-
99
- History
522
+ [Google](https://google.com)
100
523
 
101
524
  Hide code
102
525
 
103
526
  \[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; }
104
527
 
105
- <IressTabSet defaultSelected\={2}\>
106
- <IressTab label\="Address" />
107
- <IressTab label\="Employment" />
108
- <IressTab label\="History" />
528
+ <IressTabSet defaultSelected\={1}\>
529
+ <IressTab
530
+ href\="https://iress.com"
531
+ label\="Iress"
532
+ />
533
+ <IressTab
534
+ href\="https://google.com"
535
+ label\="Google"
536
+ />
109
537
  </IressTabSet\>
110
538
 
111
539
  Copy
@@ -139,7 +567,7 @@ import { useState } from 'react';
139
567
  export const TabsUsingState \= () \=> {
140
568
  const \[selected, setSelected\] \= useState<number\>();
141
569
  return (
142
- <IressStack gutter\={IressStack.Gutter.Md}\>
570
+ <IressStack gap\="md"\>
143
571
  <IressButton onClick\={() \=> setSelected(selected \=== 2 ? 0 : 2)}\>
144
572
  {selected \=== 2 ? \`Back to first tab\` : \`Change to last tab\`}
145
573
  </IressButton\>
@@ -199,7 +627,7 @@ Hide code
199
627
 
200
628
  \[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; }
201
629
 
202
- <IressStack gutter\="md"\>
630
+ <IressStack gap\="md"\>
203
631
  <IressPanel\>
204
632
  <IressText element\="h2"\>
205
633
  top-left </IressText\>
@@ -242,7 +670,7 @@ Copy
242
670
 
243
671
  ### [](#lazy-loading)Lazy Loading
244
672
 
245
- As of version 5, tabs can be lazy loaded. However, to ensure they work correctly you will need to set the `value` prop on each `IressTab`, as shown in this example.
673
+ Tabs can be lazy loaded via state, allowing you to add/remove tabs as needed.
246
674
 
247
675
  Toggle tabs
248
676
 
@@ -261,19 +689,18 @@ import { useState } from 'react';
261
689
  export const TabsLazyLoading \= () \=> {
262
690
  const \[loadTabs, setLoadTabs\] \= useState<boolean\>();
263
691
  return (
264
- <IressStack gutter\="md"\>
692
+ <IressStack gap\="md"\>
265
693
  <IressButton onClick\={() \=> setLoadTabs(!loadTabs)}\>
266
694
  Toggle tabs </IressButton\>
267
695
  <IressTabSet {...{
268
- defaultSelected: 'medical',
696
+ defaultSelected: 2,
269
697
  }}\>
270
698
  {loadTabs && (
271
699
  <\>
272
- <IressTab label\="Address" value\="address"\>
273
- Address information goes here </IressTab\>
274
- <IressTab label\="Employment" value\="employment"\>
700
+ <IressTab label\="Address"\>Address information goes here</IressTab\>
701
+ <IressTab label\="Employment"\>
275
702
  Employment information goes here </IressTab\>
276
- <IressTab label\="Medical history" value\="medical"\>
703
+ <IressTab label\="Medical history"\>
277
704
  Medical history goes here </IressTab\>
278
705
  </\>
279
706
  )}
@@ -318,7 +745,7 @@ Hide code
318
745
  pill
319
746
  \>
320
747
  3 </IressBadge\>
321
- <IressTab label\={<IressInline gutter\="sm"\><IressIcon name\="user" />{' '}Employment</IressInline\>}\>
748
+ <IressTab label\={<IressInline gap\="sm"\><IressIcon name\="user" />{' '}Employment</IressInline\>}\>
322
749
  Employment information goes here </IressTab\>
323
750
  <IressTab label\="History"\>
324
751
  Medical history goes here </IressTab\>