@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
  A button is a clickable item used to perform an action.
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
  Button
10
18
 
11
19
  Hide code
@@ -18,6 +26,528 @@ Hide code
18
26
 
19
27
  Copy
20
28
 
29
+ [](#props)Props
30
+ ---------------
31
+
32
+ | Name | Description | Default | Control |
33
+ | --- | --- | --- | --- |
34
+ | active |
35
+ Sets the active state of the button, usually used to indicate the button has activated a modal, popover or slideout.
36
+
37
+ booleanundefined
38
+
39
+
40
+
41
+ | \- | Set object |
42
+ | append |
43
+
44
+ Content for the append slot.
45
+
46
+ ReactNode
47
+
48
+
49
+
50
+ | \- | Set object |
51
+ | bg |
52
+
53
+ **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
54
+
55
+ We recommend using the following token values for best background contrast:
56
+
57
+ * `colour.primary.fill` for primary backgrounds that need to stand out
58
+ * `colour.primary.surface` for primary backgrounds that need to be less prominent
59
+ * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
60
+ * `colour.neutral.20` for a slightly darker background color, used in neutral state components
61
+ * `colour.system.danger.fill` for error backgrounds that need to stand out
62
+ * `colour.system.danger.surface` for error backgrounds that need to be less prominent
63
+ * `colour.system.success.fill` for success backgrounds that need to stand out
64
+ * `colour.system.success.surface` for success backgrounds that need to be less prominent
65
+ * `colour.system.warning.fill` for warning backgrounds that need to stand out
66
+ * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
67
+ * `colour.system.info.fill` for info backgrounds that need to stand out
68
+ * `colour.system.info.surface` for info backgrounds that need to be less prominent
69
+
70
+ ResponsiveProp<ColorToken> | undefined
71
+
72
+ | \- | Set object |
73
+ | borderRadius |
74
+
75
+ The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
76
+
77
+ | Chrome | Firefox | Safari | Edge | IE |
78
+ | --- | --- | --- | --- | --- |
79
+ | **4** | **4** | **5** | **12** | **9** |
80
+ | 1 _\-x-_ | | 3 _\-x-_ | | |
81
+
82
+ ResponsiveProp<RadiusToken> | undefined
83
+
84
+ | \- | Set object |
85
+ | children |
86
+
87
+ Content is placed between prepend and append if provided. Used to describe the expected action of this button.
88
+
89
+ ReactNode
90
+
91
+
92
+
93
+ | \- |
94
+
95
+ "Button"
96
+
97
+ |
98
+ | color |
99
+
100
+ 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`.
101
+
102
+ We recommend using the following token values for best color contrast:
103
+
104
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
105
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
106
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
107
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
108
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
109
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
110
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
111
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
112
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
113
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
114
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
115
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
116
+
117
+ ResponsiveProp<ColorToken> | undefined
118
+
119
+ | \- | Set object |
120
+ | element |
121
+
122
+ Change the component that will be rendered as the button, used for third-party libraries that require a specific element type. By default, it will render a button or an anchor tag based on the `href` prop.
123
+
124
+ ElementTypeundefined
125
+
126
+
127
+
128
+ | \- | Set object |
129
+ | fluid |
130
+
131
+ If `true`, the button will stretch to fill it's container. The prop is responsive, so you can set the breakpoint(s) at which the button will be fluid.
132
+
133
+ All breakpoints: `fluid={true}` Up to a specific breakpoint: `fluid={{ base: true, md: false }}`
134
+
135
+ true"xs""sm""md""lg""xl""xxl"undefined
136
+
137
+
138
+
139
+ | \- | Set object |
140
+ | focusable |
141
+
142
+ 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.
143
+
144
+ "true""within"undefined
145
+
146
+
147
+
148
+ | \- | Set object |
149
+ | hide |
150
+
151
+ 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.
152
+
153
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
154
+
155
+ Notes:
156
+
157
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
158
+ * Consider if you can conditionally render the element instead of hiding it.
159
+
160
+ ResponsiveProp<boolean> | undefined
161
+
162
+ | \- | Set object |
163
+ | href |
164
+
165
+ Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
166
+
167
+ stringundefined
168
+
169
+
170
+
171
+ | \- | Set object |
172
+ | layerStyle |
173
+
174
+ 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.
175
+
176
+ * `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.
177
+ * `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.
178
+ * `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.
179
+
180
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
181
+
182
+ | \- | Set object |
183
+ | loading |
184
+
185
+ When true, button is in loading state. If provided a string, will be used as the loading text for screen readers.
186
+
187
+ stringbooleanundefined
188
+
189
+
190
+
191
+ |
192
+
193
+ false
194
+
195
+ | Set object |
196
+ | m |
197
+
198
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
199
+
200
+ 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.
201
+
202
+ | Chrome | Firefox | Safari | Edge | IE |
203
+ | --- | --- | --- | --- | --- |
204
+ | **1** | **1** | **1** | **12** | **3** |
205
+
206
+ ResponsiveProp<SpacingToken | "auto"> | undefined
207
+
208
+ | \- | Set object |
209
+ | maxWidth |
210
+
211
+ 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`.
212
+
213
+ | Chrome | Firefox | Safari | Edge | IE |
214
+ | --- | --- | --- | --- | --- |
215
+ | **1** | **1** | **1** | **12** | **7** |
216
+
217
+ 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
218
+
219
+ | \- | Set object |
220
+ | mb |
221
+
222
+ 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.
223
+
224
+ It uses the spacing tokens in the design system.
225
+
226
+ | Chrome | Firefox | Safari | Edge | IE |
227
+ | --- | --- | --- | --- | --- |
228
+ | **1** | **1** | **1** | **12** | **3** |
229
+
230
+ ResponsiveProp<SpacingToken | "auto"> | undefined
231
+
232
+ | \- | Set object |
233
+ | ml |
234
+
235
+ 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.
236
+
237
+ It uses the spacing tokens in the design system.
238
+
239
+ | Chrome | Firefox | Safari | Edge | IE |
240
+ | --- | --- | --- | --- | --- |
241
+ | **1** | **1** | **1** | **12** | **3** |
242
+
243
+ ResponsiveProp<SpacingToken | "auto"> | undefined
244
+
245
+ | \- | Set object |
246
+ | mode |
247
+
248
+ Style of the button.
249
+
250
+ * Primary: Used for the main action on a page. Usually only used once per screen.
251
+ * Secondary: Used for secondary actions on a page, often an action on multiple `IressPanel`s. Can used multiple times per screen.
252
+ * Tertiary: Used for tertiary actions on a page, often the secondary action on multiple `IressPanel`s. Can used multiple times per screen.
253
+
254
+ **Migrating to version 6**
255
+
256
+ * `link` mode has been removed. If it is an action, use the `tertiary` mode. If it is a link inside a paragraph, use the new `IressLink` component instead.
257
+ * `danger` has been removed. Please use the `status` prop instead.
258
+ * `positive` and `success` have been removed. Please use the `status` prop instead.
259
+
260
+ "primary""secondary""tertiary"undefined
261
+
262
+
263
+
264
+ |
265
+
266
+ secondary
267
+
268
+ | Set object |
269
+ | mr |
270
+
271
+ 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.
272
+
273
+ It uses the spacing tokens in the design system.
274
+
275
+ | Chrome | Firefox | Safari | Edge | IE |
276
+ | --- | --- | --- | --- | --- |
277
+ | **1** | **1** | **1** | **12** | **3** |
278
+
279
+ ResponsiveProp<SpacingToken | "auto"> | undefined
280
+
281
+ | \- | Set object |
282
+ | mt |
283
+
284
+ 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.
285
+
286
+ It uses the spacing tokens in the design system.
287
+
288
+ | Chrome | Firefox | Safari | Edge | IE |
289
+ | --- | --- | --- | --- | --- |
290
+ | **1** | **1** | **1** | **12** | **3** |
291
+
292
+ ResponsiveProp<SpacingToken | "auto"> | undefined
293
+
294
+ | \- | Set object |
295
+ | mx |
296
+
297
+ 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.
298
+
299
+ 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.
300
+
301
+ | Chrome | Firefox | Safari | Edge | IE |
302
+ | --- | --- | --- | --- | --- |
303
+ | **1** | **1** | **1** | **12** | **3** |
304
+
305
+ ResponsiveProp<SpacingToken | "auto"> | undefined
306
+
307
+ | \- | Set object |
308
+ | my |
309
+
310
+ 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.
311
+
312
+ 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.
313
+
314
+ | Chrome | Firefox | Safari | Edge | IE |
315
+ | --- | --- | --- | --- | --- |
316
+ | **1** | **1** | **1** | **12** | **3** |
317
+
318
+ ResponsiveProp<SpacingToken | "auto"> | undefined
319
+
320
+ | \- | Set object |
321
+ | noGutter |
322
+
323
+ 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.
324
+
325
+ booleanundefined
326
+
327
+
328
+
329
+ | \- | Set object |
330
+ | noWrap |
331
+
332
+ Prevents text wrapping if set to true.
333
+
334
+ booleanundefined
335
+
336
+
337
+
338
+ |
339
+
340
+ false
341
+
342
+ | Set object |
343
+ | onClick |
344
+
345
+ Emitted when the menu item is clicked.
346
+
347
+ MouseEventHandler<Exclude<Parameters<Exclude<ButtonRef<C, THref>, undefined>>\[0\], null>> | undefined
348
+
349
+ | \- | Set object |
350
+ | p |
351
+
352
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
353
+
354
+ 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.
355
+
356
+ | Chrome | Firefox | Safari | Edge | IE |
357
+ | --- | --- | --- | --- | --- |
358
+ | **1** | **1** | **1** | **12** | **3** |
359
+
360
+ 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
361
+
362
+ | \- | Set object |
363
+ | pb |
364
+
365
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
366
+
367
+ 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.
368
+
369
+ | Chrome | Firefox | Safari | Edge | IE |
370
+ | --- | --- | --- | --- | --- |
371
+ | **1** | **1** | **1** | **12** | **3** |
372
+
373
+ 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
374
+
375
+ | \- | Set object |
376
+ | pl |
377
+
378
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
379
+
380
+ 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.
381
+
382
+ | Chrome | Firefox | Safari | Edge | IE |
383
+ | --- | --- | --- | --- | --- |
384
+ | **1** | **1** | **1** | **12** | **3** |
385
+
386
+ 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
387
+
388
+ | \- | Set object |
389
+ | pr |
390
+
391
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
392
+
393
+ 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.
394
+
395
+ | Chrome | Firefox | Safari | Edge | IE |
396
+ | --- | --- | --- | --- | --- |
397
+ | **1** | **1** | **1** | **12** | **3** |
398
+
399
+ 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
400
+
401
+ | \- | Set object |
402
+ | prepend |
403
+
404
+ Content for the prepend slot.
405
+
406
+ ReactNode
407
+
408
+
409
+
410
+ | \- | Set object |
411
+ | pt |
412
+
413
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
414
+
415
+ 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.
416
+
417
+ | Chrome | Firefox | Safari | Edge | IE |
418
+ | --- | --- | --- | --- | --- |
419
+ | **1** | **1** | **1** | **12** | **3** |
420
+
421
+ 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
422
+
423
+ | \- | Set object |
424
+ | px |
425
+
426
+ 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.
427
+
428
+ 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.
429
+
430
+ | Chrome | Firefox | Safari | Edge | IE |
431
+ | --- | --- | --- | --- | --- |
432
+ | **1** | **1** | **1** | **12** | **3** |
433
+
434
+ 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
435
+
436
+ | \- | Set object |
437
+ | py |
438
+
439
+ 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.
440
+
441
+ 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.
442
+
443
+ | Chrome | Firefox | Safari | Edge | IE |
444
+ | --- | --- | --- | --- | --- |
445
+ | **1** | **1** | **1** | **12** | **3** |
446
+
447
+ 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
448
+
449
+ | \- | Set object |
450
+ | ref |
451
+
452
+ any
453
+
454
+
455
+
456
+ | \- | Set object |
457
+ | rowGap |
458
+
459
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
460
+
461
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
462
+
463
+ | Chrome | Firefox | Safari | Edge | IE |
464
+ | --- | --- | --- | --- | --- |
465
+ | **47** | **52** | **10.1** | **16** | No |
466
+
467
+ 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
468
+
469
+ | \- | Set object |
470
+ | srOnly |
471
+
472
+ 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.
473
+
474
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
475
+
476
+ ResponsiveProp<boolean> | undefined
477
+
478
+ | \- | Set object |
479
+ | status |
480
+
481
+ An optional status to assign to the button.
482
+
483
+ * `success`: Indicates a successful or positive action.
484
+ * `danger`: Indicates a dangerous or potentially negative action.
485
+
486
+ "danger""success"undefined
487
+
488
+
489
+
490
+ | \- | Set object |
491
+ | stretch |
492
+
493
+ 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.
494
+
495
+ booleanundefined
496
+
497
+
498
+
499
+ | \- | Set object |
500
+ | textAlign |
501
+
502
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
503
+
504
+ | Chrome | Firefox | Safari | Edge | IE |
505
+ | --- | --- | --- | --- | --- |
506
+ | **1** | **1** | **1** | **12** | **3** |
507
+
508
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
509
+
510
+ | \- | Set object |
511
+ | textStyle |
512
+
513
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
514
+
515
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
516
+ * `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.
517
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
518
+ * `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.
519
+ * `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.
520
+ * `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.
521
+ * `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.
522
+ * `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.
523
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
524
+
525
+ 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
526
+
527
+ | \- | Set object |
528
+ | value |
529
+
530
+ The value of the button, when used in `IressButtonGroup`.
531
+
532
+ FormControlValueundefined
533
+
534
+
535
+
536
+ | \- | Set object |
537
+ | width |
538
+
539
+ 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.
540
+
541
+ 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.
542
+
543
+ | Chrome | Firefox | Safari | Edge | IE |
544
+ | --- | --- | --- | --- | --- |
545
+ | **1** | **1** | **1** | **12** | **4** |
546
+
547
+ 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
548
+
549
+ | \- | Set object |
550
+
21
551
  [](#examples)Examples
22
552
  ---------------------
23
553
 
@@ -28,40 +558,75 @@ The `mode` prop controls the visual appearance and priority of the button.
28
558
  * **Primary:** Use for the main call to action. Limit to one per view.
29
559
  * **Secondary:** Use for secondary calls to action.
30
560
  * **Tertiary:** Use when you need extra affordance between your secondary actions.
31
- * **Link:** Use when you need a button to appear like a link.
32
- * **Danger:** Use for added affordance on destructive actions, such as deleting data.
33
- * **Positive:** Use for buy/purchase actions.
34
- * **Negative:** Use for sell actions.
35
561
 
36
- **Note:** Avoid setting `mode` to `link` when the only child of the button is an icon, as icons inside link buttons do not have an underline, and will have no visual indication that they are clickable.
37
-
38
- Primary buttonSecondary buttonTertiary buttonLink buttonDanger buttonPositive buttonNegative button
562
+ Primary buttonSecondary buttonTertiary button
39
563
 
40
564
  Hide code
41
565
 
42
566
  \[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
567
 
44
- <div
45
- className\="iress-u-inline iress--gutter--md"
46
- style\={{
47
- rowGap: 'var(--iress-g-spacing-md'
48
- }}
49
- \>
568
+ <IressInline gap\="md"\>
50
569
  <IressButton mode\="primary"\>
51
570
  Primary button </IressButton\>
52
571
  <IressButton mode\="secondary"\>
53
572
  Secondary button </IressButton\>
54
573
  <IressButton mode\="tertiary"\>
55
574
  Tertiary button </IressButton\>
56
- <IressButton mode\="link"\>
57
- Link button </IressButton\>
58
- <IressButton mode\="danger"\>
59
- Danger button </IressButton\>
60
- <IressButton mode\="positive"\>
61
- Positive button </IressButton\>
62
- <IressButton mode\="negative"\>
63
- Negative button </IressButton\>
64
- </div\>
575
+ </IressInline\>
576
+
577
+ Copy
578
+
579
+ ### [](#status)Status
580
+
581
+ The `status` prop allows you to apply a visual status to the button.
582
+
583
+ * **Success:** Usually used to indicate an action that should be perceived as positive, such as "Confirm" or "Buy".
584
+ * **Danger:** Use for destructive actions, such as "Delete" or "Remove". Also used for actions that are perceived as negative, such as "Cancel" or "Sell".
585
+
586
+ Primary buttonSecondary buttonTertiary button
587
+
588
+ Primary buttonSecondary buttonTertiary button
589
+
590
+ Hide code
591
+
592
+ \[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; }
593
+
594
+ <IressStack gap\="md"\>
595
+ <IressInline gap\="md"\>
596
+ <IressButton
597
+ mode\="primary"
598
+ status\="success"
599
+ \>
600
+ Primary button </IressButton\>
601
+ <IressButton
602
+ mode\="secondary"
603
+ status\="success"
604
+ \>
605
+ Secondary button </IressButton\>
606
+ <IressButton
607
+ mode\="tertiary"
608
+ status\="success"
609
+ \>
610
+ Tertiary button </IressButton\>
611
+ </IressInline\>
612
+ <IressInline gap\="md"\>
613
+ <IressButton
614
+ mode\="primary"
615
+ status\="danger"
616
+ \>
617
+ Primary button </IressButton\>
618
+ <IressButton
619
+ mode\="secondary"
620
+ status\="danger"
621
+ \>
622
+ Secondary button </IressButton\>
623
+ <IressButton
624
+ mode\="tertiary"
625
+ status\="danger"
626
+ \>
627
+ Tertiary button </IressButton\>
628
+ </IressInline\>
629
+ </IressStack\>
65
630
 
66
631
  Copy
67
632
 
@@ -71,20 +636,20 @@ The `type` property controls the behaviour of the button. It defaults to `button
71
636
 
72
637
  **Please note:** this differs from a standard HTML button element, where the `type` defaults to submit.
73
638
 
74
- Button buttonReset buttonSubmit button
639
+ buttonsubmitreset
75
640
 
76
641
  Hide code
77
642
 
78
643
  \[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; }
79
644
 
80
- <div className\="iress-u-inline iress--gutter--md"\>
645
+ <IressInline gap\="md"\>
81
646
  <IressButton type\="button"\>
82
- Button button </IressButton\>
83
- <IressButton type\="reset"\>
84
- Reset button </IressButton\>
647
+ button </IressButton\>
85
648
  <IressButton type\="submit"\>
86
- Submit button </IressButton\>
87
- </div\>
649
+ submit </IressButton\>
650
+ <IressButton type\="reset"\>
651
+ reset </IressButton\>
652
+ </IressInline\>
88
653
 
89
654
  Copy
90
655
 
@@ -96,17 +661,29 @@ The loading state can be activated by setting the `loading` prop to `true` and p
96
661
 
97
662
  When the loading state is activated, any click events on the button are disabled.
98
663
 
99
- Button text
664
+ Button textButton textButton text
100
665
 
101
666
  Hide code
102
667
 
103
668
  \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
104
669
 
105
- <div className\="iress-u-inline iress--gutter--md"\>
106
- <IressButton loading\>
670
+ <IressInline gap\="md"\>
671
+ <IressButton
672
+ loading
673
+ mode\="primary"
674
+ \>
675
+ Button text </IressButton\>
676
+ <IressButton
677
+ loading
678
+ mode\="secondary"
679
+ \>
107
680
  Button text </IressButton\>
108
- <IressButton loading />
109
- </div\>
681
+ <IressButton
682
+ loading
683
+ mode\="tertiary"
684
+ \>
685
+ Button text </IressButton\>
686
+ </IressInline\>
110
687
 
111
688
  Copy
112
689
 
@@ -118,8 +695,6 @@ A good example of this is the Next and Previous links in a wizard layout. These
118
695
 
119
696
  You can also use the link specific props `target` and `rel`.
120
697
 
121
- If you need to use custom routing, take a look at the custom route slot documentation below.
122
-
123
698
  [This is a link (anchor tag)](https://www.iress.com/)
124
699
 
125
700
  Hide code
@@ -154,8 +729,8 @@ Hide code
154
729
  \[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; }
155
730
 
156
731
  <IressButton
157
- mode\="danger"
158
732
  onClick\={() \=> {}}
733
+ status\="danger"
159
734
  \>
160
735
  Delete button with confirm
161
736
  </IressButton\>
@@ -170,37 +745,22 @@ The `fluid` prop can also be set to a breakpoint size, which means the button wi
170
745
 
171
746
  Please resize your screen to see how the fluid value changes. Current breakpoint: **xl** (1200px and above).
172
747
 
173
- Fluid: trueFluid: xsFluid: smFluid: mdFluid: lgFluid: xlFluid: xxl
748
+ Always fluidFluid on xs and sm
174
749
 
175
750
  Hide code
176
751
 
177
752
  \[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; }
178
753
 
179
- <div
180
- className\="iress-u-inline iress--gutter--md"
181
- style\={{
182
- rowGap: 'var(--iress-g-spacing-md'
183
- }}
184
- \>
754
+ <IressInline gap\="md"\>
185
755
  <IressText element\="p"\>
186
756
  Please resize your screen to see how the fluid value changes. Current breakpoint:{' '}
187
757
  <CurrentBreakpoint renderLabel\="and-above" />
188
758
  . </IressText\>
189
759
  <IressButton fluid\>
190
- Fluid: true </IressButton\>
191
- <IressButton fluid\="xs"\>
192
- Fluid: xs </IressButton\>
193
- <IressButton fluid\="sm"\>
194
- Fluid: sm </IressButton\>
760
+ Always fluid </IressButton\>
195
761
  <IressButton fluid\="md"\>
196
- Fluid: md </IressButton\>
197
- <IressButton fluid\="lg"\>
198
- Fluid: lg </IressButton\>
199
- <IressButton fluid\="xl"\>
200
- Fluid: xl </IressButton\>
201
- <IressButton fluid\="xxl"\>
202
- Fluid: xxl </IressButton\>
203
- </div\>
762
+ Fluid on xs and sm </IressButton\>
763
+ </IressInline\>
204
764
 
205
765
  Copy
206
766
 
@@ -220,7 +780,7 @@ Hide code
220
780
 
221
781
  \[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; }
222
782
 
223
- <div
783
+ <IressText
224
784
  style\={{
225
785
  width: 250
226
786
  }}
@@ -241,7 +801,7 @@ Hide code
241
801
  <IressButton noWrap\>
242
802
  Button with lots of text content with the noWrap prop set to true </IressButton\>
243
803
  </p\>
244
- </div\>
804
+ </IressText\>
245
805
 
246
806
  Copy
247
807
 
@@ -262,25 +822,25 @@ Hide code
262
822
 
263
823
  \[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; }
264
824
 
265
- <\>
266
- <p className\="iress-u-inline iress--gutter--md"\>
825
+ <IressStack gap\="md"\>
826
+ <IressInline gap\="md"\>
267
827
  <IressButton prepend\={<IressIcon name\="home" />}\>
268
828
  Prepend icon </IressButton\>
269
829
  <IressButton prepend\={<IressBadge mode\="info"\>New</IressBadge\>}\>
270
830
  Prepend badge </IressButton\>
271
- </p\>
272
- <p className\="iress-u-inline iress--gutter--md"\>
831
+ </IressInline\>
832
+ <IressInline gap\="md"\>
273
833
  <IressButton append\={<IressIcon name\="home" />}\>
274
834
  Append icon </IressButton\>
275
835
  <IressButton append\={<IressBadge mode\="info"\>+999</IressBadge\>}\>
276
836
  Append badge </IressButton\>
277
- </p\>
278
- <p className\="iress-u-inline iress--gutter--md"\>
837
+ </IressInline\>
838
+ <IressInline gap\="md"\>
279
839
  <IressButton\>
280
840
  <IressIcon name\="home" />
281
841
  </IressButton\>
282
- </p\>
283
- </\>
842
+ </IressInline\>
843
+ </IressStack\>
284
844
 
285
845
  Copy
286
846
 
@@ -306,9 +866,7 @@ Copy
306
866
 
307
867
  ### [](#download-button)Download button
308
868
 
309
- Whilst `IressButton` does not have a `download` property, it can be configured quite easily.
310
-
311
- Please see the example below. The use of an icon is optional.
869
+ When a `href` is provided, the `download` prop can be used to indicate that the link should download a file instead of navigating to it. This is useful for links to files such as PDFs or images.
312
870
 
313
871
  [Download logo](assets/iress-logo.png)
314
872
 
@@ -326,6 +884,35 @@ Hide code
326
884
 
327
885
  Copy
328
886
 
887
+ ### [](#element)Element
888
+
889
+ You can use the `element` prop to render a custom component as the button. This is useful for rendering a component from a third-party library, such as `react-router-dom`.
890
+
891
+ [Iress](https://iress.com)
892
+
893
+ Hide code
894
+
895
+ \[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; }
896
+
897
+ /\*\*
898
+ \* This could be the \`Link\` component from \`react-router-dom\` or any other routing library. \*/
899
+ const Link \= forwardRef<
900
+ HTMLAnchorElement,
901
+ HTMLAttributes<HTMLAnchorElement\> & { to: string }
902
+ \>(({ children, className, to, ...restProps }, ref) \=> (
903
+ <div className\={className}\>
904
+ <a href\={to} ref\={ref} {...restProps}\>
905
+ {children}
906
+ </a\>
907
+ </div\>
908
+ ));
909
+ export const RoutingButton \= () \=> (
910
+ <IressButton element\={Link} to\="https://iress.com"\>
911
+ Iress </IressButton\>
912
+ );
913
+
914
+ Copy
915
+
329
916
  [](#iressclosebutton)`IressCloseButton`
330
917
  ---------------------------------------
331
918
 
@@ -344,12 +931,504 @@ Hide code
344
931
 
345
932
  Copy
346
933
 
934
+ #### [](#close-button-api)Props
935
+
936
+ | Name | Description | Default | Control |
937
+ | --- | --- | --- | --- |
938
+ | active |
939
+ Sets the active state of the button, usually used to indicate the button has activated a modal, popover or slideout.
940
+
941
+ booleanundefined
942
+
943
+
944
+
945
+ | \- | Set object |
946
+ | append |
947
+
948
+ Content for the append slot.
949
+
950
+ ReactNode
951
+
952
+
953
+
954
+ | \- |
955
+
956
+ ""
957
+
958
+ |
959
+ | bg |
960
+
961
+ **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
962
+
963
+ We recommend using the following token values for best background contrast:
964
+
965
+ * `colour.primary.fill` for primary backgrounds that need to stand out
966
+ * `colour.primary.surface` for primary backgrounds that need to be less prominent
967
+ * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
968
+ * `colour.neutral.20` for a slightly darker background color, used in neutral state components
969
+ * `colour.system.danger.fill` for error backgrounds that need to stand out
970
+ * `colour.system.danger.surface` for error backgrounds that need to be less prominent
971
+ * `colour.system.success.fill` for success backgrounds that need to stand out
972
+ * `colour.system.success.surface` for success backgrounds that need to be less prominent
973
+ * `colour.system.warning.fill` for warning backgrounds that need to stand out
974
+ * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
975
+ * `colour.system.info.fill` for info backgrounds that need to stand out
976
+ * `colour.system.info.surface` for info backgrounds that need to be less prominent
977
+
978
+ ResponsiveProp<ColorToken> | undefined
979
+
980
+ | \- | Set object |
981
+ | borderRadius |
982
+
983
+ The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
984
+
985
+ | Chrome | Firefox | Safari | Edge | IE |
986
+ | --- | --- | --- | --- | --- |
987
+ | **4** | **4** | **5** | **12** | **9** |
988
+ | 1 _\-x-_ | | 3 _\-x-_ | | |
989
+
990
+ ResponsiveProp<RadiusToken> | undefined
991
+
992
+ | \- | Set object |
993
+ | color |
994
+
995
+ 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`.
996
+
997
+ We recommend using the following token values for best color contrast:
998
+
999
+ * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
1000
+ * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
1001
+ * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
1002
+ * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
1003
+ * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
1004
+ * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
1005
+ * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
1006
+ * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
1007
+ * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
1008
+ * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
1009
+ * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
1010
+ * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
1011
+
1012
+ ResponsiveProp<ColorToken> | undefined
1013
+
1014
+ | \- | Set object |
1015
+ | element |
1016
+
1017
+ Change the component that will be rendered as the button, used for third-party libraries that require a specific element type. By default, it will render a button or an anchor tag based on the `href` prop.
1018
+
1019
+ undefined
1020
+
1021
+
1022
+
1023
+ | \- | Set object |
1024
+ | fluid |
1025
+
1026
+ If `true`, the button will stretch to fill it's container. The prop is responsive, so you can set the breakpoint(s) at which the button will be fluid.
1027
+
1028
+ All breakpoints: `fluid={true}` Up to a specific breakpoint: `fluid={{ base: true, md: false }}`
1029
+
1030
+ true"xs""sm""md""lg""xl""xxl"undefined
1031
+
1032
+
1033
+
1034
+ | \- | Set object |
1035
+ | focusable |
1036
+
1037
+ 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.
1038
+
1039
+ "true""within"undefined
1040
+
1041
+
1042
+
1043
+ | \- | Set object |
1044
+ | hide |
1045
+
1046
+ 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.
1047
+
1048
+ Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
1049
+
1050
+ Notes:
1051
+
1052
+ * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
1053
+ * Consider if you can conditionally render the element instead of hiding it.
1054
+
1055
+ ResponsiveProp<boolean> | undefined
1056
+
1057
+ | \- | Set object |
1058
+ | href |
1059
+
1060
+ Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
1061
+
1062
+ undefined
1063
+
1064
+
1065
+
1066
+ | \- | Set object |
1067
+ | layerStyle |
1068
+
1069
+ 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.
1070
+
1071
+ * `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.
1072
+ * `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.
1073
+ * `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.
1074
+
1075
+ ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
1076
+
1077
+ | \- | Set object |
1078
+ | loading |
1079
+
1080
+ When true, button is in loading state. If provided a string, will be used as the loading text for screen readers.
1081
+
1082
+ stringbooleanundefined
1083
+
1084
+
1085
+
1086
+ | \- | Set object |
1087
+ | m |
1088
+
1089
+ The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
1090
+
1091
+ 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.
1092
+
1093
+ | Chrome | Firefox | Safari | Edge | IE |
1094
+ | --- | --- | --- | --- | --- |
1095
+ | **1** | **1** | **1** | **12** | **3** |
1096
+
1097
+ ResponsiveProp<SpacingToken | "auto"> | undefined
1098
+
1099
+ | \- | Set object |
1100
+ | maxWidth |
1101
+
1102
+ 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`.
1103
+
1104
+ | Chrome | Firefox | Safari | Edge | IE |
1105
+ | --- | --- | --- | --- | --- |
1106
+ | **1** | **1** | **1** | **12** | **7** |
1107
+
1108
+ 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
1109
+
1110
+ | \- | Set object |
1111
+ | mb |
1112
+
1113
+ 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.
1114
+
1115
+ It uses the spacing tokens in the design system.
1116
+
1117
+ | Chrome | Firefox | Safari | Edge | IE |
1118
+ | --- | --- | --- | --- | --- |
1119
+ | **1** | **1** | **1** | **12** | **3** |
1120
+
1121
+ ResponsiveProp<SpacingToken | "auto"> | undefined
1122
+
1123
+ | \- | Set object |
1124
+ | ml |
1125
+
1126
+ 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.
1127
+
1128
+ It uses the spacing tokens in the design system.
1129
+
1130
+ | Chrome | Firefox | Safari | Edge | IE |
1131
+ | --- | --- | --- | --- | --- |
1132
+ | **1** | **1** | **1** | **12** | **3** |
1133
+
1134
+ ResponsiveProp<SpacingToken | "auto"> | undefined
1135
+
1136
+ | \- | Set object |
1137
+ | mr |
1138
+
1139
+ 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.
1140
+
1141
+ It uses the spacing tokens in the design system.
1142
+
1143
+ | Chrome | Firefox | Safari | Edge | IE |
1144
+ | --- | --- | --- | --- | --- |
1145
+ | **1** | **1** | **1** | **12** | **3** |
1146
+
1147
+ ResponsiveProp<SpacingToken | "auto"> | undefined
1148
+
1149
+ | \- | Set object |
1150
+ | mt |
1151
+
1152
+ 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.
1153
+
1154
+ It uses the spacing tokens in the design system.
1155
+
1156
+ | Chrome | Firefox | Safari | Edge | IE |
1157
+ | --- | --- | --- | --- | --- |
1158
+ | **1** | **1** | **1** | **12** | **3** |
1159
+
1160
+ ResponsiveProp<SpacingToken | "auto"> | undefined
1161
+
1162
+ | \- | Set object |
1163
+ | mx |
1164
+
1165
+ 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.
1166
+
1167
+ 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.
1168
+
1169
+ | Chrome | Firefox | Safari | Edge | IE |
1170
+ | --- | --- | --- | --- | --- |
1171
+ | **1** | **1** | **1** | **12** | **3** |
1172
+
1173
+ ResponsiveProp<SpacingToken | "auto"> | undefined
1174
+
1175
+ | \- | Set object |
1176
+ | my |
1177
+
1178
+ 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.
1179
+
1180
+ 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.
1181
+
1182
+ | Chrome | Firefox | Safari | Edge | IE |
1183
+ | --- | --- | --- | --- | --- |
1184
+ | **1** | **1** | **1** | **12** | **3** |
1185
+
1186
+ ResponsiveProp<SpacingToken | "auto"> | undefined
1187
+
1188
+ | \- | Set object |
1189
+ | noGutter |
1190
+
1191
+ 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.
1192
+
1193
+ booleanundefined
1194
+
1195
+
1196
+
1197
+ | \- | Set object |
1198
+ | noWrap |
1199
+
1200
+ Prevents text wrapping if set to true.
1201
+
1202
+ booleanundefined
1203
+
1204
+
1205
+
1206
+ | \- | Set object |
1207
+ | onClick |
1208
+
1209
+ Emitted when the menu item is clicked.
1210
+
1211
+ MouseEventHandler<HTMLButtonElement> | undefined
1212
+
1213
+ | \- | Set object |
1214
+ | p |
1215
+
1216
+ The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
1217
+
1218
+ 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.
1219
+
1220
+ | Chrome | Firefox | Safari | Edge | IE |
1221
+ | --- | --- | --- | --- | --- |
1222
+ | **1** | **1** | **1** | **12** | **3** |
1223
+
1224
+ 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
1225
+
1226
+ | \- | Set object |
1227
+ | pb |
1228
+
1229
+ The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
1230
+
1231
+ 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.
1232
+
1233
+ | Chrome | Firefox | Safari | Edge | IE |
1234
+ | --- | --- | --- | --- | --- |
1235
+ | **1** | **1** | **1** | **12** | **3** |
1236
+
1237
+ 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
1238
+
1239
+ | \- | Set object |
1240
+ | pl |
1241
+
1242
+ The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
1243
+
1244
+ 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.
1245
+
1246
+ | Chrome | Firefox | Safari | Edge | IE |
1247
+ | --- | --- | --- | --- | --- |
1248
+ | **1** | **1** | **1** | **12** | **3** |
1249
+
1250
+ 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
1251
+
1252
+ | \- | Set object |
1253
+ | pr |
1254
+
1255
+ The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
1256
+
1257
+ 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.
1258
+
1259
+ | Chrome | Firefox | Safari | Edge | IE |
1260
+ | --- | --- | --- | --- | --- |
1261
+ | **1** | **1** | **1** | **12** | **3** |
1262
+
1263
+ 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
1264
+
1265
+ | \- | Set object |
1266
+ | prepend |
1267
+
1268
+ Content for the prepend slot.
1269
+
1270
+ ReactNode
1271
+
1272
+
1273
+
1274
+ | \- |
1275
+
1276
+ ""
1277
+
1278
+ |
1279
+ | pt |
1280
+
1281
+ The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
1282
+
1283
+ 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.
1284
+
1285
+ | Chrome | Firefox | Safari | Edge | IE |
1286
+ | --- | --- | --- | --- | --- |
1287
+ | **1** | **1** | **1** | **12** | **3** |
1288
+
1289
+ 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
1290
+
1291
+ | \- | Set object |
1292
+ | px |
1293
+
1294
+ 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.
1295
+
1296
+ 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.
1297
+
1298
+ | Chrome | Firefox | Safari | Edge | IE |
1299
+ | --- | --- | --- | --- | --- |
1300
+ | **1** | **1** | **1** | **12** | **3** |
1301
+
1302
+ 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
1303
+
1304
+ | \- | Set object |
1305
+ | py |
1306
+
1307
+ 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.
1308
+
1309
+ 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.
1310
+
1311
+ | Chrome | Firefox | Safari | Edge | IE |
1312
+ | --- | --- | --- | --- | --- |
1313
+ | **1** | **1** | **1** | **12** | **3** |
1314
+
1315
+ 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
1316
+
1317
+ | \- | Set object |
1318
+ | rowGap |
1319
+
1320
+ The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
1321
+
1322
+ Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
1323
+
1324
+ | Chrome | Firefox | Safari | Edge | IE |
1325
+ | --- | --- | --- | --- | --- |
1326
+ | **47** | **52** | **10.1** | **16** | No |
1327
+
1328
+ 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
1329
+
1330
+ | \- | Set object |
1331
+ | screenreaderText |
1332
+
1333
+ Description for screen readers.
1334
+
1335
+ stringundefined
1336
+
1337
+
1338
+
1339
+ |
1340
+
1341
+ Close button
1342
+
1343
+ | Set object |
1344
+ | srOnly |
1345
+
1346
+ 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.
1347
+
1348
+ Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
1349
+
1350
+ ResponsiveProp<boolean> | undefined
1351
+
1352
+ | \- | Set object |
1353
+ | status |
1354
+
1355
+ An optional status to assign to the button.
1356
+
1357
+ * `success`: Indicates a successful or positive action.
1358
+ * `danger`: Indicates a dangerous or potentially negative action.
1359
+
1360
+ "danger""success"undefined
1361
+
1362
+
1363
+
1364
+ | \- | Set object |
1365
+ | stretch |
1366
+
1367
+ 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.
1368
+
1369
+ booleanundefined
1370
+
1371
+
1372
+
1373
+ | \- | Set object |
1374
+ | textAlign |
1375
+
1376
+ The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
1377
+
1378
+ | Chrome | Firefox | Safari | Edge | IE |
1379
+ | --- | --- | --- | --- | --- |
1380
+ | **1** | **1** | **1** | **12** | **3** |
1381
+
1382
+ ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
1383
+
1384
+ | \- | Set object |
1385
+ | textStyle |
1386
+
1387
+ Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
1388
+
1389
+ * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
1390
+ * `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.
1391
+ * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
1392
+ * `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.
1393
+ * `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.
1394
+ * `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.
1395
+ * `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.
1396
+ * `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.
1397
+ * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
1398
+
1399
+ 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
1400
+
1401
+ | \- | Set object |
1402
+ | value |
1403
+
1404
+ The value of the button, when used in `IressButtonGroup`.
1405
+
1406
+ FormControlValueundefined
1407
+
1408
+
1409
+
1410
+ | \- | Set object |
1411
+ | width |
1412
+
1413
+ 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.
1414
+
1415
+ 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.
1416
+
1417
+ | Chrome | Firefox | Safari | Edge | IE |
1418
+ | --- | --- | --- | --- | --- |
1419
+ | **1** | **1** | **1** | **12** | **4** |
1420
+
1421
+ 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
1422
+
1423
+ | \- | Set object |
1424
+
347
1425
  On this page
348
1426
 
349
1427
  * [Overview](#overview)
350
1428
  * [Props](#props)
351
1429
  * [Examples](#examples)
352
1430
  * [Modes](#modes)
1431
+ * [Status](#status)
353
1432
  * [Types](#types)
354
1433
  * [Loading](#loading)
355
1434
  * [Buttons as links](#buttons-as-links)
@@ -359,4 +1438,5 @@ On this page
359
1438
  * [Slot props](#slot-props)
360
1439
  * [Other attributes](#other-attributes)
361
1440
  * [Download button](#download-button)
1441
+ * [Element](#element)
362
1442
  * [IressCloseButton](#iressclosebutton)