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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/dist/searchHandlers.test.js +8 -2
  2. package/dist/toolHandler.test.js +9 -9
  3. package/dist/utils.test.js +6 -2
  4. package/package.json +32 -30
  5. package/generated/docs/components-alert-docs.md +0 -702
  6. package/generated/docs/components-autocomplete-docs.md +0 -1433
  7. package/generated/docs/components-autocomplete-recipes-docs.md +0 -104
  8. package/generated/docs/components-badge-docs.md +0 -531
  9. package/generated/docs/components-button-docs.md +0 -1442
  10. package/generated/docs/components-buttongroup-docs.md +0 -748
  11. package/generated/docs/components-card-docs.md +0 -944
  12. package/generated/docs/components-checkbox-docs.md +0 -694
  13. package/generated/docs/components-checkboxgroup-docs.md +0 -1087
  14. package/generated/docs/components-checkboxgroup-recipes-docs.md +0 -119
  15. package/generated/docs/components-col-docs.md +0 -881
  16. package/generated/docs/components-container-docs.md +0 -123
  17. package/generated/docs/components-divider-docs.md +0 -576
  18. package/generated/docs/components-expander-docs.md +0 -594
  19. package/generated/docs/components-field-docs.md +0 -2007
  20. package/generated/docs/components-filter-docs.md +0 -1322
  21. package/generated/docs/components-hide-docs.md +0 -702
  22. package/generated/docs/components-icon-docs.md +0 -816
  23. package/generated/docs/components-image-docs.md +0 -493
  24. package/generated/docs/components-inline-docs.md +0 -2003
  25. package/generated/docs/components-input-docs.md +0 -867
  26. package/generated/docs/components-input-recipes-docs.md +0 -140
  27. package/generated/docs/components-inputcurrency-docs.md +0 -689
  28. package/generated/docs/components-inputcurrency-recipes-docs.md +0 -115
  29. package/generated/docs/components-introduction-docs.md +0 -450
  30. package/generated/docs/components-label-docs.md +0 -562
  31. package/generated/docs/components-link-docs.md +0 -586
  32. package/generated/docs/components-menu-docs.md +0 -1146
  33. package/generated/docs/components-menu-menuitem-docs.md +0 -739
  34. package/generated/docs/components-modal-docs.md +0 -1346
  35. package/generated/docs/components-panel-docs.md +0 -600
  36. package/generated/docs/components-placeholder-docs.md +0 -446
  37. package/generated/docs/components-popover-docs.md +0 -1529
  38. package/generated/docs/components-popover-recipes-docs.md +0 -211
  39. package/generated/docs/components-progress-docs.md +0 -568
  40. package/generated/docs/components-provider-docs.md +0 -160
  41. package/generated/docs/components-radio-docs.md +0 -563
  42. package/generated/docs/components-radiogroup-docs.md +0 -1153
  43. package/generated/docs/components-readonly-docs.md +0 -535
  44. package/generated/docs/components-richselect-docs.md +0 -5836
  45. package/generated/docs/components-row-docs.md +0 -2354
  46. package/generated/docs/components-select-docs.md +0 -940
  47. package/generated/docs/components-skeleton-docs.md +0 -597
  48. package/generated/docs/components-skeleton-recipes-docs.md +0 -76
  49. package/generated/docs/components-skiplink-docs.md +0 -587
  50. package/generated/docs/components-slideout-docs.md +0 -1036
  51. package/generated/docs/components-slider-docs.md +0 -828
  52. package/generated/docs/components-spinner-docs.md +0 -450
  53. package/generated/docs/components-stack-docs.md +0 -923
  54. package/generated/docs/components-table-ag-grid-docs.md +0 -1444
  55. package/generated/docs/components-table-docs.md +0 -2327
  56. package/generated/docs/components-tabset-docs.md +0 -768
  57. package/generated/docs/components-tabset-tab-docs.md +0 -550
  58. package/generated/docs/components-tag-docs.md +0 -548
  59. package/generated/docs/components-text-docs.md +0 -585
  60. package/generated/docs/components-toaster-docs.md +0 -755
  61. package/generated/docs/components-toggle-docs.md +0 -614
  62. package/generated/docs/components-tooltip-docs.md +0 -747
  63. package/generated/docs/components-validationmessage-docs.md +0 -1161
  64. package/generated/docs/contact-us-docs.md +0 -27
  65. package/generated/docs/extensions-editor-docs.md +0 -1181
  66. package/generated/docs/extensions-editor-recipes-docs.md +0 -89
  67. package/generated/docs/foundations-accessibility-docs.md +0 -40
  68. package/generated/docs/foundations-consistency-docs.md +0 -52
  69. package/generated/docs/foundations-content-docs.md +0 -23
  70. package/generated/docs/foundations-grid-docs.md +0 -74
  71. package/generated/docs/foundations-introduction-docs.md +0 -19
  72. package/generated/docs/foundations-principles-docs.md +0 -70
  73. package/generated/docs/foundations-responsive-breakpoints-docs.md +0 -193
  74. package/generated/docs/foundations-tokens-colour-docs.md +0 -564
  75. package/generated/docs/foundations-tokens-elevation-docs.md +0 -155
  76. package/generated/docs/foundations-tokens-introduction-docs.md +0 -190
  77. package/generated/docs/foundations-tokens-radius-docs.md +0 -71
  78. package/generated/docs/foundations-tokens-spacing-docs.md +0 -89
  79. package/generated/docs/foundations-tokens-typography-docs.md +0 -322
  80. package/generated/docs/foundations-user-experience-docs.md +0 -63
  81. package/generated/docs/foundations-visual-design-docs.md +0 -46
  82. package/generated/docs/foundations-z-index-stacking-docs.md +0 -31
  83. package/generated/docs/frequently-asked-questions-docs.md +0 -53
  84. package/generated/docs/get-started-develop-docs.md +0 -209
  85. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  86. package/generated/docs/guidelines.md +0 -2054
  87. package/generated/docs/introduction-docs.md +0 -87
  88. package/generated/docs/news-version-6-docs.md +0 -93
  89. package/generated/docs/patterns-form-docs.md +0 -3902
  90. package/generated/docs/patterns-form-recipes-docs.md +0 -1370
  91. package/generated/docs/patterns-introduction-docs.md +0 -24
  92. package/generated/docs/patterns-loading-docs.md +0 -4043
  93. package/generated/docs/resources-code-katas-docs.md +0 -29
  94. package/generated/docs/resources-introduction-docs.md +0 -38
  95. package/generated/docs/resources-mcp-server-docs.md +0 -27
  96. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  97. package/generated/docs/styling-props-colour-docs.md +0 -172
  98. package/generated/docs/styling-props-elevation-docs.md +0 -88
  99. package/generated/docs/styling-props-radius-docs.md +0 -86
  100. package/generated/docs/styling-props-reference-docs.md +0 -160
  101. package/generated/docs/styling-props-screen-readers-docs.md +0 -71
  102. package/generated/docs/styling-props-sizing-docs.md +0 -627
  103. package/generated/docs/styling-props-spacing-docs.md +0 -2282
  104. package/generated/docs/styling-props-typography-docs.md +0 -121
  105. package/generated/docs/themes-available-themes-docs.md +0 -66
  106. package/generated/docs/themes-introduction-docs.md +0 -121
  107. package/generated/docs/versions-docs.md +0 -17
  108. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,768 +0,0 @@
