@iress-oss/ids-mcp-server 5.14.2 → 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 (105) 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 +269 -56
  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 +160 -0
  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 +501 -1723
  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 +512 -51
  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/get-started-develop-docs.md +177 -16
  74. package/generated/docs/guidelines.md +1537 -295
  75. package/generated/docs/introduction-docs.md +65 -21
  76. package/generated/docs/news-version-6-docs.md +93 -0
  77. package/generated/docs/patterns-form-docs.md +3902 -0
  78. package/generated/docs/patterns-form-recipes-docs.md +1370 -0
  79. package/generated/docs/patterns-introduction-docs.md +24 -0
  80. package/generated/docs/patterns-loading-docs.md +2942 -203
  81. package/generated/docs/resources-introduction-docs.md +38 -0
  82. package/generated/docs/resources-mcp-server-docs.md +27 -0
  83. package/generated/docs/styling-props-colour-docs.md +172 -0
  84. package/generated/docs/styling-props-elevation-docs.md +88 -0
  85. package/generated/docs/styling-props-radius-docs.md +86 -0
  86. package/generated/docs/styling-props-reference-docs.md +160 -0
  87. package/generated/docs/styling-props-screen-readers-docs.md +71 -0
  88. package/generated/docs/styling-props-sizing-docs.md +627 -0
  89. package/generated/docs/styling-props-spacing-docs.md +2282 -0
  90. package/generated/docs/styling-props-typography-docs.md +121 -0
  91. package/generated/docs/themes-available-themes-docs.md +29 -29
  92. package/generated/docs/themes-introduction-docs.md +1 -1
  93. package/package.json +3 -22
  94. package/generated/docs/components-button-recipes-docs.md +0 -76
  95. package/generated/docs/components-card-recipes-docs.md +0 -89
  96. package/generated/docs/components-combobox-docs.md +0 -1016
  97. package/generated/docs/components-form-docs.md +0 -2442
  98. package/generated/docs/components-form-recipes-docs.md +0 -892
  99. package/generated/docs/components-navbar-docs.md +0 -291
  100. package/generated/docs/components-navbar-recipes-docs.md +0 -413
  101. package/generated/docs/components-toaster-toast-docs.md +0 -157
  102. package/generated/docs/foundations-colours-docs.md +0 -257
  103. package/generated/docs/foundations-typography-docs.md +0 -191
  104. package/generated/docs/resources-changelog-docs.md +0 -6
  105. package/generated/docs/themes-tokens-docs.md +0 -1200
@@ -6,6 +6,14 @@ Overview
6
6
 
7
7
  An alert displays a short, important message in a way that attracts the user's attention without interrupting the user's task.
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
  This is a simple info alert
10
18
 
11
19
  Hide code
@@ -22,6 +30,484 @@ Hide code
22
30
 
23
31
  Copy
24
32
 
