@iress-oss/ids-mcp-server 5.15.0 → 6.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/generated/docs/components-alert-docs.md +579 -7
  2. package/generated/docs/components-autocomplete-docs.md +694 -15
  3. package/generated/docs/components-autocomplete-recipes-docs.md +1 -1
  4. package/generated/docs/components-badge-docs.md +442 -59
  5. package/generated/docs/components-button-docs.md +1150 -70
  6. package/generated/docs/components-buttongroup-docs.md +441 -3
  7. package/generated/docs/components-card-docs.md +487 -37
  8. package/generated/docs/components-checkbox-docs.md +506 -5
  9. package/generated/docs/components-checkboxgroup-docs.md +586 -191
  10. package/generated/docs/components-checkboxgroup-recipes-docs.md +3 -3
  11. package/generated/docs/components-col-docs.md +451 -36
  12. package/generated/docs/components-container-docs.md +32 -0
  13. package/generated/docs/components-divider-docs.md +427 -27
  14. package/generated/docs/components-expander-docs.md +487 -108
  15. package/generated/docs/components-field-docs.md +1400 -68
  16. package/generated/docs/components-filter-docs.md +268 -55
  17. package/generated/docs/components-hide-docs.md +447 -10
  18. package/generated/docs/components-icon-docs.md +522 -259
  19. package/generated/docs/components-image-docs.md +493 -0
  20. package/generated/docs/components-inline-docs.md +1179 -44
  21. package/generated/docs/components-input-docs.md +544 -12
  22. package/generated/docs/components-input-recipes-docs.md +4 -4
  23. package/generated/docs/components-inputcurrency-docs.md +532 -0
  24. package/generated/docs/components-inputcurrency-recipes-docs.md +4 -5
  25. package/generated/docs/components-introduction-docs.md +450 -0
  26. package/generated/docs/components-label-docs.md +454 -27
  27. package/generated/docs/components-link-docs.md +586 -0
  28. package/generated/docs/components-menu-docs.md +531 -89
  29. package/generated/docs/components-menu-menuitem-docs.md +556 -10
  30. package/generated/docs/components-modal-docs.md +814 -55
  31. package/generated/docs/components-panel-docs.md +418 -198
  32. package/generated/docs/components-placeholder-docs.md +420 -1
  33. package/generated/docs/components-popover-docs.md +1097 -32
  34. package/generated/docs/components-popover-recipes-docs.md +39 -73
  35. package/generated/docs/components-progress-docs.md +464 -0
  36. package/generated/docs/components-provider-docs.md +57 -2
  37. package/generated/docs/components-radio-docs.md +460 -4
  38. package/generated/docs/components-radiogroup-docs.md +586 -116
  39. package/generated/docs/components-readonly-docs.md +450 -4
  40. package/generated/docs/components-richselect-docs.md +4660 -1257
  41. package/generated/docs/components-row-docs.md +2065 -588
  42. package/generated/docs/components-select-docs.md +489 -5
  43. package/generated/docs/components-skeleton-docs.md +399 -16
  44. package/generated/docs/components-skeleton-recipes-docs.md +7 -7
  45. package/generated/docs/components-skiplink-docs.md +548 -27
  46. package/generated/docs/components-slideout-docs.md +648 -150
  47. package/generated/docs/components-slider-docs.md +515 -33
  48. package/generated/docs/components-spinner-docs.md +393 -2
  49. package/generated/docs/components-stack-docs.md +732 -74
  50. package/generated/docs/components-table-ag-grid-docs.md +497 -127
  51. package/generated/docs/components-table-docs.md +1049 -27
  52. package/generated/docs/components-tabset-docs.md +454 -27
  53. package/generated/docs/components-tabset-tab-docs.md +464 -0
  54. package/generated/docs/components-tag-docs.md +452 -19
  55. package/generated/docs/components-text-docs.md +322 -131
  56. package/generated/docs/components-toaster-docs.md +463 -53
  57. package/generated/docs/components-toggle-docs.md +476 -20
  58. package/generated/docs/components-tooltip-docs.md +443 -7
  59. package/generated/docs/components-validationmessage-docs.md +933 -13
  60. package/generated/docs/extensions-editor-docs.md +906 -13
  61. package/generated/docs/extensions-editor-recipes-docs.md +51 -1
  62. package/generated/docs/foundations-accessibility-docs.md +1 -23
  63. package/generated/docs/foundations-grid-docs.md +74 -0
  64. package/generated/docs/foundations-introduction-docs.md +6 -4
  65. package/generated/docs/foundations-responsive-breakpoints-docs.md +193 -0
  66. package/generated/docs/foundations-tokens-colour-docs.md +564 -0
  67. package/generated/docs/foundations-tokens-elevation-docs.md +155 -0
  68. package/generated/docs/foundations-tokens-introduction-docs.md +190 -0
  69. package/generated/docs/foundations-tokens-radius-docs.md +71 -0
  70. package/generated/docs/foundations-tokens-spacing-docs.md +89 -0
  71. package/generated/docs/foundations-tokens-typography-docs.md +322 -0
  72. package/generated/docs/foundations-z-index-stacking-docs.md +31 -0
  73. package/generated/docs/guidelines.md +1537 -295
  74. package/generated/docs/introduction-docs.md +65 -21
  75. package/generated/docs/news-version-6-docs.md +93 -0
  76. package/generated/docs/patterns-form-docs.md +3902 -0
  77. package/generated/docs/patterns-form-recipes-docs.md +1370 -0
  78. package/generated/docs/patterns-introduction-docs.md +24 -0
  79. package/generated/docs/patterns-loading-docs.md +2940 -201
  80. package/generated/docs/resources-introduction-docs.md +38 -0
  81. package/generated/docs/resources-mcp-server-docs.md +27 -0
  82. package/generated/docs/styling-props-colour-docs.md +172 -0
  83. package/generated/docs/styling-props-elevation-docs.md +88 -0
  84. package/generated/docs/styling-props-radius-docs.md +86 -0
  85. package/generated/docs/styling-props-reference-docs.md +160 -0
  86. package/generated/docs/styling-props-screen-readers-docs.md +71 -0
  87. package/generated/docs/styling-props-sizing-docs.md +627 -0
  88. package/generated/docs/styling-props-spacing-docs.md +2282 -0
  89. package/generated/docs/styling-props-typography-docs.md +121 -0
  90. package/generated/docs/themes-available-themes-docs.md +29 -29
  91. package/generated/docs/themes-introduction-docs.md +1 -1
  92. package/package.json +3 -22
  93. package/generated/docs/components-button-recipes-docs.md +0 -76
  94. package/generated/docs/components-card-recipes-docs.md +0 -89
  95. package/generated/docs/components-combobox-docs.md +0 -1016
  96. package/generated/docs/components-form-docs.md +0 -2410
  97. package/generated/docs/components-form-recipes-docs.md +0 -886
  98. package/generated/docs/components-navbar-docs.md +0 -291
  99. package/generated/docs/components-navbar-recipes-docs.md +0 -413
  100. package/generated/docs/components-toaster-toast-docs.md +0 -157
  101. package/generated/docs/foundations-colours-docs.md +0 -257
  102. package/generated/docs/foundations-typography-docs.md +0 -191
  103. package/generated/docs/resources-changelog-docs.md +0 -6
  104. package/generated/docs/themes-tokens-docs.md +0 -1200