1
- [](#tab-set)Tab Set
2
- ===================
3
-
4
- Overview
5
- --------
6
-
7
- Tabs are used to display modular pieces of related data that do not need to be compared or accessed simultaneously.
8
-
9
- * * *
10
-
11
- Updated
12
-
13
- **Recently updated**
14
-
15
- This component has been recently updated with new props. The props have been marked as beta. Please tell us if there are any issues.
16
-
17
- Address
18
-
19
- Employment
20
-
21
- History
22
-
23
- Address information goes here
24
-
25
- Hide code
26
-
27
- \[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; }
28
-
29
- <IressTabSet\>
30
- <IressTab label\="Address"\>
31
- Address information goes here </IressTab\>
32
- <IressTab label\="Employment"\>
33
- Employment information goes here </IressTab\>
34
- <IressTab label\="History"\>
35
- Medical history goes here </IressTab\>
36
- </IressTabSet\>
37
-
38
- Copy
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
-
456
- [](#usage)Usage
457
- ---------------
458
-
459
- The `IressTabSet` is a wrapper for `IressTab` components to make a up a set of tabs.
460
-
461
- ### [](#navigation)Navigation
462
-
463
- You can use the `IressTabSet` component to create tab navigation to control an area of the page, or even navigate between different pages.
464
-
465
- [Iress](https://iress.com)
466
-
467
- [Google](https://google.com)
468
-
469
- Hide code
470
-
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; }
472
-
473
- <IressTabSet\>
474
- <IressTab
475
- href\="https://iress.com"
476
- label\="Iress"
477
- />
478
- <IressTab
479
- href\="https://google.com"
480
- label\="Google"
481
- />
482
- </IressTabSet\>
483
-
484
- Copy
485
-
486
- ### [](#with-children-prop)With `children` prop
487
-
488
- Using the `children` prop will automatically inject the content as a tab panel when active, along with appropriate attributes for accessibility, ensuring the tab and its associated panel can be navigated by screenreaders.
489
-
490
- Address
491
-
492
- Employment
493
-
494
- History
495
-
496
- Address information goes here
497
-
498
- Hide code
499
-
500
- \[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; }
501
-
502
- <IressTabSet\>
503
- <IressTab label\="Address"\>
504
- Address information goes here </IressTab\>
505
- <IressTab label\="Employment"\>
506
- Employment information goes here </IressTab\>
507
- <IressTab label\="History"\>
508
- Medical history goes here </IressTab\>
509
- </IressTabSet\>
510
-
511
- Copy
512
-
513
- [](#examples)Examples
514
- ---------------------
515
-
516
- ### [](#default-selected)Default selected
517
-
518
- If you would like to set a tab by default, use the `defaultSelected` prop.
519
-
520
- [Iress](https://iress.com)
521
-
522
- [Google](https://google.com)
523
-
524
- Hide code
525
-
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; }
527
-
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
- />
537
- </IressTabSet\>
538
-
539
- Copy
540
-
541
- ### [](#controlled)Controlled
542
-
543
- You can use state to control the active tab by setting the `selected` property to which tab you would like to select. This should be the `value` of the tab you would like to select, or if you do not use the `value` prop, it's index.
544
-
545
- Change to last tab
546
-
547
- Address
548
-
549
- Employment
550
-
551
- History
552
-
553
- Address information goes here
554
-
555
- Hide code
556
-
557
- \[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; }
558
-
559
- import {
560
- IressButton,
561
- IressStack,
562
- IressTab,
563
- IressTabSet,
564
- IressTabSetProps,
565
- } from '@iress-oss/ids-components';
566
- import { useState } from 'react';
567
- export const TabsUsingState \= () \=> {
568
- const \[selected, setSelected\] \= useState<number\>();
569
- return (
570
- <IressStack gap\="md"\>
571
- <IressButton onClick\={() \=> setSelected(selected \=== 2 ? 0 : 2)}\>
572
- {selected \=== 2 ? \`Back to first tab\` : \`Change to last tab\`}
573
- </IressButton\>
574
- <IressTabSet
575
-
576
- selected\={selected}
577
- onChange\={({ index }) \=> setSelected(index)}
578
- \>
579
- <IressTab label\="Address"\>Address information goes here</IressTab\>
580
- <IressTab label\="Employment"\>Employment information goes here</IressTab\>
581
- <IressTab label\="History"\>Medical history goes here</IressTab\>
582
- </IressTabSet\>
583
- </IressStack\>
584
- );
585
- };
586
-
587
- Copy
588
-
589
- ### [](#layout)Layout
590
-
591
- `IressTabSet` controls the layout of the tab buttons. These will always appear at the top of the tab container, and can be aligned to the left (default), centrally or to the right via the `layout` prop.
592
-
593
- top-left
594
- --------
595
-
596
- Address
597
-
598
- Employment
599
-
600
- History
601
-
602
- Address information goes here
603
-
604
- top-center
605
- ----------
606
-
607
- Address
608
-
609
- Employment
610
-
611
- History
612
-
613
- Address information goes here
614
-
615
- top-right
616
- ---------
617
-
618
- Address
619
-
620
- Employment
621
-
622
- History
623
-
624
- Address information goes here
625
-
626
- Hide code
627
-
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; }
629
-
630
- <IressStack gap\="md"\>
631
- <IressPanel\>
632
- <IressText element\="h2"\>
633
- top-left </IressText\>
634
- <IressTabSet layout\="top-left"\>
635
- <IressTab label\="Address"\>
636
- Address information goes here </IressTab\>
637
- <IressTab label\="Employment"\>
638
- Employment information goes here </IressTab\>
639
- <IressTab label\="History"\>
640
- Medical history goes here </IressTab\>
641
- </IressTabSet\>
642
- </IressPanel\>
643
- <IressPanel\>
644
- <IressText element\="h2"\>
645
- top-center </IressText\>
646
- <IressTabSet layout\="top-center"\>
647
- <IressTab label\="Address"\>
648
- Address information goes here </IressTab\>
649
- <IressTab label\="Employment"\>
650
- Employment information goes here </IressTab\>
651
- <IressTab label\="History"\>
652
- Medical history goes here </IressTab\>
653
- </IressTabSet\>
654
- </IressPanel\>
655
- <IressPanel\>
656
- <IressText element\="h2"\>
657
- top-right </IressText\>
658
- <IressTabSet layout\="top-right"\>
659
- <IressTab label\="Address"\>
660
- Address information goes here </IressTab\>
661
- <IressTab label\="Employment"\>
662
- Employment information goes here </IressTab\>
663
- <IressTab label\="History"\>
664
- Medical history goes here </IressTab\>
665
- </IressTabSet\>
666
- </IressPanel\>
667
- </IressStack\>
668
-
669
- Copy
670
-
671
- ### [](#lazy-loading)Lazy Loading
672
-
673
- Tabs can be lazy loaded via state, allowing you to add/remove tabs as needed.
674
-
675
- Toggle tabs
676
-
677
- Hide code
678
-
679
- \[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; }
680
-
681
- import {
682
- IressButton,
683
- IressStack,
684
- IressTab,
685
- IressTabSet,
686
- IressTabSetProps,
687
- } from '@iress-oss/ids-components';
688
- import { useState } from 'react';
689
- export const TabsLazyLoading \= () \=> {
690
- const \[loadTabs, setLoadTabs\] \= useState<boolean\>();
691
- return (
692
- <IressStack gap\="md"\>
693
- <IressButton onClick\={() \=> setLoadTabs(!loadTabs)}\>
694
- Toggle tabs </IressButton\>
695
- <IressTabSet {...{
696
- defaultSelected: 2,
697
- }}\>
698
- {loadTabs && (
699
- <\>
700
- <IressTab label\="Address"\>Address information goes here</IressTab\>
701
- <IressTab label\="Employment"\>
702
- Employment information goes here </IressTab\>
703
- <IressTab label\="Medical history"\>
704
- Medical history goes here </IressTab\>
705
- </\>
706
- )}
707
- </IressTabSet\>
708
- </IressStack\>
709
- );
710
- };
711
-
712
- Copy
713
-
714
- ### [](#badges-and-icons)Badges and icons
715
-
716
- You can add rich content into the `label` of the `IressTab` to customise the tab further.
717
-
718
- Some common examples include:
719
-
720
- * Adding a badge to the tab button.
721
- * Adding icons to the tab button.
722
-
723
- Notes:
724
-
725
- * For best accessibility, the `IressTab` component will find the first focusable element inside the custom label to add the tab role.
726
-
727
- Address
728
-
729
- 3
730
-
731
- Employment
732
-
733
- History
734
-
735
- Address information goes here
736
-
737
- Hide code
738
-
739
- \[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; }
740
-
741
- <IressTabSet\>
742
- <IressBadge
743
- host\={<IressTab label\="Address"\>Address information goes here</IressTab\>}
744
- mode\="info"
745
- pill
746
- \>
747
- 3 </IressBadge\>
748
- <IressTab label\={<IressInline gap\="sm"\><IressIcon name\="user" />{' '}Employment</IressInline\>}\>
749
- Employment information goes here </IressTab\>
750
- <IressTab label\="History"\>
751
- Medical history goes here </IressTab\>
752
- </IressTabSet\>
753
-
754
- Copy
755
-
756
- On this page
757
-
758
- * [Overview](#overview)
759
- * [Props](#props)
760
- * [Usage](#usage)
761
- * [Navigation](#navigation)
762
- * [With children prop](#with-children-prop)
763
- * [Examples](#examples)
764
- * [Default selected](#default-selected)
765
- * [Controlled](#controlled)
766
- * [Layout](#layout)
767
- * [Lazy Loading](#lazy-loading)
768
- * [Badges and icons](#badges-and-icons)