@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,20 +6,465 @@ Overview
6
6
 
7
7
  Expanders are commonly used to reveal more information or details about an element or content on a page.
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
  Expander activator
10
18
 
11
- Expander content will go here (it is unformatted by default, use IressText to format the text)
19
+ Expander content will go here
12
20
 
13
21
  Hide code
14
22
 
15
23
  \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
16
24
 
17
25
  <IressExpander activator\="Expander activator"\>
18
- Expander content will go here (it is unformatted by default, use IressText to format the text)
26
+ Expander content will go here
19
27
  </IressExpander\>
20
28
 
21
29
  Copy
22
30
 
31
+ [](#props)Props
32
+ ---------------
33
+
34
+ | Name | Description | Default | Control |
35
+ | --- | --- | --- | --- |
36
+ | activator\* |
37
+ The element used to activate the expandable container.
38
+
39
+ ReactNode
40
+
41
+
42
+
43
+ | \- |
44
+
45
+ "Expander activator"
46
+
47
+ |
48
+ | activatorStyle |
49
+
50
+ This allows you to customise the content styling specifically, which is the floating element. It accepts an object with any of the styling properties available on `IressCSSProps`, as well as `className` and `style`.
51
+
52
+ IressCustomiseSlotundefined
53
+
54
+
55
+
56
+ | \- | Set object |
57
+ | bg |
58
+
59
+ **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
60
+
61
+ We recommend using the following token values for best background contrast:
62
+
63
+ * `colour.primary.fill` for primary backgrounds that need to stand out
64
+ * `colour.primary.surface` for primary backgrounds that need to be less prominent
65
+ * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
66
+ * `colour.neutral.20` for a slightly darker background color, used in neutral state components
67
+ * `colour.system.danger.fill` for error backgrounds that need to stand out
68
+ * `colour.system.danger.surface` for error backgrounds that need to be less prominent
69
+ * `colour.system.success.fill` for success backgrounds that need to stand out
70
+ * `colour.system.success.surface` for success backgrounds that need to be less prominent
71
+ * `colour.system.warning.fill` for warning backgrounds that need to stand out
72
+ * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
73
+ * `colour.system.info.fill` for info backgrounds that need to stand out
74
+ * `colour.system.info.surface` for info backgrounds that need to be less prominent
75
+
76
+ ResponsiveProp<ColorToken> | undefined
77
+
78
+ | \- | Set object |
79
+ | borderRadius |
80
+
81
+ The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
82
+
83
+ | Chrome | Firefox | Safari | Edge | IE |
84
+ | --- | --- | --- | --- | --- |
85
+ | **4** | **4** | **5** | **12** | **9** |
86
+ | 1 _\-x-_ | | 3 _\-x-_ | | |
87
+
88
+ ResponsiveProp<RadiusToken> | undefined
89
+
90
+ | \- | Set object |
91
+ | children |
92
+
93
+ Contents that will be expanded/collapsed when the expander is activated.
94
+
95
+ ReactNode
96
+
97
+
98
+
99
+ | \- |
100
+
101
+ "Expander content will go here"
102
+
103
+ |
104
+ | color |
105
+
106
+ 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`.
107
+
108
+ We recommend using the following token values for best color contrast:
109
+
110
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
111
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
112
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
113
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
114
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
115
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
116
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
117
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
118
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
119
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
120
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
121
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
122
+
123
+ ResponsiveProp<ColorToken> | undefined
124
+
125
+ | \- | Set object |
126
+ | focusable |
127
+
128
+ 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.
129
+
130
+ "true""within"undefined
131
+
132
+
133
+
134
+ | \- | Set object |
135
+ | hide |
136
+
137
+ 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.
138
+
139
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
140
+
141
+ Notes:
142
+
143
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
144
+ * Consider if you can conditionally render the element instead of hiding it.
145
+
146
+ ResponsiveProp<boolean> | undefined
147
+
148
+ | \- | Set object |
149
+ | layerStyle |
150
+
151
+ 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.
152
+
153
+ * `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.
154
+ * `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.
155
+ * `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.
156
+
157
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
158
+
159
+ | \- | Set object |
160
+ | m |
161
+
162
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
163
+
164
+ 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.
165
+
166
+ | Chrome | Firefox | Safari | Edge | IE |
167
+ | --- | --- | --- | --- | --- |
168
+ | **1** | **1** | **1** | **12** | **3** |
169
+
170
+ ResponsiveProp<SpacingToken | "auto"> | undefined
171
+
172
+ | \- | Set object |
173
+ | maxWidth |
174
+
175
+ 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`.
176
+
177
+ | Chrome | Firefox | Safari | Edge | IE |
178
+ | --- | --- | --- | --- | --- |
179
+ | **1** | **1** | **1** | **12** | **7** |
180
+
181
+ 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
182
+
183
+ | \- | Set object |
184
+ | mb |
185
+
186
+ 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.
187
+
188
+ It uses the spacing tokens in the design system.
189
+
190
+ | Chrome | Firefox | Safari | Edge | IE |
191
+ | --- | --- | --- | --- | --- |
192
+ | **1** | **1** | **1** | **12** | **3** |
193
+
194
+ ResponsiveProp<SpacingToken | "auto"> | undefined
195
+
196
+ | \- | Set object |
197
+ | ml |
198
+
199
+ 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.
200
+
201
+ It uses the spacing tokens in the design system.
202
+
203
+ | Chrome | Firefox | Safari | Edge | IE |
204
+ | --- | --- | --- | --- | --- |
205
+ | **1** | **1** | **1** | **12** | **3** |
206
+
207
+ ResponsiveProp<SpacingToken | "auto"> | undefined
208
+
209
+ | \- | Set object |
210
+ | mode |
211
+
212
+ Controls the display mode of the activator element. Can be Section, Heading or Link.
213
+
214
+ "link""section"undefined
215
+
216
+
217
+
218
+ |
219
+
220
+ section
221
+
222
+ | Set object |
223
+ | mr |
224
+
225
+ 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.
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
+ | mt |
237
+
238
+ 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.
239
+
240
+ It uses the spacing tokens in the design system.
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
+ | mx |
250
+
251
+ 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.
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
+ | my |
263
+
264
+ 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.
265
+
266
+ 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.
267
+
268
+ | Chrome | Firefox | Safari | Edge | IE |
269
+ | --- | --- | --- | --- | --- |
270
+ | **1** | **1** | **1** | **12** | **3** |
271
+
272
+ ResponsiveProp<SpacingToken | "auto"> | undefined
273
+
274
+ | \- | Set object |
275
+ | noGutter |
276
+
277
+ 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.
278
+
279
+ booleanundefined
280
+
281
+
282
+
283
+ | \- | Set object |
284
+ | onChange |
285
+
286
+ Emitted when the open state changes.
287
+
288
+ ((newValue: boolean) => void) | undefined
289
+
290
+ | \- | \- |
291
+ | open |
292
+
293
+ When true the expandable container will be visible and the activator will display as open.
294
+
295
+ booleanundefined
296
+
297
+
298
+
299
+ |
300
+
301
+ false
302
+
303
+ | Set object |
304
+ | p |
305
+
306
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
307
+
308
+ 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.
309
+
310
+ | Chrome | Firefox | Safari | Edge | IE |
311
+ | --- | --- | --- | --- | --- |
312
+ | **1** | **1** | **1** | **12** | **3** |
313
+
314
+ 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
315
+
316
+ | \- | Set object |
317
+ | pb |
318
+
319
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
320
+
321
+ 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.
322
+
323
+ | Chrome | Firefox | Safari | Edge | IE |
324
+ | --- | --- | --- | --- | --- |
325
+ | **1** | **1** | **1** | **12** | **3** |
326
+
327
+ 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
328
+
329
+ | \- | Set object |
330
+ | pl |
331
+
332
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
333
+
334
+ 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.
335
+
336
+ | Chrome | Firefox | Safari | Edge | IE |
337
+ | --- | --- | --- | --- | --- |
338
+ | **1** | **1** | **1** | **12** | **3** |
339
+
340
+ 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
341
+
342
+ | \- | Set object |
343
+ | pr |
344
+
345
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
346
+
347
+ 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.
348
+
349
+ | Chrome | Firefox | Safari | Edge | IE |
350
+ | --- | --- | --- | --- | --- |
351
+ | **1** | **1** | **1** | **12** | **3** |
352
+
353
+ 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
354
+
355
+ | \- | Set object |
356
+ | pt |
357
+
358
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
359
+
360
+ 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.
361
+
362
+ | Chrome | Firefox | Safari | Edge | IE |
363
+ | --- | --- | --- | --- | --- |
364
+ | **1** | **1** | **1** | **12** | **3** |
365
+
366
+ 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
367
+
368
+ | \- | Set object |
369
+ | px |
370
+
371
+ 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.
372
+
373
+ 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.
374
+
375
+ | Chrome | Firefox | Safari | Edge | IE |
376
+ | --- | --- | --- | --- | --- |
377
+ | **1** | **1** | **1** | **12** | **3** |
378
+
379
+ 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
380
+
381
+ | \- | Set object |
382
+ | py |
383
+
384
+ 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.
385
+
386
+ 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.
387
+
388
+ | Chrome | Firefox | Safari | Edge | IE |
389
+ | --- | --- | --- | --- | --- |
390
+ | **1** | **1** | **1** | **12** | **3** |
391
+
392
+ 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
393
+
394
+ | \- | Set object |
395
+ | rowGap |
396
+
397
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
398
+
399
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
400
+
401
+ | Chrome | Firefox | Safari | Edge | IE |
402
+ | --- | --- | --- | --- | --- |
403
+ | **47** | **52** | **10.1** | **16** | No |
404
+
405
+ 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
406
+
407
+ | \- | Set object |
408
+ | srOnly |
409
+
410
+ 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.
411
+
412
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
413
+
414
+ ResponsiveProp<boolean> | undefined
415
+
416
+ | \- | Set object |
417
+ | stretch |
418
+
419
+ 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.
420
+
421
+ booleanundefined
422
+
423
+
424
+
425
+ | \- | Set object |
426
+ | textAlign |
427
+
428
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
429
+
430
+ | Chrome | Firefox | Safari | Edge | IE |
431
+ | --- | --- | --- | --- | --- |
432
+ | **1** | **1** | **1** | **12** | **3** |
433
+
434
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
435
+
436
+ | \- | Set object |
437
+ | textStyle |
438
+
439
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
440
+
441
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
442
+ * `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.
443
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
444
+ * `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.
445
+ * `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.
446
+ * `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.
447
+ * `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.
448
+ * `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.
449
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
450
+
451
+ 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
452
+
453
+ | \- | Set object |
454
+ | width |
455
+
456
+ 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.
457
+
458
+ 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.
459
+
460
+ | Chrome | Firefox | Safari | Edge | IE |
461
+ | --- | --- | --- | --- | --- |
462
+ | **1** | **1** | **1** | **12** | **4** |
463
+
464
+ 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
465
+
466
+ | \- | Set object |
467
+
23
468
  [](#accessibility)Accessibility
24
469
  -------------------------------
25
470
 
@@ -30,110 +475,49 @@ For Accessibility guidelines refer to [W3 ARIA Patterns Disclosure](https://www.
30
475
 
31
476
  ### [](#mode)Mode
32
477
 
33
- Expander has a `mode` prop which can be used to change how the expander is displayed. There are 3 modes `section` (default), `heading` and `link`.
34
-
35
- section mode
36
- ------------
478
+ Expander has a `mode` prop which can be used to change how the expander is displayed. There are two modes `section` (default) and `link`.
37
479
 
38
- ### Expander activator
480
+ * `section` mode is used to expand larger sections of rich content, such as a table or a detailed transcript.
481
+ * `link` mode is used to expand a small section of content, usually used to provide additional context (eg. "Learn more" or "See more details").
39
482
 
40
- Okay, so 9:00 you are strolling through the parking lot, you see us struggling in the car, you walk up, you open the door and you say, your line, George.
483
+ Section (default)
484
+ -----------------
41
485
 
42
- heading mode
43
- ------------
44
-
45
- ### Expander activator
486
+ Expander activator
46
487
 
47
- Okay, so 9:00 you are strolling through the parking lot, you see us struggling in the car, you walk up, you open the door and you say, your line, George.
488
+ Expander content will go here
48
489
 
49
- link mode
50
- ---------
490
+ Link
491
+ ----
51
492
 
52
- ### Expander activator
493
+ Expander activator
53
494
 
54
- Okay, so 9:00 you are strolling through the parking lot, you see us struggling in the car, you walk up, you open the door and you say, your line, George.
495
+ Expander content will go here
55
496
 
56
497
  Hide code
57
498
 
58
499
  \[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; }
59
500
 
60
- <div className\="iress-u-stack iress--gutter--md"\>
61
- <div\>
501
+ <IressStack gap\="lg"\>
502
+ <IressStack gap\="xs"\>
62
503
  <IressText element\="h2"\>
63
- section mode </IressText\>
64
- <div className\="iress-u-inline iress--gutter--md"\>
65
- <IressExpander
66
- activator\={<div\><IressText element\="h3"\>Expander activator</IressText\></div\>}
67
- mode\="section"
68
- \>
69
- <IressRow
70
- gutter\="md"
71
- verticalAlign\="stretch"
72
- \>
73
- <IressCol
74
- data-testid\="security-infra"
75
- span\={{
76
- sm: 6
77
- }}
78
- \>
79
- <IressText\>
80
- Okay, so 9:00 you are strolling through the parking lot, you see us struggling in the car, you walk up, you open the door and you say, your line, George. </IressText\>
81
- </IressCol\>
82
- </IressRow\>
83
- </IressExpander\>
84
- </div\>
85
- </div\>
86
- <div\>
87
- <IressText element\="h2"\>
88
- heading mode </IressText\>
89
- <div className\="iress-u-inline iress--gutter--md"\>
90
- <IressExpander
91
- activator\={<div\><IressText element\="h3"\>Expander activator</IressText\></div\>}
92
- mode\="heading"
93
- \>
94
- <IressRow
95
- gutter\="md"
96
- verticalAlign\="stretch"
97
- \>
98
- <IressCol
99
- data-testid\="security-infra"
100
- span\={{
101
- sm: 6
102
- }}
103
- \>
104
- <IressText\>
105
- Okay, so 9:00 you are strolling through the parking lot, you see us struggling in the car, you walk up, you open the door and you say, your line, George. </IressText\>
106
- </IressCol\>
107
- </IressRow\>
108
- </IressExpander\>
109
- </div\>
110
- </div\>
111
- <div\>
504
+ Section (default) </IressText\>
505
+ <IressExpander
506
+ activator\="Expander activator"
507
+ mode\="section"
508
+ \>
509
+ Expander content will go here </IressExpander\>
510
+ </IressStack\>
511
+ <IressStack gap\="xs"\>
112
512
  <IressText element\="h2"\>
113
- link mode </IressText\>
114
- <div className\="iress-u-inline iress--gutter--md"\>
115
- <IressExpander
116
- activator\={<div\><IressText element\="h3"\>Expander activator</IressText\></div\>}
117
- mode\="link"
118
- \>
119
- <IressRow
120
- gutter\="md"
121
- verticalAlign\="stretch"
122
- \>
123
- <IressCol
124
- data-testid\="security-infra"
125
- span\={{
126
- sm: 6
127
- }}
128
- \>
129
- <IressText\>
130
- Okay, so 9:00 you are strolling through the parking lot, you see us struggling in the car, you walk up, you open the door and you say, your line, George. </IressText\>
131
- </IressCol\>
132
- </IressRow\>
133
- </IressExpander\>
134
- </div\>
135
- </div\>
136
- </div\>
513
+ Link </IressText\>
514
+ <IressExpander
515
+ activator\="Expander activator"
516
+ mode\="link"
517
+ \>
518
+ Expander content will go here </IressExpander\>
519
+ </IressStack\>
520
+ </IressStack\>
137
521
 
138
522
  Copy
139
523
 
@@ -143,7 +527,7 @@ The `open` prop can be used to control the open state of the expander as can be
143
527
 
144
528
  Expander activator
145
529
 
146
- Expander content will go here (it is unformatted by default, use IressText to format the text)
530
+ Expander content will go here
147
531
 
148
532
  Hide code
149
533
 
@@ -151,10 +535,9 @@ Hide code
151
535
 
152
536
  <IressExpander
153
537
  activator\="Expander activator"
154
- mode\="heading"
155
538
  open
156
539
  \>
157
- Expander content will go here (it is unformatted by default, use IressText to format the text)
540
+ Expander content will go here
158
541
  </IressExpander\>
159
542
 
160
543
  Copy
@@ -163,15 +546,13 @@ Copy
163
546
 
164
547
  You can use multiple expanders to create an accordion, where al expander closes when another is opened.
165
548
 
166
- top
167
-
168
549
  Top
169
- ===
170
550
 
171
- bottom
551
+ Expander content for the top activator goes here.
172
552
 
173
553
  Bottom
174
- ------
554
+
555
+ Expander content for the bottom activator goes here.
175
556
 
176
557
  Hide code
177
558
 
@@ -185,19 +566,17 @@ export const MultipleExpander \= () \=> {
185
566
  return (
186
567
  <div\>
187
568
  <IressExpander
188
- activator\="top"
569
+ activator\="Top"
189
570
  open\={openActivator \=== 'top'}
190
- onChange\={({ open }) \=> handleChange('top', open)}
571
+ onChange\={(open) \=> handleChange('top', open)}
191
572
  \>
192
- <h1\>Top</h1\>
193
- </IressExpander\>
573
+ Expander content for the top activator goes here. </IressExpander\>
194
574
  <IressExpander
195
- activator\="bottom"
575
+ activator\="Bottom"
196
576
  open\={openActivator \=== 'bottom'}
197
- onChange\={({ open }) \=> handleChange('bottom', open)}
577
+ onChange\={(open) \=> handleChange('bottom', open)}
198
578
  \>
199
- <h2\>Bottom</h2\>
200
- </IressExpander\>
579
+ Expander content for the bottom activator goes here. </IressExpander\>
201
580
  </div\>
202
581
  );
203
582
  };