@@ -6,6 +6,14 @@ Overview
6
6
 
7
7
  Toaster provide users with important, time-sensitive information.
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
  `IressToasterProvider` does not change the position on each render, it can only be done on the initial render.
10
18
 
11
19
  Show toast using provider
@@ -27,7 +35,7 @@ const ToastWithTrigger \= () \=> {
27
35
  onClick\={() \=>
28
36
  toaster.error({
29
37
  heading: 'Error',
30
- children:
38
+ content:
31
39
  'Connection failure. Longer text description should wrap and look like this. Try to limit to 3 lines or less.',
32
40
  })
33
41
  }
@@ -43,14 +51,412 @@ export const SimpleToasterExample \= () \=> (
43
51
 
44
52
  Copy
45
53
 
46
- [](#controlling-toasts)Controlling toasts
47
- -----------------------------------------
54
+ [](#props)Props
55
+ ---------------
56
+
57
+ | Name | Description | Default | Control |
58
+ | --- | --- | --- | --- |
59
+ | bg |
60
+ **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
61
+
62
+ We recommend using the following token values for best background contrast:
63
+
64
+ * `colour.primary.fill` for primary backgrounds that need to stand out
65
+ * `colour.primary.surface` for primary backgrounds that need to be less prominent
66
+ * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
67
+ * `colour.neutral.20` for a slightly darker background color, used in neutral state components
68
+ * `colour.system.danger.fill` for error backgrounds that need to stand out
69
+ * `colour.system.danger.surface` for error backgrounds that need to be less prominent
70
+ * `colour.system.success.fill` for success backgrounds that need to stand out
71
+ * `colour.system.success.surface` for success backgrounds that need to be less prominent
72
+ * `colour.system.warning.fill` for warning backgrounds that need to stand out
73
+ * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
74
+ * `colour.system.info.fill` for info backgrounds that need to stand out
75
+ * `colour.system.info.surface` for info backgrounds that need to be less prominent
76
+
77
+ ResponsiveProp<ColorToken> | undefined
78
+
79
+ | \- | Set object |
80
+ | borderRadius |
81
+
82
+ The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
83
+
84
+ | Chrome | Firefox | Safari | Edge | IE |
85
+ | --- | --- | --- | --- | --- |
86
+ | **4** | **4** | **5** | **12** | **9** |
87
+ | 1 _\-x-_ | | 3 _\-x-_ | | |
88
+
89
+ ResponsiveProp<RadiusToken> | undefined
90
+
91
+ | \- | Set object |
92
+ | color |
93
+
94
+ 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`.
95
+
96
+ We recommend using the following token values for best color contrast:
97
+
98
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
99
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
100
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
101
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
102
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
103
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
104
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
105
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
106
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
107
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
108
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
109
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
110
+
111
+ ResponsiveProp<ColorToken> | undefined
112
+
113
+ | \- | Set object |
114
+ | container |
115
+
116
+ The container element to render the toaster into. By default, the toaster will render at the end of the document body.
117
+
118
+ FloatingUIContainerundefined
119
+
120
+
121
+
122
+ | \- | \- |
123
+ | focusable |
124
+
125
+ 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.
126
+
127
+ "true""within"undefined
128
+
129
+
130
+
131
+ | \- | Set object |
132
+ | hide |
133
+
134
+ 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.
135
+
136
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
137
+
138
+ Notes:
139
+
140
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
141
+ * Consider if you can conditionally render the element instead of hiding it.
142
+
143
+ ResponsiveProp<boolean> | undefined
144
+
145
+ | \- | Set object |
146
+ | id |
147
+
148
+ A unique identifier for the toaster provider. This is useful if you have multiple toaster providers in your application based on context.
149
+
150
+ stringundefined
151
+
152
+
153
+
154
+ | \- | Set object |
155
+ | layerStyle |
156
+
157
+ 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.
158
+
159
+ * `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.
160
+ * `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.
161
+ * `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.
162
+
163
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
164
+
165
+ | \- | Set object |
166
+ | m |
167
+
168
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
169
+
170
+ 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.
171
+
172
+ | Chrome | Firefox | Safari | Edge | IE |
173
+ | --- | --- | --- | --- | --- |
174
+ | **1** | **1** | **1** | **12** | **3** |
175
+
176
+ ResponsiveProp<SpacingToken | "auto"> | undefined
177
+
178
+ | \- | Set object |
179
+ | maxWidth |
180
+
181
+ 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`.
182
+
183
+ | Chrome | Firefox | Safari | Edge | IE |
184
+ | --- | --- | --- | --- | --- |
185
+ | **1** | **1** | **1** | **12** | **7** |
186
+
187
+ 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
188
+
189
+ | \- | Set object |
190
+ | mb |
191
+
192
+ 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.
193
+
194
+ It uses the spacing tokens in the design system.
195
+
196
+ | Chrome | Firefox | Safari | Edge | IE |
197
+ | --- | --- | --- | --- | --- |
198
+ | **1** | **1** | **1** | **12** | **3** |
199
+
200
+ ResponsiveProp<SpacingToken | "auto"> | undefined
201
+
202
+ | \- | Set object |
203
+ | ml |
204
+
205
+ 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.
206
+
207
+ It uses the spacing tokens in the design system.
208
+
209
+ | Chrome | Firefox | Safari | Edge | IE |
210
+ | --- | --- | --- | --- | --- |
211
+ | **1** | **1** | **1** | **12** | **3** |
212
+
213
+ ResponsiveProp<SpacingToken | "auto"> | undefined
214
+
215
+ | \- | Set object |
216
+ | mr |
217
+
218
+ 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.
219
+
220
+ It uses the spacing tokens in the design system.
221
+
222
+ | Chrome | Firefox | Safari | Edge | IE |
223
+ | --- | --- | --- | --- | --- |
224
+ | **1** | **1** | **1** | **12** | **3** |
225
+
226
+ ResponsiveProp<SpacingToken | "auto"> | undefined
227
+
228
+ | \- | Set object |
229
+ | mt |
230
+
231
+ 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.
232
+
233
+ It uses the spacing tokens in the design system.
234
+
235
+ | Chrome | Firefox | Safari | Edge | IE |
236
+ | --- | --- | --- | --- | --- |
237
+ | **1** | **1** | **1** | **12** | **3** |
238
+
239
+ ResponsiveProp<SpacingToken | "auto"> | undefined
240
+
241
+ | \- | Set object |
242
+ | mx |
243
+
244
+ 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.
245
+
246
+ 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.
247
+
248
+ | Chrome | Firefox | Safari | Edge | IE |
249
+ | --- | --- | --- | --- | --- |
250
+ | **1** | **1** | **1** | **12** | **3** |
251
+
252
+ ResponsiveProp<SpacingToken | "auto"> | undefined
253
+
254
+ | \- | Set object |
255
+ | my |
256
+
257
+ 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.
258
+
259
+ 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.
260
+
261
+ | Chrome | Firefox | Safari | Edge | IE |
262
+ | --- | --- | --- | --- | --- |
263
+ | **1** | **1** | **1** | **12** | **3** |
48
264
 
49
- ### [](#using-the-iresstoasterprovider)Using the `IressToasterProvider`
265
+ ResponsiveProp<SpacingToken | "auto"> | undefined
50
266
 
51
- The recommended way to create toasts is by using the `<IressToasterProvider />` alongside the `useToaster` hook. By using the `success`, `info` and `error` methods from the hook, you can trigger toasts in your application.
267
+ | \- | Set object |
268
+ | noGutter |
52
269
 
53
- To use, wrap your `<App/>` or the component that you want to use the `useToaster` hook with `<IressToasterProvider />`.
270
+ 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.
271
+
272
+ booleanundefined
273
+
274
+
275
+
276
+ | \- | Set object |
277
+ | p |
278
+
279
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
280
+
281
+ 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.
282
+
283
+ | Chrome | Firefox | Safari | Edge | IE |
284
+ | --- | --- | --- | --- | --- |
285
+ | **1** | **1** | **1** | **12** | **3** |
286
+
287
+ 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
288
+
289
+ | \- | Set object |
290
+ | pb |
291
+
292
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
293
+
294
+ 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.
295
+
296
+ | Chrome | Firefox | Safari | Edge | IE |
297
+ | --- | --- | --- | --- | --- |
298
+ | **1** | **1** | **1** | **12** | **3** |
299
+
300
+ 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
301
+
302
+ | \- | Set object |
303
+ | pl |
304
+
305
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
306
+
307
+ 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.
308
+
309
+ | Chrome | Firefox | Safari | Edge | IE |
310
+ | --- | --- | --- | --- | --- |
311
+ | **1** | **1** | **1** | **12** | **3** |
312
+
313
+ 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
314
+
315
+ | \- | Set object |
316
+ | position |
317
+
318
+ The position on the screen where the toast will appear.
319
+
320
+ "bottom-start""bottom-end""top-start""top-end""bottom-center""top-center"undefined
321
+
322
+
323
+
324
+ |
325
+
326
+ bottom-end
327
+
328
+ | Set object |
329
+ | pr |
330
+
331
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
332
+
333
+ 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.
334
+
335
+ | Chrome | Firefox | Safari | Edge | IE |
336
+ | --- | --- | --- | --- | --- |
337
+ | **1** | **1** | **1** | **12** | **3** |
338
+
339
+ 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
340
+
341
+ | \- | Set object |
342
+ | pt |
343
+
344
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
345
+
346
+ 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.
347
+
348
+ | Chrome | Firefox | Safari | Edge | IE |
349
+ | --- | --- | --- | --- | --- |
350
+ | **1** | **1** | **1** | **12** | **3** |
351
+
352
+ 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
353
+
354
+ | \- | Set object |
355
+ | px |
356
+
357
+ 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.
358
+
359
+ 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.
360
+
361
+ | Chrome | Firefox | Safari | Edge | IE |
362
+ | --- | --- | --- | --- | --- |
363
+ | **1** | **1** | **1** | **12** | **3** |
364
+
365
+ 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
366
+
367
+ | \- | Set object |
368
+ | py |
369
+
370
+ 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.
371
+
372
+ 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.
373
+
374
+ | Chrome | Firefox | Safari | Edge | IE |
375
+ | --- | --- | --- | --- | --- |
376
+ | **1** | **1** | **1** | **12** | **3** |
377
+
378
+ 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
379
+
380
+ | \- | Set object |
381
+ | rowGap |
382
+
383
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
384
+
385
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
386
+
387
+ | Chrome | Firefox | Safari | Edge | IE |
388
+ | --- | --- | --- | --- | --- |
389
+ | **47** | **52** | **10.1** | **16** | No |
390
+
391
+ 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
392
+
393
+ | \- | Set object |
394
+ | srOnly |
395
+
396
+ 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.
397
+
398
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
399
+
400
+ ResponsiveProp<boolean> | undefined
401
+
402
+ | \- | Set object |
403
+ | stretch |
404
+
405
+ 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.
406
+
407
+ booleanundefined
408
+
409
+
410
+
411
+ | \- | Set object |
412
+ | textAlign |
413
+
414
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
415
+
416
+ | Chrome | Firefox | Safari | Edge | IE |
417
+ | --- | --- | --- | --- | --- |
418
+ | **1** | **1** | **1** | **12** | **3** |
419
+
420
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
421
+
422
+ | \- | Set object |
423
+ | textStyle |
424
+
425
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
426
+
427
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
428
+ * `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.
429
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
430
+ * `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.
431
+ * `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.
432
+ * `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.
433
+ * `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.
434
+ * `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.
435
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
436
+
437
+ 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
438
+
439
+ | \- | Set object |
440
+ | width |
441
+
442
+ 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.
443
+
444
+ 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.
445
+
446
+ | Chrome | Firefox | Safari | Edge | IE |
447
+ | --- | --- | --- | --- | --- |
448
+ | **1** | **1** | **1** | **12** | **4** |
449
+
450
+ 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
451
+
452
+ | \- | Set object |
453
+
454
+ [](#usage)Usage
455
+ ---------------
456
+
457
+ To use the toaster, wrap your `<App/>` or the component that you want to use the toasts within with `<IressToasterProvider />`. This provides the context for the `useToaster` hook, which is used to trigger toasts in your application.
458
+
459
+ You can use the `success`, `info` and `error` methods from the hook to trigger toasts in your application.
54
460
 
55
461
  `IressToasterProvider` does not change the position on each render, it can only be done on the initial render.
56
462
 
@@ -73,7 +479,7 @@ const ToastWithTrigger \= () \=> {
73
479
  onClick\={() \=>
74
480
  toaster.error({
75
481
  heading: 'Error',
76
- children:
482
+ content:
77
483
  'Connection failure. Longer text description should wrap and look like this. Try to limit to 3 lines or less.',
78
484
  })
79
485
  }
@@ -111,11 +517,11 @@ const ToastWithTrigger \= () \=> {
111
517
  const toaster \= useToaster();
112
518
  const \[lastToastId, setLastToastId\] \= useState<string | null\>(null);
113
519
  return (
114
- <IressInline gutter\="sm"\>
520
+ <IressInline gap\="sm"\>
115
521
  <IressButton onClick={() \=> {
116
522
  const toastId \= toaster.error({
117
523
  heading: 'Error',
118
- children:
524
+ content:
119
525
  'Connection failure. Longer text description should wrap and look like this. Try to limit to 3 lines or less.',
120
526
  onClose: () \=> {
121
527
  setLastToastId(null);
@@ -146,7 +552,7 @@ Copy
146
552
 
147
553
  The toast offers three status that set a distinctive colour and icon. They can be set using the `status` prop. Their different use cases are described here.
148
554
 
149
- successerrorinfo
555
+ errorinfosuccess
150
556
 
151
557
  Hide code
152
558
 
@@ -155,30 +561,29 @@ Hide code
155
561
  import {
156
562
  IressButton,
157
563
  IressInline,
158
- IressToastProps,
159
- IressToasterProps,
160
564
  IressToasterProvider,
161
- TOAST\_STATUS,
565
+ IressToasterProviderProps,
566
+ ToastStatus,
162
567
  useToaster,
163
568
  } from '@iress-oss/ids-components';
164
- const ToastWithTrigger \= ({ status }: Pick<IressToastProps, 'status'\>) \=> {
569
+ const ToastWithTrigger \= ({ status }: { status: ToastStatus }) \=> {
165
570
  const toaster \= useToaster();
166
571
  return (
167
572
  <IressButton
168
573
  onClick\={() \=>
169
- toaster\[status\]({ children: \`Hello, I am a ${status} toast\` })
574
+ toaster\[status\]({ content: \`Hello, I am a ${status} toast\` })
170
575
  }
171
576
  \>
172
577
  {status}
173
578
  </IressButton\>
174
579
  );
175
580
  };
176
- export const ToastStatuses \= (args: IressToasterProps) \=> (
581
+ export const ToastStatuses \= () \=> (
177
582
  <IressToasterProvider \>
178
- <IressInline gutter\="sm"\>
179
- {TOAST\_STATUS.map((status) \=> (
180
- <ToastWithTrigger status\={status} />
181
- ))}
583
+ <IressInline gap\="sm"\>
584
+ <ToastWithTrigger status\="error" />
585
+ <ToastWithTrigger status\="info" />
586
+ <ToastWithTrigger status\="success" />
182
587
  </IressInline\>
183
588
  </IressToasterProvider\>
184
589
  );
@@ -209,7 +614,7 @@ const ToastWithTrigger \= () \=> {
209
614
  <IressButton
210
615
  onClick\={() \=>
211
616
  toaster.success({
212
- children: 'This is a really quick toast',
617
+ content: 'This is a really quick toast',
213
618
  timeout: 1000,
214
619
  })
215
620
  }
@@ -227,9 +632,9 @@ Copy
227
632
 
228
633
  ### [](#position)Position
229
634
 
230
- By default, the `IressToaster`'s `position` is set to `bottom-end`, but there may be occasions when you need toasts to appear in a different part of the screen. This can be controlled with the `position` prop on the `IressToasterProvider` component, or as the first argument to `useToaster`. There are 6 positions to choose from.
635
+ By default, the `IressToasterProvider`'s `position` is set to `bottom-end`, but there may be occasions when you need toasts to appear in a different part of the screen. This can be controlled with the `position` prop on the `IressToasterProvider` component, or as the first argument to `useToaster`. There are 6 positions to choose from.
231
636
 
232
- **Note:** The toast position should be consistent across your app. For this reason, the position is set on the `IressToastProvider` or the `useToaster` hook, and not on the individual toasts.
637
+ **Note:** The toast position should be consistent based on context, so users can find them easily.
233
638
 
234
639
  top-starttop-centertop-end
235
640
 
@@ -247,47 +652,43 @@ import {
247
652
  IressPanel,
248
653
  IressStack,
249
654
  IressText,
250
- IressToasterProps,
251
655
  IressToasterProvider,
252
656
  IressToasterProviderProps,
253
- IressToastProps,
657
+ NewToast,
254
658
  useToaster,
255
659
  } from '@iress-oss/ids-components';
256
- import { useState } from 'react';
257
- const DEFAULT\_TOAST: IressToastProps \= {
258
- children: 'Message sent successfully',
660
+ const DEFAULT\_TOAST: NewToast \= {
661
+ content: 'Message sent successfully',
259
662
  heading: 'Success',
260
663
  status: 'success',
261
664
  };
262
665
  const Toaster \= () \=> {
263
- const \[position, setPosition\] \=
264
- useState<IressToasterProps\['position'\]\>('bottom-end');
265
- const { status, ...toast } \= DEFAULT\_TOAST;
266
- const toaster \= useToaster(position);
267
- const changePosition \= (position: IressToasterProps\['position'\]) \=> {
268
- setPosition(position);
269
- queueMicrotask(() \=> toaster\[status\](toast));
270
- };
666
+ const topStart \= useToaster('top-start');
667
+ const topCenter \= useToaster('top-center');
668
+ const topEnd \= useToaster('top-end');
669
+ const bottomStart \= useToaster('bottom-start');
670
+ const bottomCenter \= useToaster('bottom-center');
671
+ const bottomEnd \= useToaster('bottom-end');
271
672
  return (
272
673
  <div style\={{ padding: '80px 150px' }}\>
273
- <IressStack gutter\="md"\>
274
- <IressInline horizontalAlign\="between" gutter\="sm"\>
275
- <IressButton onClick\={() \=> changePosition('top-start')}\>
674
+ <IressStack gap\="md"\>
675
+ <IressInline horizontalAlign\="between" gap\="sm"\>
676
+ <IressButton onClick\={() \=> topStart.success(DEFAULT\_TOAST)}\>
276
677
  top-start </IressButton\>
277
- <IressButton onClick\={() \=> changePosition('top-center')}\>
678
+ <IressButton onClick\={() \=> topCenter.success(DEFAULT\_TOAST)}\>
278
679
  top-center </IressButton\>
279
- <IressButton onClick\={() \=> changePosition('top-end')}\>
680
+ <IressButton onClick\={() \=> topEnd.success(DEFAULT\_TOAST)}\>
280
681
  top-end </IressButton\>
281
682
  </IressInline\>
282
- <IressPanel background\="transparent" padding\="lg"\>
283
- <IressText align\="center"\>Toaster positions</IressText\>
683
+ <IressPanel bg\="transparent" p\="lg"\>
684
+ <IressText textAlign\="center"\>Toaster positions</IressText\>
284
685
  </IressPanel\>
285
686
  <IressInline horizontalAlign\="between"\>
286
- <IressButton onClick\={() \=> changePosition('bottom-start')}\>
687
+ <IressButton onClick\={() \=> bottomStart.success(DEFAULT\_TOAST)}\>
287
688
  bottom-start </IressButton\>
288
- <IressButton onClick\={() \=> changePosition('bottom-center')}\>
689
+ <IressButton onClick\={() \=> bottomCenter.success(DEFAULT\_TOAST)}\>
289
690
  bottom-center </IressButton\>
290
- <IressButton onClick\={() \=> changePosition('bottom-end')}\>
691
+ <IressButton onClick\={() \=> bottomEnd.success(DEFAULT\_TOAST)}\>
291
692
  bottom-end </IressButton\>
292
693
  </IressInline\>
293
694
  </IressStack\>
@@ -295,15 +696,25 @@ const Toaster \= () \=> {
295
696
  );
296
697
  };
297
698
  export const ToasterPositionExamples \= () \=> (
298
- <IressToasterProvider \>
299
- <Toaster />
699
+ <IressToasterProvider id\="bottom-end" position\="bottom-end"\>
700
+ <IressToasterProvider id\="bottom-center" position\="bottom-center"\>
701
+ <IressToasterProvider id\="bottom-start" position\="bottom-start"\>
702
+ <IressToasterProvider id\="top-start" position\="top-start"\>
703
+ <IressToasterProvider id\="top-center" position\="top-center"\>
704
+ <IressToasterProvider id\="top-end" position\="top-end"\>
705
+ <Toaster />
706
+ </IressToasterProvider\>
707
+ </IressToasterProvider\>
708
+ </IressToasterProvider\>
709
+ </IressToasterProvider\>
710
+ </IressToasterProvider\>
300
711
  </IressToasterProvider\>
301
712
  );
302
713
 
303
714
  Copy
304
715
 
305
- [](#migrating-to-version-5)Migrating to version 5
306
- -------------------------------------------------
716
+ [](#migrating-from-version-4-and-below)Migrating from version 4 and below
717
+ -------------------------------------------------------------------------
307
718
 
308
719
  ### [](#adding-the-provider)Adding the provider
309
720
 
@@ -334,12 +745,11 @@ On this page
334
745
 
335
746
  * [Overview](#overview)
336
747
  * [Props](#props)
337
- * [Controlling toasts](#controlling-toasts)
338
- * [Using the IressToasterProvider](#using-the-iresstoasterprovider)
748
+ * [Usage](#usage)
339
749
  * [Closing toasts via the provider](#closing-toasts-via-the-provider)
340
750
  * [Examples](#examples)
341
751
  * [Status](#status)
342
752
  * [Timeout](#timeout)
343
753
  * [Position](#position)
344
- * [Migrating to version 5](#migrating-to-version-5)
754
+ * [Migrating from version 4 and below](#migrating-from-version-4-and-below)
345
755
  * [Adding the provider](#adding-the-provider)