@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.
Files changed (132) hide show
  1. package/generated/docs/components_components-alert-docs.md +492 -0
  2. package/generated/docs/components_components-autocomplete-docs.md +3485 -0
  3. package/generated/docs/{components-autocomplete-recipes-docs.md → components_components-autocomplete-recipes-docs.md} +32 -14
  4. package/generated/docs/{components-badge-docs.md → components_components-badge-docs.md} +222 -30
  5. package/generated/docs/components_components-button-docs.md +2078 -0
  6. package/generated/docs/components_components-button-recipes-docs.md +37 -0
  7. package/generated/docs/components_components-buttongroup-docs.md +1045 -0
  8. package/generated/docs/components_components-card-docs.md +2276 -0
  9. package/generated/docs/{components-card-recipes-docs.md → components_components-card-recipes-docs.md} +131 -14
  10. package/generated/docs/components_components-checkbox-docs.md +1054 -0
  11. package/generated/docs/{components-checkboxgroup-docs.md → components_components-checkboxgroup-docs.md} +1000 -81
  12. package/generated/docs/{components-checkboxgroup-recipes-docs.md → components_components-checkboxgroup-recipes-docs.md} +101 -11
  13. package/generated/docs/{components-col-docs.md → components_components-col-docs.md} +331 -58
  14. package/generated/docs/components_components-combobox-docs.md +3767 -0
  15. package/generated/docs/{components-container-docs.md → components_components-container-docs.md} +61 -24
  16. package/generated/docs/{components-divider-docs.md → components_components-divider-docs.md} +83 -24
  17. package/generated/docs/{components-expander-docs.md → components_components-expander-docs.md} +264 -33
  18. package/generated/docs/{components-field-docs.md → components_components-field-docs.md} +814 -120
  19. package/generated/docs/components_components-filter-docs.md +4080 -0
  20. package/generated/docs/{components-form-docs.md → components_components-form-docs.md} +1515 -353
  21. package/generated/docs/{components-form-recipes-docs.md → components_components-form-recipes-docs.md} +170 -54
  22. package/generated/docs/components_components-hide-docs.md +293 -0
  23. package/generated/docs/components_components-icon-docs.md +1337 -0
  24. package/generated/docs/{components-inline-docs.md → components_components-inline-docs.md} +462 -42
  25. package/generated/docs/components_components-input-docs.md +1468 -0
  26. package/generated/docs/components_components-input-recipes-docs.md +367 -0
  27. package/generated/docs/components_components-inputcurrency-docs.md +432 -0
  28. package/generated/docs/{components-inputcurrency-recipes-docs.md → components_components-inputcurrency-recipes-docs.md} +110 -17
  29. package/generated/docs/components_components-label-docs.md +323 -0
  30. package/generated/docs/components_components-menu-docs.md +2345 -0
  31. package/generated/docs/components_components-menu-menuitem-docs.md +633 -0
  32. package/generated/docs/{components-modal-docs.md → components_components-modal-docs.md} +1625 -232
  33. package/generated/docs/components_components-navbar-docs.md +1847 -0
  34. package/generated/docs/{components-navbar-recipes-docs.md → components_components-navbar-recipes-docs.md} +697 -39
  35. package/generated/docs/{components-panel-docs.md → components_components-panel-docs.md} +754 -57
  36. package/generated/docs/components_components-placeholder-docs.md +92 -0
  37. package/generated/docs/components_components-popover-docs.md +1641 -0
  38. package/generated/docs/{components-popover-recipes-docs.md → components_components-popover-recipes-docs.md} +347 -17
  39. package/generated/docs/components_components-progress-docs.md +115 -0
  40. package/generated/docs/{components-provider-docs.md → components_components-provider-docs.md} +41 -32
  41. package/generated/docs/components_components-radio-docs.md +491 -0
  42. package/generated/docs/{components-radiogroup-docs.md → components_components-radiogroup-docs.md} +943 -75
  43. package/generated/docs/components_components-readonly-docs.md +263 -0
  44. package/generated/docs/components_components-richselect-docs.md +6497 -0
  45. package/generated/docs/{components-row-docs.md → components_components-row-docs.md} +353 -43
  46. package/generated/docs/{components-select-docs.md → components_components-select-docs.md} +719 -61
  47. package/generated/docs/components_components-skeleton-docs.md +480 -0
  48. package/generated/docs/{components-skeleton-recipes-docs.md → components_components-skeleton-recipes-docs.md} +50 -10
  49. package/generated/docs/{components-skiplink-docs.md → components_components-skiplink-docs.md} +53 -14
  50. package/generated/docs/components_components-slideout-docs.md +2262 -0
  51. package/generated/docs/components_components-slider-docs.md +1276 -0
  52. package/generated/docs/components_components-spinner-docs.md +82 -0
  53. package/generated/docs/{components-stack-docs.md → components_components-stack-docs.md} +223 -40
  54. package/generated/docs/components_components-table-docs.md +3651 -0
  55. package/generated/docs/components_components-tabset-docs.md +772 -0
  56. package/generated/docs/components_components-tabset-tab-docs.md +262 -0
  57. package/generated/docs/components_components-tag-docs.md +259 -0
  58. package/generated/docs/{components-text-docs.md → components_components-text-docs.md} +491 -51
  59. package/generated/docs/{components-toaster-docs.md → components_components-toaster-docs.md} +181 -79
  60. package/generated/docs/components_components-toaster-toast-docs.md +634 -0
  61. package/generated/docs/components_components-toggle-docs.md +461 -0
  62. package/generated/docs/{components-tooltip-docs.md → components_components-tooltip-docs.md} +286 -41
  63. package/generated/docs/{components-validationmessage-docs.md → components_components-validationmessage-docs.md} +230 -61
  64. package/generated/docs/components_contact-us-docs.md +12 -0
  65. package/generated/docs/{foundations-accessibility-docs.md → components_foundations-accessibility-docs.md} +11 -21
  66. package/generated/docs/{foundations-colours-docs.md → components_foundations-colour-030-colours.md} +8 -15
  67. package/generated/docs/{foundations-consistency-docs.md → components_foundations-consistency-docs.md} +12 -20
  68. package/generated/docs/{foundations-content-docs.md → components_foundations-content-docs.md} +6 -11
  69. package/generated/docs/components_foundations-introduction-docs.md +15 -0
  70. package/generated/docs/{foundations-principles-docs.md → components_foundations-principles-docs.md} +14 -24
  71. package/generated/docs/components_foundations-typography-docs.md +608 -0
  72. package/generated/docs/{foundations-user-experience-docs.md → components_foundations-user-experience-docs.md} +16 -26
  73. package/generated/docs/{foundations-visual-design-docs.md → components_foundations-visual-design-docs.md} +10 -17
  74. package/generated/docs/{frequently-asked-questions-docs.md → components_frequently-asked-questions-docs.md} +14 -23
  75. package/generated/docs/components_get-started-develop-docs.md +84 -0
  76. package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
  77. package/generated/docs/components_introduction-docs.md +15 -0
  78. package/generated/docs/{patterns-loading-docs.md → components_patterns-loading-docs.md} +711 -143
  79. package/generated/docs/components_resources-changelog-docs.md +4 -0
  80. package/generated/docs/{resources-code-katas-docs.md → components_resources-code-katas-docs.md} +5 -9
  81. package/generated/docs/{resources-migration-guides-from-v4-to-v5-docs.md → components_resources-migration-guides-from-v4-to-v5-docs.md} +54 -239
  82. package/generated/docs/{versions-docs.md → components_versions-docs.md} +5 -8
  83. package/generated/docs/guidelines.md +484 -200
  84. package/generated/docs/introduction-docs.md +19 -30
  85. package/package.json +41 -45
  86. package/generated/docs/components-alert-docs.md +0 -130
  87. package/generated/docs/components-autocomplete-docs.md +0 -754
  88. package/generated/docs/components-button-docs.md +0 -362
  89. package/generated/docs/components-button-recipes-docs.md +0 -76
  90. package/generated/docs/components-buttongroup-docs.md +0 -310
  91. package/generated/docs/components-card-docs.md +0 -494
  92. package/generated/docs/components-checkbox-docs.md +0 -193
  93. package/generated/docs/components-combobox-docs.md +0 -1016
  94. package/generated/docs/components-filter-docs.md +0 -1109
  95. package/generated/docs/components-hide-docs.md +0 -265
  96. package/generated/docs/components-icon-docs.md +0 -553
  97. package/generated/docs/components-input-docs.md +0 -335
  98. package/generated/docs/components-input-recipes-docs.md +0 -140
  99. package/generated/docs/components-inputcurrency-docs.md +0 -157
  100. package/generated/docs/components-label-docs.md +0 -135
  101. package/generated/docs/components-menu-docs.md +0 -704
  102. package/generated/docs/components-menu-menuitem-docs.md +0 -193
  103. package/generated/docs/components-navbar-docs.md +0 -291
  104. package/generated/docs/components-placeholder-docs.md +0 -27
  105. package/generated/docs/components-popover-docs.md +0 -464
  106. package/generated/docs/components-progress-docs.md +0 -104
  107. package/generated/docs/components-radio-docs.md +0 -107
  108. package/generated/docs/components-readonly-docs.md +0 -89
  109. package/generated/docs/components-richselect-docs.md +0 -2433
  110. package/generated/docs/components-skeleton-docs.md +0 -214
  111. package/generated/docs/components-slideout-docs.md +0 -538
  112. package/generated/docs/components-slider-docs.md +0 -346
  113. package/generated/docs/components-spinner-docs.md +0 -59
  114. package/generated/docs/components-table-ag-grid-docs.md +0 -1074
  115. package/generated/docs/components-table-docs.md +0 -1305
  116. package/generated/docs/components-tabset-docs.md +0 -341
  117. package/generated/docs/components-tabset-tab-docs.md +0 -86
  118. package/generated/docs/components-tag-docs.md +0 -115
  119. package/generated/docs/components-toaster-toast-docs.md +0 -157
  120. package/generated/docs/components-toggle-docs.md +0 -158
  121. package/generated/docs/contact-us-docs.md +0 -27
  122. package/generated/docs/extensions-editor-docs.md +0 -288
  123. package/generated/docs/extensions-editor-recipes-docs.md +0 -39
  124. package/generated/docs/foundations-introduction-docs.md +0 -17
  125. package/generated/docs/foundations-typography-docs.md +0 -191
  126. package/generated/docs/get-started-develop-docs.md +0 -209
  127. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  128. package/generated/docs/resources-changelog-docs.md +0 -6
  129. package/generated/docs/themes-available-themes-docs.md +0 -66
  130. package/generated/docs/themes-introduction-docs.md +0 -121
  131. package/generated/docs/themes-tokens-docs.md +0 -1200
  132. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,704 +0,0 @@
