@iress-oss/ids-mcp-server 5.15.0 → 6.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/docs/components-alert-docs.md +579 -7
- package/generated/docs/components-autocomplete-docs.md +694 -15
- package/generated/docs/components-autocomplete-recipes-docs.md +1 -1
- package/generated/docs/components-badge-docs.md +442 -59
- package/generated/docs/components-button-docs.md +1150 -70
- package/generated/docs/components-buttongroup-docs.md +441 -3
- package/generated/docs/components-card-docs.md +487 -37
- package/generated/docs/components-checkbox-docs.md +506 -5
- package/generated/docs/components-checkboxgroup-docs.md +586 -191
- package/generated/docs/components-checkboxgroup-recipes-docs.md +3 -3
- package/generated/docs/components-col-docs.md +451 -36
- package/generated/docs/components-container-docs.md +32 -0
- package/generated/docs/components-divider-docs.md +427 -27
- package/generated/docs/components-expander-docs.md +487 -108
- package/generated/docs/components-field-docs.md +1400 -68
- package/generated/docs/components-filter-docs.md +268 -55
- package/generated/docs/components-hide-docs.md +447 -10
- package/generated/docs/components-icon-docs.md +522 -259
- package/generated/docs/components-image-docs.md +493 -0
- package/generated/docs/components-inline-docs.md +1179 -44
- package/generated/docs/components-input-docs.md +544 -12
- package/generated/docs/components-input-recipes-docs.md +4 -4
- package/generated/docs/components-inputcurrency-docs.md +532 -0
- package/generated/docs/components-inputcurrency-recipes-docs.md +4 -5
- package/generated/docs/components-introduction-docs.md +450 -0
- package/generated/docs/components-label-docs.md +454 -27
- package/generated/docs/components-link-docs.md +586 -0
- package/generated/docs/components-menu-docs.md +531 -89
- package/generated/docs/components-menu-menuitem-docs.md +556 -10
- package/generated/docs/components-modal-docs.md +814 -55
- package/generated/docs/components-panel-docs.md +418 -198
- package/generated/docs/components-placeholder-docs.md +420 -1
- package/generated/docs/components-popover-docs.md +1097 -32
- package/generated/docs/components-popover-recipes-docs.md +39 -73
- package/generated/docs/components-progress-docs.md +464 -0
- package/generated/docs/components-provider-docs.md +57 -2
- package/generated/docs/components-radio-docs.md +460 -4
- package/generated/docs/components-radiogroup-docs.md +586 -116
- package/generated/docs/components-readonly-docs.md +450 -4
- package/generated/docs/components-richselect-docs.md +4660 -1257
- package/generated/docs/components-row-docs.md +2065 -588
- package/generated/docs/components-select-docs.md +489 -5
- package/generated/docs/components-skeleton-docs.md +399 -16
- package/generated/docs/components-skeleton-recipes-docs.md +7 -7
- package/generated/docs/components-skiplink-docs.md +548 -27
- package/generated/docs/components-slideout-docs.md +648 -150
- package/generated/docs/components-slider-docs.md +515 -33
- package/generated/docs/components-spinner-docs.md +393 -2
- package/generated/docs/components-stack-docs.md +732 -74
- package/generated/docs/components-table-ag-grid-docs.md +497 -127
- package/generated/docs/components-table-docs.md +1049 -27
- package/generated/docs/components-tabset-docs.md +454 -27
- package/generated/docs/components-tabset-tab-docs.md +464 -0
- package/generated/docs/components-tag-docs.md +452 -19
- package/generated/docs/components-text-docs.md +322 -131
- package/generated/docs/components-toaster-docs.md +463 -53
- package/generated/docs/components-toggle-docs.md +476 -20
- package/generated/docs/components-tooltip-docs.md +443 -7
- package/generated/docs/components-validationmessage-docs.md +933 -13
- package/generated/docs/extensions-editor-docs.md +906 -13
- package/generated/docs/extensions-editor-recipes-docs.md +51 -1
- package/generated/docs/foundations-accessibility-docs.md +1 -23
- package/generated/docs/foundations-grid-docs.md +74 -0
- package/generated/docs/foundations-introduction-docs.md +6 -4
- package/generated/docs/foundations-responsive-breakpoints-docs.md +193 -0
- package/generated/docs/foundations-tokens-colour-docs.md +564 -0
- package/generated/docs/foundations-tokens-elevation-docs.md +155 -0
- package/generated/docs/foundations-tokens-introduction-docs.md +190 -0
- package/generated/docs/foundations-tokens-radius-docs.md +71 -0
- package/generated/docs/foundations-tokens-spacing-docs.md +89 -0
- package/generated/docs/foundations-tokens-typography-docs.md +322 -0
- package/generated/docs/foundations-z-index-stacking-docs.md +31 -0
- package/generated/docs/guidelines.md +1537 -295
- package/generated/docs/introduction-docs.md +65 -21
- package/generated/docs/news-version-6-docs.md +93 -0
- package/generated/docs/patterns-form-docs.md +3902 -0
- package/generated/docs/patterns-form-recipes-docs.md +1370 -0
- package/generated/docs/patterns-introduction-docs.md +24 -0
- package/generated/docs/patterns-loading-docs.md +2940 -201
- package/generated/docs/resources-introduction-docs.md +38 -0
- package/generated/docs/resources-mcp-server-docs.md +27 -0
- package/generated/docs/styling-props-colour-docs.md +172 -0
- package/generated/docs/styling-props-elevation-docs.md +88 -0
- package/generated/docs/styling-props-radius-docs.md +86 -0
- package/generated/docs/styling-props-reference-docs.md +160 -0
- package/generated/docs/styling-props-screen-readers-docs.md +71 -0
- package/generated/docs/styling-props-sizing-docs.md +627 -0
- package/generated/docs/styling-props-spacing-docs.md +2282 -0
- package/generated/docs/styling-props-typography-docs.md +121 -0
- package/generated/docs/themes-available-themes-docs.md +29 -29
- package/generated/docs/themes-introduction-docs.md +1 -1
- package/package.json +3 -22
- package/generated/docs/components-button-recipes-docs.md +0 -76
- package/generated/docs/components-card-recipes-docs.md +0 -89
- package/generated/docs/components-combobox-docs.md +0 -1016
- package/generated/docs/components-form-docs.md +0 -2410
- package/generated/docs/components-form-recipes-docs.md +0 -886
- package/generated/docs/components-navbar-docs.md +0 -291
- package/generated/docs/components-navbar-recipes-docs.md +0 -413
- package/generated/docs/components-toaster-toast-docs.md +0 -157
- package/generated/docs/foundations-colours-docs.md +0 -257
- package/generated/docs/foundations-typography-docs.md +0 -191
- package/generated/docs/resources-changelog-docs.md +0 -6
- package/generated/docs/themes-tokens-docs.md +0 -1200
|
@@ -6,6 +6,14 @@ Overview
|
|
|
6
6
|
|
|
7
7
|
A menu can display grouped action buttons, navigation items or headings.
|
|
8
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
|
+
|
|
9
17
|
Menu heading
|
|
10
18
|
------------
|
|
11
19
|
|
|
@@ -36,18 +44,493 @@ Hide code
|
|
|
36
44
|
|
|
37
45
|
Copy
|
|
38
46
|
|
|
47
|
+
[](#props)Props
|
|
48
|
+
---------------
|
|
49
|
+
|
|
50
|
+
Below are the custom props you can access when using `IressMenu`. In addition to these, you have access to the original props of the underlying [`div` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div).
|
|
51
|
+
|
|
52
|
+
| Name | Description | Default | Control |
|
|
53
|
+
| --- | --- | --- | --- |
|
|
54
|
+
| bg |
|
|
55
|
+
**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
|
|
56
|
+
|
|
57
|
+
We recommend using the following token values for best background contrast:
|
|
58
|
+
|
|
59
|
+
* `colour.primary.fill` for primary backgrounds that need to stand out
|
|
60
|
+
* `colour.primary.surface` for primary backgrounds that need to be less prominent
|
|
61
|
+
* `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
|
|
62
|
+
* `colour.neutral.20` for a slightly darker background color, used in neutral state components
|
|
63
|
+
* `colour.system.danger.fill` for error backgrounds that need to stand out
|
|
64
|
+
* `colour.system.danger.surface` for error backgrounds that need to be less prominent
|
|
65
|
+
* `colour.system.success.fill` for success backgrounds that need to stand out
|
|
66
|
+
* `colour.system.success.surface` for success backgrounds that need to be less prominent
|
|
67
|
+
* `colour.system.warning.fill` for warning backgrounds that need to stand out
|
|
68
|
+
* `colour.system.warning.surface` for warning backgrounds that need to be less prominent
|
|
69
|
+
* `colour.system.info.fill` for info backgrounds that need to stand out
|
|
70
|
+
* `colour.system.info.surface` for info backgrounds that need to be less prominent
|
|
71
|
+
|
|
72
|
+
ResponsiveProp<ColorToken> | undefined
|
|
73
|
+
|
|
74
|
+
| \- | Set object |
|
|
75
|
+
| borderRadius |
|
|
76
|
+
|
|
77
|
+
The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
|
|
78
|
+
|
|
79
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
80
|
+
| --- | --- | --- | --- | --- |
|
|
81
|
+
| **4** | **4** | **5** | **12** | **9** |
|
|
82
|
+
| 1 _\-x-_ | | 3 _\-x-_ | | |
|
|
83
|
+
|
|
84
|
+
ResponsiveProp<RadiusToken> | undefined
|
|
85
|
+
|
|
86
|
+
| \- | Set object |
|
|
87
|
+
| changeOnBlur |
|
|
88
|
+
|
|
89
|
+
If set to true, change event will be fired with the correctly selected value.
|
|
90
|
+
|
|
91
|
+
booleanundefined
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
| \- | Set object |
|
|
96
|
+
| children |
|
|
97
|
+
|
|
98
|
+
Content of the menu, usually multiple `IressMenuItem`, `IressMenuHeading`, `IressMenuText` or `IressMenuDivider`.
|
|
99
|
+
|
|
100
|
+
ReactNode
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
| \- | Choose option...nonebasiccomplexnavigationheadingsdividersslotsextraInformationselectable |
|
|
105
|
+
| color |
|
|
106
|
+
|
|
107
|
+
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`.
|
|
108
|
+
|
|
109
|
+
We recommend using the following token values for best color contrast:
|
|
110
|
+
|
|
111
|
+
* `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
|
|
112
|
+
* `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
|
|
113
|
+
* `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
|
|
114
|
+
* `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
|
|
115
|
+
* `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
|
|
116
|
+
* `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
|
|
117
|
+
* `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
|
|
118
|
+
* `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
|
|
119
|
+
* `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
|
|
120
|
+
* `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
|
|
121
|
+
* `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
|
|
122
|
+
* `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
|
|
123
|
+
|
|
124
|
+
ResponsiveProp<ColorToken> | undefined
|
|
125
|
+
|
|
126
|
+
| \- | Set object |
|
|
127
|
+
| defaultSelected |
|
|
128
|
+
|
|
129
|
+
Initially selected values of menu when `role` is listbox. Used for uncontrolled menus.
|
|
130
|
+
|
|
131
|
+
ControlledValue<T, TMultiple> | undefined
|
|
132
|
+
|
|
133
|
+
| \- |
|
|
134
|
+
|
|
135
|
+
"5"
|
|
136
|
+
|
|
137
|
+
|
|
|
138
|
+
| fluid |
|
|
139
|
+
|
|
140
|
+
If set to true, menu will fill the width of its container.
|
|
141
|
+
|
|
142
|
+
booleanundefined
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
| \- | Set object |
|
|
147
|
+
| focusable |
|
|
148
|
+
|
|
149
|
+
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.
|
|
150
|
+
|
|
151
|
+
"true""within"undefined
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
| \- | Set object |
|
|
156
|
+
| hide |
|
|
157
|
+
|
|
158
|
+
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.
|
|
159
|
+
|
|
160
|
+
Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
161
|
+
|
|
162
|
+
Notes:
|
|
163
|
+
|
|
164
|
+
* If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
|
|
165
|
+
* Consider if you can conditionally render the element instead of hiding it.
|
|
166
|
+
|
|
167
|
+
ResponsiveProp<boolean> | undefined
|
|
168
|
+
|
|
169
|
+
| \- | Set object |
|
|
170
|
+
| id |
|
|
171
|
+
|
|
172
|
+
Unique ID of the menu. If not provided, will be automatically generated. Used to add aria attributes for accessibility.
|
|
173
|
+
|
|
174
|
+
stringundefined
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
| \- | Set object |
|
|
179
|
+
| layerStyle |
|
|
180
|
+
|
|
181
|
+
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.
|
|
182
|
+
|
|
183
|
+
* `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.
|
|
184
|
+
* `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.
|
|
185
|
+
* `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.
|
|
186
|
+
|
|
187
|
+
ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
|
|
188
|
+
|
|
189
|
+
| \- | Set object |
|
|
190
|
+
| layout |
|
|
191
|
+
|
|
192
|
+
Sets whether the layout is vertical (stack) or horizontal (inline/inline-equal-width).
|
|
193
|
+
|
|
194
|
+
"inline""stack""inline-equal-width"undefined
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
|
199
|
+
|
|
200
|
+
stack
|
|
201
|
+
|
|
202
|
+
| Set object |
|
|
203
|
+
| m |
|
|
204
|
+
|
|
205
|
+
The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
|
|
206
|
+
|
|
207
|
+
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.
|
|
208
|
+
|
|
209
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
210
|
+
| --- | --- | --- | --- | --- |
|
|
211
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
212
|
+
|
|
213
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
214
|
+
|
|
215
|
+
| \- | Set object |
|
|
216
|
+
| maxWidth |
|
|
217
|
+
|
|
218
|
+
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`.
|
|
219
|
+
|
|
220
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
221
|
+
| --- | --- | --- | --- | --- |
|
|
222
|
+
| **1** | **1** | **1** | **12** | **7** |
|
|
223
|
+
|
|
224
|
+
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
|
|
225
|
+
|
|
226
|
+
| \- | Set object |
|
|
227
|
+
| mb |
|
|
228
|
+
|
|
229
|
+
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.
|
|
230
|
+
|
|
231
|
+
It uses the spacing tokens in the design system.
|
|
232
|
+
|
|
233
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
234
|
+
| --- | --- | --- | --- | --- |
|
|
235
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
236
|
+
|
|
237
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
238
|
+
|
|
239
|
+
| \- | Set object |
|
|
240
|
+
| ml |
|
|
241
|
+
|
|
242
|
+
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.
|
|
243
|
+
|
|
244
|
+
It uses the spacing tokens in the design system.
|
|
245
|
+
|
|
246
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
247
|
+
| --- | --- | --- | --- | --- |
|
|
248
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
249
|
+
|
|
250
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
251
|
+
|
|
252
|
+
| \- | Set object |
|
|
253
|
+
| mr |
|
|
254
|
+
|
|
255
|
+
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.
|
|
256
|
+
|
|
257
|
+
It uses the spacing tokens in the design system.
|
|
258
|
+
|
|
259
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
260
|
+
| --- | --- | --- | --- | --- |
|
|
261
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
262
|
+
|
|
263
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
264
|
+
|
|
265
|
+
| \- | Set object |
|
|
266
|
+
| mt |
|
|
267
|
+
|
|
268
|
+
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.
|
|
269
|
+
|
|
270
|
+
It uses the spacing tokens in the design system.
|
|
271
|
+
|
|
272
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
273
|
+
| --- | --- | --- | --- | --- |
|
|
274
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
275
|
+
|
|
276
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
277
|
+
|
|
278
|
+
| \- | Set object |
|
|
279
|
+
| multiSelect |
|
|
280
|
+
|
|
281
|
+
If set to true, menu items will contain checkboxes.
|
|
282
|
+
|
|
283
|
+
booleanundefined
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
| \- | Set object |
|
|
288
|
+
| mx |
|
|
289
|
+
|
|
290
|
+
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.
|
|
291
|
+
|
|
292
|
+
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.
|
|
293
|
+
|
|
294
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
295
|
+
| --- | --- | --- | --- | --- |
|
|
296
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
297
|
+
|
|
298
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
299
|
+
|
|
300
|
+
| \- | Set object |
|
|
301
|
+
| my |
|
|
302
|
+
|
|
303
|
+
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.
|
|
304
|
+
|
|
305
|
+
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.
|
|
306
|
+
|
|
307
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
308
|
+
| --- | --- | --- | --- | --- |
|
|
309
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
310
|
+
|
|
311
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
312
|
+
|
|
313
|
+
| \- | Set object |
|
|
314
|
+
| noGutter |
|
|
315
|
+
|
|
316
|
+
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.
|
|
317
|
+
|
|
318
|
+
booleanundefined
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
| \- | Set object |
|
|
323
|
+
| noWrap |
|
|
324
|
+
|
|
325
|
+
If set to true, menu items will not wrap onto a separate line when space is exceeded.
|
|
326
|
+
|
|
327
|
+
booleanundefined
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
| \- | Set object |
|
|
332
|
+
| onChange |
|
|
333
|
+
|
|
334
|
+
Emitted when the menu value changes
|
|
335
|
+
|
|
336
|
+
((value?: ControlledValue<T, TMultiple> | null | undefined) => void) | undefined
|
|
337
|
+
|
|
338
|
+
| \- | \- |
|
|
339
|
+
| p |
|
|
340
|
+
|
|
341
|
+
The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
|
|
342
|
+
|
|
343
|
+
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.
|
|
344
|
+
|
|
345
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
346
|
+
| --- | --- | --- | --- | --- |
|
|
347
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
348
|
+
|
|
349
|
+
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
|
|
350
|
+
|
|
351
|
+
| \- | Set object |
|
|
352
|
+
| pb |
|
|
353
|
+
|
|
354
|
+
The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
|
|
355
|
+
|
|
356
|
+
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.
|
|
357
|
+
|
|
358
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
359
|
+
| --- | --- | --- | --- | --- |
|
|
360
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
361
|
+
|
|
362
|
+
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
|
|
363
|
+
|
|
364
|
+
| \- | Set object |
|
|
365
|
+
| pl |
|
|
366
|
+
|
|
367
|
+
The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
|
|
368
|
+
|
|
369
|
+
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.
|
|
370
|
+
|
|
371
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
372
|
+
| --- | --- | --- | --- | --- |
|
|
373
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
374
|
+
|
|
375
|
+
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
|
|
376
|
+
|
|
377
|
+
| \- | Set object |
|
|
378
|
+
| pr |
|
|
379
|
+
|
|
380
|
+
The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
|
|
381
|
+
|
|
382
|
+
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.
|
|
383
|
+
|
|
384
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
385
|
+
| --- | --- | --- | --- | --- |
|
|
386
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
387
|
+
|
|
388
|
+
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
|
|
389
|
+
|
|
390
|
+
| \- | Set object |
|
|
391
|
+
| pt |
|
|
392
|
+
|
|
393
|
+
The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
|
|
394
|
+
|
|
395
|
+
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.
|
|
396
|
+
|
|
397
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
398
|
+
| --- | --- | --- | --- | --- |
|
|
399
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
400
|
+
|
|
401
|
+
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
|
|
402
|
+
|
|
403
|
+
| \- | Set object |
|
|
404
|
+
| px |
|
|
405
|
+
|
|
406
|
+
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.
|
|
407
|
+
|
|
408
|
+
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.
|
|
409
|
+
|
|
410
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
411
|
+
| --- | --- | --- | --- | --- |
|
|
412
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
413
|
+
|
|
414
|
+
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
|
|
415
|
+
|
|
416
|
+
| \- | Set object |
|
|
417
|
+
| py |
|
|
418
|
+
|
|
419
|
+
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.
|
|
420
|
+
|
|
421
|
+
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.
|
|
422
|
+
|
|
423
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
424
|
+
| --- | --- | --- | --- | --- |
|
|
425
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
426
|
+
|
|
427
|
+
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
|
|
428
|
+
|
|
429
|
+
| \- | Set object |
|
|
430
|
+
| role |
|
|
431
|
+
|
|
432
|
+
Type of menu, corresponding to [aria-roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles). Will be set automatically when used inside popover or when the `multiSelect` prop is set to true.
|
|
433
|
+
|
|
434
|
+
"list""menu""listbox"undefined
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
|
439
|
+
|
|
440
|
+
list
|
|
441
|
+
|
|
442
|
+
| Set object |
|
|
443
|
+
| rowGap |
|
|
444
|
+
|
|
445
|
+
The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
|
|
446
|
+
|
|
447
|
+
Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
|
|
448
|
+
|
|
449
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
450
|
+
| --- | --- | --- | --- | --- |
|
|
451
|
+
| **47** | **52** | **10.1** | **16** | No |
|
|
452
|
+
|
|
453
|
+
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
|
|
454
|
+
|
|
455
|
+
| \- | Set object |
|
|
456
|
+
| selected |
|
|
457
|
+
|
|
458
|
+
Selected values of menu when `role` is listbox. Used for controlled menus.
|
|
459
|
+
|
|
460
|
+
ControlledValue<T, TMultiple> | undefined
|
|
461
|
+
|
|
462
|
+
| \- | Set object |
|
|
463
|
+
| srOnly |
|
|
464
|
+
|
|
465
|
+
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.
|
|
466
|
+
|
|
467
|
+
Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
468
|
+
|
|
469
|
+
ResponsiveProp<boolean> | undefined
|
|
470
|
+
|
|
471
|
+
| \- | Set object |
|
|
472
|
+
| stretch |
|
|
473
|
+
|
|
474
|
+
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.
|
|
475
|
+
|
|
476
|
+
booleanundefined
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
| \- | Set object |
|
|
481
|
+
| textAlign |
|
|
482
|
+
|
|
483
|
+
The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
|
|
484
|
+
|
|
485
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
486
|
+
| --- | --- | --- | --- | --- |
|
|
487
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
488
|
+
|
|
489
|
+
ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
|
|
490
|
+
|
|
491
|
+
| \- | Set object |
|
|
492
|
+
| textStyle |
|
|
493
|
+
|
|
494
|
+
Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
|
|
495
|
+
|
|
496
|
+
* `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
|
|
497
|
+
* `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.
|
|
498
|
+
* `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
|
|
499
|
+
* `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.
|
|
500
|
+
* `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.
|
|
501
|
+
* `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.
|
|
502
|
+
* `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.
|
|
503
|
+
* `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.
|
|
504
|
+
* `typography.code` - Used to display code snippets in the product, such as in the API documentation.
|
|
505
|
+
|
|
506
|
+
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
|
|
507
|
+
|
|
508
|
+
| \- | Set object |
|
|
509
|
+
| width |
|
|
510
|
+
|
|
511
|
+
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.
|
|
512
|
+
|
|
513
|
+
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.
|
|
514
|
+
|
|
515
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
516
|
+
| --- | --- | --- | --- | --- |
|
|
517
|
+
| **1** | **1** | **1** | **12** | **4** |
|
|
518
|
+
|
|
519
|
+
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
|
|
520
|
+
|
|
521
|
+
| \- | Set object |
|
|
522
|
+
|
|
39
523
|
[](#usage)Usage
|
|
40
524
|
---------------
|
|
41
525
|
|
|
42
526
|
### [](#basic)Basic
|
|
43
527
|
|
|
44
|
-
`IressMenuHeading`, `
|
|
528
|
+
`IressMenuDivider`, `IressMenuHeading`, `IressMenuItem` and `IressMenuText` should be supplied as `children` of the menu.
|
|
45
529
|
|
|
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
530
|
* `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
|
-
* `
|
|
49
|
-
|
|
50
|
-
|
|
531
|
+
* `IressMenuHeading` is used to display headings. It supports all of the props of `IressText` and will adjust according to the menu's role and layout.
|
|
532
|
+
* `IressMenuItem` is used to display an interactive item. If provided a `href` prop will render the item as a link, otherwise it will render as a button.
|
|
533
|
+
* `IressMenuText` can be used to display other non-interactive text. It supports all of the props of `IressText`.
|
|
51
534
|
|
|
52
535
|
Menu heading
|
|
53
536
|
------------
|
|
@@ -81,13 +564,17 @@ Copy
|
|
|
81
564
|
|
|
82
565
|
### [](#complex)Complex
|
|
83
566
|
|
|
84
|
-
`IressMenuHeading` and `
|
|
567
|
+
`IressMenuItem`, `IressMenuHeading` and `IressMenuText` support `prepend`, `divider` and `append` slots, to allow you to create complex menu items.
|
|
568
|
+
|
|
569
|
+
Note: Instead of using the `divider` prop on `IressMenuItem`, you can use `IressMenuDivider` to separate items. This gives you more control over where the divider sits.
|
|
85
570
|
|
|
86
571
|
Heading with prepend
|
|
87
572
|
--------------------
|
|
88
573
|
|
|
89
574
|
Button with append and prepend
|
|
90
575
|
|
|
576
|
+
* * *
|
|
577
|
+
|
|
91
578
|
### Heading with append and prepend
|
|
92
579
|
|
|
93
580
|
[Link with append](https://iress.com)
|
|
@@ -100,7 +587,7 @@ Hide code
|
|
|
100
587
|
|
|
101
588
|
\[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
589
|
|
|
103
|
-
<IressMenu\>
|
|
590
|
+
<IressMenu maxWidth\="input.25perc"\>
|
|
104
591
|
<IressMenuHeading prepend\={<IressIcon fixedWidth name\="smile"/>}\>
|
|
105
592
|
Heading with prepend </IressMenuHeading\>
|
|
106
593
|
<IressMenuItem
|
|
@@ -113,7 +600,7 @@ Hide code
|
|
|
113
600
|
Button with append and prepend </IressMenuItem\>
|
|
114
601
|
<IressMenuHeading
|
|
115
602
|
append\={<IressIcon fixedWidth name\="smile"/>}
|
|
116
|
-
|
|
603
|
+
element\="h3"
|
|
117
604
|
prepend\={<IressIcon fixedWidth name\="smile"/>}
|
|
118
605
|
\>
|
|
119
606
|
Heading with append and prepend </IressMenuHeading\>
|
|
@@ -147,7 +634,7 @@ Copy
|
|
|
147
634
|
|
|
148
635
|
### [](#secondary-navigation)Secondary navigation
|
|
149
636
|
|
|
150
|
-
When the `href` prop is set on `
|
|
637
|
+
When the `href` prop is set on `IressMenuItem`, it will render as a link.
|
|
151
638
|
|
|
152
639
|
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
640
|
|
|
@@ -179,7 +666,7 @@ Copy
|
|
|
179
666
|
|
|
180
667
|
### [](#headings)Headings
|
|
181
668
|
|
|
182
|
-
Using the `IressMenuHeading` component, you can create headings within the menu.
|
|
669
|
+
Using the `IressMenuHeading` component, you can create headings within the menu. Simply set the `element` or `textStyle` prop to your desired heading level.
|
|
183
670
|
|
|
184
671
|
#### Menu heading (h4)
|
|
185
672
|
|
|
@@ -194,11 +681,11 @@ Hide code
|
|
|
194
681
|
\[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
682
|
|
|
196
683
|
<IressMenu\>
|
|
197
|
-
<IressMenuHeading
|
|
684
|
+
<IressMenuHeading element\="h4"\>
|
|
198
685
|
Menu heading (h4) </IressMenuHeading\>
|
|
199
686
|
<IressMenuItem\>
|
|
200
687
|
Menu item 1 </IressMenuItem\>
|
|
201
|
-
<IressMenuHeading
|
|
688
|
+
<IressMenuHeading element\="h5"\>
|
|
202
689
|
Menu heading (h5) </IressMenuHeading\>
|
|
203
690
|
<IressMenuItem\>
|
|
204
691
|
Menu item 2 </IressMenuItem\>
|
|
@@ -208,14 +695,18 @@ Copy
|
|
|
208
695
|
|
|
209
696
|
### [](#dividers)Dividers
|
|
210
697
|
|
|
211
|
-
When the `divider` prop is set, the `
|
|
698
|
+
When the `divider` prop is set, the `IressMenuItem`, `IressMenuHeading` and `IressMenuText` will render a bottom border.
|
|
212
699
|
|
|
213
700
|
In situations where a bottom border will not work, you can also use `IressMenuDivider` inside the menu to separate items.
|
|
214
701
|
|
|
215
702
|
#### Menu heading (h4)
|
|
216
703
|
|
|
704
|
+
* * *
|
|
705
|
+
|
|
217
706
|
Menu item 1Menu item 2
|
|
218
707
|
|
|
708
|
+
* * *
|
|
709
|
+
|
|
219
710
|
##### Menu heading (h5)
|
|
220
711
|
|
|
221
712
|
Menu item 3Menu item 4
|
|
@@ -231,14 +722,14 @@ Hide code
|
|
|
231
722
|
<IressMenu\>
|
|
232
723
|
<IressMenuHeading
|
|
233
724
|
divider
|
|
234
|
-
|
|
725
|
+
element\="h4"
|
|
235
726
|
\>
|
|
236
727
|
Menu heading (h4) </IressMenuHeading\>
|
|
237
728
|
<IressMenuItem\>
|
|
238
729
|
Menu item 1 </IressMenuItem\>
|
|
239
730
|
<IressMenuItem divider\>
|
|
240
731
|
Menu item 2 </IressMenuItem\>
|
|
241
|
-
<IressMenuHeading
|
|
732
|
+
<IressMenuHeading element\="h5"\>
|
|
242
733
|
Menu heading (h5) </IressMenuHeading\>
|
|
243
734
|
<IressMenuItem selected\>
|
|
244
735
|
Menu item 3 </IressMenuItem\>
|
|
@@ -296,7 +787,7 @@ The `layout` prop comes with three options:
|
|
|
296
787
|
* `inline` - menu items will be inline
|
|
297
788
|
* `inline-equal-width` - menu items will be inline and have equal width
|
|
298
789
|
|
|
299
|
-
###
|
|
790
|
+
### Stack (default)
|
|
300
791
|
|
|
301
792
|
Menu heading
|
|
302
793
|
------------
|
|
@@ -307,7 +798,7 @@ Menu item (button)
|
|
|
307
798
|
|
|
308
799
|
[Menu item (link)](https://iress.com)Menu item (selected)
|
|
309
800
|
|
|
310
|
-
###
|
|
801
|
+
### Inline
|
|
311
802
|
|
|
312
803
|
Menu heading
|
|
313
804
|
------------
|
|
@@ -318,7 +809,7 @@ Menu item (button)
|
|
|
318
809
|
|
|
319
810
|
[Menu item (link)](https://iress.com)Menu item (selected)
|
|
320
811
|
|
|
321
|
-
###
|
|
812
|
+
### Inline Equal Width
|
|
322
813
|
|
|
323
814
|
Menu heading
|
|
324
815
|
------------
|
|
@@ -333,10 +824,10 @@ Hide code
|
|
|
333
824
|
|
|
334
825
|
\[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
826
|
|
|
336
|
-
<IressStack
|
|
827
|
+
<IressStack gap\="lg"\>
|
|
337
828
|
<IressText\>
|
|
338
829
|
<h3\>
|
|
339
|
-
|
|
830
|
+
Stack (default) </h3\>
|
|
340
831
|
<IressMenu
|
|
341
832
|
defaultSelected\="5"
|
|
342
833
|
layout\="stack"
|
|
@@ -357,7 +848,7 @@ Hide code
|
|
|
357
848
|
</IressText\>
|
|
358
849
|
<IressText\>
|
|
359
850
|
<h3\>
|
|
360
|
-
|
|
851
|
+
Inline </h3\>
|
|
361
852
|
<IressMenu
|
|
362
853
|
defaultSelected\="5"
|
|
363
854
|
layout\="inline"
|
|
@@ -378,7 +869,7 @@ Hide code
|
|
|
378
869
|
</IressText\>
|
|
379
870
|
<IressText\>
|
|
380
871
|
<h3\>
|
|
381
|
-
|
|
872
|
+
Inline Equal Width </h3\>
|
|
382
873
|
<IressMenu
|
|
383
874
|
defaultSelected\="5"
|
|
384
875
|
layout\="inline-equal-width"
|
|
@@ -413,36 +904,36 @@ Hide code
|
|
|
413
904
|
|
|
414
905
|
\[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
906
|
|
|
416
|
-
<
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
maxWidth
|
|
420
|
-
|
|
421
|
-
\>
|
|
422
|
-
<IressMenu defaultSelected\="5"\>
|
|
907
|
+
<IressInline\>
|
|
908
|
+
<IressMenu
|
|
909
|
+
defaultSelected\="5"
|
|
910
|
+
maxWidth\="input.12"
|
|
911
|
+
\>
|
|
423
912
|
<IressMenuItem\>
|
|
424
913
|
Menu item with some text that wraps </IressMenuItem\>
|
|
425
914
|
</IressMenu\>
|
|
426
915
|
<IressMenu
|
|
427
916
|
defaultSelected\="5"
|
|
917
|
+
maxWidth\="input.12"
|
|
428
918
|
noWrap
|
|
429
919
|
\>
|
|
430
920
|
<IressMenuItem\>
|
|
431
921
|
Non wrapping menu item with some text </IressMenuItem\>
|
|
432
922
|
</IressMenu\>
|
|
433
|
-
</
|
|
923
|
+
</IressInline\>
|
|
434
924
|
|
|
435
925
|
Copy
|
|
436
926
|
|
|
437
927
|
### [](#slot-props)Slot props
|
|
438
928
|
|
|
439
|
-
`
|
|
929
|
+
`IressMenuItem`, `IressMenuHeading` and `IressMenuText` provide `prepend` and `append` props to position content either before or after its content.
|
|
440
930
|
|
|
441
|
-
Prepend slot
|
|
442
|
-
------------
|
|
931
|
+
#### Prepend slot
|
|
443
932
|
|
|
444
933
|
New fileSave file as
|
|
445
934
|
|
|
935
|
+
* * *
|
|
936
|
+
|
|
446
937
|
### Append slot
|
|
447
938
|
|
|
448
939
|
[Visit the Iress website](https://www.iress.com)[Visit Google8+](https://google.com)
|
|
@@ -452,7 +943,10 @@ Hide code
|
|
|
452
943
|
\[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
944
|
|
|
454
945
|
<IressMenu role\="menu"\>
|
|
455
|
-
<IressMenuHeading
|
|
946
|
+
<IressMenuHeading
|
|
947
|
+
element\="h4"
|
|
948
|
+
prepend\={<IressIcon name\="cog" />}
|
|
949
|
+
\>
|
|
456
950
|
Prepend slot </IressMenuHeading\>
|
|
457
951
|
<IressMenuItem
|
|
458
952
|
onClick\={() \=> {}}
|
|
@@ -467,7 +961,7 @@ Hide code
|
|
|
467
961
|
Save file as </IressMenuItem\>
|
|
468
962
|
<IressMenuHeading
|
|
469
963
|
append\={<IressIcon name\="link" />}
|
|
470
|
-
|
|
964
|
+
element\="h3"
|
|
471
965
|
\>
|
|
472
966
|
Append slot </IressMenuHeading\>
|
|
473
967
|
<IressMenuItem
|
|
@@ -493,9 +987,8 @@ There are four roles supported:
|
|
|
493
987
|
* `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
988
|
* `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
989
|
* `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
990
|
|
|
498
|
-
**Note:** When menu is used as a child of popover, the `
|
|
991
|
+
**Note:** When menu is used as a child of popover, the `type` that is set on popover will be applied to menu (so you don't need to set it twice).
|
|
499
992
|
|
|
500
993
|
#### [](#list)List
|
|
501
994
|
|
|
@@ -603,7 +1096,7 @@ A value is supplied to MenuItem (like you would with an `option` element inside
|
|
|
603
1096
|
|
|
604
1097
|
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
1098
|
|
|
606
|
-
**Note:** This is the menu type used to power Filter
|
|
1099
|
+
**Note:** This is the menu type used to power Filter components.
|
|
607
1100
|
|
|
608
1101
|
Keyboard interaction
|
|
609
1102
|
|
|
@@ -635,57 +1128,6 @@ Hide code
|
|
|
635
1128
|
|
|
636
1129
|
Copy
|
|
637
1130
|
|
|
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
1131
|
On this page
|
|
690
1132
|
|
|
691
1133
|
* [Overview](#overview)
|