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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/dist/searchHandlers.test.js +8 -2
  2. package/dist/toolHandler.test.js +9 -9
  3. package/dist/utils.test.js +6 -2
  4. package/package.json +32 -30
  5. package/generated/docs/components-alert-docs.md +0 -702
  6. package/generated/docs/components-autocomplete-docs.md +0 -1433
  7. package/generated/docs/components-autocomplete-recipes-docs.md +0 -104
  8. package/generated/docs/components-badge-docs.md +0 -531
  9. package/generated/docs/components-button-docs.md +0 -1442
  10. package/generated/docs/components-buttongroup-docs.md +0 -748
  11. package/generated/docs/components-card-docs.md +0 -944
  12. package/generated/docs/components-checkbox-docs.md +0 -694
  13. package/generated/docs/components-checkboxgroup-docs.md +0 -1087
  14. package/generated/docs/components-checkboxgroup-recipes-docs.md +0 -119
  15. package/generated/docs/components-col-docs.md +0 -881
  16. package/generated/docs/components-container-docs.md +0 -123
  17. package/generated/docs/components-divider-docs.md +0 -576
  18. package/generated/docs/components-expander-docs.md +0 -594
  19. package/generated/docs/components-field-docs.md +0 -2007
  20. package/generated/docs/components-filter-docs.md +0 -1322
  21. package/generated/docs/components-hide-docs.md +0 -702
  22. package/generated/docs/components-icon-docs.md +0 -816
  23. package/generated/docs/components-image-docs.md +0 -493
  24. package/generated/docs/components-inline-docs.md +0 -2003
  25. package/generated/docs/components-input-docs.md +0 -867
  26. package/generated/docs/components-input-recipes-docs.md +0 -140
  27. package/generated/docs/components-inputcurrency-docs.md +0 -689
  28. package/generated/docs/components-inputcurrency-recipes-docs.md +0 -115
  29. package/generated/docs/components-introduction-docs.md +0 -450
  30. package/generated/docs/components-label-docs.md +0 -562
  31. package/generated/docs/components-link-docs.md +0 -586
  32. package/generated/docs/components-menu-docs.md +0 -1146
  33. package/generated/docs/components-menu-menuitem-docs.md +0 -739
  34. package/generated/docs/components-modal-docs.md +0 -1346
  35. package/generated/docs/components-panel-docs.md +0 -600
  36. package/generated/docs/components-placeholder-docs.md +0 -446
  37. package/generated/docs/components-popover-docs.md +0 -1529
  38. package/generated/docs/components-popover-recipes-docs.md +0 -211
  39. package/generated/docs/components-progress-docs.md +0 -568
  40. package/generated/docs/components-provider-docs.md +0 -160
  41. package/generated/docs/components-radio-docs.md +0 -563
  42. package/generated/docs/components-radiogroup-docs.md +0 -1153
  43. package/generated/docs/components-readonly-docs.md +0 -535
  44. package/generated/docs/components-richselect-docs.md +0 -5836
  45. package/generated/docs/components-row-docs.md +0 -2354
  46. package/generated/docs/components-select-docs.md +0 -940
  47. package/generated/docs/components-skeleton-docs.md +0 -597
  48. package/generated/docs/components-skeleton-recipes-docs.md +0 -76
  49. package/generated/docs/components-skiplink-docs.md +0 -587
  50. package/generated/docs/components-slideout-docs.md +0 -1036
  51. package/generated/docs/components-slider-docs.md +0 -828
  52. package/generated/docs/components-spinner-docs.md +0 -450
  53. package/generated/docs/components-stack-docs.md +0 -923
  54. package/generated/docs/components-table-ag-grid-docs.md +0 -1444
  55. package/generated/docs/components-table-docs.md +0 -2327
  56. package/generated/docs/components-tabset-docs.md +0 -768
  57. package/generated/docs/components-tabset-tab-docs.md +0 -550
  58. package/generated/docs/components-tag-docs.md +0 -548
  59. package/generated/docs/components-text-docs.md +0 -585
  60. package/generated/docs/components-toaster-docs.md +0 -755
  61. package/generated/docs/components-toggle-docs.md +0 -614
  62. package/generated/docs/components-tooltip-docs.md +0 -747
  63. package/generated/docs/components-validationmessage-docs.md +0 -1161
  64. package/generated/docs/contact-us-docs.md +0 -27
  65. package/generated/docs/extensions-editor-docs.md +0 -1181
  66. package/generated/docs/extensions-editor-recipes-docs.md +0 -89
  67. package/generated/docs/foundations-accessibility-docs.md +0 -40
  68. package/generated/docs/foundations-consistency-docs.md +0 -52
  69. package/generated/docs/foundations-content-docs.md +0 -23
  70. package/generated/docs/foundations-grid-docs.md +0 -74
  71. package/generated/docs/foundations-introduction-docs.md +0 -19
  72. package/generated/docs/foundations-principles-docs.md +0 -70
  73. package/generated/docs/foundations-responsive-breakpoints-docs.md +0 -193
  74. package/generated/docs/foundations-tokens-colour-docs.md +0 -564
  75. package/generated/docs/foundations-tokens-elevation-docs.md +0 -155
  76. package/generated/docs/foundations-tokens-introduction-docs.md +0 -190
  77. package/generated/docs/foundations-tokens-radius-docs.md +0 -71
  78. package/generated/docs/foundations-tokens-spacing-docs.md +0 -89
  79. package/generated/docs/foundations-tokens-typography-docs.md +0 -322
  80. package/generated/docs/foundations-user-experience-docs.md +0 -63
  81. package/generated/docs/foundations-visual-design-docs.md +0 -46
  82. package/generated/docs/foundations-z-index-stacking-docs.md +0 -31
  83. package/generated/docs/frequently-asked-questions-docs.md +0 -53
  84. package/generated/docs/get-started-develop-docs.md +0 -209
  85. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  86. package/generated/docs/guidelines.md +0 -2054
  87. package/generated/docs/introduction-docs.md +0 -87
  88. package/generated/docs/news-version-6-docs.md +0 -93
  89. package/generated/docs/patterns-form-docs.md +0 -3902
  90. package/generated/docs/patterns-form-recipes-docs.md +0 -1370
  91. package/generated/docs/patterns-introduction-docs.md +0 -24
  92. package/generated/docs/patterns-loading-docs.md +0 -4043
  93. package/generated/docs/resources-code-katas-docs.md +0 -29
  94. package/generated/docs/resources-introduction-docs.md +0 -38
  95. package/generated/docs/resources-mcp-server-docs.md +0 -27
  96. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  97. package/generated/docs/styling-props-colour-docs.md +0 -172
  98. package/generated/docs/styling-props-elevation-docs.md +0 -88
  99. package/generated/docs/styling-props-radius-docs.md +0 -86
  100. package/generated/docs/styling-props-reference-docs.md +0 -160
  101. package/generated/docs/styling-props-screen-readers-docs.md +0 -71
  102. package/generated/docs/styling-props-sizing-docs.md +0 -627
  103. package/generated/docs/styling-props-spacing-docs.md +0 -2282
  104. package/generated/docs/styling-props-typography-docs.md +0 -121
  105. package/generated/docs/themes-available-themes-docs.md +0 -66
  106. package/generated/docs/themes-introduction-docs.md +0 -121
  107. package/generated/docs/versions-docs.md +0 -17
  108. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,1442 +0,0 @@