1
- [](#menu)Menu
2
- =============
3
-
4
- Overview
5
- --------
6
-
7
- A menu can display grouped action buttons, navigation items or headings.
8
-
9
- Menu heading
10
- ------------
11
-
12
- Menu item (button)
13
-
14
- * * *
15
-
16
- [Menu item (link)](https://iress.com)Menu item (selected)
17
-
18
- Hide code
19
-
20
- \[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; }
21
-
22
- <IressMenu defaultSelected\="5"\>
23
- <IressMenuHeading\>
24
- Menu heading </IressMenuHeading\>
25
- <IressMenuItem value\="2"\>
26
- Menu item (button) </IressMenuItem\>
27
- <IressMenuDivider />
28
- <IressMenuItem href\="https://iress.com"\>
29
- Menu item (link) </IressMenuItem\>
30
- <IressMenuItem
31
- selected
32
- value\={5}
33
- \>
34
- Menu item (selected) </IressMenuItem\>
35
- </IressMenu\>
36
-
37
- Copy
38
-
39
- [](#usage)Usage
40
- ---------------
41
-
42
- ### [](#basic)Basic
43
-
44
- `IressMenuHeading`, `IressMenuDivider` and `IressMenuItem` should be supplied as `children` of the menu.
45
-
46
- * `IressMenuHeading` can be used to display a heading, it supports all of the props of `h*`. You can change the heading level with the `level` prop.
47
- * `IressMenuDivider` can be used to display a divider, it supports all of the props of `hr`. It will adjust according to the menu's role and layout.
48
- * `IressMenuItem` is a wrapper around `IressButton` and supports all of its props.
49
-
50
- **Note:** The `mapMenuItems` helper function, originally used to map options to MenuItem components, is now deprecated. Instead, you can use `array.map` to map the options to menu sub-components.
51
-
52
- Menu heading
53
- ------------
54
-
55
- Menu item (button)
56
-
57
- * * *
58
-
59
- [Menu item (link)](https://iress.com)Menu item (selected)
60
-
61
- Hide code
62
-
63
- \[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; }
64
-
65
- <IressMenu defaultSelected\="5"\>
66
- <IressMenuHeading\>
67
- Menu heading </IressMenuHeading\>
68
- <IressMenuItem value\="2"\>
69
- Menu item (button) </IressMenuItem\>
70
- <IressMenuDivider />
71
- <IressMenuItem href\="https://iress.com"\>
72
- Menu item (link) </IressMenuItem\>
73
- <IressMenuItem
74
- selected
75
- value\={5}
76
- \>
77
- Menu item (selected) </IressMenuItem\>
78
- </IressMenu\>
79
-
80
- Copy
81
-
82
- ### [](#complex)Complex
83
-
84
- `IressMenuHeading` and `IressMenuItem` support `prepend`, `divider` and `append` slots, to allow you to create complex menu items.
85
-
86
- Heading with prepend
87
- --------------------
88
-
89
- Button with append and prepend
90
-
91
- ### Heading with append and prepend
92
-
93
- [Link with append](https://iress.com)
94
-
95
- * * *
96
-
97
- Button with append[A link with a very long name that wraps based on the menu's `noWrap` prop](https://iress.com)
98
-
99
- Hide code
100
-
101
- \[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; }
102
-
103
- <IressMenu\>
104
- <IressMenuHeading prepend\={<IressIcon fixedWidth name\="smile"/>}\>
105
- Heading with prepend </IressMenuHeading\>
106
- <IressMenuItem
107
- append\={<IressIcon name\="chevron-right" />}
108
- divider
109
- prepend\={<IressIcon fixedWidth name\="flag"/>}
110
- selected
111
- value\="3"
112
- \>
113
- Button with append and prepend </IressMenuItem\>
114
- <IressMenuHeading
115
- append\={<IressIcon fixedWidth name\="smile"/>}
116
- level\="h3"
117
- prepend\={<IressIcon fixedWidth name\="smile"/>}
118
- \>
119
- Heading with append and prepend </IressMenuHeading\>
120
- <IressMenuItem
121
- append\={<IressIcon name\="chevron-right" />}
122
- href\="https://iress.com"
123
- value\="4"
124
- \>
125
- Link with append </IressMenuItem\>
126
- <IressMenuDivider />
127
- <IressMenuItem
128
- append\={<IressIcon name\="chevron-right" />}
129
- value\="6"
130
- \>
131
- Button with append </IressMenuItem\>
132
- <IressMenuItem
133
- append\={<IressIcon name\="chevron-right" />}
134
- href\="https://iress.com"
135
- value\="7"
136
- \>
137
- A link with a very long name that wraps based on the menu's{' '} <code\>
138
- noWrap </code\>
139
- {' '}prop
140
- </IressMenuItem\>
141
- </IressMenu\>
142
-
143
- Copy
144
-
145
- [](#examples)Examples
146
- ---------------------
147
-
148
- ### [](#secondary-navigation)Secondary navigation
149
-
150
- When the `href` prop is set on `MenuLink`, it will render as a link.
151
-
152
- When rendering a set of links for navigation purposes (as a secondary nav in this example) make sure you wrap the `IressMenu` in a nav element and set the menu's `role` prop to list.
153
-
154
- [Financial advice](https://www.iress.com/software/financial-advice/)[Trading and market data](https://www.iress.com/software/trading-and-market-data/)[Investment management](https://www.iress.com/software/investment-management/)[Mortgages](https://www.iress.com/software/mortgages/)[Life and pensions](https://www.iress.com/software/life-and-pensions/)
155
-
156
- Hide code
157
-
158
- \[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; }
159
-
160
- <nav aria-label\="Secondary"\>
161
- <IressMenu\>
162
- <IressMenuItem href\="https://www.iress.com/software/financial-advice/"\>
163
- Financial advice </IressMenuItem\>
164
- <IressMenuItem
165
- href\="https://www.iress.com/software/trading-and-market-data/"
166
- selected
167
- \>
168
- Trading and market data </IressMenuItem\>
169
- <IressMenuItem href\="https://www.iress.com/software/investment-management/"\>
170
- Investment management </IressMenuItem\>
171
- <IressMenuItem href\="https://www.iress.com/software/mortgages/"\>
172
- Mortgages </IressMenuItem\>
173
- <IressMenuItem href\="https://www.iress.com/software/life-and-pensions/"\>
174
- Life and pensions </IressMenuItem\>
175
- </IressMenu\>
176
- </nav\>
177
-
178
- Copy
179
-
180
- ### [](#headings)Headings
181
-
182
- Using the `IressMenuHeading` component, you can create headings within the menu. You can also change the heading level with the `level` prop.
183
-
184
- #### Menu heading (h4)
185
-
186
- Menu item 1
187
-
188
- ##### Menu heading (h5)
189
-
190
- Menu item 2
191
-
192
- Hide code
193
-
194
- \[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; }
195
-
196
- <IressMenu\>
197
- <IressMenuHeading level\="h4"\>
198
- Menu heading (h4) </IressMenuHeading\>
199
- <IressMenuItem\>
200
- Menu item 1 </IressMenuItem\>
201
- <IressMenuHeading level\="h5"\>
202
- Menu heading (h5) </IressMenuHeading\>
203
- <IressMenuItem\>
204
- Menu item 2 </IressMenuItem\>
205
- </IressMenu\>
206
-
207
- Copy
208
-
209
- ### [](#dividers)Dividers
210
-
211
- When the `divider` prop is set, the `IressMenuHeading`, `IressMenuButton` and `IressMenuLink` will render a bottom border.
212
-
213
- In situations where a bottom border will not work, you can also use `IressMenuDivider` inside the menu to separate items.
214
-
215
- #### Menu heading (h4)
216
-
217
- Menu item 1Menu item 2
218
-
219
- ##### Menu heading (h5)
220
-
221
- Menu item 3Menu item 4
222
-
223
- * * *
224
-
225
- Menu item 5
226
-
227
- Hide code
228
-
229
- \[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; }
230
-
231
- <IressMenu\>
232
- <IressMenuHeading
233
- divider
234
- level\="h4"
235
- \>
236
- Menu heading (h4) </IressMenuHeading\>
237
- <IressMenuItem\>
238
- Menu item 1 </IressMenuItem\>
239
- <IressMenuItem divider\>
240
- Menu item 2 </IressMenuItem\>
241
- <IressMenuHeading level\="h5"\>
242
- Menu heading (h5) </IressMenuHeading\>
243
- <IressMenuItem selected\>
244
- Menu item 3 </IressMenuItem\>
245
- <IressMenuItem\>
246
- Menu item 4 </IressMenuItem\>
247
- <IressMenuDivider />
248
- <IressMenuItem\>
249
- Menu item 5 </IressMenuItem\>
250
- </IressMenu\>
251
-
252
- Copy
253
-
254
- ### [](#fluid-menus)Fluid menus
255
-
256
- By setting the `fluid` prop on the menu component, the menu will stretch to the width of its containing element.
257
-
258
- Menu heading
259
- ------------
260
-
261
- Menu item (button)
262
-
263
- * * *
264
-
265
- [Menu item (link)](https://iress.com)Menu item (selected)
266
-
267
- Hide code
268
-
269
- \[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; }
270
-
271
- <IressMenu
272
- defaultSelected\="5"
273
- fluid
274
- \>
275
- <IressMenuHeading\>
276
- Menu heading </IressMenuHeading\>
277
- <IressMenuItem value\="2"\>
278
- Menu item (button) </IressMenuItem\>
279
- <IressMenuDivider />
280
- <IressMenuItem href\="https://iress.com"\>
281
- Menu item (link) </IressMenuItem\>
282
- <IressMenuItem
283
- selected
284
- value\={5}
285
- \>
286
- Menu item (selected) </IressMenuItem\>
287
- </IressMenu\>
288
-
289
- Copy
290
-
291
- ### [](#layout)Layout
292
-
293
- The `layout` prop comes with three options:
294
-
295
- * `stack` (default) - menu items will stack on top of each other
296
- * `inline` - menu items will be inline
297
- * `inline-equal-width` - menu items will be inline and have equal width
298
-
299
- ### stack
300
-
301
- Menu heading
302
- ------------
303
-
304
- Menu item (button)
305
-
306
- * * *
307
-
308
- [Menu item (link)](https://iress.com)Menu item (selected)
309
-
310
- ### inline
311
-
312
- Menu heading
313
- ------------
314
-
315
- Menu item (button)
316
-
317
- * * *
318
-
319
- [Menu item (link)](https://iress.com)Menu item (selected)
320
-
321
- ### inline-equal-width
322
-
323
- Menu heading
324
- ------------
325
-
326
- Menu item (button)
327
-
328
- * * *
329
-
330
- [Menu item (link)](https://iress.com)Menu item (selected)
331
-
332
- Hide code
333
-
334
- \[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; }
335
-
336
- <IressStack gutter\="lg"\>
337
- <IressText\>
338
- <h3\>
339
- stack </h3\>
340
- <IressMenu
341
- defaultSelected\="5"
342
- layout\="stack"
343
- \>
344
- <IressMenuHeading\>
345
- Menu heading </IressMenuHeading\>
346
- <IressMenuItem value\="2"\>
347
- Menu item (button) </IressMenuItem\>
348
- <IressMenuDivider />
349
- <IressMenuItem href\="https://iress.com"\>
350
- Menu item (link) </IressMenuItem\>
351
- <IressMenuItem
352
- selected
353
- value\={5}
354
- \>
355
- Menu item (selected) </IressMenuItem\>
356
- </IressMenu\>
357
- </IressText\>
358
- <IressText\>
359
- <h3\>
360
- inline </h3\>
361
- <IressMenu
362
- defaultSelected\="5"
363
- layout\="inline"
364
- \>
365
- <IressMenuHeading\>
366
- Menu heading </IressMenuHeading\>
367
- <IressMenuItem value\="2"\>
368
- Menu item (button) </IressMenuItem\>
369
- <IressMenuDivider />
370
- <IressMenuItem href\="https://iress.com"\>
371
- Menu item (link) </IressMenuItem\>
372
- <IressMenuItem
373
- selected
374
- value\={5}
375
- \>
376
- Menu item (selected) </IressMenuItem\>
377
- </IressMenu\>
378
- </IressText\>
379
- <IressText\>
380
- <h3\>
381
- inline-equal-width </h3\>
382
- <IressMenu
383
- defaultSelected\="5"
384
- layout\="inline-equal-width"
385
- \>
386
- <IressMenuHeading\>
387
- Menu heading </IressMenuHeading\>
388
- <IressMenuItem value\="2"\>
389
- Menu item (button) </IressMenuItem\>
390
- <IressMenuDivider />
391
- <IressMenuItem href\="https://iress.com"\>
392
- Menu item (link) </IressMenuItem\>
393
- <IressMenuItem
394
- selected
395
- value\={5}
396
- \>
397
- Menu item (selected) </IressMenuItem\>
398
- </IressMenu\>
399
- </IressText\>
400
- </IressStack\>
401
-
402
- Copy
403
-
404
- ### [](#text-wrapping)Text wrapping
405
-
406
- By default, menu item text will wrap on to the next line when it exceeds the menu width. Using the `noWrap` prop, you set the menu item text to not wrap.
407
-
408
- Menu item with some text that wraps
409
-
410
- Non wrapping menu item with some text
411
-
412
- Hide code
413
-
414
- \[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; }
415
-
416
- <div
417
- style\={{
418
- display: 'flex',
419
- maxWidth: '300px'
420
- }}
421
- \>
422
- <IressMenu defaultSelected\="5"\>
423
- <IressMenuItem\>
424
- Menu item with some text that wraps </IressMenuItem\>
425
- </IressMenu\>
426
- <IressMenu
427
- defaultSelected\="5"
428
- noWrap
429
- \>
430
- <IressMenuItem\>
431
- Non wrapping menu item with some text </IressMenuItem\>
432
- </IressMenu\>
433
- </div\>
434
-
435
- Copy
436
-
437
- ### [](#slot-props)Slot props
438
-
439
- `IressMenuHeading`, `IressMenuButton` and `IressMenuLink` provide `prepend` and `append` props to position content either before or after its content.
440
-
441
- Prepend slot
442
- ------------
443
-
444
- New fileSave file as
445
-
446
- ### Append slot
447
-
448
- [Visit the Iress website](https://www.iress.com)[Visit Google8+](https://google.com)
449
-
450
- Hide code
451
-
452
- \[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; }
453
-
454
- <IressMenu role\="menu"\>
455
- <IressMenuHeading prepend\={<IressIcon name\="cog" />}\>
456
- Prepend slot </IressMenuHeading\>
457
- <IressMenuItem
458
- onClick\={() \=> {}}
459
- prepend\={<IressIcon name\="file-alt" />}
460
- \>
461
- New file </IressMenuItem\>
462
- <IressMenuItem
463
- divider
464
- onClick\={() \=> {}}
465
- prepend\={<IressIcon name\="save" />}
466
- \>
467
- Save file as </IressMenuItem\>
468
- <IressMenuHeading
469
- append\={<IressIcon name\="link" />}
470
- level\="h3"
471
- \>
472
- Append slot </IressMenuHeading\>
473
- <IressMenuItem
474
- append\={<IressIcon name\="chevron-right" />}
475
- href\="https://www.iress.com"
476
- \>
477
- Visit the Iress website </IressMenuItem\>
478
- <IressMenuItem
479
- append\={<IressBadge mode\="warning"\>8+</IressBadge\>}
480
- href\="https://google.com"
481
- \>
482
- Visit Google </IressMenuItem\>
483
- </IressMenu\>
484
-
485
- Copy
486
-
487
- ### [](#roles)Roles
488
-
489
- The `role` prop that comes with the menu component not only changes the aria-role of the menu to allow it to be easily recognised in screen readers, but also changes how the menu is interacted with.
490
-
491
- There are four roles supported:
492
-
493
- * `list` (default): The menu is treated as a list of items. Child menu subcomponents render with the `listitem` role where appropriate. The user navigates using the `tab` key.
494
- * `menu`: The menu is treated as a menu of items. Child menu subcomponents render with the `menuitem` role where appropriate. The user navigates using `arrow` keys.
495
- * `listbox`: The menu is treated as a list of selectable items, similar to a `<select />`. Child menu subcomponents render with the `option` role where appropriate. The user navigates using `arrow` keys.
496
- * `nav`: The menu is treated the same as the `list` role, except the menu is styled differently.
497
-
498
- **Note:** When menu is used as a child of popover, the `role` that is set on popover will be applied to menu (so you don't need to set it twice).
499
-
500
- #### [](#list)List
501
-
502
- The default role for the menu component is `list`. It is most often used for navigation and its items can be navigated (using the keyboard) with the `tab` key.
503
-
504
- Menu heading
505
- ------------
506
-
507
- Menu item (button)
508
-
509
- * * *
510
-
511
- [Menu item (link)](https://iress.com)Menu item (selected)
512
-
513
- The list menu is used to describe that the items are related to the same context, similar to using `ul` or `ol` lists. It is activated by setting the `role` prop to `list`.
514
-
515
- Keyboard interaction
516
-
517
- * Menu items cannot be navigated using the arrow keys
518
- * Menu items are navigated using the `tab` key
519
-
520
- Hide code
521
-
522
- \[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; }
523
-
524
- <IressMenu defaultSelected\={5}\>
525
- <IressMenuHeading\>
526
- Menu heading </IressMenuHeading\>
527
- <IressMenuItem value\="2"\>
528
- Menu item (button) </IressMenuItem\>
529
- <IressMenuDivider />
530
- <IressMenuItem href\="https://iress.com"\>
531
- Menu item (link) </IressMenuItem\>
532
- <IressMenuItem
533
- selected
534
- value\={5}
535
- \>
536
- Menu item (selected) </IressMenuItem\>
537
- </IressMenu\>
538
-
539
- Copy
540
-
541
- #### [](#menu-1)Menu
542
-
543
- The `menu` role is used when the items in the menu has an action that performs a task in the application. The items can be navigated (using the keyboard) with the `arrow` keys, depending on the layout.
544
-
545
- Menu heading
546
- ------------
547
-
548
- Menu item (button)
549
-
550
- * * *
551
-
552
- [Menu item (link)](https://iress.com)Menu item (selected)
553
-
554
- The application menu is used when the items in the menu has an action that performs a task in the application. It is activated by setting the `role` prop to `menu`.
555
-
556
- Keyboard interaction
557
-
558
- * In stack layout, pressing the `up` arrow key on the first item will focus the last item
559
- * In stack layout, pressing the `down` arrow key on the last item will focus the first item
560
- * In inline layouts, pressing the `left` arrow key on the first item will focus the last item
561
- * In inline layouts, pressing the `right` arrow key on the last item will focus the first item
562
- * Pressing the `tab` key when focused on any item in the menu will focus to next focusable item outside of the menu
563
-
564
- Hide code
565
-
566
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
567
-
568
- <IressMenu
569
- defaultSelected\={5}
570
- role\="menu"
571
- \>
572
- <IressMenuHeading\>
573
- Menu heading </IressMenuHeading\>
574
- <IressMenuItem value\="2"\>
575
- Menu item (button) </IressMenuItem\>
576
- <IressMenuDivider />
577
- <IressMenuItem href\="https://iress.com"\>
578
- Menu item (link) </IressMenuItem\>
579
- <IressMenuItem
580
- selected
581
- value\={5}
582
- \>
583
- Menu item (selected) </IressMenuItem\>
584
- </IressMenu\>
585
-
586
- Copy
587
-
588
- #### [](#listbox)Listbox
589
-
590
- The `listbox` role is used for lists from which a user may select one or more items.
591
-
592
- A value is supplied to `IressMenuButton` (like you would with an option element inside a select) and a `onChange` event is emitted with the selected value(s) whenever the selection is changed by the user.
593
-
594
- Set the `multiSelect` prop to true for a multi-selectable listbox.
595
-
596
- New taskSend prospect welcome packBook in Discovery meetingProspect proceeding
597
-
598
- Multi-select
599
-
600
- The `listbox` menu is used for lists from which a user may select one or more items.
601
-
602
- A value is supplied to MenuItem (like you would with an `option` element inside a `select`) and a `onChange` event is emitted with the selected value(s) whenever the selection is changed by the user.
603
-
604
- If you need to set the selected state of an item programmatically, you can use the `selected` prop. This is set as string on Menu (or an array of strings for multi-selectable Menus), which then sets the selected state the child MenuItems. You can also set the `selected` prop on individual MenuItems, although we recommend that you use Menu's `selected` prop instead.
605
-
606
- **Note:** This is the menu type used to power Filter and Combobox components.
607
-
608
- Keyboard interaction
609
-
610
- * Menu items can be navigated using the arrow keys, depending on the orientation of the menu.
611
- * In stack layouts, pressing the `up` arrow key on the first item will **not** focus the last item
612
- * In stack layouts, pressing the `down` arrow key on the last item will **not** focus the first item
613
- * In inline layouts, pressing the `right` arrow key on the last item will **not** focus the first item
614
- * In inline layouts, pressing the `left` arrow key on the first item will **not** focus the last item
615
- * Pressing the `tab` key when focused on any item in the menu will focus to next focusable item outside of the menu
616
-
617
- Hide code
618
-
619
- \[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; }
620
-
621
- <IressMenu
622
- aria-label\="Selectable listbox"
623
- defaultSelected\={5}
624
- role\="listbox"
625
- \>
626
- <IressMenuItem value\={0}\>
627
- New task </IressMenuItem\>
628
- <IressMenuItem value\={1}\>
629
- Send prospect welcome pack </IressMenuItem\>
630
- <IressMenuItem value\={2}\>
631
- Book in Discovery meeting </IressMenuItem\>
632
- <IressMenuItem value\={3}\>
633
- Prospect proceeding </IressMenuItem\>
634
- </IressMenu\>
635
-
636
- Copy
637
-
638
- #### [](#nav)Nav
639
-
640
- The `nav` role acts as a styling hook to be able to style the selected menu item differently to default menus. This will be most often used as a child of the `IressNavbar` component.
641
-
642
- Menu heading
643
- ------------
644
-
645
- Menu item (button)
646
-
647
- * * *
648
-
649
- [Menu item (link)](https://iress.com)Menu item (selected)
650
-
651
- The `nav` type acts as a styling hook to be able to style the selected menu item differently to default menus. This will be most often used as a child of the `Navbar` component.
652
-
653
- The nav menu exposes the following theme tokens in order to customise the styling:
654
-
655
- * `--iress-menu-item-nav-selected-background-color`
656
- * `--iress-menu-item-nav-selected-text-color`
657
- * `--iress-menu-item-nav-text-align`
658
- * `--iress-menu-item-nav-border-radius`
659
-
660
- Keyboard interaction
661
-
662
- * Menu items cannot be navigated using the arrow keys
663
- * Menu items are navigated using the `tab` key
664
-
665
- Hide code
666
-
667
- \[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; }
668
-
669
- <IressMenu
670
- defaultSelected\={5}
671
- role\="nav"
672
- \>
673
- <IressMenuHeading\>
674
- Menu heading </IressMenuHeading\>
675
- <IressMenuItem value\="2"\>
676
- Menu item (button) </IressMenuItem\>
677
- <IressMenuDivider />
678
- <IressMenuItem href\="https://iress.com"\>
679
- Menu item (link) </IressMenuItem\>
680
- <IressMenuItem
681
- selected
682
- value\={5}
683
- \>
684
- Menu item (selected) </IressMenuItem\>
685
- </IressMenu\>
686
-
687
- Copy
688
-
689
- On this page
690
-
691
- * [Overview](#overview)
692
- * [Props](#props)
693
- * [Usage](#usage)
694
- * [Basic](#basic)
695
- * [Complex](#complex)
696
- * [Examples](#examples)
697
- * [Secondary navigation](#secondary-navigation)
698
- * [Headings](#headings)
699
- * [Dividers](#dividers)
700
- * [Fluid menus](#fluid-menus)
701
- * [Layout](#layout)
702
- * [Text wrapping](#text-wrapping)
703
- * [Slot props](#slot-props)
704
- * [Roles](#roles)