@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,940 +0,0 @@
1
- [](#select)Select
2
- =================
3
-
4
- Overview
5
- --------
6
-
7
- Selects allow users to interact with data and select from a predetermined list of options.
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
- Option 1Option 2Option 3Option 4Option 5
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
- <IressSelect\>
24
- <option value\="1"\>
25
- Option 1 </option\>
26
- <option value\="2"\>
27
- Option 2 </option\>
28
- <option value\="3"\>
29
- Option 3 </option\>
30
- <option value\="4"\>
31
- Option 4 </option\>
32
- <option value\="5"\>
33
- Option 5 </option\>
34
- </IressSelect\>
35
-
36
- Copy
37
-
38
- [](#props)Props
39
- ---------------
40
-
41
- | Name | Description | Default | Control |
42
- | --- | --- | --- | --- |
43
- | bg |
44
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
45
-
46
- We recommend using the following token values for best background contrast:
47
-
48
- * `colour.primary.fill` for primary backgrounds that need to stand out
49
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
50
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
51
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
52
- * `colour.system.danger.fill` for error backgrounds that need to stand out
53
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
54
- * `colour.system.success.fill` for success backgrounds that need to stand out
55
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
56
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
57
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
58
- * `colour.system.info.fill` for info backgrounds that need to stand out
59
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
60
-
61
- "colorPalette""colour.primary.fill""colour.primary.fillHover""colour.primary.onFill""colour.primary.surface""colour.primary.surfaceHover""colour.primary.text"... 33 more ...Show 1 more...
62
-
63
-
64
-
65
- | \- | Set object |
66
- | borderRadius |
67
-
68
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
69
-
70
- | Chrome | Firefox | Safari | Edge | IE |
71
- | --- | --- | --- | --- | --- |
72
- | **4** | **4** | **5** | **12** | **9** |
73
- | 1 _\-x-_ | | 3 _\-x-_ | | |
74
-
75
- "none" | "radius.000" | "radius.025" | "radius.050" | "radius.075" | "radius.100" | "radius.system.badge" | "radius.system.button" | "radius.system.form" | "radius.system.layout" | Partial<...> | undefined
76
-
77
- | \- | Set object |
78
- | children |
79
-
80
- array
81
-
82
-
83
-
84
- | \- | \- |
85
- | color |
86
-
87
- 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`.
88
-
89
- We recommend using the following token values for best color contrast:
90
-
91
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
92
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
93
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
94
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
95
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
96
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
97
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
98
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
99
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
100
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
101
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
102
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
103
-
104
- "colorPalette""colour.primary.fill""colour.primary.fillHover""colour.primary.onFill""colour.primary.surface""colour.primary.surfaceHover""colour.primary.text"... 33 more ...Show 1 more...
105
-
106
-
107
-
108
- | \- | Set object |
109
- | defaultValue |
110
-
111
- Value of selected option for uncontrolled select.
112
-
113
- FormControlValueundefined
114
-
115
-
116
-
117
- | \- | Set object |
118
- | focusable |
119
-
120
- 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.
121
-
122
- "true""within"undefined
123
-
124
-
125
-
126
- | \- | Set object |
127
- | hide |
128
-
129
- 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.
130
-
131
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
132
-
133
- Notes:
134
-
135
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
136
- * Consider if you can conditionally render the element instead of hiding it.
137
-
138
- boolean | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", boolean>> | undefined
139
-
140
- | \- | Set object |
141
- | layerStyle |
142
-
143
- 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.
144
-
145
- * `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.
146
- * `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.
147
- * `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.
148
-
149
- "elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact" | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", "elevation.raised" | ... 3 more ... | "elevation.focusCompact">> | undefined
150
-
151
- | \- | Set object |
152
- | m |
153
-
154
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
155
-
156
- 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.
157
-
158
- | Chrome | Firefox | Safari | Edge | IE |
159
- | --- | --- | --- | --- | --- |
160
- | **1** | **1** | **1** | **12** | **3** |
161
-
162
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
163
-
164
-
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
- "slider.tick""auto""container.xs""container.sm""container.md""container.lg""container.xl""container.xxl"Show 6 more...
176
-
177
-
178
-
179
- | \- | Set object |
180
- | mb |
181
-
182
- 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.
183
-
184
- It uses the spacing tokens in the design system.
185
-
186
- | Chrome | Firefox | Safari | Edge | IE |
187
- | --- | --- | --- | --- | --- |
188
- | **1** | **1** | **1** | **12** | **3** |
189
-
190
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
191
-
192
-
193
-
194
- | \- | Set object |
195
- | ml |
196
-
197
- 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.
198
-
199
- It uses the spacing tokens in the design system.
200
-
201
- | Chrome | Firefox | Safari | Edge | IE |
202
- | --- | --- | --- | --- | --- |
203
- | **1** | **1** | **1** | **12** | **3** |
204
-
205
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
206
-
207
-
208
-
209
- | \- | Set object |
210
- | mr |
211
-
212
- 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.
213
-
214
- It uses the spacing tokens in the design system.
215
-
216
- | Chrome | Firefox | Safari | Edge | IE |
217
- | --- | --- | --- | --- | --- |
218
- | **1** | **1** | **1** | **12** | **3** |
219
-
220
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
221
-
222
-
223
-
224
- | \- | Set object |
225
- | mt |
226
-
227
- 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.
228
-
229
- It uses the spacing tokens in the design system.
230
-
231
- | Chrome | Firefox | Safari | Edge | IE |
232
- | --- | --- | --- | --- | --- |
233
- | **1** | **1** | **1** | **12** | **3** |
234
-
235
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
236
-
237
-
238
-
239
- | \- | Set object |
240
- | mx |
241
-
242
- 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.
243
-
244
- 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.
245
-
246
- | Chrome | Firefox | Safari | Edge | IE |
247
- | --- | --- | --- | --- | --- |
248
- | **1** | **1** | **1** | **12** | **3** |
249
-
250
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
251
-
252
-
253
-
254
- | \- | Set object |
255
- | my |
256
-
257
- 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.
258
-
259
- 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.
260
-
261
- | Chrome | Firefox | Safari | Edge | IE |
262
- | --- | --- | --- | --- | --- |
263
- | **1** | **1** | **1** | **12** | **3** |
264
-
265
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
266
-
267
-
268
-
269
- | \- | Set object |
270
- | name |
271
-
272
- Identifier for select.
273
-
274
- stringundefined
275
-
276
-
277
-
278
- | \- | Set object |
279
- | noGutter |
280
-
281
- 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.
282
-
283
- booleanundefined
284
-
285
-
286
-
287
- | \- | Set object |
288
- | onChange |
289
-
290
- Handles the onChange event of the select input. If you pass in a non-string value, you can access it using the second parameter of the function.
291
-
292
- ((e: ChangeEvent<HTMLSelectElement>, value?: T | undefined) => void) | undefined
293
-
294
- | \- | \- |
295
- | p |
296
-
297
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
298
-
299
- 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.
300
-
301
- | Chrome | Firefox | Safari | Edge | IE |
302
- | --- | --- | --- | --- | --- |
303
- | **1** | **1** | **1** | **12** | **3** |
304
-
305
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
306
-
307
-
308
-
309
- | \- | Set object |
310
- | pb |
311
-
312
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
313
-
314
- 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.
315
-
316
- | Chrome | Firefox | Safari | Edge | IE |
317
- | --- | --- | --- | --- | --- |
318
- | **1** | **1** | **1** | **12** | **3** |
319
-
320
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
321
-
322
-
323
-
324
- | \- | Set object |
325
- | pl |
326
-
327
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
328
-
329
- 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.
330
-
331
- | Chrome | Firefox | Safari | Edge | IE |
332
- | --- | --- | --- | --- | --- |
333
- | **1** | **1** | **1** | **12** | **3** |
334
-
335
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
336
-
337
-
338
-
339
- | \- | Set object |
340
- | placeholder |
341
-
342
- Adds an `option` as the first element with the placeholder text and no value.
343
-
344
- stringundefined
345
-
346
-
347
-
348
- | \- | Set object |
349
- | pr |
350
-
351
- The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
352
-
353
- 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.
354
-
355
- | Chrome | Firefox | Safari | Edge | IE |
356
- | --- | --- | --- | --- | --- |
357
- | **1** | **1** | **1** | **12** | **3** |
358
-
359
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
360
-
361
-
362
-
363
- | \- | Set object |
364
- | pt |
365
-
366
- The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
367
-
368
- 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.
369
-
370
- | Chrome | Firefox | Safari | Edge | IE |
371
- | --- | --- | --- | --- | --- |
372
- | **1** | **1** | **1** | **12** | **3** |
373
-
374
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
375
-
376
-
377
-
378
- | \- | Set object |
379
- | px |
380
-
381
- 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.
382
-
383
- 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.
384
-
385
- | Chrome | Firefox | Safari | Edge | IE |
386
- | --- | --- | --- | --- | --- |
387
- | **1** | **1** | **1** | **12** | **3** |
388
-
389
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
390
-
391
-
392
-
393
- | \- | Set object |
394
- | py |
395
-
396
- 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.
397
-
398
- 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.
399
-
400
- | Chrome | Firefox | Safari | Edge | IE |
401
- | --- | --- | --- | --- | --- |
402
- | **1** | **1** | **1** | **12** | **3** |
403
-
404
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
405
-
406
-
407
-
408
- | \- | Set object |
409
- | readOnly |
410
-
411
- If `true`, the user cannot modify the value.
412
-
413
- booleanundefined
414
-
415
-
416
-
417
- | \- | Set object |
418
- | ref |
419
-
420
- ForwardedRef<HTMLElementTagNameMap\[SelectElement<TReadonly>\]> | undefined
421
-
422
- | \- | Set object |
423
- | required |
424
-
425
- Mark the select as a required field.
426
-
427
- booleanundefined
428
-
429
-
430
-
431
- | \- | Set object |
432
- | rowGap |
433
-
434
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
435
-
436
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
437
-
438
- | Chrome | Firefox | Safari | Edge | IE |
439
- | --- | --- | --- | --- | --- |
440
- | **47** | **52** | **10.1** | **16** | No |
441
-
442
- "xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
443
-
444
-
445
-
446
- | \- | Set object |
447
- | srOnly |
448
-
449
- 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.
450
-
451
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
452
-
453
- boolean | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", boolean>> | undefined
454
-
455
- | \- | Set object |
456
- | stretch |
457
-
458
- 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.
459
-
460
- booleanundefined
461
-
462
-
463
-
464
- | \- | Set object |
465
- | textAlign |
466
-
467
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
468
-
469
- | Chrome | Firefox | Safari | Edge | IE |
470
- | --- | --- | --- | --- | --- |
471
- | **1** | **1** | **1** | **12** | **3** |
472
-
473
- "center" | "left" | "right" | "inherit" | "justify" | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", "center" | "left" | "right" | "inherit" | "justify">> | undefined
474
-
475
- | \- | Set object |
476
- | textStyle |
477
-
478
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
479
-
480
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
481
- * `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.
482
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
483
- * `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.
484
- * `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.
485
- * `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.
486
- * `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.
487
- * `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.
488
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
489
-
490
- "typography.heading.1""typography.heading.2""typography.heading.3""typography.heading.4""typography.heading.5""typography.body.sm""typography.body.sm.regular"... 12 more ...Show 1 more...
491
-
492
-
493
-
494
- | \- | Set object |
495
- | value |
496
-
497
- Value of selected option for controlled select.
498
-
499
- FormControlValueundefined
500
-
501
-
502
-
503
- | \- | Set object |
504
- | width |
505
-
506
- The width of the select.
507
-
508
- "2""4""6""8""10""12""16""25perc"Show 4 more...
509
-
510
-
511
-
512
- | \- | Set object |
513
-
514
- [](#usage)Usage
515
- ---------------
516
-
517
- Selects allow users to interact with data and select from a predetermined list of options, usually when you are constrained for space and have a limited number of options to choose from.
518
-
519
- ### [](#when-to-use)When To Use
520
-
521
- * If you have less than 5 options to choose from, consider using `IressRadioGroup` instead.
522
- * If you need to display rich content in your selects (eg. icons and metadata), you can use `IressRichSelect`.
523
- * Otherwise, `IressSelect` is the way to go.
524
-
525
- [](#examples)Examples
526
- ---------------------
527
-
528
- ### [](#options)Options
529
-
530
- Individual options can be passed directly into `IressSelect` using the native `option` element.
531
-
532
- **Note:** The `mapSelectOptions` helper function, originally used to map options to `<option>` elements, is now deprecated. Instead, you can use `array.map` to map the options to `<option>` elements.
533
-
534
- Option 1Option 2Option 3Option 4Option 5
535
-
536
- Hide code
537
-
538
- \[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; }
539
-
540
- <IressSelect\>
541
- <option value\="1"\>
542
- Option 1 </option\>
543
- <option value\="2"\>
544
- Option 2 </option\>
545
- <option value\="3"\>
546
- Option 3 </option\>
547
- <option value\="4"\>
548
- Option 4 </option\>
549
- <option value\="5"\>
550
- Option 5 </option\>
551
- </IressSelect\>
552
-
553
- Copy
554
-
555
- ### [](#option-groups)Option groups
556
-
557
- Just like the native `<select />` element, `IressSelect` supports option groups.
558
-
559
- Group 1 / Option 1Group 1 / Option 2Group 1 / Option 3Group 1 / Option 4Group 1 / Option 5Group 2 / Option 1Group 2 / Option 2Group 2 / Option 3Group 2 / Option 4Group 2 / Option 5
560
-
561
- Hide code
562
-
563
- \[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; }
564
-
565
- <IressSelect\>
566
- <optgroup label\="Group 1"\>
567
- <option value\="1-1"\>
568
- Group 1 / Option 1 </option\>
569
- <option value\="1-2"\>
570
- Group 1 / Option 2 </option\>
571
- <option value\="1-3"\>
572
- Group 1 / Option 3 </option\>
573
- <option value\="1-4"\>
574
- Group 1 / Option 4 </option\>
575
- <option value\="1-5"\>
576
- Group 1 / Option 5 </option\>
577
- </optgroup\>
578
- <optgroup label\="Group 2"\>
579
- <option value\="2-1"\>
580
- Group 2 / Option 1 </option\>
581
- <option value\="2-2"\>
582
- Group 2 / Option 2 </option\>
583
- <option value\="2-3"\>
584
- Group 2 / Option 3 </option\>
585
- <option value\="2-4"\>
586
- Group 2 / Option 4 </option\>
587
- <option value\="2-5"\>
588
- Group 2 / Option 5 </option\>
589
- </optgroup\>
590
- </IressSelect\>
591
-
592
- Copy
593
-
594
- ### [](#non-string-values)Non-string values
595
-
596
- If you would like to introduce options with non-string values, you can use the `IressSelectOption` component to define your options.
597
-
598
- **Note:** Since the `onChange` event of a select relies on strings, it will try to find a string representation of the value. If you are using non-string values, you will need to ensure the `toString` conversion is unique per option.
599
-
600
- Option 1Option 2Group 1 / Option 1Group 1 / Option 2Group 1 / Option 3
601
-
602
- Hide code
603
-
604
- \[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; }
605
-
606
- <IressSelect\>
607
- <IressSelectOption value\={1}\>
608
- Option 1 </IressSelectOption\>
609
- <IressSelectOption value\={2}\>
610
- Option 2 </IressSelectOption\>
611
- <optgroup label\="Group 1"\>
612
- <IressSelectOption value\="1-1"\>
613
- Group 1 / Option 1 </IressSelectOption\>
614
- <IressSelectOption value\="1-2"\>
615
- Group 1 / Option 2 </IressSelectOption\>
616
- <IressSelectOption value\="1-3"\>
617
- Group 1 / Option 3 </IressSelectOption\>
618
- </optgroup\>
619
- </IressSelect\>
620
-
621
- Copy
622
-
623
- ### [](#placeholder)Placeholder
624
-
625
- A default placeholder option can be set using the `placeholder` prop.
626
-
627
- Please select an optionOption 1Option 2Option 3Option 4Option 5
628
-
629
- Hide code
630
-
631
- \[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; }
632
-
633
- <IressSelect placeholder\="Please select an option"\>
634
- <option value\="1"\>
635
- Option 1 </option\>
636
- <option value\="2"\>
637
- Option 2 </option\>
638
- <option value\="3"\>
639
- Option 3 </option\>
640
- <option value\="4"\>
641
- Option 4 </option\>
642
- <option value\="5"\>
643
- Option 5 </option\>
644
- </IressSelect\>
645
-
646
- Copy
647
-
648
- ### [](#selected-option)Selected option
649
-
650
- An option can be selected by using either the `defaultValue` prop for uncontrolled components, or the `value` prop for controlled components.
651
-
652
- Option 1Option 2Option 3Option 4Option 5
653
-
654
- Hide code
655
-
656
- \[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; }
657
-
658
- <IressSelect defaultValue\={3}\>
659
- <option value\="1"\>
660
- Option 1 </option\>
661
- <option value\="2"\>
662
- Option 2 </option\>
663
- <option value\="3"\>
664
- Option 3 </option\>
665
- <option value\="4"\>
666
- Option 4 </option\>
667
- <option value\="5"\>
668
- Option 5 </option\>
669
- </IressSelect\>
670
-
671
- Copy
672
-
673
- ### [](#sizing)Sizing
674
-
675
- Selects can be resized to suit a specific number of characters. This sets an expectation of what data is to be presented; for example using the `16` width for a credit card number.
676
-
677
- Widths can also be set as a percentage, allowing the input to take up a proportion of the width of its container.
678
-
679
- 2Option 1Option 2Option 3Option 4Option 5
680
-
681
- 4Option 1Option 2Option 3Option 4Option 5
682
-
683
- 6Option 1Option 2Option 3Option 4Option 5
684
-
685
- 8Option 1Option 2Option 3Option 4Option 5
686
-
687
- 10Option 1Option 2Option 3Option 4Option 5
688
-
689
- 12Option 1Option 2Option 3Option 4Option 5
690
-
691
- 16Option 1Option 2Option 3Option 4Option 5
692
-
693
- 25percOption 1Option 2Option 3Option 4Option 5
694
-
695
- 50percOption 1Option 2Option 3Option 4Option 5
696
-
697
- 75percOption 1Option 2Option 3Option 4Option 5
698
-
699
- 100percOption 1Option 2Option 3Option 4Option 5
700
-
701
- Hide code
702
-
703
- \[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; }
704
-
705
- <IressStack gap\="md"\>
706
- <div\>
707
- <IressSelect
708
- placeholder\="2"
709
- width\="2"
710
- \>
711
- <option value\="1"\>
712
- Option 1 </option\>
713
- <option value\="2"\>
714
- Option 2 </option\>
715
- <option value\="3"\>
716
- Option 3 </option\>
717
- <option value\="4"\>
718
- Option 4 </option\>
719
- <option value\="5"\>
720
- Option 5 </option\>
721
- </IressSelect\>
722
- </div\>
723
- <div\>
724
- <IressSelect
725
- placeholder\="4"
726
- width\="4"
727
- \>
728
- <option value\="1"\>
729
- Option 1 </option\>
730
- <option value\="2"\>
731
- Option 2 </option\>
732
- <option value\="3"\>
733
- Option 3 </option\>
734
- <option value\="4"\>
735
- Option 4 </option\>
736
- <option value\="5"\>
737
- Option 5 </option\>
738
- </IressSelect\>
739
- </div\>
740
- <div\>
741
- <IressSelect
742
- placeholder\="6"
743
- width\="6"
744
- \>
745
- <option value\="1"\>
746
- Option 1 </option\>
747
- <option value\="2"\>
748
- Option 2 </option\>
749
- <option value\="3"\>
750
- Option 3 </option\>
751
- <option value\="4"\>
752
- Option 4 </option\>
753
- <option value\="5"\>
754
- Option 5 </option\>
755
- </IressSelect\>
756
- </div\>
757
- <div\>
758
- <IressSelect
759
- placeholder\="8"
760
- width\="8"
761
- \>
762
- <option value\="1"\>
763
- Option 1 </option\>
764
- <option value\="2"\>
765
- Option 2 </option\>
766
- <option value\="3"\>
767
- Option 3 </option\>
768
- <option value\="4"\>
769
- Option 4 </option\>
770
- <option value\="5"\>
771
- Option 5 </option\>
772
- </IressSelect\>
773
- </div\>
774
- <div\>
775
- <IressSelect
776
- placeholder\="10"
777
- width\="10"
778
- \>
779
- <option value\="1"\>
780
- Option 1 </option\>
781
- <option value\="2"\>
782
- Option 2 </option\>
783
- <option value\="3"\>
784
- Option 3 </option\>
785
- <option value\="4"\>
786
- Option 4 </option\>
787
- <option value\="5"\>
788
- Option 5 </option\>
789
- </IressSelect\>
790
- </div\>
791
- <div\>
792
- <IressSelect
793
- placeholder\="12"
794
- width\="12"
795
- \>
796
- <option value\="1"\>
797
- Option 1 </option\>
798
- <option value\="2"\>
799
- Option 2 </option\>
800
- <option value\="3"\>
801
- Option 3 </option\>
802
- <option value\="4"\>
803
- Option 4 </option\>
804
- <option value\="5"\>
805
- Option 5 </option\>
806
- </IressSelect\>
807
- </div\>
808
- <div\>
809
- <IressSelect
810
- placeholder\="16"
811
- width\="16"
812
- \>
813
- <option value\="1"\>
814
- Option 1 </option\>
815
- <option value\="2"\>
816
- Option 2 </option\>
817
- <option value\="3"\>
818
- Option 3 </option\>
819
- <option value\="4"\>
820
- Option 4 </option\>
821
- <option value\="5"\>
822
- Option 5 </option\>
823
- </IressSelect\>
824
- </div\>
825
- <div\>
826
- <IressSelect
827
- placeholder\="25perc"
828
- width\="25perc"
829
- \>
830
- <option value\="1"\>
831
- Option 1 </option\>
832
- <option value\="2"\>
833
- Option 2 </option\>
834
- <option value\="3"\>
835
- Option 3 </option\>
836
- <option value\="4"\>
837
- Option 4 </option\>
838
- <option value\="5"\>
839
- Option 5 </option\>
840
- </IressSelect\>
841
- </div\>
842
- <div\>
843
- <IressSelect
844
- placeholder\="50perc"
845
- width\="50perc"
846
- \>
847
- <option value\="1"\>
848
- Option 1 </option\>
849
- <option value\="2"\>
850
- Option 2 </option\>
851
- <option value\="3"\>
852
- Option 3 </option\>
853
- <option value\="4"\>
854
- Option 4 </option\>
855
- <option value\="5"\>
856
- Option 5 </option\>
857
- </IressSelect\>
858
- </div\>
859
- <div\>
860
- <IressSelect
861
- placeholder\="75perc"
862
- width\="75perc"
863
- \>
864
- <option value\="1"\>
865
- Option 1 </option\>
866
- <option value\="2"\>
867
- Option 2 </option\>
868
- <option value\="3"\>
869
- Option 3 </option\>
870
- <option value\="4"\>
871
- Option 4 </option\>
872
- <option value\="5"\>
873
- Option 5 </option\>
874
- </IressSelect\>
875
- </div\>
876
- <div\>
877
- <IressSelect
878
- placeholder\="100perc"
879
- width\="100perc"
880
- \>
881
- <option value\="1"\>
882
- Option 1 </option\>
883
- <option value\="2"\>
884
- Option 2 </option\>
885
- <option value\="3"\>
886
- Option 3 </option\>
887
- <option value\="4"\>
888
- Option 4 </option\>
889
- <option value\="5"\>
890
- Option 5 </option\>
891
- </IressSelect\>
892
- </div\>
893
- </IressStack\>
894
-
895
- Copy
896
-
897
- ### [](#read-only)Read only
898
-
899
- Unlike the standard HTML `select` element, the `IressSelect` component can be set to `readOnly`. In this case, an `IressReadonly` component will render the selected label text, while the selected value is rendered in a hidden HTML `input` element for form submission.
900
-
901
- If you need more control over the read-only state (for example, rendering a stylised version of the value), you can use the [`IressReadonly` component](?path=/docs/components-readonly--docs).
902
-
903
- Option 2
904
-
905
- Hide code
906
-
907
- \[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; }
908
-
909
- <IressSelect
910
- readOnly
911
- value\="2"
912
- \>
913
- <option value\="1"\>
914
- Option 1 </option\>
915
- <option value\="2"\>
916
- Option 2 </option\>
917
- <option value\="3"\>
918
- Option 3 </option\>
919
- <option value\="4"\>
920
- Option 4 </option\>
921
- <option value\="5"\>
922
- Option 5 </option\>
923
- </IressSelect\>
924
-
925
- Copy
926
-
927
- On this page
928
-
929
- * [Overview](#overview)
930
- * [Props](#props)
931
- * [Usage](#usage)
932
- * [When To Use](#when-to-use)
933
- * [Examples](#examples)
934
- * [Options](#options)
935
- * [Option groups](#option-groups)
936
- * [Non-string values](#non-string-values)
937
- * [Placeholder](#placeholder)
938
- * [Selected option](#selected-option)
939
- * [Sizing](#sizing)
940
- * [Read only](#read-only)