1
- [](#button)Button
2
- =================
3
-
4
- Overview
5
- --------
6
-
7
- A button is a clickable item used to perform an action.
8
-
9
- * * *
10
-
11
- Updated
12
-
13
- **Recently updated**
14
-
15
- This component has been recently updated with new props. The props have been marked as beta. Please tell us if there are any issues.
16
-
17
- Button
18
-
19
- Hide code
20
-
21
- \[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; }
22
-
23
- <IressButton\>
24
- Button
25
- </IressButton\>
26
-
27
- Copy
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
-
551
- [](#examples)Examples
552
- ---------------------
553
-
554
- ### [](#modes)Modes
555
-
556
- The `mode` prop controls the visual appearance and priority of the button.
557
-
558
- * **Primary:** Use for the main call to action. Limit to one per view.
559
- * **Secondary:** Use for secondary calls to action.
560
- * **Tertiary:** Use when you need extra affordance between your secondary actions.
561
-
562
- Primary buttonSecondary buttonTertiary button
563
-
564
- Hide code
565
-
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; }
567
-
568
- <IressInline gap\="md"\>
569
- <IressButton mode\="primary"\>
570
- Primary button </IressButton\>
571
- <IressButton mode\="secondary"\>
572
- Secondary button </IressButton\>
573
- <IressButton mode\="tertiary"\>
574
- Tertiary button </IressButton\>
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\>
630
-
631
- Copy
632
-
633
- ### [](#types)Types
634
-
635
- The `type` property controls the behaviour of the button. It defaults to `button`, which is the best option for most situations, but can also be set to `submit` or `reset`. `submit` should be used for buttons that submit forms, and `reset` should be used if the button clears form data and resets the form to its original state.
636
-
637
- **Please note:** this differs from a standard HTML button element, where the `type` defaults to submit.
638
-
639
- buttonsubmitreset
640
-
641
- Hide code
642
-
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; }
644
-
645
- <IressInline gap\="md"\>
646
- <IressButton type\="button"\>
647
- button </IressButton\>
648
- <IressButton type\="submit"\>
649
- submit </IressButton\>
650
- <IressButton type\="reset"\>
651
- reset </IressButton\>
652
- </IressInline\>
653
-
654
- Copy
655
-
656
- ### [](#loading)Loading
657
-
658
- Loading buttons give the user an indication something is happening (eg. a form submission or extra content being loaded) after they have been triggered.
659
-
660
- The loading state can be activated by setting the `loading` prop to `true` and providing some `loadingText` for screenreaders to announce when in loading state (which defaults to Loading...).
661
-
662
- When the loading state is activated, any click events on the button are disabled.
663
-
664
- Button textButton textButton text
665
-
666
- Hide code
667
-
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; }
669
-
670
- <IressInline gap\="md"\>
671
- <IressButton
672
- loading
673
- mode\="primary"
674
- \>
675
- Button text </IressButton\>
676
- <IressButton
677
- loading
678
- mode\="secondary"
679
- \>
680
- Button text </IressButton\>
681
- <IressButton
682
- loading
683
- mode\="tertiary"
684
- \>
685
- Button text </IressButton\>
686
- </IressInline\>
687
-
688
- Copy
689
-
690
- ### [](#buttons-as-links)Buttons as links
691
-
692
- The `href` prop allows you to create a link that looks like a button. When set, the component will render an HTML anchor element instead of an HTML button element. This can be useful when you want to increase the target area and visual weight of a link, without changing the markup.
693
-
694
- A good example of this is the Next and Previous links in a wizard layout. These should be HTML links (to tells the user that navigation will occur when clicked) but styling them as buttons makes them more prominent.
695
-
696
- You can also use the link specific props `target` and `rel`.
697
-
698
- [This is a link (anchor tag)](https://www.iress.com/)
699
-
700
- Hide code
701
-
702
- \[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; }
703
-
704
- <IressButton
705
- href\="https://www.iress.com/"
706
- rel\="opener noreferrer"
707
- target\="\_blank"
708
- \>
709
- This is a link (anchor tag)
710
- </IressButton\>
711
-
712
- Copy
713
-
714
- ### [](#delete-confirmation)Delete confirmation
715
-
716
- Make sure that the user understands the consequences of clicking the button
717
- ---------------------------------------------------------------------------
718
-
719
- You may want to add a confirmation step to prevent accidental data loss if the action is irreversible.
720
-
721
- The confirmation step should be a modal with a simple message, as with the example below. Use a delete button for the modal's primary call to action, and use a secondary button for the cancel action.
722
-
723
- If you're using a heading, ensure that it has an appropriate heading level to match the document structure. You should use a danger variant of the `IressText` element, with the element prop set to the appropriate heading level.
724
-
725
- Delete button with confirm
726
-
727
- Hide code
728
-
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; }
730
-
731
- <IressButton
732
- onClick\={() \=> {}}
733
- status\="danger"
734
- \>
735
- Delete button with confirm
736
- </IressButton\>
737
-
738
- Copy
739
-
740
- ### [](#fluid)Fluid
741
-
742
- If the `fluid` prop is set to true, the button will expand to be 100% of the width of its container.
743
-
744
- The `fluid` prop can also be set to a breakpoint size, which means the button will be fluid up until its breakpoint is passed.
745
-
746
- Please resize your screen to see how the fluid value changes. Current breakpoint: **xl** (1200px and above).
747
-
748
- Always fluidFluid on xs and sm
749
-
750
- Hide code
751
-
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; }
753
-
754
- <IressInline gap\="md"\>
755
- <IressText element\="p"\>
756
- Please resize your screen to see how the fluid value changes. Current breakpoint:{' '}
757
- <CurrentBreakpoint renderLabel\="and-above" />
758
- . </IressText\>
759
- <IressButton fluid\>
760
- Always fluid </IressButton\>
761
- <IressButton fluid\="md"\>
762
- Fluid on xs and sm </IressButton\>
763
- </IressInline\>
764
-
765
- Copy
766
-
767
- ### [](#wrapping-text)Wrapping text
768
-
769
- Button text will wrap on to a new line if there's not enough space for the text to sit on a single line. If you want to prevent the text from wrapping, you can set the `noWrap` prop to `true`.
770
-
771
- If your button contains a lot of text, the text may wrap on to more than one line. You can manage this on a case by case basis by setting a minimum width on your button via CSS if you need to.
772
-
773
- Button with lots of text content that will wrap (default behaviour)
774
-
775
- Button with lots of text content and a minimum width set via CSS
776
-
777
- Button with lots of text content with the noWrap prop set to true
778
-
779
- Hide code
780
-
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; }
782
-
783
- <IressText
784
- style\={{
785
- width: 250
786
- }}
787
- \>
788
- <p\>
789
- <IressButton\>
790
- Button with lots of text content that will wrap (default behaviour) </IressButton\>
791
- </p\>
792
- <p\>
793
- <IressButton
794
- style\={{
795
- minWidth: 300
796
- }}
797
- \>
798
- Button with lots of text content and a minimum width set via CSS </IressButton\>
799
- </p\>
800
- <p\>
801
- <IressButton noWrap\>
802
- Button with lots of text content with the noWrap prop set to true </IressButton\>
803
- </p\>
804
- </IressText\>
805
-
806
- Copy
807
-
808
- ### [](#slot-props)Slot props
809
-
810
- Use the slots to correctly position icons or badges inside buttons.
811
-
812
- * **Prepend** - Places the element before the text
813
- * **Append** - Places the element after the text
814
-
815
- The iconOnly slot from previous versions of IDS has been deprecated. Please use the default slot instead.
816
-
817
- Prepend iconNewPrepend badge
818
-
819
- Append iconAppend badge+999
820
-
821
- Hide code
822
-
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; }
824
-
825
- <IressStack gap\="md"\>
826
- <IressInline gap\="md"\>
827
- <IressButton prepend\={<IressIcon name\="home" />}\>
828
- Prepend icon </IressButton\>
829
- <IressButton prepend\={<IressBadge mode\="info"\>New</IressBadge\>}\>
830
- Prepend badge </IressButton\>
831
- </IressInline\>
832
- <IressInline gap\="md"\>
833
- <IressButton append\={<IressIcon name\="home" />}\>
834
- Append icon </IressButton\>
835
- <IressButton append\={<IressBadge mode\="info"\>+999</IressBadge\>}\>
836
- Append badge </IressButton\>
837
- </IressInline\>
838
- <IressInline gap\="md"\>
839
- <IressButton\>
840
- <IressIcon name\="home" />
841
- </IressButton\>
842
- </IressInline\>
843
- </IressStack\>
844
-
845
- Copy
846
-
847
- ### [](#other-attributes)Other attributes
848
-
849
- Any other attributes you pass to the component will be spread to the underlying HTML button or anchor element.
850
-
851
- This allows you to add your own aria attributes, or data attributes for analytics, as an example.
852
-
853
- **Note:** The `attrs` prop has been deprecated, and will be removed in a future version. Please pass the attributes directly to the component instead.
854
-
855
- Button text
856
-
857
- Hide code
858
-
859
- \[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; }
860
-
861
- <IressButton data-analytics-id\="test"\>
862
- Button text
863
- </IressButton\>
864
-
865
- Copy
866
-
867
- ### [](#download-button)Download button
868
-
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.
870
-
871
- [Download logo](assets/iress-logo.png)
872
-
873
- Hide code
874
-
875
- \[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; }
876
-
877
- <IressButton
878
- download
879
- href\="assets/iress-logo.png"
880
- prepend\={<IressIcon name\="download" />}
881
- \>
882
- Download logo
883
- </IressButton\>
884
-
885
- Copy
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
-
916
- [](#iressclosebutton)`IressCloseButton`
917
- ---------------------------------------
918
-
919
- `IressCloseButton` is a special variant of `IressButton` that is used to execute a close action. It is used in modals, slideouts, and other components that require a close button.
920
-
921
- It has one additional prop, `screenReaderText`, which is used to provide a screen reader only label for the close button.
922
-
923
- Hide code
924
-
925
- \[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; }
926
-
927
- <IressCloseButton
928
- append\=""
929
- prepend\=""
930
- />
931
-
932
- Copy
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
-
1425
- On this page
1426
-
1427
- * [Overview](#overview)
1428
- * [Props](#props)
1429
- * [Examples](#examples)
1430
- * [Modes](#modes)
1431
- * [Status](#status)
1432
- * [Types](#types)
1433
- * [Loading](#loading)
1434
- * [Buttons as links](#buttons-as-links)
1435
- * [Delete confirmation](#delete-confirmation)
1436
- * [Fluid](#fluid)
1437
- * [Wrapping text](#wrapping-text)
1438
- * [Slot props](#slot-props)
1439
- * [Other attributes](#other-attributes)
1440
- * [Download button](#download-button)
1441
- * [Element](#element)
1442
- * [IressCloseButton](#iressclosebutton)