@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,1153 +0,0 @@
1
- [](#radiogroup)RadioGroup
2
- =========================
3
-
4
- Overview
5
- --------
6
-
7
- A radio group is a group of radio buttons that allows the user to select one option from multiple options, where all options are visible.
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
- Google
18
-
19
- Newspaper
20
-
21
- Friend
22
-
23
- Other
24
-
25
- Hide code
26
-
27
- \[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; }
28
-
29
- <IressRadioGroup\>
30
- <IressRadio value\="google"\>
31
- Google </IressRadio\>
32
- <IressRadio value\="newspaper"\>
33
- Newspaper </IressRadio\>
34
- <IressRadio value\="friend"\>
35
- Friend </IressRadio\>
36
- <IressRadio value\="other"\>
37
- Other </IressRadio\>
38
- </IressRadioGroup\>
39
-
40
- Copy
41
-
42
- [](#props)Props
43
- ---------------
44
-
45
- IressRadioGroupIressRadio
46
-
47
- Tabs
48
-
49
- | Name | Description | Default | Control |
50
- | --- | --- | --- | --- |
51
- | bg |
52
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
53
-
54
- We recommend using the following token values for best background contrast:
55
-
56
- * `colour.primary.fill` for primary backgrounds that need to stand out
57
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
58
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
59
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
60
- * `colour.system.danger.fill` for error backgrounds that need to stand out
61
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
62
- * `colour.system.success.fill` for success backgrounds that need to stand out
63
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
64
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
65
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
66
- * `colour.system.info.fill` for info backgrounds that need to stand out
67
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
68
-
69
- ResponsiveProp<ColorToken> | undefined
70
-
71
- | \- | Set object |
72
- | borderRadius |
73
-
74
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
75
-
76
- | Chrome | Firefox | Safari | Edge | IE |
77
- | --- | --- | --- | --- | --- |
78
- | **4** | **4** | **5** | **12** | **9** |
79
- | 1 _\-x-_ | | 3 _\-x-_ | | |
80
-
81
- ResponsiveProp<RadiusToken> | undefined
82
-
83
- | \- | Set object |
84
- | children |
85
-
86
- Content of the radio group, usually multiple `IressRadio` components.
87
-
88
- ReactNode
89
-
90
-
91
-
92
- | \- | \- |
93
- | color |
94
-
95
- 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`.
96
-
97
- We recommend using the following token values for best color contrast:
98
-
99
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
100
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
101
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
102
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
103
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
104
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
105
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
106
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
107
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
108
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
109
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
110
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
111
-
112
- ResponsiveProp<ColorToken> | undefined
113
-
114
- | \- | Set object |
115
- | defaultValue |
116
-
117
- Initial value of radio group when in uncontrolled mode.
118
-
119
- Tundefined
120
-
121
-
122
-
123
- | \- | Set object |
124
- | focusable |
125
-
126
- 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.
127
-
128
- "true""within"undefined
129
-
130
-
131
-
132
- | \- | Set object |
133
- | hiddenRadio |
134
-
135
- Hides the radio control to allow the creation of custom radio buttons.
136
-
137
- booleanundefined
138
-
139
-
140
-
141
- | \- | Set object |
142
- | hide |
143
-
144
- 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.
145
-
146
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
147
-
148
- Notes:
149
-
150
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
151
- * Consider if you can conditionally render the element instead of hiding it.
152
-
153
- ResponsiveProp<boolean> | undefined
154
-
155
- | \- | Set object |
156
- | layerStyle |
157
-
158
- 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.
159
-
160
- * `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.
161
- * `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.
162
- * `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.
163
-
164
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
165
-
166
- | \- | Set object |
167
- | layout |
168
-
169
- Sets which of the block / inline layout options apply.
170
-
171
- "block""inline""stack""inlineFlex""inlineEqualWidth"undefined
172
-
173
-
174
-
175
- |
176
-
177
- stack
178
-
179
- | Set object |
180
- | m |
181
-
182
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
183
-
184
- 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.
185
-
186
- | Chrome | Firefox | Safari | Edge | IE |
187
- | --- | --- | --- | --- | --- |
188
- | **1** | **1** | **1** | **12** | **3** |
189
-
190
- ResponsiveProp<SpacingToken | "auto"> | undefined
191
-
192
- | \- | Set object |
193
- | maxWidth |
194
-
195
- 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`.
196
-
197
- | Chrome | Firefox | Safari | Edge | IE |
198
- | --- | --- | --- | --- | --- |
199
- | **1** | **1** | **1** | **12** | **7** |
200
-
201
- 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
202
-
203
- | \- | Set object |
204
- | mb |
205
-
206
- 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.
207
-
208
- It uses the spacing tokens in the design system.
209
-
210
- | Chrome | Firefox | Safari | Edge | IE |
211
- | --- | --- | --- | --- | --- |
212
- | **1** | **1** | **1** | **12** | **3** |
213
-
214
- ResponsiveProp<SpacingToken | "auto"> | undefined
215
-
216
- | \- | Set object |
217
- | ml |
218
-
219
- 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.
220
-
221
- It uses the spacing tokens in the design system.
222
-
223
- | Chrome | Firefox | Safari | Edge | IE |
224
- | --- | --- | --- | --- | --- |
225
- | **1** | **1** | **1** | **12** | **3** |
226
-
227
- ResponsiveProp<SpacingToken | "auto"> | undefined
228
-
229
- | \- | Set object |
230
- | mr |
231
-
232
- 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.
233
-
234
- It uses the spacing tokens in the design system.
235
-
236
- | Chrome | Firefox | Safari | Edge | IE |
237
- | --- | --- | --- | --- | --- |
238
- | **1** | **1** | **1** | **12** | **3** |
239
-
240
- ResponsiveProp<SpacingToken | "auto"> | undefined
241
-
242
- | \- | Set object |
243
- | mt |
244
-
245
- 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.
246
-
247
- It uses the spacing tokens in the design system.
248
-
249
- | Chrome | Firefox | Safari | Edge | IE |
250
- | --- | --- | --- | --- | --- |
251
- | **1** | **1** | **1** | **12** | **3** |
252
-
253
- ResponsiveProp<SpacingToken | "auto"> | undefined
254
-
255
- | \- | Set object |
256
- | mx |
257
-
258
- 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.
259
-
260
- 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.
261
-
262
- | Chrome | Firefox | Safari | Edge | IE |
263
- | --- | --- | --- | --- | --- |
264
- | **1** | **1** | **1** | **12** | **3** |
265
-
266
- ResponsiveProp<SpacingToken | "auto"> | undefined
267
-
268
- | \- | Set object |
269
- | my |
270
-
271
- 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.
272
-
273
- 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.
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
- | name |
283
-
284
- Name to be applied to all radios in the group.
285
-
286
- stringundefined
287
-
288
-
289
-
290
- | \- | Set object |
291
- | noGutter |
292
-
293
- 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.
294
-
295
- booleanundefined
296
-
297
-
298
-
299
- | \- | Set object |
300
- | onChange |
301
-
302
- Called when a user selects one of its children radio buttons. If you pass in a non-string value, you can access it using the second parameter of the function.
303
-
304
- ((e: ChangeEvent<HTMLInputElement>, value?: T | undefined) => void) | undefined
305
-
306
- | \- | \- |
307
- | p |
308
-
309
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
310
-
311
- 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.
312
-
313
- | Chrome | Firefox | Safari | Edge | IE |
314
- | --- | --- | --- | --- | --- |
315
- | **1** | **1** | **1** | **12** | **3** |
316
-
317
- 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
318
-
319
- | \- | Set object |
320
- | pb |
321
-
322
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
323
-
324
- 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.
325
-
326
- | Chrome | Firefox | Safari | Edge | IE |
327
- | --- | --- | --- | --- | --- |
328
- | **1** | **1** | **1** | **12** | **3** |
329
-
330
- 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
331
-
332
- | \- | Set object |
333
- | pl |
334
-
335
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
336
-
337
- 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.
338
-
339
- | Chrome | Firefox | Safari | Edge | IE |
340
- | --- | --- | --- | --- | --- |
341
- | **1** | **1** | **1** | **12** | **3** |
342
-
343
- 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
344
-
345
- | \- | Set object |
346
- | pr |
347
-
348
- The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
349
-
350
- 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.
351
-
352
- | Chrome | Firefox | Safari | Edge | IE |
353
- | --- | --- | --- | --- | --- |
354
- | **1** | **1** | **1** | **12** | **3** |
355
-
356
- 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
357
-
358
- | \- | Set object |
359
- | pt |
360
-
361
- The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
362
-
363
- 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.
364
-
365
- | Chrome | Firefox | Safari | Edge | IE |
366
- | --- | --- | --- | --- | --- |
367
- | **1** | **1** | **1** | **12** | **3** |
368
-
369
- 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
370
-
371
- | \- | Set object |
372
- | px |
373
-
374
- 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.
375
-
376
- 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.
377
-
378
- | Chrome | Firefox | Safari | Edge | IE |
379
- | --- | --- | --- | --- | --- |
380
- | **1** | **1** | **1** | **12** | **3** |
381
-
382
- 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
383
-
384
- | \- | Set object |
385
- | py |
386
-
387
- 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.
388
-
389
- 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.
390
-
391
- | Chrome | Firefox | Safari | Edge | IE |
392
- | --- | --- | --- | --- | --- |
393
- | **1** | **1** | **1** | **12** | **3** |
394
-
395
- 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
396
-
397
- | \- | Set object |
398
- | readOnly |
399
-
400
- Renders a readOnly radio group.
401
-
402
- booleanundefined
403
-
404
-
405
-
406
- | \- | Set object |
407
- | ref |
408
-
409
- Ref<RadioGroupRef> | undefined
410
-
411
- | \- | Set object |
412
- | required |
413
-
414
- When true, marks the field as required
415
-
416
- booleanundefined
417
-
418
-
419
-
420
- | \- | Set object |
421
- | rowGap |
422
-
423
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
424
-
425
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
426
-
427
- | Chrome | Firefox | Safari | Edge | IE |
428
- | --- | --- | --- | --- | --- |
429
- | **47** | **52** | **10.1** | **16** | No |
430
-
431
- 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
432
-
433
- | \- | Set object |
434
- | srOnly |
435
-
436
- 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.
437
-
438
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
439
-
440
- ResponsiveProp<boolean> | undefined
441
-
442
- | \- | Set object |
443
- | stretch |
444
-
445
- 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.
446
-
447
- booleanundefined
448
-
449
-
450
-
451
- | \- | Set object |
452
- | textAlign |
453
-
454
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
455
-
456
- | Chrome | Firefox | Safari | Edge | IE |
457
- | --- | --- | --- | --- | --- |
458
- | **1** | **1** | **1** | **12** | **3** |
459
-
460
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
461
-
462
- | \- | Set object |
463
- | textStyle |
464
-
465
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
466
-
467
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
468
- * `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.
469
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
470
- * `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.
471
- * `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.
472
- * `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.
473
- * `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.
474
- * `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.
475
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
476
-
477
- 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
478
-
479
- | \- | Set object |
480
- | touch |
481
-
482
- Add the button-like border and padding to radio when `touch` is true.
483
-
484
- booleanundefined
485
-
486
-
487
-
488
- | \- | Set object |
489
- | value |
490
-
491
- Value of radio group when in controlled mode.
492
-
493
- Tundefined
494
-
495
-
496
-
497
- | \- | Set object |
498
- | width |
499
-
500
- 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.
501
-
502
- 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.
503
-
504
- | Chrome | Firefox | Safari | Edge | IE |
505
- | --- | --- | --- | --- | --- |
506
- | **1** | **1** | **1** | **12** | **4** |
507
-
508
- 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
509
-
510
- | \- | Set object |
511
-
512
- [](#examples)Examples
513
- ---------------------
514
-
515
- ### [](#radio-children)Radio children
516
-
517
- Individual radio buttons can be passed directly into `IressRadioGroup`.
518
-
519
- **Note:** The `mapRadioGroupOptions` helper function, originally used to map options to `IressRadio` components, is now deprecated. Instead, you can use `array.map` to map the options to `IressRadio` components.
520
-
521
- Google
522
-
523
- Newspaper
524
-
525
- Friend
526
-
527
- Other
528
-
529
- Hide code
530
-
531
- \[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; }
532
-
533
- <IressRadioGroup\>
534
- <IressRadio value\="google"\>
535
- Google </IressRadio\>
536
- <IressRadio value\="newspaper"\>
537
- Newspaper </IressRadio\>
538
- <IressRadio value\="friend"\>
539
- Friend </IressRadio\>
540
- <IressRadio value\="other"\>
541
- Other </IressRadio\>
542
- </IressRadioGroup\>
543
-
544
- Copy
545
-
546
- ### [](#radio-selection)Radio selection
547
-
548
- The default checked state of the radio children should always be set using the `value` prop. Sometimes you may wish to use the `IressRadioGroup` as an "uncontrolled" component - for example, because you are using a third party form library that requires it. In this case, simply use `defaultValue` instead of `value`.
549
-
550
- **Note:** The `value` prop on the `IressRadioGroup` component will always override the `checked` state of the `IressRadio` children.
551
-
552
- Google
553
-
554
- Newspaper
555
-
556
- Friend
557
-
558
- Other
559
-
560
- Hide code
561
-
562
- \[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; }
563
-
564
- <IressRadioGroup defaultValue\="newspaper"\>
565
- <IressRadio value\="google"\>
566
- Google </IressRadio\>
567
- <IressRadio value\="newspaper"\>
568
- Newspaper </IressRadio\>
569
- <IressRadio value\="friend"\>
570
- Friend </IressRadio\>
571
- <IressRadio value\="other"\>
572
- Other </IressRadio\>
573
- </IressRadioGroup\>
574
-
575
- Copy
576
-
577
- ### [](#layout)Layout
578
-
579
- The layout prop controls how the radio group is displayed and can have three basic layouts:
580
-
581
- * **stack (Default):** Radio buttons are laid out vertically. Labels are only as wide as their text.
582
- * **block:** Same as Stack, but labels take up the full width of the container.
583
- * **inline:** Radio buttons are laid out horizontally. Labels are only as wide as their text.
584
- * **inlineFlex:** Radio buttons are laid out horizontally. The container is only as wide as its contents.
585
- * **inlineEqualWidth:** Radio buttons are laid out horizontally. Labels take up an equal amount of space in the container.
586
-
587
- Note:
588
- -----
589
-
590
- If using any of the inline\* props within a `Field` component, the `Field` also needs the inline prop to be set for the inline layouts to take effect.
591
-
592
- ### block (default)
593
-
594
- Google
595
-
596
- Newspaper
597
-
598
- Friend
599
-
600
- Other
601
-
602
- ### inline
603
-
604
- Google
605
-
606
- Newspaper
607
-
608
- Friend
609
-
610
- Other
611
-
612
- ### inlineEqualWidth
613
-
614
- Google
615
-
616
- Newspaper
617
-
618
- Friend
619
-
620
- Other
621
-
622
- ### inlineFlex
623
-
624
- Google
625
-
626
- Newspaper
627
-
628
- Friend
629
-
630
- Other
631
-
632
- ### stack
633
-
634
- Google
635
-
636
- Newspaper
637
-
638
- Friend
639
-
640
- Other
641
-
642
- Hide code
643
-
644
- \[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; }
645
-
646
- <IressStack gap\="md"\>
647
- <IressText\>
648
- <h3\>
649
- block (default) </h3\>
650
- <IressRadioGroup layout\="block"\>
651
- <IressRadio
652
- className\="\_addBorder\_1d00u\_70"
653
- value\="google"
654
- \>
655
- Google </IressRadio\>
656
- <IressRadio
657
- className\="\_addBorder\_1d00u\_70"
658
- value\="newspaper"
659
- \>
660
- Newspaper </IressRadio\>
661
- <IressRadio
662
- className\="\_addBorder\_1d00u\_70"
663
- value\="friend"
664
- \>
665
- Friend </IressRadio\>
666
- <IressRadio
667
- className\="\_addBorder\_1d00u\_70"
668
- value\="other"
669
- \>
670
- Other </IressRadio\>
671
- </IressRadioGroup\>
672
- </IressText\>
673
- <IressText\>
674
- <h3\>
675
- inline </h3\>
676
- <IressRadioGroup layout\="inline"\>
677
- <IressRadio
678
- className\="\_addBorder\_1d00u\_70"
679
- value\="google"
680
- \>
681
- Google </IressRadio\>
682
- <IressRadio
683
- className\="\_addBorder\_1d00u\_70"
684
- value\="newspaper"
685
- \>
686
- Newspaper </IressRadio\>
687
- <IressRadio
688
- className\="\_addBorder\_1d00u\_70"
689
- value\="friend"
690
- \>
691
- Friend </IressRadio\>
692
- <IressRadio
693
- className\="\_addBorder\_1d00u\_70"
694
- value\="other"
695
- \>
696
- Other </IressRadio\>
697
- </IressRadioGroup\>
698
- </IressText\>
699
- <IressText\>
700
- <h3\>
701
- inlineEqualWidth </h3\>
702
- <IressRadioGroup layout\="inlineEqualWidth"\>
703
- <IressRadio
704
- className\="\_addBorder\_1d00u\_70"
705
- value\="google"
706
- \>
707
- Google </IressRadio\>
708
- <IressRadio
709
- className\="\_addBorder\_1d00u\_70"
710
- value\="newspaper"
711
- \>
712
- Newspaper </IressRadio\>
713
- <IressRadio
714
- className\="\_addBorder\_1d00u\_70"
715
- value\="friend"
716
- \>
717
- Friend </IressRadio\>
718
- <IressRadio
719
- className\="\_addBorder\_1d00u\_70"
720
- value\="other"
721
- \>
722
- Other </IressRadio\>
723
- </IressRadioGroup\>
724
- </IressText\>
725
- <IressText\>
726
- <h3\>
727
- inlineFlex </h3\>
728
- <IressRadioGroup layout\="inlineFlex"\>
729
- <IressRadio
730
- className\="\_addBorder\_1d00u\_70"
731
- value\="google"
732
- \>
733
- Google </IressRadio\>
734
- <IressRadio
735
- className\="\_addBorder\_1d00u\_70"
736
- value\="newspaper"
737
- \>
738
- Newspaper </IressRadio\>
739
- <IressRadio
740
- className\="\_addBorder\_1d00u\_70"
741
- value\="friend"
742
- \>
743
- Friend </IressRadio\>
744
- <IressRadio
745
- className\="\_addBorder\_1d00u\_70"
746
- value\="other"
747
- \>
748
- Other </IressRadio\>
749
- </IressRadioGroup\>
750
- </IressText\>
751
- <IressText\>
752
- <h3\>
753
- stack </h3\>
754
- <IressRadioGroup layout\="stack"\>
755
- <IressRadio
756
- className\="\_addBorder\_1d00u\_70"
757
- value\="google"
758
- \>
759
- Google </IressRadio\>
760
- <IressRadio
761
- className\="\_addBorder\_1d00u\_70"
762
- value\="newspaper"
763
- \>
764
- Newspaper </IressRadio\>
765
- <IressRadio
766
- className\="\_addBorder\_1d00u\_70"
767
- value\="friend"
768
- \>
769
- Friend </IressRadio\>
770
- <IressRadio
771
- className\="\_addBorder\_1d00u\_70"
772
- value\="other"
773
- \>
774
- Other </IressRadio\>
775
- </IressRadioGroup\>
776
- </IressText\>
777
- </IressStack\>
778
-
779
- Copy
780
-
781
- ### [](#hidden-radio-buttons)Hidden radio buttons
782
-
783
- You can use the `hiddenRadio` prop to create custom radio buttons. When enabled, the actual radio button will be visually hidden, allowing you to create more interesting controls. The checked state will be shown by the label's border, which is thicker when the radio button is checked.
784
-
785
- When `hiddenRadio` is enabled, the label will have no padding. Padding can be added by using a Panel or utility classes.
786
-
787
- **I'd like to discuss the following in my financial review:**
788
-
789
- Select one option
790
-
791
- Buying my first home
792
-
793
- Saving for a holiday
794
-
795
- Reducing my debt
796
-
797
- Hide code
798
-
799
- \[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; }
800
-
801
- <IressField
802
- hint\="Select one option"
803
- label\="I'd like to discuss the following in my financial review:"
804
- \>
805
- <IressRadioGroup
806
- defaultValue\="home"
807
- hiddenRadio
808
- layout\="inline"
809
- required
810
- \>
811
- <IressRadio value\="home"\>
812
- <IressPanel
813
- bg\="transparent"
814
- p\="lg"
815
- textAlign\="center"
816
- \>
817
- <IressStack gap\="md"\>
818
- <IressIcon
819
- name\="house"
820
- textStyle\="typography.heading.1"
821
- />
822
- <IressText
823
- noGutter
824
- textStyle\="typography.heading.4"
825
- \>
826
- Buying my first home </IressText\>
827
- </IressStack\>
828
- </IressPanel\>
829
- </IressRadio\>
830
- <IressRadio value\="holiday"\>
831
- <IressPanel
832
- bg\="transparent"
833
- p\="lg"
834
- textAlign\="center"
835
- \>
836
- <IressStack gap\="md"\>
837
- <IressIcon
838
- name\="mountain"
839
- textStyle\="typography.heading.1"
840
- />
841
- <IressText
842
- noGutter
843
- textStyle\="typography.heading.4"
844
- \>
845
- Saving for a holiday </IressText\>
846
- </IressStack\>
847
- </IressPanel\>
848
- </IressRadio\>
849
- <IressRadio value\="debt"\>
850
- <IressPanel
851
- bg\="transparent"
852
- p\="lg"
853
- textAlign\="center"
854
- \>
855
- <IressStack gap\="md"\>
856
- <IressIcon
857
- name\="credit-card"
858
- textStyle\="typography.heading.1"
859
- />
860
- <IressText
861
- noGutter
862
- textStyle\="typography.heading.4"
863
- \>
864
- Reducing my debt </IressText\>
865
- </IressStack\>
866
- </IressPanel\>
867
- </IressRadio\>
868
- </IressRadioGroup\>
869
- </IressField\>
870
-
871
- Copy
872
-
873
- ### [](#laying-out-custom-radio-buttons)Laying out custom radio buttons
874
-
875
- The radio group's `layout` prop gives you some default options to help control the layout of your controls. But sometimes you need more granular control, which you can achieve with a bit of custom CSS.
876
-
877
- The example below uses CSS grid to give us evenly spaced / sized radio buttons, which will wrap on to new lines as the screen size reduces. The grid wrapper element is a div that wraps around the `<IressRadio />` elements, as shown by the dashed border. Use the grab handle in the bottom right-hand corner of the grid wrapper to see how the controls change size to respond to the container's width.
878
-
879
- **I'd like to discuss the following in my financial review:**
880
-
881
- Select one option
882
-
883
- Retirement
884
-
885
- Buying my first home
886
-
887
- Saving for a holiday
888
-
889
- Saving for my child's education
890
-
891
- Saving for emergency
892
-
893
- Spending more time on my hobbies
894
-
895
- Reducing my debt
896
-
897
- Starting a business
898
-
899
- Hide code
900
-
901
- \[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; }
902
-
903
- <IressField
904
- hint\="Select one option"
905
- label\="I'd like to discuss the following in my financial review:"
906
- \>
907
- <IressRadioGroup
908
- hiddenRadio
909
- layout\="block"
910
- name\="financial-review"
911
- required
912
- \>
913
- <div
914
- className\="\_resizable\_1d00u\_78"
915
- style\={{
916
- display: 'grid',
917
- gridAutoRows: '1fr',
918
- gridGap: '0.75rem',
919
- gridTemplateColumns: 'repeat(auto-fit, minmax(240px, 1fr))',
920
- padding: '0.5rem',
921
- width: '100%'
922
- }}
923
- \>
924
- <IressRadio value\="retirement"\>
925
- <IressPanel
926
- bg\="transparent"
927
- p\="lg"
928
- textAlign\="center"
929
- \>
930
- <IressStack gap\="md"\>
931
- <IressIcon
932
- name\="tree-palm"
933
- textStyle\="typography.heading.1"
934
- />
935
- <IressText
936
- noGutter
937
- textStyle\="typography.heading.4"
938
- \>
939
- Retirement </IressText\>
940
- </IressStack\>
941
- </IressPanel\>
942
- </IressRadio\>
943
- <IressRadio value\="home"\>
944
- <IressPanel
945
- bg\="transparent"
946
- p\="lg"
947
- textAlign\="center"
948
- \>
949
- <IressStack gap\="md"\>
950
- <IressIcon
951
- name\="house"
952
- textStyle\="typography.heading.1"
953
- />
954
- <IressText
955
- noGutter
956
- textStyle\="typography.heading.4"
957
- \>
958
- Buying my first home </IressText\>
959
- </IressStack\>
960
- </IressPanel\>
961
- </IressRadio\>
962
- <IressRadio value\="holiday"\>
963
- <IressPanel
964
- bg\="transparent"
965
- p\="lg"
966
- textAlign\="center"
967
- \>
968
- <IressStack gap\="md"\>
969
- <IressIcon
970
- name\="mountain"
971
- textStyle\="typography.heading.1"
972
- />
973
- <IressText
974
- noGutter
975
- textStyle\="typography.heading.4"
976
- \>
977
- Saving for a holiday </IressText\>
978
- </IressStack\>
979
- </IressPanel\>
980
- </IressRadio\>
981
- <IressRadio value\="education"\>
982
- <IressPanel
983
- bg\="transparent"
984
- p\="lg"
985
- textAlign\="center"
986
- \>
987
- <IressStack gap\="md"\>
988
- <IressIcon
989
- name\="graduation-cap"
990
- textStyle\="typography.heading.1"
991
- />
992
- <IressText
993
- noGutter
994
- textStyle\="typography.heading.4"
995
- \>
996
- Saving for my child's education </IressText\>
997
- </IressStack\>
998
- </IressPanel\>
999
- </IressRadio\>
1000
- <IressRadio value\="emergency"\>
1001
- <IressPanel
1002
- bg\="transparent"
1003
- p\="lg"
1004
- textAlign\="center"
1005
- \>
1006
- <IressStack gap\="md"\>
1007
- <IressIcon
1008
- name\="medkit"
1009
- textStyle\="typography.heading.1"
1010
- />
1011
- <IressText
1012
- noGutter
1013
- textStyle\="typography.heading.4"
1014
- \>
1015
- Saving for emergency </IressText\>
1016
- </IressStack\>
1017
- </IressPanel\>
1018
- </IressRadio\>
1019
- <IressRadio value\="hobby"\>
1020
- <IressPanel
1021
- bg\="transparent"
1022
- p\="lg"
1023
- textAlign\="center"
1024
- \>
1025
- <IressStack gap\="md"\>
1026
- <IressIcon
1027
- name\="bicycle"
1028
- textStyle\="typography.heading.1"
1029
- />
1030
- <IressText
1031
- noGutter
1032
- textStyle\="typography.heading.4"
1033
- \>
1034
- Spending more time on my hobbies </IressText\>
1035
- </IressStack\>
1036
- </IressPanel\>
1037
- </IressRadio\>
1038
- <IressRadio value\="debt"\>
1039
- <IressPanel
1040
- bg\="transparent"
1041
- p\="lg"
1042
- textAlign\="center"
1043
- \>
1044
- <IressStack gap\="md"\>
1045
- <IressIcon
1046
- name\="chart-line-down"
1047
- textStyle\="typography.heading.1"
1048
- />
1049
- <IressText
1050
- noGutter
1051
- textStyle\="typography.heading.4"
1052
- \>
1053
- Reducing my debt </IressText\>
1054
- </IressStack\>
1055
- </IressPanel\>
1056
- </IressRadio\>
1057
- <IressRadio value\="business"\>
1058
- <IressPanel
1059
- bg\="transparent"
1060
- p\="lg"
1061
- textAlign\="center"
1062
- \>
1063
- <IressStack gap\="md"\>
1064
- <IressIcon
1065
- name\="user-tie"
1066
- textStyle\="typography.heading.1"
1067
- />
1068
- <IressText
1069
- noGutter
1070
- textStyle\="typography.heading.4"
1071
- \>
1072
- Starting a business </IressText\>
1073
- </IressStack\>
1074
- </IressPanel\>
1075
- </IressRadio\>
1076
- </div\>
1077
- </IressRadioGroup\>
1078
- </IressField\>
1079
-
1080
- Copy
1081
-
1082
- ### [](#read-only)Read only
1083
-
1084
- The `readOnly` prop changes how the radio group is rendered. It will only render if the children radio that is checked (alongside a hidden input that contains the `value` if it was set), otherwise it will not be rendered.
1085
-
1086
- It is understandable that this may not be the desired behavior for all use cases. If you need a radio group that is not editable, but still visible, simply do not set the `readOnly` prop and set the `value` prop instead.
1087
-
1088
- Newspaper
1089
-
1090
- Hide code
1091
-
1092
- \[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; }
1093
-
1094
- <IressRadioGroup
1095
- defaultValue\="newspaper"
1096
- readOnly
1097
- \>
1098
- <IressRadio value\="google"\>
1099
- Google </IressRadio\>
1100
- <IressRadio value\="newspaper"\>
1101
- Newspaper </IressRadio\>
1102
- <IressRadio value\="friend"\>
1103
- Friend </IressRadio\>
1104
- <IressRadio value\="other"\>
1105
- Other </IressRadio\>
1106
- </IressRadioGroup\>
1107
-
1108
- Copy
1109
-
1110
- ### [](#touch)Touch
1111
-
1112
- The `touch` prop adds the button-like border and padding to radio.
1113
-
1114
- Google
1115
-
1116
- Newspaper
1117
-
1118
- Friend
1119
-
1120
- Other
1121
-
1122
- Hide code
1123
-
1124
- \[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; }
1125
-
1126
- <IressRadioGroup
1127
- defaultValue\="newspaper"
1128
- touch
1129
- \>
1130
- <IressRadio value\="google"\>
1131
- Google </IressRadio\>
1132
- <IressRadio value\="newspaper"\>
1133
- Newspaper </IressRadio\>
1134
- <IressRadio value\="friend"\>
1135
- Friend </IressRadio\>
1136
- <IressRadio value\="other"\>
1137
- Other </IressRadio\>
1138
- </IressRadioGroup\>
1139
-
1140
- Copy
1141
-
1142
- On this page
1143
-
1144
- * [Overview](#overview)
1145
- * [Props](#props)
1146
- * [Examples](#examples)
1147
- * [Radio children](#radio-children)
1148
- * [Radio selection](#radio-selection)
1149
- * [Layout](#layout)
1150
- * [Hidden radio buttons](#hidden-radio-buttons)
1151
- * [Laying out custom radio buttons](#laying-out-custom-radio-buttons)
1152
- * [Read only](#read-only)
1153
- * [Touch](#touch)