33
+ [](#props)Props
34
+ ---------------
35
+
36
+ | Name | Description | Default | Control |
37
+ | --- | --- | --- | --- |
38
+ | actions |
39
+ Actions to display in the alert. These will be rendered as buttons with opinionated styling. If you want to use custom buttons, use the `footer` prop instead.
40
+
41
+ Omit<IressButtonProps, "mode" | "status">\[\] | undefined
42
+
43
+ | \- | Set object |
44
+ | bg |
45
+
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
+ Contents of the alert. Is automatically wrapped in `<IressText />` and will inherit its styling.
81
+
82
+ ReactNode
83
+
84
+
85
+
86
+ | \- |
87
+
88
+ "This is a simple info alert"
89
+
90
+ |
91
+ | color |
92
+
93
+ 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`.
94
+
95
+ We recommend using the following token values for best color contrast:
96
+
97
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
98
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
99
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
100
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
101
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
102
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
103
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
104
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
105
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
106
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
107
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
108
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
109
+
110
+ ResponsiveProp<ColorToken> | undefined
111
+
112
+ | \- | Set object |
113
+ | defaultDismissed |
114
+
115
+ Contents of the alert. Is automatically wrapped in `<IressText />` and will inherit its styling.
116
+
117
+ booleanundefined
118
+
119
+
120
+
121
+ | \- | Set object |
122
+ | dismissed |
123
+
124
+ Contents of the alert. Is automatically wrapped in `<IressText />` and will inherit its styling.
125
+
126
+ booleanundefined
127
+
128
+
129
+
130
+ | \- | Set object |
131
+ | focusable |
132
+
133
+ 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.
134
+
135
+ "true""within"undefined
136
+
137
+
138
+
139
+ | \- | Set object |
140
+ | footer |
141
+
142
+ Buttons and controls for the alert.
143
+
144
+ ReactNode
145
+
146
+ <table class="css-3nr4py"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `actions` instead for buttons with opinionated styling. If you need other footer content, use the `children` prop instead.</td></tr></tbody></table>
147
+
148
+ | \- |
149
+
150
+ ""
151
+
152
+ |
153
+ | heading |
154
+
155
+ Text for alert heading. If a string, it will use a heading with level 2.
156
+
157
+ ReactNode
158
+
159
+
160
+
161
+ | \- |
162
+
163
+ ""
164
+
165
+ |
166
+ | hide |
167
+
168
+ 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.
169
+
170
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
171
+
172
+ Notes:
173
+
174
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
175
+ * Consider if you can conditionally render the element instead of hiding it.
176
+
177
+ ResponsiveProp<boolean> | undefined
178
+
179
+ | \- | Set object |
180
+ | icon |
181
+
182
+ Icon to display in the alert. If set to `false`, no icon will be displayed. If not provided, the icon will be determined by the `status` prop.
183
+
184
+ falseIconNameundefined
185
+
186
+
187
+
188
+ | \- | Set object |
189
+ | layerStyle |
190
+
191
+ 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.
192
+
193
+ * `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.
194
+ * `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.
195
+ * `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.
196
+
197
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
198
+
199
+ | \- | Set object |
200
+ | m |
201
+
202
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
203
+
204
+ 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.
205
+
206
+ | Chrome | Firefox | Safari | Edge | IE |
207
+ | --- | --- | --- | --- | --- |
208
+ | **1** | **1** | **1** | **12** | **3** |
209
+
210
+ ResponsiveProp<SpacingToken | "auto"> | undefined
211
+
212
+ | \- | Set object |
213
+ | maxWidth |
214
+
215
+ 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`.
216
+
217
+ | Chrome | Firefox | Safari | Edge | IE |
218
+ | --- | --- | --- | --- | --- |
219
+ | **1** | **1** | **1** | **12** | **7** |
220
+
221
+ 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
222
+
223
+ | \- | Set object |
224
+ | mb |
225
+
226
+ 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.
227
+
228
+ It uses the spacing tokens in the design system.
229
+
230
+ | Chrome | Firefox | Safari | Edge | IE |
231
+ | --- | --- | --- | --- | --- |
232
+ | **1** | **1** | **1** | **12** | **3** |
233
+
234
+ ResponsiveProp<SpacingToken | "auto"> | undefined
235
+
236
+ | \- | Set object |
237
+ | ml |
238
+
239
+ 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.
240
+
241
+ It uses the spacing tokens in the design system.
242
+
243
+ | Chrome | Firefox | Safari | Edge | IE |
244
+ | --- | --- | --- | --- | --- |
245
+ | **1** | **1** | **1** | **12** | **3** |
246
+
247
+ ResponsiveProp<SpacingToken | "auto"> | undefined
248
+
249
+ | \- | Set object |
250
+ | mr |
251
+
252
+ 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.
253
+
254
+ It uses the spacing tokens in the design system.
255
+
256
+ | Chrome | Firefox | Safari | Edge | IE |
257
+ | --- | --- | --- | --- | --- |
258
+ | **1** | **1** | **1** | **12** | **3** |
259
+
260
+ ResponsiveProp<SpacingToken | "auto"> | undefined
261
+
262
+ | \- | Set object |
263
+ | mt |
264
+
265
+ 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.
266
+
267
+ It uses the spacing tokens in the design system.
268
+
269
+ | Chrome | Firefox | Safari | Edge | IE |
270
+ | --- | --- | --- | --- | --- |
271
+ | **1** | **1** | **1** | **12** | **3** |
272
+
273
+ ResponsiveProp<SpacingToken | "auto"> | undefined
274
+
275
+ | \- | Set object |
276
+ | mx |
277
+
278
+ 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.
279
+
280
+ 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.
281
+
282
+ | Chrome | Firefox | Safari | Edge | IE |
283
+ | --- | --- | --- | --- | --- |
284
+ | **1** | **1** | **1** | **12** | **3** |
285
+
286
+ ResponsiveProp<SpacingToken | "auto"> | undefined
287
+
288
+ | \- | Set object |
289
+ | my |
290
+
291
+ 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.
292
+
293
+ 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.
294
+
295
+ | Chrome | Firefox | Safari | Edge | IE |
296
+ | --- | --- | --- | --- | --- |
297
+ | **1** | **1** | **1** | **12** | **3** |
298
+
299
+ ResponsiveProp<SpacingToken | "auto"> | undefined
300
+
301
+ | \- | Set object |
302
+ | noGutter |
303
+
304
+ 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.
305
+
306
+ booleanundefined
307
+
308
+
309
+
310
+ | \- | Set object |
311
+ | onDismiss |
312
+
313
+ Icon to display in the alert. If set to `false`, no icon will be displayed. If not provided, the icon will be determined by the `status` prop.
314
+
315
+ MouseEventHandler<HTMLButtonElement> | undefined
316
+
317
+ | \- | Set object |
318
+ | p |
319
+
320
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
321
+
322
+ 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.
323
+
324
+ | Chrome | Firefox | Safari | Edge | IE |
325
+ | --- | --- | --- | --- | --- |
326
+ | **1** | **1** | **1** | **12** | **3** |
327
+
328
+ 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
329
+
330
+ | \- | Set object |
331
+ | pb |
332
+
333
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
334
+
335
+ 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.
336
+
337
+ | Chrome | Firefox | Safari | Edge | IE |
338
+ | --- | --- | --- | --- | --- |
339
+ | **1** | **1** | **1** | **12** | **3** |
340
+
341
+ 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
342
+
343
+ | \- | Set object |
344
+ | pl |
345
+
346
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
347
+
348
+ 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.
349
+
350
+ | Chrome | Firefox | Safari | Edge | IE |
351
+ | --- | --- | --- | --- | --- |
352
+ | **1** | **1** | **1** | **12** | **3** |
353
+
354
+ 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
355
+
356
+ | \- | Set object |
357
+ | pr |
358
+
359
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
360
+
361
+ 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.
362
+
363
+ | Chrome | Firefox | Safari | Edge | IE |
364
+ | --- | --- | --- | --- | --- |
365
+ | **1** | **1** | **1** | **12** | **3** |
366
+
367
+ 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
368
+
369
+ | \- | Set object |
370
+ | pt |
371
+
372
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
373
+
374
+ 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.
375
+
376
+ | Chrome | Firefox | Safari | Edge | IE |
377
+ | --- | --- | --- | --- | --- |
378
+ | **1** | **1** | **1** | **12** | **3** |
379
+
380
+ 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
381
+
382
+ | \- | Set object |
383
+ | px |
384
+
385
+ 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.
386
+
387
+ 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.
388
+
389
+ | Chrome | Firefox | Safari | Edge | IE |
390
+ | --- | --- | --- | --- | --- |
391
+ | **1** | **1** | **1** | **12** | **3** |
392
+
393
+ 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
394
+
395
+ | \- | Set object |
396
+ | py |
397
+
398
+ 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.
399
+
400
+ 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.
401
+
402
+ | Chrome | Firefox | Safari | Edge | IE |
403
+ | --- | --- | --- | --- | --- |
404
+ | **1** | **1** | **1** | **12** | **3** |
405
+
406
+ 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
407
+
408
+ | \- | Set object |
409
+ | rowGap |
410
+
411
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
412
+
413
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
414
+
415
+ | Chrome | Firefox | Safari | Edge | IE |
416
+ | --- | --- | --- | --- | --- |
417
+ | **47** | **52** | **10.1** | **16** | No |
418
+
419
+ 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
420
+
421
+ | \- | Set object |
422
+ | srOnly |
423
+
424
+ 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.
425
+
426
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
427
+
428
+ ResponsiveProp<boolean> | undefined
429
+
430
+ | \- | Set object |
431
+ | status |
432
+
433
+ Alert type - danger, info, success or warning.
434
+
435
+ "danger""info""success""warning"undefined
436
+
437
+
438
+
439
+ |
440
+
441
+ info
442
+
443
+ |
444
+
445
+ "info"
446
+
447
+ |
448
+ | stretch |
449
+
450
+ 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.
451
+
452
+ booleanundefined
453
+
454
+
455
+
456
+ | \- | Set object |
457
+ | textAlign |
458
+
459
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
460
+
461
+ | Chrome | Firefox | Safari | Edge | IE |
462
+ | --- | --- | --- | --- | --- |
463
+ | **1** | **1** | **1** | **12** | **3** |
464
+
465
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
466
+
467
+ | \- | Set object |
468
+ | textStyle |
469
+
470
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
471
+
472
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
473
+ * `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.
474
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
475
+ * `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.
476
+ * `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.
477
+ * `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.
478
+ * `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.
479
+ * `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.
480
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
481
+
482
+ 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
483
+
484
+ | \- | Set object |
485
+ | variant |
486
+
487
+ Variants of the alert, allowing it to be styled differently based on where its used in the application.
488
+
489
+ * Sidebar: The icon will be aligned to the heading, and the text will appear below the icon.
490
+ * Site-wide: The border will be removed, except for the bottom border.
491
+
492
+ "sidebar""site-wide"undefined
493
+
494
+
495
+
496
+ | \- | Set object |
497
+ | width |
498
+
499
+ 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.
500
+
501
+ 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.
502
+
503
+ | Chrome | Firefox | Safari | Edge | IE |
504
+ | --- | --- | --- | --- | --- |
505
+ | **1** | **1** | **1** | **12** | **4** |
506
+
507
+ 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
508
+
509
+ | \- | Set object |
510
+
25
511
  [](#examples)Examples
26
512
  ---------------------
27
513
 
@@ -41,7 +527,7 @@ Hide code
41
527
 
42
528
  \[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; }
43
529
 
44
- <div className\="iress-u-stack iress--gutter--md"\>
530
+ <IressStack gap\="md"\>
45
531
  <IressAlert
46
532
  footer\=""
47
533
  heading\=""
@@ -66,7 +552,7 @@ Hide code
66
552
  status\="warning"
67
553
  \>
68
554
  This is a simple warning alert. It is used for a message requiring attention but not resolution in order to continue, such as noting data is not current or your password is about to expire. </IressAlert\>
69
- </div\>
555
+ </IressStack\>
70
556
 
71
557
  Copy
72
558
 
@@ -95,23 +581,28 @@ Hide code
95
581
 
96
582
  Copy
97
583
 
98
- ### [](#footer)Footer
584
+ ### [](#actions)Actions
99
585
 
100
- The `footer` prop allows for content to be placed below the header and body of the alert. This can be useful for displaying call to actions.
586
+ The `actions` prop allows you to display call to action buttons within the alert. This is useful for providing users with options to take action based on the alert message.
101
587
 
102
588
  Alert heading
103
589
  -------------
104
590
 
105
591
  Here is the warning
106
592
 
107
- Close
593
+ Action
108
594
 
109
595
  Hide code
110
596
 
111
597
  \[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; }
112
598
 
113
599
  <IressAlert
114
- footer\={<IressButton\>Close</IressButton\>}
600
+ actions\={\[
601
+ {
602
+ children: 'Action',
603
+ onClick: () \=> {}
604
+ }
605
+ \]}
115
606
  heading\="Alert heading"
116
607
  \>
117
608
  <IressText\>
@@ -120,6 +611,84 @@ Hide code
120
611
 
121
612
  Copy
122
613
 
614
+ ### [](#icon)Icon
615
+
616
+ The `icon` prop allows you to customise the icon displayed in the alert. It accepts a string for the icon name, or can be set to `false` to remove the icon entirely.
617
+
618
+ Some information
619
+ ----------------
620
+
621
+ This is an alert without an icon
622
+
623
+ Hide code
624
+
625
+ \[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; }
626
+
627
+ <IressAlert
628
+ heading\="Some information"
629
+ \>
630
+ This is an alert without an icon
631
+ </IressAlert\>
632
+
633
+ Copy
634
+
635
+ ### [](#variants)Variants
636
+
637
+ The alert can be displayed in different variants to suit different use cases. The `variant` prop allows you to set the variant of the alert. The available variants are:
638
+
639
+ * `sidebar`: The alert is displayed in the sidebar of the page, typically used for informational messages on longer forms.
640
+ * `site-wide`: The alert is displayed in the site-wide banner, typically used for important messages that need to be seen by all users.
641
+
642
+ Did you know?
643
+ -------------
644
+
645
+ You can use the alert component in different ways.
646
+
647
+ Did you know?
648
+ -------------
649
+
650
+ You can use the alert component in different ways.
651
+
652
+ Hide code
653
+
654
+ \[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; }
655
+
656
+ <IressStack gap\="md"\>
657
+ <IressAlert
658
+ heading\="Did you know?"
659
+ variant\="sidebar"
660
+ \>
661
+ You can use the alert component in different ways. </IressAlert\>
662
+ <IressAlert
663
+ heading\="Did you know?"
664
+ variant\="site-wide"
665
+ \>
666
+ You can use the alert component in different ways. </IressAlert\>
667
+ </IressStack\>
668
+
669
+ Copy
670
+
671
+ ### [](#dimissable)Dimissable
672
+
673
+ The alert can be made dismissable by setting the `onDismiss` prop. This will display a close button in the top right corner of the alert, allowing users to dismiss it.
674
+
675
+ This is a simple info alert
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
+ <IressAlert
682
+ footer\=""
683
+ heading\=""
684
+ onDismiss\={() \=> {}}
685
+ status\="info"
686
+ \>
687
+ This is a simple info alert
688
+ </IressAlert\>
689
+
690
+ Copy
691
+
123
692
  On this page
124
693
 
125
694
  * [Overview](#overview)
@@ -127,4 +696,7 @@ On this page
127
696
  * [Examples](#examples)
128
697
  * [Status](#status)
129
698
  * [Heading](#heading)
130
- * [Footer](#footer)
699
+ * [Actions](#actions)
700
+ * [Icon](#icon)
701
+ * [Variants](#variants)
702
+ * [Dimissable](#dimissable)