@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,563 +0,0 @@
1
- [](#radio)Radio
2
- ===============
3
-
4
- Overview
5
- --------
6
-
7
- A radio is a single option presented with a radio button. It is used to select a single option from multiple options. It is typically used in an `IressRadioGroup`.
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
- Radio button
18
-
19
- Hide code
20
-
21
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
22
-
23
- <IressRadio\>
24
- Radio button
25
- </IressRadio\>
26
-
27
- Copy
28
-
29
- [](#props)Props
30
- ---------------
31
-
32
- | Name | Description | Default | Control |
33
- | --- | --- | --- | --- |
34
- | bg |
35
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
36
-
37
- We recommend using the following token values for best background contrast:
38
-
39
- * `colour.primary.fill` for primary backgrounds that need to stand out
40
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
41
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
42
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
43
- * `colour.system.danger.fill` for error backgrounds that need to stand out
44
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
45
- * `colour.system.success.fill` for success backgrounds that need to stand out
46
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
47
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
48
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
49
- * `colour.system.info.fill` for info backgrounds that need to stand out
50
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
51
-
52
- ResponsiveProp<ColorToken> | undefined
53
-
54
- | \- | Set object |
55
- | borderRadius |
56
-
57
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
58
-
59
- | Chrome | Firefox | Safari | Edge | IE |
60
- | --- | --- | --- | --- | --- |
61
- | **4** | **4** | **5** | **12** | **9** |
62
- | 1 _\-x-_ | | 3 _\-x-_ | | |
63
-
64
- ResponsiveProp<RadiusToken> | undefined
65
-
66
- | \- | Set object |
67
- | checked |
68
-
69
- Sets the checked state of the radio. If it is within a radio group, it will be overridden by the radio group's value and whether it matches this radio's value.
70
-
71
- booleanundefined
72
-
73
-
74
-
75
- | \- | Set object |
76
- | children |
77
-
78
- Label of the radio
79
-
80
- ReactNode
81
-
82
-
83
-
84
- | \- |
85
-
86
- "Radio button"
87
-
88
- |
89
- | color |
90
-
91
- 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`.
92
-
93
- We recommend using the following token values for best color contrast:
94
-
95
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
96
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
97
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
98
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
99
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
100
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
101
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
102
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
103
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
104
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
105
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
106
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
107
-
108
- ResponsiveProp<ColorToken> | undefined
109
-
110
- | \- | Set object |
111
- | focusable |
112
-
113
- 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.
114
-
115
- "true""within"undefined
116
-
117
-
118
-
119
- | \- | Set object |
120
- | hiddenControl |
121
-
122
- Sets whether the control is hidden. If it is within a radio group, it will be overridden with the radio group's hiddenControl setting.
123
-
124
- booleanundefined
125
-
126
-
127
-
128
- | \- | Set object |
129
- | hide |
130
-
131
- 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.
132
-
133
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
134
-
135
- Notes:
136
-
137
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
138
- * Consider if you can conditionally render the element instead of hiding it.
139
-
140
- ResponsiveProp<boolean> | undefined
141
-
142
- | \- | Set object |
143
- | layerStyle |
144
-
145
- 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.
146
-
147
- * `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.
148
- * `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.
149
- * `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.
150
-
151
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
152
-
153
- | \- | Set object |
154
- | m |
155
-
156
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
157
-
158
- 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.
159
-
160
- | Chrome | Firefox | Safari | Edge | IE |
161
- | --- | --- | --- | --- | --- |
162
- | **1** | **1** | **1** | **12** | **3** |
163
-
164
- ResponsiveProp<SpacingToken | "auto"> | undefined
165
-
166
- | \- | Set object |
167
- | maxWidth |
168
-
169
- 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`.
170
-
171
- | Chrome | Firefox | Safari | Edge | IE |
172
- | --- | --- | --- | --- | --- |
173
- | **1** | **1** | **1** | **12** | **7** |
174
-
175
- 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
176
-
177
- | \- | Set object |
178
- | mb |
179
-
180
- 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.
181
-
182
- It uses the spacing tokens in the design system.
183
-
184
- | Chrome | Firefox | Safari | Edge | IE |
185
- | --- | --- | --- | --- | --- |
186
- | **1** | **1** | **1** | **12** | **3** |
187
-
188
- ResponsiveProp<SpacingToken | "auto"> | undefined
189
-
190
- | \- | Set object |
191
- | ml |
192
-
193
- 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.
194
-
195
- It uses the spacing tokens in the design system.
196
-
197
- | Chrome | Firefox | Safari | Edge | IE |
198
- | --- | --- | --- | --- | --- |
199
- | **1** | **1** | **1** | **12** | **3** |
200
-
201
- ResponsiveProp<SpacingToken | "auto"> | undefined
202
-
203
- | \- | Set object |
204
- | mr |
205
-
206
- 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.
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
- | mt |
218
-
219
- 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.
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
- | mx |
231
-
232
- 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.
233
-
234
- 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.
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
- | my |
244
-
245
- 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.
246
-
247
- 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.
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
- | name |
257
-
258
- Sets the name attribute on the radio input. If it is within a radio group, it will be overridden with the radio group's name.
259
-
260
- stringundefined
261
-
262
-
263
-
264
- | \- | Set object |
265
- | noGutter |
266
-
267
- 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.
268
-
269
- booleanundefined
270
-
271
-
272
-
273
- | \- | Set object |
274
- | onChange |
275
-
276
- Handles the onChange event of the radio input. If you pass in a non-string value, you can access it using the second parameter of the function.
277
-
278
- ((e: ChangeEvent<HTMLInputElement>, value?: T | undefined) => void) | undefined
279
-
280
- | \- | \- |
281
- | p |
282
-
283
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
284
-
285
- 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.
286
-
287
- | Chrome | Firefox | Safari | Edge | IE |
288
- | --- | --- | --- | --- | --- |
289
- | **1** | **1** | **1** | **12** | **3** |
290
-
291
- 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
292
-
293
- | \- | Set object |
294
- | pb |
295
-
296
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
297
-
298
- 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.
299
-
300
- | Chrome | Firefox | Safari | Edge | IE |
301
- | --- | --- | --- | --- | --- |
302
- | **1** | **1** | **1** | **12** | **3** |
303
-
304
- 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
305
-
306
- | \- | Set object |
307
- | pl |
308
-
309
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
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
- | pr |
321
-
322
- The **`pr`** property is short for `padding-right` and sets the padding area on the right 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
- | pt |
334
-
335
- The **`pt`** property is short for `padding-top` and sets the padding area on the top 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
- | px |
347
-
348
- 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.
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
- | py |
360
-
361
- 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.
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
- | ref |
373
-
374
- Ref<HTMLInputElement> | undefined
375
-
376
- | \- | Set object |
377
- | required |
378
-
379
- If `true`, the radio is a required field and will be validated as such. If it is within a radio group, it will be overridden with the radio group's required state.
380
-
381
- booleanundefined
382
-
383
-
384
-
385
- | \- | Set object |
386
- | rowGap |
387
-
388
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
389
-
390
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
391
-
392
- | Chrome | Firefox | Safari | Edge | IE |
393
- | --- | --- | --- | --- | --- |
394
- | **47** | **52** | **10.1** | **16** | No |
395
-
396
- 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
397
-
398
- | \- | Set object |
399
- | srOnly |
400
-
401
- 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.
402
-
403
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
404
-
405
- ResponsiveProp<boolean> | undefined
406
-
407
- | \- | Set object |
408
- | stretch |
409
-
410
- 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.
411
-
412
- booleanundefined
413
-
414
-
415
-
416
- | \- | Set object |
417
- | textAlign |
418
-
419
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
420
-
421
- | Chrome | Firefox | Safari | Edge | IE |
422
- | --- | --- | --- | --- | --- |
423
- | **1** | **1** | **1** | **12** | **3** |
424
-
425
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
426
-
427
- | \- | Set object |
428
- | textStyle |
429
-
430
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
431
-
432
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
433
- * `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.
434
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
435
- * `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.
436
- * `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.
437
- * `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.
438
- * `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.
439
- * `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.
440
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
441
-
442
- 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
443
-
444
- | \- | Set object |
445
- | touch |
446
-
447
- Add the button-like border and padding to radio when `touch` is true.
448
-
449
- booleanundefined
450
-
451
-
452
-
453
- | \- | Set object |
454
- | value |
455
-
456
- The value which is submitted with the form data when this radio button is checked. To set this radio as checked by default, use the `checked` property.
457
-
458
- Tundefined
459
-
460
-
461
-
462
- | \- | Set object |
463
- | width |
464
-
465
- 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.
466
-
467
- 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.
468
-
469
- | Chrome | Firefox | Safari | Edge | IE |
470
- | --- | --- | --- | --- | --- |
471
- | **1** | **1** | **1** | **12** | **4** |
472
-
473
- 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
474
-
475
- | \- | Set object |
476
-
477
- [](#examples)Examples
478
- ---------------------
479
-
480
- ### [](#checked)Checked
481
-
482
- You can set the radio to `checked` by default. This is useful when you want to pre-select an option.
483
-
484
- **Note:** If you are using an `IressRadioGroup`, you should use the `value` prop on the `IressRadioGroup` to set the checked state of its `<IressRadio />` children, as the `checked` prop will be ignored.
485
-
486
- Checked radio button
487
-
488
- Hide code
489
-
490
- \[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; }
491
-
492
- <IressRadio checked\>
493
- Checked radio button
494
- </IressRadio\>
495
-
496
- Copy
497
-
498
- ### [](#hidden-control)Hidden control
499
-
500
- You can hide the radio button and use a custom UI to display the content. Even though the radio button is hidden, it still acts like a radio.
501
-
502
- Hidden radio button
503
-
504
- Hide code
505
-
506
- \[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; }
507
-
508
- <IressRadio hiddenControl\>
509
- <IressPanel bg\="transparent"\>
510
- Hidden radio button </IressPanel\>
511
- </IressRadio\>
512
-
513
- Copy
514
-
515
- ### [](#read-only)Read only
516
-
517
- The `readOnly` prop changes how the radio is rendered. It will only render if the radio is checked (alongside a hidden input that contains the `value` if it was set), otherwise it not be rendered.
518
-
519
- It is understandable that this may not be the desired behavior for all use cases. If you need a radio that is not editable, but still visible, simply do not set the `readOnly` prop and set the `checked` prop instead.
520
-
521
- Radio button
522
-
523
- Hide code
524
-
525
- \[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; }
526
-
527
- <IressStack gap\="sm"\>
528
- <IressRadio
529
- defaultChecked
530
- readOnly
531
- \>
532
- Radio button </IressRadio\>
533
- <IressRadio readOnly\>
534
- Radio button </IressRadio\>
535
- </IressStack\>
536
-
537
- Copy
538
-
539
- ### [](#touch)Touch
540
-
541
- The `touch` prop adds the button-like border and padding to radio.
542
-
543
- Radio button
544
-
545
- Hide code
546
-
547
- \[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; }
548
-
549
- <IressRadio touch\>
550
- Radio button
551
- </IressRadio\>
552
-
553
- Copy
554
-
555
- On this page
556
-
557
- * [Overview](#overview)
558
- * [Props](#props)
559
- * [Examples](#examples)
560
- * [Checked](#checked)
561
- * [Hidden control](#hidden-control)
562
- * [Read only](#read-only)
563
- * [Touch](#touch)