@iress-oss/ids-mcp-server 5.15.0 → 5.20.1
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.
- package/generated/docs/components_components-alert-docs.md +492 -0
- package/generated/docs/components_components-autocomplete-docs.md +3485 -0
- package/generated/docs/{components-autocomplete-recipes-docs.md → components_components-autocomplete-recipes-docs.md} +32 -14
- package/generated/docs/{components-badge-docs.md → components_components-badge-docs.md} +222 -30
- package/generated/docs/components_components-button-docs.md +2078 -0
- package/generated/docs/components_components-button-recipes-docs.md +37 -0
- package/generated/docs/components_components-buttongroup-docs.md +1045 -0
- package/generated/docs/components_components-card-docs.md +2276 -0
- package/generated/docs/{components-card-recipes-docs.md → components_components-card-recipes-docs.md} +131 -14
- package/generated/docs/components_components-checkbox-docs.md +1054 -0
- package/generated/docs/{components-checkboxgroup-docs.md → components_components-checkboxgroup-docs.md} +1000 -81
- package/generated/docs/{components-checkboxgroup-recipes-docs.md → components_components-checkboxgroup-recipes-docs.md} +101 -11
- package/generated/docs/{components-col-docs.md → components_components-col-docs.md} +331 -58
- package/generated/docs/components_components-combobox-docs.md +3767 -0
- package/generated/docs/{components-container-docs.md → components_components-container-docs.md} +61 -24
- package/generated/docs/{components-divider-docs.md → components_components-divider-docs.md} +83 -24
- package/generated/docs/{components-expander-docs.md → components_components-expander-docs.md} +264 -33
- package/generated/docs/{components-field-docs.md → components_components-field-docs.md} +814 -120
- package/generated/docs/components_components-filter-docs.md +4080 -0
- package/generated/docs/{components-form-docs.md → components_components-form-docs.md} +1515 -353
- package/generated/docs/{components-form-recipes-docs.md → components_components-form-recipes-docs.md} +170 -54
- package/generated/docs/components_components-hide-docs.md +293 -0
- package/generated/docs/components_components-icon-docs.md +1337 -0
- package/generated/docs/{components-inline-docs.md → components_components-inline-docs.md} +462 -42
- package/generated/docs/components_components-input-docs.md +1468 -0
- package/generated/docs/components_components-input-recipes-docs.md +367 -0
- package/generated/docs/components_components-inputcurrency-docs.md +432 -0
- package/generated/docs/{components-inputcurrency-recipes-docs.md → components_components-inputcurrency-recipes-docs.md} +110 -17
- package/generated/docs/components_components-label-docs.md +323 -0
- package/generated/docs/components_components-menu-docs.md +2345 -0
- package/generated/docs/components_components-menu-menuitem-docs.md +633 -0
- package/generated/docs/{components-modal-docs.md → components_components-modal-docs.md} +1625 -232
- package/generated/docs/components_components-navbar-docs.md +1847 -0
- package/generated/docs/{components-navbar-recipes-docs.md → components_components-navbar-recipes-docs.md} +697 -39
- package/generated/docs/{components-panel-docs.md → components_components-panel-docs.md} +754 -57
- package/generated/docs/components_components-placeholder-docs.md +92 -0
- package/generated/docs/components_components-popover-docs.md +1641 -0
- package/generated/docs/{components-popover-recipes-docs.md → components_components-popover-recipes-docs.md} +347 -17
- package/generated/docs/components_components-progress-docs.md +115 -0
- package/generated/docs/{components-provider-docs.md → components_components-provider-docs.md} +41 -32
- package/generated/docs/components_components-radio-docs.md +491 -0
- package/generated/docs/{components-radiogroup-docs.md → components_components-radiogroup-docs.md} +943 -75
- package/generated/docs/components_components-readonly-docs.md +263 -0
- package/generated/docs/components_components-richselect-docs.md +6497 -0
- package/generated/docs/{components-row-docs.md → components_components-row-docs.md} +353 -43
- package/generated/docs/{components-select-docs.md → components_components-select-docs.md} +719 -61
- package/generated/docs/components_components-skeleton-docs.md +480 -0
- package/generated/docs/{components-skeleton-recipes-docs.md → components_components-skeleton-recipes-docs.md} +50 -10
- package/generated/docs/{components-skiplink-docs.md → components_components-skiplink-docs.md} +53 -14
- package/generated/docs/components_components-slideout-docs.md +2262 -0
- package/generated/docs/components_components-slider-docs.md +1276 -0
- package/generated/docs/components_components-spinner-docs.md +82 -0
- package/generated/docs/{components-stack-docs.md → components_components-stack-docs.md} +223 -40
- package/generated/docs/components_components-table-docs.md +3651 -0
- package/generated/docs/components_components-tabset-docs.md +772 -0
- package/generated/docs/components_components-tabset-tab-docs.md +262 -0
- package/generated/docs/components_components-tag-docs.md +259 -0
- package/generated/docs/{components-text-docs.md → components_components-text-docs.md} +491 -51
- package/generated/docs/{components-toaster-docs.md → components_components-toaster-docs.md} +181 -79
- package/generated/docs/components_components-toaster-toast-docs.md +634 -0
- package/generated/docs/components_components-toggle-docs.md +461 -0
- package/generated/docs/{components-tooltip-docs.md → components_components-tooltip-docs.md} +286 -41
- package/generated/docs/{components-validationmessage-docs.md → components_components-validationmessage-docs.md} +230 -61
- package/generated/docs/components_contact-us-docs.md +12 -0
- package/generated/docs/{foundations-accessibility-docs.md → components_foundations-accessibility-docs.md} +11 -21
- package/generated/docs/{foundations-colours-docs.md → components_foundations-colour-030-colours.md} +8 -15
- package/generated/docs/{foundations-consistency-docs.md → components_foundations-consistency-docs.md} +12 -20
- package/generated/docs/{foundations-content-docs.md → components_foundations-content-docs.md} +6 -11
- package/generated/docs/components_foundations-introduction-docs.md +15 -0
- package/generated/docs/{foundations-principles-docs.md → components_foundations-principles-docs.md} +14 -24
- package/generated/docs/components_foundations-typography-docs.md +608 -0
- package/generated/docs/{foundations-user-experience-docs.md → components_foundations-user-experience-docs.md} +16 -26
- package/generated/docs/{foundations-visual-design-docs.md → components_foundations-visual-design-docs.md} +10 -17
- package/generated/docs/{frequently-asked-questions-docs.md → components_frequently-asked-questions-docs.md} +14 -23
- package/generated/docs/components_get-started-develop-docs.md +84 -0
- package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
- package/generated/docs/components_introduction-docs.md +15 -0
- package/generated/docs/{patterns-loading-docs.md → components_patterns-loading-docs.md} +711 -143
- package/generated/docs/components_resources-changelog-docs.md +4 -0
- package/generated/docs/{resources-code-katas-docs.md → components_resources-code-katas-docs.md} +5 -9
- package/generated/docs/{resources-migration-guides-from-v4-to-v5-docs.md → components_resources-migration-guides-from-v4-to-v5-docs.md} +54 -239
- package/generated/docs/{versions-docs.md → components_versions-docs.md} +5 -8
- package/generated/docs/guidelines.md +484 -200
- package/generated/docs/introduction-docs.md +19 -30
- package/package.json +41 -45
- package/generated/docs/components-alert-docs.md +0 -130
- package/generated/docs/components-autocomplete-docs.md +0 -754
- package/generated/docs/components-button-docs.md +0 -362
- package/generated/docs/components-button-recipes-docs.md +0 -76
- package/generated/docs/components-buttongroup-docs.md +0 -310
- package/generated/docs/components-card-docs.md +0 -494
- package/generated/docs/components-checkbox-docs.md +0 -193
- package/generated/docs/components-combobox-docs.md +0 -1016
- package/generated/docs/components-filter-docs.md +0 -1109
- package/generated/docs/components-hide-docs.md +0 -265
- package/generated/docs/components-icon-docs.md +0 -553
- package/generated/docs/components-input-docs.md +0 -335
- package/generated/docs/components-input-recipes-docs.md +0 -140
- package/generated/docs/components-inputcurrency-docs.md +0 -157
- package/generated/docs/components-label-docs.md +0 -135
- package/generated/docs/components-menu-docs.md +0 -704
- package/generated/docs/components-menu-menuitem-docs.md +0 -193
- package/generated/docs/components-navbar-docs.md +0 -291
- package/generated/docs/components-placeholder-docs.md +0 -27
- package/generated/docs/components-popover-docs.md +0 -464
- package/generated/docs/components-progress-docs.md +0 -104
- package/generated/docs/components-radio-docs.md +0 -107
- package/generated/docs/components-readonly-docs.md +0 -89
- package/generated/docs/components-richselect-docs.md +0 -2433
- package/generated/docs/components-skeleton-docs.md +0 -214
- package/generated/docs/components-slideout-docs.md +0 -538
- package/generated/docs/components-slider-docs.md +0 -346
- package/generated/docs/components-spinner-docs.md +0 -59
- package/generated/docs/components-table-ag-grid-docs.md +0 -1074
- package/generated/docs/components-table-docs.md +0 -1305
- package/generated/docs/components-tabset-docs.md +0 -341
- package/generated/docs/components-tabset-tab-docs.md +0 -86
- package/generated/docs/components-tag-docs.md +0 -115
- package/generated/docs/components-toaster-toast-docs.md +0 -157
- package/generated/docs/components-toggle-docs.md +0 -158
- package/generated/docs/contact-us-docs.md +0 -27
- package/generated/docs/extensions-editor-docs.md +0 -288
- package/generated/docs/extensions-editor-recipes-docs.md +0 -39
- package/generated/docs/foundations-introduction-docs.md +0 -17
- package/generated/docs/foundations-typography-docs.md +0 -191
- package/generated/docs/get-started-develop-docs.md +0 -209
- package/generated/docs/get-started-using-storybook-docs.md +0 -68
- package/generated/docs/resources-changelog-docs.md +0 -6
- package/generated/docs/themes-available-themes-docs.md +0 -66
- package/generated/docs/themes-introduction-docs.md +0 -121
- package/generated/docs/themes-tokens-docs.md +0 -1200
- /package/{LICENSE.txt → LICENSE} +0 -0
package/generated/docs/{components-radiogroup-docs.md → components_components-radiogroup-docs.md}
RENAMED
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
RadioGroup
|
|
2
|
+
==========
|
|
3
3
|
|
|
4
4
|
Overview
|
|
5
5
|
--------
|
|
6
6
|
|
|
7
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
8
|
|
|
9
|
+
[](./iframe.html?id=components-radiogroup--radio-children)
|
|
10
|
+
|
|
9
11
|
Google
|
|
10
12
|
|
|
11
13
|
Newspaper
|
|
@@ -14,9 +16,7 @@ Friend
|
|
|
14
16
|
|
|
15
17
|
Other
|
|
16
18
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
\[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; }
|
|
19
|
+
```
|
|
20
20
|
|
|
21
21
|
<IressRadioGroup\>
|
|
22
22
|
<IressRadio value\="google"\>
|
|
@@ -29,17 +29,127 @@ Hide code
|
|
|
29
29
|
Other </IressRadio\>
|
|
30
30
|
</IressRadioGroup\>
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Props
|
|
35
|
+
-----
|
|
36
|
+
|
|
37
|
+
IressRadioGroupIressRadio
|
|
38
|
+
|
|
39
|
+
Tabs
|
|
40
|
+
|
|
41
|
+
| Name | Description | Default | Control |
|
|
42
|
+
| --- | --- | --- | --- |
|
|
43
|
+
| children |
|
|
44
|
+
Content of the radio group, usually multiple `IressRadio` components.
|
|
45
|
+
|
|
46
|
+
ReactNode
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
| \- | \- |
|
|
51
|
+
| defaultValue |
|
|
52
|
+
|
|
53
|
+
Initial value of radio group when in uncontrolled mode.
|
|
54
|
+
|
|
55
|
+
FormControlValue
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
| \- | Set object |
|
|
60
|
+
| hiddenRadio |
|
|
61
|
+
|
|
62
|
+
Hides the radio control to allow the creation of custom radio buttons.
|
|
63
|
+
|
|
64
|
+
boolean
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
| \- | Set boolean |
|
|
69
|
+
| layout |
|
|
70
|
+
|
|
71
|
+
Sets which of the block / inline layout options apply.
|
|
72
|
+
|
|
73
|
+
union
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
|
78
|
+
|
|
79
|
+
'stack'
|
|
80
|
+
|
|
81
|
+
| Set object |
|
|
82
|
+
| name |
|
|
83
|
+
|
|
84
|
+
Name to be applied to all radios in the group.
|
|
85
|
+
|
|
86
|
+
string
|
|
33
87
|
|
|
34
|
-
[](#examples)Examples
|
|
35
|
-
---------------------
|
|
36
88
|
|
|
37
|
-
|
|
89
|
+
|
|
90
|
+
| \- | Set string |
|
|
91
|
+
| onChange |
|
|
92
|
+
|
|
93
|
+
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.
|
|
94
|
+
|
|
95
|
+
( e: React.ChangeEvent<HTMLInputElement>, value?: FormControlValue, ) => void
|
|
96
|
+
|
|
97
|
+
| \- | \- |
|
|
98
|
+
| readonly |
|
|
99
|
+
|
|
100
|
+
Renders a readonly radio group.
|
|
101
|
+
|
|
102
|
+
boolean
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
| \- | Set boolean |
|
|
107
|
+
| required |
|
|
108
|
+
|
|
109
|
+
When true, marks the field as required
|
|
110
|
+
|
|
111
|
+
boolean
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
| \- | Set boolean |
|
|
116
|
+
| role |
|
|
117
|
+
|
|
118
|
+
|
|
|
119
|
+
|
|
120
|
+
'radiogroup'
|
|
121
|
+
|
|
122
|
+
| Set object |
|
|
123
|
+
| touch |
|
|
124
|
+
|
|
125
|
+
Add the button-like border and padding to radio when `touch` is true.
|
|
126
|
+
|
|
127
|
+
boolean
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
| \- | Set boolean |
|
|
132
|
+
| value |
|
|
133
|
+
|
|
134
|
+
Value of radio group when in controlled mode.
|
|
135
|
+
|
|
136
|
+
FormControlValue
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
| \- | Set object |
|
|
141
|
+
|
|
142
|
+
Examples
|
|
143
|
+
--------
|
|
144
|
+
|
|
145
|
+
### Radio children
|
|
38
146
|
|
|
39
147
|
Individual radio buttons can be passed directly into `IressRadioGroup`.
|
|
40
148
|
|
|
41
149
|
**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.
|
|
42
150
|
|
|
151
|
+
[](./iframe.html?id=components-radiogroup--radio-children)
|
|
152
|
+
|
|
43
153
|
Google
|
|
44
154
|
|
|
45
155
|
Newspaper
|
|
@@ -48,9 +158,7 @@ Friend
|
|
|
48
158
|
|
|
49
159
|
Other
|
|
50
160
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
\[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; }
|
|
161
|
+
```
|
|
54
162
|
|
|
55
163
|
<IressRadioGroup\>
|
|
56
164
|
<IressRadio value\="google"\>
|
|
@@ -63,14 +171,123 @@ Hide code
|
|
|
63
171
|
Other </IressRadio\>
|
|
64
172
|
</IressRadioGroup\>
|
|
65
173
|
|
|
66
|
-
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
#### Props
|
|
177
|
+
|
|
178
|
+
IressRadioGroupIressRadio
|
|
179
|
+
|
|
180
|
+
Tabs
|
|
181
|
+
|
|
182
|
+
| Name | Description | Default | Control |
|
|
183
|
+
| --- | --- | --- | --- |
|
|
184
|
+
| children |
|
|
185
|
+
Content of the radio group, usually multiple `IressRadio` components.
|
|
186
|
+
|
|
187
|
+
ReactNode
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
| \- | \- |
|
|
192
|
+
| defaultValue |
|
|
193
|
+
|
|
194
|
+
Initial value of radio group when in uncontrolled mode.
|
|
195
|
+
|
|
196
|
+
FormControlValue
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
| \- | Set object |
|
|
201
|
+
| hiddenRadio |
|
|
202
|
+
|
|
203
|
+
Hides the radio control to allow the creation of custom radio buttons.
|
|
204
|
+
|
|
205
|
+
boolean
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
| \- | Set boolean |
|
|
210
|
+
| layout |
|
|
211
|
+
|
|
212
|
+
Sets which of the block / inline layout options apply.
|
|
213
|
+
|
|
214
|
+
union
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
|
219
|
+
|
|
220
|
+
'stack'
|
|
221
|
+
|
|
222
|
+
| Set object |
|
|
223
|
+
| name |
|
|
224
|
+
|
|
225
|
+
Name to be applied to all radios in the group.
|
|
226
|
+
|
|
227
|
+
string
|
|
228
|
+
|
|
67
229
|
|
|
68
|
-
|
|
230
|
+
|
|
231
|
+
| \- | Set string |
|
|
232
|
+
| onChange |
|
|
233
|
+
|
|
234
|
+
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.
|
|
235
|
+
|
|
236
|
+
( e: React.ChangeEvent<HTMLInputElement>, value?: FormControlValue, ) => void
|
|
237
|
+
|
|
238
|
+
| \- | \- |
|
|
239
|
+
| readonly |
|
|
240
|
+
|
|
241
|
+
Renders a readonly radio group.
|
|
242
|
+
|
|
243
|
+
boolean
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
| \- | Set boolean |
|
|
248
|
+
| required |
|
|
249
|
+
|
|
250
|
+
When true, marks the field as required
|
|
251
|
+
|
|
252
|
+
boolean
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
| \- | Set boolean |
|
|
257
|
+
| role |
|
|
258
|
+
|
|
259
|
+
|
|
|
260
|
+
|
|
261
|
+
'radiogroup'
|
|
262
|
+
|
|
263
|
+
| Set object |
|
|
264
|
+
| touch |
|
|
265
|
+
|
|
266
|
+
Add the button-like border and padding to radio when `touch` is true.
|
|
267
|
+
|
|
268
|
+
boolean
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
| \- | Set boolean |
|
|
273
|
+
| value |
|
|
274
|
+
|
|
275
|
+
Value of radio group when in controlled mode.
|
|
276
|
+
|
|
277
|
+
FormControlValue
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
| \- | Set object |
|
|
282
|
+
|
|
283
|
+
### Radio selection
|
|
69
284
|
|
|
70
285
|
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`.
|
|
71
286
|
|
|
72
287
|
**Note:** The `value` prop on the `IressRadioGroup` component will always override the `checked` state of the `IressRadio` children.
|
|
73
288
|
|
|
289
|
+
[](./iframe.html?id=components-radiogroup--radio-selection)
|
|
290
|
+
|
|
74
291
|
Google
|
|
75
292
|
|
|
76
293
|
Newspaper
|
|
@@ -79,9 +296,7 @@ Friend
|
|
|
79
296
|
|
|
80
297
|
Other
|
|
81
298
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
\[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; }
|
|
299
|
+
```
|
|
85
300
|
|
|
86
301
|
<IressRadioGroup defaultValue\="newspaper"\>
|
|
87
302
|
<IressRadio value\="google"\>
|
|
@@ -94,9 +309,120 @@ Hide code
|
|
|
94
309
|
Other </IressRadio\>
|
|
95
310
|
</IressRadioGroup\>
|
|
96
311
|
|
|
97
|
-
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
#### Props
|
|
315
|
+
|
|
316
|
+
IressRadioGroupIressRadio
|
|
317
|
+
|
|
318
|
+
Tabs
|
|
319
|
+
|
|
320
|
+
| Name | Description | Default | Control |
|
|
321
|
+
| --- | --- | --- | --- |
|
|
322
|
+
| children |
|
|
323
|
+
Content of the radio group, usually multiple `IressRadio` components.
|
|
324
|
+
|
|
325
|
+
ReactNode
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
| \- | \- |
|
|
330
|
+
| defaultValue |
|
|
331
|
+
|
|
332
|
+
Initial value of radio group when in uncontrolled mode.
|
|
333
|
+
|
|
334
|
+
FormControlValue
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
| \- |
|
|
339
|
+
|
|
340
|
+
"newspaper"
|
|
341
|
+
|
|
342
|
+
|
|
|
343
|
+
| hiddenRadio |
|
|
344
|
+
|
|
345
|
+
Hides the radio control to allow the creation of custom radio buttons.
|
|
346
|
+
|
|
347
|
+
boolean
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
| \- | Set boolean |
|
|
352
|
+
| layout |
|
|
353
|
+
|
|
354
|
+
Sets which of the block / inline layout options apply.
|
|
355
|
+
|
|
356
|
+
union
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
|
361
|
+
|
|
362
|
+
'stack'
|
|
363
|
+
|
|
364
|
+
| Set object |
|
|
365
|
+
| name |
|
|
366
|
+
|
|
367
|
+
Name to be applied to all radios in the group.
|
|
368
|
+
|
|
369
|
+
string
|
|
98
370
|
|
|
99
|
-
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
| \- | Set string |
|
|
374
|
+
| onChange |
|
|
375
|
+
|
|
376
|
+
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.
|
|
377
|
+
|
|
378
|
+
( e: React.ChangeEvent<HTMLInputElement>, value?: FormControlValue, ) => void
|
|
379
|
+
|
|
380
|
+
| \- | \- |
|
|
381
|
+
| readonly |
|
|
382
|
+
|
|
383
|
+
Renders a readonly radio group.
|
|
384
|
+
|
|
385
|
+
boolean
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
| \- | Set boolean |
|
|
390
|
+
| required |
|
|
391
|
+
|
|
392
|
+
When true, marks the field as required
|
|
393
|
+
|
|
394
|
+
boolean
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
| \- | Set boolean |
|
|
399
|
+
| role |
|
|
400
|
+
|
|
401
|
+
|
|
|
402
|
+
|
|
403
|
+
'radiogroup'
|
|
404
|
+
|
|
405
|
+
| Set object |
|
|
406
|
+
| touch |
|
|
407
|
+
|
|
408
|
+
Add the button-like border and padding to radio when `touch` is true.
|
|
409
|
+
|
|
410
|
+
boolean
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
| \- | Set boolean |
|
|
415
|
+
| value |
|
|
416
|
+
|
|
417
|
+
Value of radio group when in controlled mode.
|
|
418
|
+
|
|
419
|
+
FormControlValue
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
| \- | Set object |
|
|
424
|
+
|
|
425
|
+
### Layout
|
|
100
426
|
|
|
101
427
|
The layout prop controls how the radio group is displayed and can have three basic layouts:
|
|
102
428
|
|
|
@@ -111,6 +437,8 @@ Note:
|
|
|
111
437
|
|
|
112
438
|
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.
|
|
113
439
|
|
|
440
|
+
[](./iframe.html?id=components-radiogroup--layout)
|
|
441
|
+
|
|
114
442
|
### stack
|
|
115
443
|
|
|
116
444
|
Google
|
|
@@ -161,9 +489,7 @@ Friend
|
|
|
161
489
|
|
|
162
490
|
Other
|
|
163
491
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
\[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; }
|
|
492
|
+
```
|
|
167
493
|
|
|
168
494
|
<IressText className\="iress-u-stack iress--gutter--lg"\>
|
|
169
495
|
<div\>
|
|
@@ -171,22 +497,22 @@ Hide code
|
|
|
171
497
|
stack </h3\>
|
|
172
498
|
<IressRadioGroup layout\="stack"\>
|
|
173
499
|
<IressRadio
|
|
174
|
-
className\="ids-styles--add-border-
|
|
500
|
+
className\="ids-styles--add-border-v5202"
|
|
175
501
|
value\="google"
|
|
176
502
|
\>
|
|
177
503
|
Google </IressRadio\>
|
|
178
504
|
<IressRadio
|
|
179
|
-
className\="ids-styles--add-border-
|
|
505
|
+
className\="ids-styles--add-border-v5202"
|
|
180
506
|
value\="newspaper"
|
|
181
507
|
\>
|
|
182
508
|
Newspaper </IressRadio\>
|
|
183
509
|
<IressRadio
|
|
184
|
-
className\="ids-styles--add-border-
|
|
510
|
+
className\="ids-styles--add-border-v5202"
|
|
185
511
|
value\="friend"
|
|
186
512
|
\>
|
|
187
513
|
Friend </IressRadio\>
|
|
188
514
|
<IressRadio
|
|
189
|
-
className\="ids-styles--add-border-
|
|
515
|
+
className\="ids-styles--add-border-v5202"
|
|
190
516
|
value\="other"
|
|
191
517
|
\>
|
|
192
518
|
Other </IressRadio\>
|
|
@@ -197,22 +523,22 @@ Hide code
|
|
|
197
523
|
block </h3\>
|
|
198
524
|
<IressRadioGroup layout\="block"\>
|
|
199
525
|
<IressRadio
|
|
200
|
-
className\="ids-styles--add-border-
|
|
526
|
+
className\="ids-styles--add-border-v5202"
|
|
201
527
|
value\="google"
|
|
202
528
|
\>
|
|
203
529
|
Google </IressRadio\>
|
|
204
530
|
<IressRadio
|
|
205
|
-
className\="ids-styles--add-border-
|
|
531
|
+
className\="ids-styles--add-border-v5202"
|
|
206
532
|
value\="newspaper"
|
|
207
533
|
\>
|
|
208
534
|
Newspaper </IressRadio\>
|
|
209
535
|
<IressRadio
|
|
210
|
-
className\="ids-styles--add-border-
|
|
536
|
+
className\="ids-styles--add-border-v5202"
|
|
211
537
|
value\="friend"
|
|
212
538
|
\>
|
|
213
539
|
Friend </IressRadio\>
|
|
214
540
|
<IressRadio
|
|
215
|
-
className\="ids-styles--add-border-
|
|
541
|
+
className\="ids-styles--add-border-v5202"
|
|
216
542
|
value\="other"
|
|
217
543
|
\>
|
|
218
544
|
Other </IressRadio\>
|
|
@@ -223,22 +549,22 @@ Hide code
|
|
|
223
549
|
inline </h3\>
|
|
224
550
|
<IressRadioGroup layout\="inline"\>
|
|
225
551
|
<IressRadio
|
|
226
|
-
className\="ids-styles--add-border-
|
|
552
|
+
className\="ids-styles--add-border-v5202"
|
|
227
553
|
value\="google"
|
|
228
554
|
\>
|
|
229
555
|
Google </IressRadio\>
|
|
230
556
|
<IressRadio
|
|
231
|
-
className\="ids-styles--add-border-
|
|
557
|
+
className\="ids-styles--add-border-v5202"
|
|
232
558
|
value\="newspaper"
|
|
233
559
|
\>
|
|
234
560
|
Newspaper </IressRadio\>
|
|
235
561
|
<IressRadio
|
|
236
|
-
className\="ids-styles--add-border-
|
|
562
|
+
className\="ids-styles--add-border-v5202"
|
|
237
563
|
value\="friend"
|
|
238
564
|
\>
|
|
239
565
|
Friend </IressRadio\>
|
|
240
566
|
<IressRadio
|
|
241
|
-
className\="ids-styles--add-border-
|
|
567
|
+
className\="ids-styles--add-border-v5202"
|
|
242
568
|
value\="other"
|
|
243
569
|
\>
|
|
244
570
|
Other </IressRadio\>
|
|
@@ -249,22 +575,22 @@ Hide code
|
|
|
249
575
|
inlineFlex </h3\>
|
|
250
576
|
<IressRadioGroup layout\="inlineFlex"\>
|
|
251
577
|
<IressRadio
|
|
252
|
-
className\="ids-styles--add-border-
|
|
578
|
+
className\="ids-styles--add-border-v5202"
|
|
253
579
|
value\="google"
|
|
254
580
|
\>
|
|
255
581
|
Google </IressRadio\>
|
|
256
582
|
<IressRadio
|
|
257
|
-
className\="ids-styles--add-border-
|
|
583
|
+
className\="ids-styles--add-border-v5202"
|
|
258
584
|
value\="newspaper"
|
|
259
585
|
\>
|
|
260
586
|
Newspaper </IressRadio\>
|
|
261
587
|
<IressRadio
|
|
262
|
-
className\="ids-styles--add-border-
|
|
588
|
+
className\="ids-styles--add-border-v5202"
|
|
263
589
|
value\="friend"
|
|
264
590
|
\>
|
|
265
591
|
Friend </IressRadio\>
|
|
266
592
|
<IressRadio
|
|
267
|
-
className\="ids-styles--add-border-
|
|
593
|
+
className\="ids-styles--add-border-v5202"
|
|
268
594
|
value\="other"
|
|
269
595
|
\>
|
|
270
596
|
Other </IressRadio\>
|
|
@@ -275,22 +601,22 @@ Hide code
|
|
|
275
601
|
inlineEqualWidth </h3\>
|
|
276
602
|
<IressRadioGroup layout\="inlineEqualWidth"\>
|
|
277
603
|
<IressRadio
|
|
278
|
-
className\="ids-styles--add-border-
|
|
604
|
+
className\="ids-styles--add-border-v5202"
|
|
279
605
|
value\="google"
|
|
280
606
|
\>
|
|
281
607
|
Google </IressRadio\>
|
|
282
608
|
<IressRadio
|
|
283
|
-
className\="ids-styles--add-border-
|
|
609
|
+
className\="ids-styles--add-border-v5202"
|
|
284
610
|
value\="newspaper"
|
|
285
611
|
\>
|
|
286
612
|
Newspaper </IressRadio\>
|
|
287
613
|
<IressRadio
|
|
288
|
-
className\="ids-styles--add-border-
|
|
614
|
+
className\="ids-styles--add-border-v5202"
|
|
289
615
|
value\="friend"
|
|
290
616
|
\>
|
|
291
617
|
Friend </IressRadio\>
|
|
292
618
|
<IressRadio
|
|
293
|
-
className\="ids-styles--add-border-
|
|
619
|
+
className\="ids-styles--add-border-v5202"
|
|
294
620
|
value\="other"
|
|
295
621
|
\>
|
|
296
622
|
Other </IressRadio\>
|
|
@@ -298,14 +624,123 @@ Hide code
|
|
|
298
624
|
</div\>
|
|
299
625
|
</IressText\>
|
|
300
626
|
|
|
301
|
-
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
#### Props
|
|
630
|
+
|
|
631
|
+
IressRadioGroupIressRadio
|
|
632
|
+
|
|
633
|
+
Tabs
|
|
634
|
+
|
|
635
|
+
| Name | Description | Default | Control |
|
|
636
|
+
| --- | --- | --- | --- |
|
|
637
|
+
| children |
|
|
638
|
+
Content of the radio group, usually multiple `IressRadio` components.
|
|
639
|
+
|
|
640
|
+
ReactNode
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
| \- | \- |
|
|
645
|
+
| defaultValue |
|
|
646
|
+
|
|
647
|
+
Initial value of radio group when in uncontrolled mode.
|
|
648
|
+
|
|
649
|
+
FormControlValue
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
| \- | Set object |
|
|
654
|
+
| hiddenRadio |
|
|
655
|
+
|
|
656
|
+
Hides the radio control to allow the creation of custom radio buttons.
|
|
657
|
+
|
|
658
|
+
boolean
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
| \- | Set boolean |
|
|
663
|
+
| layout |
|
|
664
|
+
|
|
665
|
+
Sets which of the block / inline layout options apply.
|
|
666
|
+
|
|
667
|
+
union
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
|
672
|
+
|
|
673
|
+
'stack'
|
|
674
|
+
|
|
675
|
+
| \- |
|
|
676
|
+
| name |
|
|
677
|
+
|
|
678
|
+
Name to be applied to all radios in the group.
|
|
679
|
+
|
|
680
|
+
string
|
|
681
|
+
|
|
682
|
+
|
|
302
683
|
|
|
303
|
-
|
|
684
|
+
| \- | Set string |
|
|
685
|
+
| onChange |
|
|
686
|
+
|
|
687
|
+
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.
|
|
688
|
+
|
|
689
|
+
( e: React.ChangeEvent<HTMLInputElement>, value?: FormControlValue, ) => void
|
|
690
|
+
|
|
691
|
+
| \- | \- |
|
|
692
|
+
| readonly |
|
|
693
|
+
|
|
694
|
+
Renders a readonly radio group.
|
|
695
|
+
|
|
696
|
+
boolean
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
| \- | Set boolean |
|
|
701
|
+
| required |
|
|
702
|
+
|
|
703
|
+
When true, marks the field as required
|
|
704
|
+
|
|
705
|
+
boolean
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
| \- | Set boolean |
|
|
710
|
+
| role |
|
|
711
|
+
|
|
712
|
+
|
|
|
713
|
+
|
|
714
|
+
'radiogroup'
|
|
715
|
+
|
|
716
|
+
| Set object |
|
|
717
|
+
| touch |
|
|
718
|
+
|
|
719
|
+
Add the button-like border and padding to radio when `touch` is true.
|
|
720
|
+
|
|
721
|
+
boolean
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
| \- | Set boolean |
|
|
726
|
+
| value |
|
|
727
|
+
|
|
728
|
+
Value of radio group when in controlled mode.
|
|
729
|
+
|
|
730
|
+
FormControlValue
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
| \- | Set object |
|
|
735
|
+
|
|
736
|
+
### Hidden radio buttons
|
|
304
737
|
|
|
305
738
|
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.
|
|
306
739
|
|
|
307
740
|
When `hiddenRadio` is enabled, the label will have no padding. Padding can be added by using a Panel or utility classes.
|
|
308
741
|
|
|
742
|
+
[](./iframe.html?id=components-radiogroup--hidden-radio-buttons)
|
|
743
|
+
|
|
309
744
|
**I'd like to discuss the following in my financial review:
|
|
310
745
|
|
|
311
746
|
Select one option
|
|
@@ -318,9 +753,7 @@ Saving for a holiday
|
|
|
318
753
|
|
|
319
754
|
Reducing my debt
|
|
320
755
|
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
\[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; }
|
|
756
|
+
```
|
|
324
757
|
|
|
325
758
|
<IressField
|
|
326
759
|
hint\="Select one option"
|
|
@@ -392,14 +825,131 @@ Hide code
|
|
|
392
825
|
</IressRadioGroup\>
|
|
393
826
|
</IressField\>
|
|
394
827
|
|
|
395
|
-
|
|
828
|
+
```
|
|
396
829
|
|
|
397
|
-
|
|
830
|
+
#### Props
|
|
831
|
+
|
|
832
|
+
IressRadioGroupIressRadio
|
|
833
|
+
|
|
834
|
+
Tabs
|
|
835
|
+
|
|
836
|
+
| Name | Description | Default | Control |
|
|
837
|
+
| --- | --- | --- | --- |
|
|
838
|
+
| children |
|
|
839
|
+
Content of the radio group, usually multiple `IressRadio` components.
|
|
840
|
+
|
|
841
|
+
ReactNode
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
| \- | \- |
|
|
846
|
+
| defaultValue |
|
|
847
|
+
|
|
848
|
+
Initial value of radio group when in uncontrolled mode.
|
|
849
|
+
|
|
850
|
+
FormControlValue
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
| \- |
|
|
855
|
+
|
|
856
|
+
"home"
|
|
857
|
+
|
|
858
|
+
|
|
|
859
|
+
| hiddenRadio |
|
|
860
|
+
|
|
861
|
+
Hides the radio control to allow the creation of custom radio buttons.
|
|
862
|
+
|
|
863
|
+
boolean
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
| \- | FalseTrue |
|
|
868
|
+
| layout |
|
|
869
|
+
|
|
870
|
+
Sets which of the block / inline layout options apply.
|
|
871
|
+
|
|
872
|
+
union
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
|
|
|
877
|
+
|
|
878
|
+
'stack'
|
|
879
|
+
|
|
880
|
+
|
|
|
881
|
+
|
|
882
|
+
"inline"
|
|
883
|
+
|
|
884
|
+
|
|
|
885
|
+
| name |
|
|
886
|
+
|
|
887
|
+
Name to be applied to all radios in the group.
|
|
888
|
+
|
|
889
|
+
string
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
| \- | Set string |
|
|
894
|
+
| onChange |
|
|
895
|
+
|
|
896
|
+
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.
|
|
897
|
+
|
|
898
|
+
( e: React.ChangeEvent<HTMLInputElement>, value?: FormControlValue, ) => void
|
|
899
|
+
|
|
900
|
+
| \- | \- |
|
|
901
|
+
| readonly |
|
|
902
|
+
|
|
903
|
+
Renders a readonly radio group.
|
|
904
|
+
|
|
905
|
+
boolean
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
| \- | Set boolean |
|
|
910
|
+
| required |
|
|
911
|
+
|
|
912
|
+
When true, marks the field as required
|
|
913
|
+
|
|
914
|
+
boolean
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
| \- | FalseTrue |
|
|
919
|
+
| role |
|
|
920
|
+
|
|
921
|
+
|
|
|
922
|
+
|
|
923
|
+
'radiogroup'
|
|
924
|
+
|
|
925
|
+
| Set object |
|
|
926
|
+
| touch |
|
|
927
|
+
|
|
928
|
+
Add the button-like border and padding to radio when `touch` is true.
|
|
929
|
+
|
|
930
|
+
boolean
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
| \- | Set boolean |
|
|
935
|
+
| value |
|
|
936
|
+
|
|
937
|
+
Value of radio group when in controlled mode.
|
|
938
|
+
|
|
939
|
+
FormControlValue
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
| \- | Set object |
|
|
944
|
+
|
|
945
|
+
### Laying out custom radio buttons
|
|
398
946
|
|
|
399
947
|
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.
|
|
400
948
|
|
|
401
949
|
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.
|
|
402
950
|
|
|
951
|
+
[](./iframe.html?id=components-radiogroup--custom-radio-group-layout)
|
|
952
|
+
|
|
403
953
|
**I'd like to discuss the following in my financial review:
|
|
404
954
|
|
|
405
955
|
Select one option
|
|
@@ -422,9 +972,7 @@ Reducing my debt
|
|
|
422
972
|
|
|
423
973
|
Starting a business
|
|
424
974
|
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
\[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; }
|
|
975
|
+
```
|
|
428
976
|
|
|
429
977
|
<IressField
|
|
430
978
|
hint\="Select one option"
|
|
@@ -441,7 +989,7 @@ Hide code
|
|
|
441
989
|
}}
|
|
442
990
|
\>
|
|
443
991
|
<div
|
|
444
|
-
className\="ids-styles--resizable-
|
|
992
|
+
className\="ids-styles--resizable-v5202"
|
|
445
993
|
style\={{
|
|
446
994
|
display: 'grid',
|
|
447
995
|
gridAutoRows: '1fr',
|
|
@@ -607,19 +1155,130 @@ Hide code
|
|
|
607
1155
|
</IressRadioGroup\>
|
|
608
1156
|
</IressField\>
|
|
609
1157
|
|
|
610
|
-
|
|
1158
|
+
```
|
|
1159
|
+
|
|
1160
|
+
#### Props
|
|
1161
|
+
|
|
1162
|
+
IressRadioGroupIressRadio
|
|
1163
|
+
|
|
1164
|
+
Tabs
|
|
1165
|
+
|
|
1166
|
+
| Name | Description | Default | Control |
|
|
1167
|
+
| --- | --- | --- | --- |
|
|
1168
|
+
| children |
|
|
1169
|
+
Content of the radio group, usually multiple `IressRadio` components.
|
|
1170
|
+
|
|
1171
|
+
ReactNode
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
| \- | \- |
|
|
1176
|
+
| defaultValue |
|
|
1177
|
+
|
|
1178
|
+
Initial value of radio group when in uncontrolled mode.
|
|
1179
|
+
|
|
1180
|
+
FormControlValue
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
| \- | Set object |
|
|
1185
|
+
| hiddenRadio |
|
|
1186
|
+
|
|
1187
|
+
Hides the radio control to allow the creation of custom radio buttons.
|
|
1188
|
+
|
|
1189
|
+
boolean
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
| \- | FalseTrue |
|
|
1194
|
+
| layout |
|
|
1195
|
+
|
|
1196
|
+
Sets which of the block / inline layout options apply.
|
|
1197
|
+
|
|
1198
|
+
union
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
|
|
|
1203
|
+
|
|
1204
|
+
'stack'
|
|
1205
|
+
|
|
1206
|
+
|
|
|
1207
|
+
|
|
1208
|
+
"block"
|
|
1209
|
+
|
|
1210
|
+
|
|
|
1211
|
+
| name |
|
|
1212
|
+
|
|
1213
|
+
Name to be applied to all radios in the group.
|
|
1214
|
+
|
|
1215
|
+
string
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
| \- | financial-review |
|
|
1220
|
+
| onChange |
|
|
1221
|
+
|
|
1222
|
+
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.
|
|
1223
|
+
|
|
1224
|
+
( e: React.ChangeEvent<HTMLInputElement>, value?: FormControlValue, ) => void
|
|
1225
|
+
|
|
1226
|
+
| \- | \- |
|
|
1227
|
+
| readonly |
|
|
1228
|
+
|
|
1229
|
+
Renders a readonly radio group.
|
|
1230
|
+
|
|
1231
|
+
boolean
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
| \- | Set boolean |
|
|
1236
|
+
| required |
|
|
1237
|
+
|
|
1238
|
+
When true, marks the field as required
|
|
1239
|
+
|
|
1240
|
+
boolean
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
| \- | FalseTrue |
|
|
1245
|
+
| role |
|
|
1246
|
+
|
|
1247
|
+
|
|
|
1248
|
+
|
|
1249
|
+
'radiogroup'
|
|
1250
|
+
|
|
1251
|
+
| Set object |
|
|
1252
|
+
| touch |
|
|
1253
|
+
|
|
1254
|
+
Add the button-like border and padding to radio when `touch` is true.
|
|
1255
|
+
|
|
1256
|
+
boolean
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
| \- | Set boolean |
|
|
1261
|
+
| value |
|
|
1262
|
+
|
|
1263
|
+
Value of radio group when in controlled mode.
|
|
1264
|
+
|
|
1265
|
+
FormControlValue
|
|
1266
|
+
|
|
1267
|
+
|
|
611
1268
|
|
|
612
|
-
|
|
1269
|
+
| \- | Set object |
|
|
1270
|
+
|
|
1271
|
+
### Readonly
|
|
613
1272
|
|
|
614
1273
|
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.
|
|
615
1274
|
|
|
616
1275
|
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.
|
|
617
1276
|
|
|
618
|
-
|
|
1277
|
+
[](./iframe.html?id=components-radiogroup--readonly)
|
|
619
1278
|
|
|
620
|
-
|
|
1279
|
+
Newspaper
|
|
621
1280
|
|
|
622
|
-
|
|
1281
|
+
```
|
|
623
1282
|
|
|
624
1283
|
<IressRadioGroup
|
|
625
1284
|
defaultValue\="newspaper"
|
|
@@ -635,12 +1294,125 @@ Hide code
|
|
|
635
1294
|
Other </IressRadio\>
|
|
636
1295
|
</IressRadioGroup\>
|
|
637
1296
|
|
|
638
|
-
|
|
1297
|
+
```
|
|
1298
|
+
|
|
1299
|
+
#### Props
|
|
1300
|
+
|
|
1301
|
+
IressRadioGroupIressRadio
|
|
1302
|
+
|
|
1303
|
+
Tabs
|
|
1304
|
+
|
|
1305
|
+
| Name | Description | Default | Control |
|
|
1306
|
+
| --- | --- | --- | --- |
|
|
1307
|
+
| children |
|
|
1308
|
+
Content of the radio group, usually multiple `IressRadio` components.
|
|
1309
|
+
|
|
1310
|
+
ReactNode
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
| \- | \- |
|
|
1315
|
+
| defaultValue |
|
|
1316
|
+
|
|
1317
|
+
Initial value of radio group when in uncontrolled mode.
|
|
1318
|
+
|
|
1319
|
+
FormControlValue
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
| \- |
|
|
1324
|
+
|
|
1325
|
+
"newspaper"
|
|
1326
|
+
|
|
1327
|
+
|
|
|
1328
|
+
| hiddenRadio |
|
|
1329
|
+
|
|
1330
|
+
Hides the radio control to allow the creation of custom radio buttons.
|
|
1331
|
+
|
|
1332
|
+
boolean
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
| \- | Set boolean |
|
|
1337
|
+
| layout |
|
|
1338
|
+
|
|
1339
|
+
Sets which of the block / inline layout options apply.
|
|
1340
|
+
|
|
1341
|
+
union
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
|
1346
|
+
|
|
1347
|
+
'stack'
|
|
1348
|
+
|
|
1349
|
+
| Set object |
|
|
1350
|
+
| name |
|
|
1351
|
+
|
|
1352
|
+
Name to be applied to all radios in the group.
|
|
1353
|
+
|
|
1354
|
+
string
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
| \- | Set string |
|
|
1359
|
+
| onChange |
|
|
1360
|
+
|
|
1361
|
+
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.
|
|
1362
|
+
|
|
1363
|
+
( e: React.ChangeEvent<HTMLInputElement>, value?: FormControlValue, ) => void
|
|
1364
|
+
|
|
1365
|
+
| \- | \- |
|
|
1366
|
+
| readonly |
|
|
1367
|
+
|
|
1368
|
+
Renders a readonly radio group.
|
|
1369
|
+
|
|
1370
|
+
boolean
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
| \- | FalseTrue |
|
|
1375
|
+
| required |
|
|
1376
|
+
|
|
1377
|
+
When true, marks the field as required
|
|
1378
|
+
|
|
1379
|
+
boolean
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
| \- | Set boolean |
|
|
1384
|
+
| role |
|
|
1385
|
+
|
|
1386
|
+
|
|
|
1387
|
+
|
|
1388
|
+
'radiogroup'
|
|
1389
|
+
|
|
1390
|
+
| Set object |
|
|
1391
|
+
| touch |
|
|
1392
|
+
|
|
1393
|
+
Add the button-like border and padding to radio when `touch` is true.
|
|
1394
|
+
|
|
1395
|
+
boolean
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
| \- | Set boolean |
|
|
1400
|
+
| value |
|
|
1401
|
+
|
|
1402
|
+
Value of radio group when in controlled mode.
|
|
1403
|
+
|
|
1404
|
+
FormControlValue
|
|
1405
|
+
|
|
1406
|
+
|
|
639
1407
|
|
|
640
|
-
|
|
1408
|
+
| \- | Set object |
|
|
1409
|
+
|
|
1410
|
+
### Touch
|
|
641
1411
|
|
|
642
1412
|
The `touch` prop adds the button-like border and padding to radio.
|
|
643
1413
|
|
|
1414
|
+
[](./iframe.html?id=components-radiogroup--touch)
|
|
1415
|
+
|
|
644
1416
|
Google
|
|
645
1417
|
|
|
646
1418
|
Newspaper
|
|
@@ -649,9 +1421,7 @@ Friend
|
|
|
649
1421
|
|
|
650
1422
|
Other
|
|
651
1423
|
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
|
|
1424
|
+
```
|
|
655
1425
|
|
|
656
1426
|
<IressRadioGroup
|
|
657
1427
|
defaultValue\="newspaper"
|
|
@@ -667,17 +1437,115 @@ Hide code
|
|
|
667
1437
|
Other </IressRadio\>
|
|
668
1438
|
</IressRadioGroup\>
|
|
669
1439
|
|
|
670
|
-
|
|
1440
|
+
```
|
|
1441
|
+
|
|
1442
|
+
#### Props
|
|
1443
|
+
|
|
1444
|
+
IressRadioGroupIressRadio
|
|
1445
|
+
|
|
1446
|
+
Tabs
|
|
1447
|
+
|
|
1448
|
+
| Name | Description | Default | Control |
|
|
1449
|
+
| --- | --- | --- | --- |
|
|
1450
|
+
| children |
|
|
1451
|
+
Content of the radio group, usually multiple `IressRadio` components.
|
|
1452
|
+
|
|
1453
|
+
ReactNode
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
| \- | \- |
|
|
1458
|
+
| defaultValue |
|
|
1459
|
+
|
|
1460
|
+
Initial value of radio group when in uncontrolled mode.
|
|
1461
|
+
|
|
1462
|
+
FormControlValue
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
| \- |
|
|
1467
|
+
|
|
1468
|
+
"newspaper"
|
|
1469
|
+
|
|
1470
|
+
|
|
|
1471
|
+
| hiddenRadio |
|
|
1472
|
+
|
|
1473
|
+
Hides the radio control to allow the creation of custom radio buttons.
|
|
1474
|
+
|
|
1475
|
+
boolean
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
| \- | Set boolean |
|
|
1480
|
+
| layout |
|
|
1481
|
+
|
|
1482
|
+
Sets which of the block / inline layout options apply.
|
|
1483
|
+
|
|
1484
|
+
union
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
|
1489
|
+
|
|
1490
|
+
'stack'
|
|
1491
|
+
|
|
1492
|
+
| Set object |
|
|
1493
|
+
| name |
|
|
1494
|
+
|
|
1495
|
+
Name to be applied to all radios in the group.
|
|
1496
|
+
|
|
1497
|
+
string
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
| \- | Set string |
|
|
1502
|
+
| onChange |
|
|
1503
|
+
|
|
1504
|
+
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.
|
|
1505
|
+
|
|
1506
|
+
( e: React.ChangeEvent<HTMLInputElement>, value?: FormControlValue, ) => void
|
|
1507
|
+
|
|
1508
|
+
| \- | \- |
|
|
1509
|
+
| readonly |
|
|
1510
|
+
|
|
1511
|
+
Renders a readonly radio group.
|
|
1512
|
+
|
|
1513
|
+
boolean
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
| \- | Set boolean |
|
|
1518
|
+
| required |
|
|
1519
|
+
|
|
1520
|
+
When true, marks the field as required
|
|
1521
|
+
|
|
1522
|
+
boolean
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
|
|
1526
|
+
| \- | Set boolean |
|
|
1527
|
+
| role |
|
|
1528
|
+
|
|
1529
|
+
|
|
|
1530
|
+
|
|
1531
|
+
'radiogroup'
|
|
1532
|
+
|
|
1533
|
+
| Set object |
|
|
1534
|
+
| touch |
|
|
1535
|
+
|
|
1536
|
+
Add the button-like border and padding to radio when `touch` is true.
|
|
1537
|
+
|
|
1538
|
+
boolean
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
| \- | FalseTrue |
|
|
1543
|
+
| value |
|
|
1544
|
+
|
|
1545
|
+
Value of radio group when in controlled mode.
|
|
1546
|
+
|
|
1547
|
+
FormControlValue
|
|
1548
|
+
|
|
671
1549
|
|
|
672
|
-
On this page
|
|
673
1550
|
|
|
674
|
-
|
|
675
|
-
* [Props](#props)
|
|
676
|
-
* [Examples](#examples)
|
|
677
|
-
* [Radio children](#radio-children)
|
|
678
|
-
* [Radio selection](#radio-selection)
|
|
679
|
-
* [Layout](#layout)
|
|
680
|
-
* [Hidden radio buttons](#hidden-radio-buttons)
|
|
681
|
-
* [Laying out custom radio buttons](#laying-out-custom-radio-buttons)
|
|
682
|
-
* [Readonly](#readonly)
|
|
683
|
-
* [Touch](#touch)
|
|
1551
|
+
| \- | Set object |
|