@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
|
@@ -15,12 +15,544 @@ Hide code
|
|
|
15
15
|
\[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; }
|
|
16
16
|
|
|
17
17
|
<IressPopover activator\={<IressButton\>Toggle popover</IressButton\>}\>
|
|
18
|
-
<IressPanel
|
|
18
|
+
<IressPanel\>
|
|
19
19
|
A little more information about this area. </IressPanel\>
|
|
20
20
|
</IressPopover\>
|
|
21
21
|
|
|
22
22
|
Copy
|
|
23
23
|
|
|
24
|
+
[](#props)Props
|
|
25
|
+
---------------
|
|
26
|
+
|
|
27
|
+
| Name | Description | Default | Control |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| activator\* |
|
|
30
|
+
Content for an activator element, usually an `IressButton`.
|
|
31
|
+
|
|
32
|
+
ReactElement<any, string | JSXElementConstructor<any>> | undefined
|
|
33
|
+
|
|
34
|
+
| \- | \- |
|
|
35
|
+
| align |
|
|
36
|
+
|
|
37
|
+
Sets the alignment of the popover relative to the activator element.
|
|
38
|
+
|
|
39
|
+
"bottom""left""right""top""auto""bottom-start""bottom-end""top-start"Show 6 more...
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
|
44
|
+
|
|
45
|
+
auto
|
|
46
|
+
|
|
47
|
+
| Set object |
|
|
48
|
+
| bg |
|
|
49
|
+
|
|
50
|
+
**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
|
|
51
|
+
|
|
52
|
+
We recommend using the following token values for best background contrast:
|
|
53
|
+
|
|
54
|
+
* `colour.primary.fill` for primary backgrounds that need to stand out
|
|
55
|
+
* `colour.primary.surface` for primary backgrounds that need to be less prominent
|
|
56
|
+
* `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
|
|
57
|
+
* `colour.neutral.20` for a slightly darker background color, used in neutral state components
|
|
58
|
+
* `colour.system.danger.fill` for error backgrounds that need to stand out
|
|
59
|
+
* `colour.system.danger.surface` for error backgrounds that need to be less prominent
|
|
60
|
+
* `colour.system.success.fill` for success backgrounds that need to stand out
|
|
61
|
+
* `colour.system.success.surface` for success backgrounds that need to be less prominent
|
|
62
|
+
* `colour.system.warning.fill` for warning backgrounds that need to stand out
|
|
63
|
+
* `colour.system.warning.surface` for warning backgrounds that need to be less prominent
|
|
64
|
+
* `colour.system.info.fill` for info backgrounds that need to stand out
|
|
65
|
+
* `colour.system.info.surface` for info backgrounds that need to be less prominent
|
|
66
|
+
|
|
67
|
+
ResponsiveProp<ColorToken> | undefined
|
|
68
|
+
|
|
69
|
+
| \- | Set object |
|
|
70
|
+
| borderRadius |
|
|
71
|
+
|
|
72
|
+
The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
|
|
73
|
+
|
|
74
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
75
|
+
| --- | --- | --- | --- | --- |
|
|
76
|
+
| **4** | **4** | **5** | **12** | **9** |
|
|
77
|
+
| 1 _\-x-_ | | 3 _\-x-_ | | |
|
|
78
|
+
|
|
79
|
+
ResponsiveProp<RadiusToken> | undefined
|
|
80
|
+
|
|
81
|
+
| \- | Set object |
|
|
82
|
+
| children |
|
|
83
|
+
|
|
84
|
+
The content to render within the popover.
|
|
85
|
+
|
|
86
|
+
ReactNode
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
| \- | Choose option...nonehellobasicdetailsparagraphmenu |
|
|
91
|
+
| color |
|
|
92
|
+
|
|
93
|
+
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`.
|
|
94
|
+
|
|
95
|
+
We recommend using the following token values for best color contrast:
|
|
96
|
+
|
|
97
|
+
* `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
|
|
98
|
+
* `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
|
|
99
|
+
* `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
|
|
100
|
+
* `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
|
|
101
|
+
* `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
|
|
102
|
+
* `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
|
|
103
|
+
* `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
|
|
104
|
+
* `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
|
|
105
|
+
* `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
|
|
106
|
+
* `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
|
|
107
|
+
* `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
|
|
108
|
+
* `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
|
|
109
|
+
|
|
110
|
+
ResponsiveProp<ColorToken> | undefined
|
|
111
|
+
|
|
112
|
+
| \- | Set object |
|
|
113
|
+
| container |
|
|
114
|
+
|
|
115
|
+
The container element to render the popover into. By default, the popover will render where its parent is rendered.
|
|
116
|
+
|
|
117
|
+
**Note:** If the `container` doesn’t exist when the popover is mounted, ensure you pass an element directly (not a ref) and specify null as the default value before it is set. This lets it wait for the root to be available. For example, if you reference the parent element of a popover.
|
|
118
|
+
|
|
119
|
+
FloatingUIContainerundefined
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
| \- | Set object |
|
|
124
|
+
| contentClassName |
|
|
125
|
+
|
|
126
|
+
Class name of the popover content.
|
|
127
|
+
|
|
128
|
+
stringundefined
|
|
129
|
+
|
|
130
|
+
<table class="css-3nr4py"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `contentStyle` instead.</td></tr></tbody></table>
|
|
131
|
+
|
|
132
|
+
| \- | Set object |
|
|
133
|
+
| contentStyle |
|
|
134
|
+
|
|
135
|
+
This allows you to customise the content styling specifically, which is the floating element. It accepts an object with any of the styling properties available on `IressCSSProps`, as well as `className` and `style`.
|
|
136
|
+
|
|
137
|
+
IressCustomiseSlotundefined
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
| \- | Set object |
|
|
142
|
+
| defaultShow |
|
|
143
|
+
|
|
144
|
+
When set to `true` the popover will be visible by default. Use for uncontrolled popovers.
|
|
145
|
+
|
|
146
|
+
booleanundefined
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
| \- | Set object |
|
|
151
|
+
| displayMode |
|
|
152
|
+
|
|
153
|
+
Sets the display mode of popover.
|
|
154
|
+
|
|
155
|
+
"overlay""inline"undefined
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
|
160
|
+
|
|
161
|
+
overlay
|
|
162
|
+
|
|
163
|
+
| Set object |
|
|
164
|
+
| fluid |
|
|
165
|
+
|
|
166
|
+
Popovers can be fluid, meaning they will take up the full width of their container.
|
|
167
|
+
|
|
168
|
+
booleanundefined
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
| \- | Set object |
|
|
173
|
+
| focusable |
|
|
174
|
+
|
|
175
|
+
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.
|
|
176
|
+
|
|
177
|
+
"true""within"undefined
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
| \- | Set object |
|
|
182
|
+
| focusStartIndex |
|
|
183
|
+
|
|
184
|
+
Which index to start the focus on when the popover is opened. Only works with `type` listbox and menu. Note: The index must exist in the list of items, otherwise it will not work.
|
|
185
|
+
|
|
186
|
+
numberundefined
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
|
191
|
+
|
|
192
|
+
0
|
|
193
|
+
|
|
194
|
+
| Set object |
|
|
195
|
+
| hide |
|
|
196
|
+
|
|
197
|
+
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.
|
|
198
|
+
|
|
199
|
+
Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
200
|
+
|
|
201
|
+
Notes:
|
|
202
|
+
|
|
203
|
+
* If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
|
|
204
|
+
* Consider if you can conditionally render the element instead of hiding it.
|
|
205
|
+
|
|
206
|
+
ResponsiveProp<boolean> | undefined
|
|
207
|
+
|
|
208
|
+
| \- | Set object |
|
|
209
|
+
| layerStyle |
|
|
210
|
+
|
|
211
|
+
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.
|
|
212
|
+
|
|
213
|
+
* `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.
|
|
214
|
+
* `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.
|
|
215
|
+
* `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.
|
|
216
|
+
|
|
217
|
+
ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
|
|
218
|
+
|
|
219
|
+
| \- | Set object |
|
|
220
|
+
| m |
|
|
221
|
+
|
|
222
|
+
The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
|
|
223
|
+
|
|
224
|
+
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.
|
|
225
|
+
|
|
226
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
227
|
+
| --- | --- | --- | --- | --- |
|
|
228
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
229
|
+
|
|
230
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
231
|
+
|
|
232
|
+
| \- | Set object |
|
|
233
|
+
| matchActivatorWidth |
|
|
234
|
+
|
|
235
|
+
Sets the popover to match the width of the activator. Note: This only works when `displayMode="overlay"`.
|
|
236
|
+
|
|
237
|
+
booleanundefined
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
| \- | Set object |
|
|
242
|
+
| maxWidth |
|
|
243
|
+
|
|
244
|
+
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`.
|
|
245
|
+
|
|
246
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
247
|
+
| --- | --- | --- | --- | --- |
|
|
248
|
+
| **1** | **1** | **1** | **12** | **7** |
|
|
249
|
+
|
|
250
|
+
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
|
|
251
|
+
|
|
252
|
+
| \- | Set object |
|
|
253
|
+
| mb |
|
|
254
|
+
|
|
255
|
+
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.
|
|
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
|
+
| ml |
|
|
267
|
+
|
|
268
|
+
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.
|
|
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
|
+
| mr |
|
|
280
|
+
|
|
281
|
+
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.
|
|
282
|
+
|
|
283
|
+
It uses the spacing tokens in the design system.
|
|
284
|
+
|
|
285
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
286
|
+
| --- | --- | --- | --- | --- |
|
|
287
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
288
|
+
|
|
289
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
290
|
+
|
|
291
|
+
| \- | Set object |
|
|
292
|
+
| mt |
|
|
293
|
+
|
|
294
|
+
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.
|
|
295
|
+
|
|
296
|
+
It uses the spacing tokens in the design system.
|
|
297
|
+
|
|
298
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
299
|
+
| --- | --- | --- | --- | --- |
|
|
300
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
301
|
+
|
|
302
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
303
|
+
|
|
304
|
+
| \- | Set object |
|
|
305
|
+
| mx |
|
|
306
|
+
|
|
307
|
+
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.
|
|
308
|
+
|
|
309
|
+
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.
|
|
310
|
+
|
|
311
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
312
|
+
| --- | --- | --- | --- | --- |
|
|
313
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
314
|
+
|
|
315
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
316
|
+
|
|
317
|
+
| \- | Set object |
|
|
318
|
+
| my |
|
|
319
|
+
|
|
320
|
+
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.
|
|
321
|
+
|
|
322
|
+
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.
|
|
323
|
+
|
|
324
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
325
|
+
| --- | --- | --- | --- | --- |
|
|
326
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
327
|
+
|
|
328
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
329
|
+
|
|
330
|
+
| \- | Set object |
|
|
331
|
+
| noGutter |
|
|
332
|
+
|
|
333
|
+
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.
|
|
334
|
+
|
|
335
|
+
booleanundefined
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
| \- | Set object |
|
|
340
|
+
| onActivated |
|
|
341
|
+
|
|
342
|
+
Is called when popover is activated.
|
|
343
|
+
|
|
344
|
+
((e?: Event | undefined, reason?: OpenChangeReason | undefined, activeIndex?: number | null | undefined) => void) | undefined
|
|
345
|
+
|
|
346
|
+
| \- | \- |
|
|
347
|
+
| onDeactivated |
|
|
348
|
+
|
|
349
|
+
Is called when popover is deactivated.
|
|
350
|
+
|
|
351
|
+
((e?: Event | undefined, reason?: OpenChangeReason | undefined, activeIndex?: number | null | undefined) => void) | undefined
|
|
352
|
+
|
|
353
|
+
| \- | \- |
|
|
354
|
+
| onNavigate |
|
|
355
|
+
|
|
356
|
+
Is called when registered popover items are navigated using arrow keys. Only works with `type` listbox and menu.
|
|
357
|
+
|
|
358
|
+
((activeIndex: number | null) => void) | undefined
|
|
359
|
+
|
|
360
|
+
| \- | \- |
|
|
361
|
+
| p |
|
|
362
|
+
|
|
363
|
+
The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
|
|
364
|
+
|
|
365
|
+
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.
|
|
366
|
+
|
|
367
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
368
|
+
| --- | --- | --- | --- | --- |
|
|
369
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
370
|
+
|
|
371
|
+
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
|
|
372
|
+
|
|
373
|
+
| \- | Set object |
|
|
374
|
+
| pb |
|
|
375
|
+
|
|
376
|
+
The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
|
|
377
|
+
|
|
378
|
+
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.
|
|
379
|
+
|
|
380
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
381
|
+
| --- | --- | --- | --- | --- |
|
|
382
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
383
|
+
|
|
384
|
+
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
|
|
385
|
+
|
|
386
|
+
| \- | Set object |
|
|
387
|
+
| pl |
|
|
388
|
+
|
|
389
|
+
The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
|
|
390
|
+
|
|
391
|
+
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.
|
|
392
|
+
|
|
393
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
394
|
+
| --- | --- | --- | --- | --- |
|
|
395
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
396
|
+
|
|
397
|
+
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
|
|
398
|
+
|
|
399
|
+
| \- | Set object |
|
|
400
|
+
| pr |
|
|
401
|
+
|
|
402
|
+
The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
|
|
403
|
+
|
|
404
|
+
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.
|
|
405
|
+
|
|
406
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
407
|
+
| --- | --- | --- | --- | --- |
|
|
408
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
409
|
+
|
|
410
|
+
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
|
|
411
|
+
|
|
412
|
+
| \- | Set object |
|
|
413
|
+
| pt |
|
|
414
|
+
|
|
415
|
+
The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
|
|
416
|
+
|
|
417
|
+
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.
|
|
418
|
+
|
|
419
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
420
|
+
| --- | --- | --- | --- | --- |
|
|
421
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
422
|
+
|
|
423
|
+
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
|
|
424
|
+
|
|
425
|
+
| \- | Set object |
|
|
426
|
+
| px |
|
|
427
|
+
|
|
428
|
+
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.
|
|
429
|
+
|
|
430
|
+
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.
|
|
431
|
+
|
|
432
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
433
|
+
| --- | --- | --- | --- | --- |
|
|
434
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
435
|
+
|
|
436
|
+
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
|
|
437
|
+
|
|
438
|
+
| \- | Set object |
|
|
439
|
+
| py |
|
|
440
|
+
|
|
441
|
+
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.
|
|
442
|
+
|
|
443
|
+
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.
|
|
444
|
+
|
|
445
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
446
|
+
| --- | --- | --- | --- | --- |
|
|
447
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
448
|
+
|
|
449
|
+
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
|
|
450
|
+
|
|
451
|
+
| \- | Set object |
|
|
452
|
+
| rowGap |
|
|
453
|
+
|
|
454
|
+
The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
|
|
455
|
+
|
|
456
|
+
Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
|
|
457
|
+
|
|
458
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
459
|
+
| --- | --- | --- | --- | --- |
|
|
460
|
+
| **47** | **52** | **10.1** | **16** | No |
|
|
461
|
+
|
|
462
|
+
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
|
|
463
|
+
|
|
464
|
+
| \- | Set object |
|
|
465
|
+
| show |
|
|
466
|
+
|
|
467
|
+
When set to `true` the modal will be visible. Use for controlled popovers.
|
|
468
|
+
|
|
469
|
+
booleanundefined
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
| \- | Set object |
|
|
474
|
+
| srOnly |
|
|
475
|
+
|
|
476
|
+
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.
|
|
477
|
+
|
|
478
|
+
Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
479
|
+
|
|
480
|
+
ResponsiveProp<boolean> | undefined
|
|
481
|
+
|
|
482
|
+
| \- | Set object |
|
|
483
|
+
| stretch |
|
|
484
|
+
|
|
485
|
+
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.
|
|
486
|
+
|
|
487
|
+
booleanundefined
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
| \- | Set object |
|
|
492
|
+
| textAlign |
|
|
493
|
+
|
|
494
|
+
The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
|
|
495
|
+
|
|
496
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
497
|
+
| --- | --- | --- | --- | --- |
|
|
498
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
499
|
+
|
|
500
|
+
ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
|
|
501
|
+
|
|
502
|
+
| \- | Set object |
|
|
503
|
+
| textStyle |
|
|
504
|
+
|
|
505
|
+
Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
|
|
506
|
+
|
|
507
|
+
* `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
|
|
508
|
+
* `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.
|
|
509
|
+
* `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
|
|
510
|
+
* `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.
|
|
511
|
+
* `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.
|
|
512
|
+
* `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.
|
|
513
|
+
* `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.
|
|
514
|
+
* `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.
|
|
515
|
+
* `typography.code` - Used to display code snippets in the product, such as in the API documentation.
|
|
516
|
+
|
|
517
|
+
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
|
|
518
|
+
|
|
519
|
+
| \- | Set object |
|
|
520
|
+
| type |
|
|
521
|
+
|
|
522
|
+
Describes the type of content contained in the popover.
|
|
523
|
+
|
|
524
|
+
"tree""dialog""menu""grid""listbox"undefined
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
| \- | Set object |
|
|
529
|
+
| virtualFocus |
|
|
530
|
+
|
|
531
|
+
Whether the focus is virtual (using `aria-activedescendant`). Use this if you need focus to remain on the reference element (such as an input), but allow arrow keys to navigate items. Note: This is only applicable when type is set to: `listbox` or `menu`, and only works out of the box with `IressMenu` and its subcomponents.
|
|
532
|
+
|
|
533
|
+
booleanundefined
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
|
538
|
+
|
|
539
|
+
false
|
|
540
|
+
|
|
541
|
+
| Set object |
|
|
542
|
+
| width |
|
|
543
|
+
|
|
544
|
+
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.
|
|
545
|
+
|
|
546
|
+
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.
|
|
547
|
+
|
|
548
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
549
|
+
| --- | --- | --- | --- | --- |
|
|
550
|
+
| **1** | **1** | **1** | **12** | **4** |
|
|
551
|
+
|
|
552
|
+
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
|
|
553
|
+
|
|
554
|
+
| \- | Set object |
|
|
555
|
+
|
|
24
556
|
[](#usage)Usage
|
|
25
557
|
---------------
|
|
26
558
|
|
|
@@ -39,7 +571,7 @@ Hide code
|
|
|
39
571
|
\[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; }
|
|
40
572
|
|
|
41
573
|
<IressPopover activator\={<IressButton\>Toggle popover</IressButton\>}\>
|
|
42
|
-
<IressPanel
|
|
574
|
+
<IressPanel\>
|
|
43
575
|
A little more information about this area. </IressPanel\>
|
|
44
576
|
</IressPopover\>
|
|
45
577
|
|
|
@@ -159,41 +691,41 @@ Hide code
|
|
|
159
691
|
padding: '80px 150px'
|
|
160
692
|
}}
|
|
161
693
|
\>
|
|
162
|
-
<IressStack
|
|
694
|
+
<IressStack gap\="md"\>
|
|
163
695
|
<IressInline
|
|
164
|
-
|
|
696
|
+
gap\="sm"
|
|
165
697
|
horizontalAlign\="center"
|
|
166
698
|
\>
|
|
167
699
|
<IressPopover
|
|
168
700
|
activator\={<IressTooltip align\="bottom-start" tooltipText\="Tooltips and popovers can go together if needed!"\><IressButton\>top-start</IressButton\></IressTooltip\>}
|
|
169
701
|
align\="top-start"
|
|
170
702
|
\>
|
|
171
|
-
<IressPanel
|
|
703
|
+
<IressPanel\>
|
|
172
704
|
Hello! </IressPanel\>
|
|
173
705
|
</IressPopover\>
|
|
174
706
|
<IressPopover
|
|
175
707
|
activator\={<IressButton\>top</IressButton\>}
|
|
176
708
|
align\="top"
|
|
177
709
|
\>
|
|
178
|
-
<IressPanel
|
|
710
|
+
<IressPanel\>
|
|
179
711
|
Hello! </IressPanel\>
|
|
180
712
|
</IressPopover\>
|
|
181
713
|
<IressPopover
|
|
182
714
|
activator\={<IressButton\>top-end</IressButton\>}
|
|
183
715
|
align\="top-end"
|
|
184
716
|
\>
|
|
185
|
-
<IressPanel
|
|
717
|
+
<IressPanel\>
|
|
186
718
|
Hello! </IressPanel\>
|
|
187
719
|
</IressPopover\>
|
|
188
720
|
</IressInline\>
|
|
189
721
|
<IressInline horizontalAlign\="between"\>
|
|
190
|
-
<IressStack
|
|
722
|
+
<IressStack gap\="sm"\>
|
|
191
723
|
<IressInline horizontalAlign\="left"\>
|
|
192
724
|
<IressPopover
|
|
193
725
|
activator\={<IressButton\>left-start</IressButton\>}
|
|
194
726
|
align\="left-start"
|
|
195
727
|
\>
|
|
196
|
-
<IressPanel
|
|
728
|
+
<IressPanel\>
|
|
197
729
|
Hello! </IressPanel\>
|
|
198
730
|
</IressPopover\>
|
|
199
731
|
</IressInline\>
|
|
@@ -202,7 +734,7 @@ Hide code
|
|
|
202
734
|
activator\={<IressButton\>left</IressButton\>}
|
|
203
735
|
align\="left"
|
|
204
736
|
\>
|
|
205
|
-
<IressPanel
|
|
737
|
+
<IressPanel\>
|
|
206
738
|
Hello! </IressPanel\>
|
|
207
739
|
</IressPopover\>
|
|
208
740
|
</IressInline\>
|
|
@@ -211,18 +743,18 @@ Hide code
|
|
|
211
743
|
activator\={<IressButton\>left-end</IressButton\>}
|
|
212
744
|
align\="left-end"
|
|
213
745
|
\>
|
|
214
|
-
<IressPanel
|
|
746
|
+
<IressPanel\>
|
|
215
747
|
Hello! </IressPanel\>
|
|
216
748
|
</IressPopover\>
|
|
217
749
|
</IressInline\>
|
|
218
750
|
</IressStack\>
|
|
219
|
-
<IressStack
|
|
751
|
+
<IressStack gap\="sm"\>
|
|
220
752
|
<IressInline horizontalAlign\="right"\>
|
|
221
753
|
<IressPopover
|
|
222
754
|
activator\={<IressButton\>right-start</IressButton\>}
|
|
223
755
|
align\="right-start"
|
|
224
756
|
\>
|
|
225
|
-
<IressPanel
|
|
757
|
+
<IressPanel\>
|
|
226
758
|
Hello! </IressPanel\>
|
|
227
759
|
</IressPopover\>
|
|
228
760
|
</IressInline\>
|
|
@@ -231,7 +763,7 @@ Hide code
|
|
|
231
763
|
activator\={<IressButton\>right</IressButton\>}
|
|
232
764
|
align\="right"
|
|
233
765
|
\>
|
|
234
|
-
<IressPanel
|
|
766
|
+
<IressPanel\>
|
|
235
767
|
Hello! </IressPanel\>
|
|
236
768
|
</IressPopover\>
|
|
237
769
|
</IressInline\>
|
|
@@ -240,35 +772,35 @@ Hide code
|
|
|
240
772
|
activator\={<IressButton\>right-end</IressButton\>}
|
|
241
773
|
align\="right-end"
|
|
242
774
|
\>
|
|
243
|
-
<IressPanel
|
|
775
|
+
<IressPanel\>
|
|
244
776
|
Hello! </IressPanel\>
|
|
245
777
|
</IressPopover\>
|
|
246
778
|
</IressInline\>
|
|
247
779
|
</IressStack\>
|
|
248
780
|
</IressInline\>
|
|
249
781
|
<IressInline
|
|
250
|
-
|
|
782
|
+
gap\="sm"
|
|
251
783
|
horizontalAlign\="center"
|
|
252
784
|
\>
|
|
253
785
|
<IressPopover
|
|
254
786
|
activator\={<IressButton\>bottom-start</IressButton\>}
|
|
255
787
|
align\="bottom-start"
|
|
256
788
|
\>
|
|
257
|
-
<IressPanel
|
|
789
|
+
<IressPanel\>
|
|
258
790
|
Hello! </IressPanel\>
|
|
259
791
|
</IressPopover\>
|
|
260
792
|
<IressPopover
|
|
261
793
|
activator\={<IressButton\>bottom</IressButton\>}
|
|
262
794
|
align\="bottom"
|
|
263
795
|
\>
|
|
264
|
-
<IressPanel
|
|
796
|
+
<IressPanel\>
|
|
265
797
|
Hello! </IressPanel\>
|
|
266
798
|
</IressPopover\>
|
|
267
799
|
<IressPopover
|
|
268
800
|
activator\={<IressButton\>bottom-end</IressButton\>}
|
|
269
801
|
align\="bottom-end"
|
|
270
802
|
\>
|
|
271
|
-
<IressPanel
|
|
803
|
+
<IressPanel\>
|
|
272
804
|
Hello! </IressPanel\>
|
|
273
805
|
</IressPopover\>
|
|
274
806
|
</IressInline\>
|
|
@@ -281,10 +813,6 @@ Copy
|
|
|
281
813
|
|
|
282
814
|
Occasionally, you may have more information to display than the width set by the theme can comfortably show.
|
|
283
815
|
|
|
284
|
-
This is where the `--iress-width` CSS token come in, it will allow you to set the width for the popover panel. For better results, its recommended to use it with the `--iress-max-width` CSS token, to allow your popovers to be responsive.
|
|
285
|
-
|
|
286
|
-
**Note:** The `width` prop has been deprecated in favour of the CSS tokens.
|
|
287
|
-
|
|
288
816
|
Toggle popover
|
|
289
817
|
|
|
290
818
|
Hide code
|
|
@@ -294,9 +822,10 @@ Hide code
|
|
|
294
822
|
<IressPopover
|
|
295
823
|
activator\={<IressButton\>Toggle popover</IressButton\>}
|
|
296
824
|
container\={document.body}
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
825
|
+
contentStyle\={{
|
|
826
|
+
style: {
|
|
827
|
+
maxWidth: '30rem'
|
|
828
|
+
}
|
|
300
829
|
}}
|
|
301
830
|
\>
|
|
302
831
|
<IressPanel\>
|
|
@@ -339,7 +868,7 @@ Copy
|
|
|
339
868
|
|
|
340
869
|
Popovers can contain a wide variety of different content, including components that use popovers themselves (like Combobox). This can cause issues with overflowing content, so by default we allow popovers to grow in height based on their content.
|
|
341
870
|
|
|
342
|
-
If you need to fix the height of a popover, you can set a maximum height using the
|
|
871
|
+
If you need to fix the height of a popover, you can set a maximum height using the `maxHeight` and `overflowY` css on your popover's `contentStyle` prop.
|
|
343
872
|
|
|
344
873
|
Normal popover
|
|
345
874
|
|
|
@@ -349,7 +878,7 @@ Hide code
|
|
|
349
878
|
|
|
350
879
|
\[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; }
|
|
351
880
|
|
|
352
|
-
<IressInline
|
|
881
|
+
<IressInline gap\="md"\>
|
|
353
882
|
<IressPopover
|
|
354
883
|
activator\={<IressButton\>Normal popover</IressButton\>}
|
|
355
884
|
align\="bottom-start"
|
|
@@ -366,9 +895,11 @@ Hide code
|
|
|
366
895
|
activator\={<IressButton\>Fixed height popover</IressButton\>}
|
|
367
896
|
align\="bottom-start"
|
|
368
897
|
container\={document.body}
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
898
|
+
contentStyle\={{
|
|
899
|
+
style: {
|
|
900
|
+
maxHeight: '200px',
|
|
901
|
+
overflowY: 'auto'
|
|
902
|
+
}
|
|
372
903
|
}}
|
|
373
904
|
\>
|
|
374
905
|
<IressPanel\>
|
|
@@ -441,12 +972,546 @@ Hide code
|
|
|
441
972
|
activator\={<IressInput />}
|
|
442
973
|
container\={document.body}
|
|
443
974
|
\>
|
|
444
|
-
<IressPanel
|
|
975
|
+
<IressPanel\>
|
|
445
976
|
A little more information about this area. </IressPanel\>
|
|
446
977
|
</IressInputPopover\>
|
|
447
978
|
|
|
448
979
|
Copy
|
|
449
980
|
|
|
981
|
+
#### [](#input-popover-api)Props
|
|
982
|
+
|
|
983
|
+
| Name | Description | Default | Control |
|
|
984
|
+
| --- | --- | --- | --- |
|
|
985
|
+
| activator\* |
|
|
986
|
+
Content for an activator element, usually an `IressInput`.
|
|
987
|
+
|
|
988
|
+
ReactElement<any, string | JSXElementConstructor<any>> | undefined
|
|
989
|
+
|
|
990
|
+
| \- | \- |
|
|
991
|
+
| align |
|
|
992
|
+
|
|
993
|
+
Sets the alignment of the popover relative to the activator element.
|
|
994
|
+
|
|
995
|
+
"bottom""left""right""top""auto""bottom-start""bottom-end""top-start"Show 6 more...
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
|
|
|
1000
|
+
|
|
1001
|
+
auto
|
|
1002
|
+
|
|
1003
|
+
| Set object |
|
|
1004
|
+
| autoHighlight |
|
|
1005
|
+
|
|
1006
|
+
If true, the first supported is automatically highlighted.
|
|
1007
|
+
|
|
1008
|
+
booleanundefined
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
|
|
|
1013
|
+
|
|
1014
|
+
true
|
|
1015
|
+
|
|
1016
|
+
| Set object |
|
|
1017
|
+
| bg |
|
|
1018
|
+
|
|
1019
|
+
**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
|
|
1020
|
+
|
|
1021
|
+
We recommend using the following token values for best background contrast:
|
|
1022
|
+
|
|
1023
|
+
* `colour.primary.fill` for primary backgrounds that need to stand out
|
|
1024
|
+
* `colour.primary.surface` for primary backgrounds that need to be less prominent
|
|
1025
|
+
* `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
|
|
1026
|
+
* `colour.neutral.20` for a slightly darker background color, used in neutral state components
|
|
1027
|
+
* `colour.system.danger.fill` for error backgrounds that need to stand out
|
|
1028
|
+
* `colour.system.danger.surface` for error backgrounds that need to be less prominent
|
|
1029
|
+
* `colour.system.success.fill` for success backgrounds that need to stand out
|
|
1030
|
+
* `colour.system.success.surface` for success backgrounds that need to be less prominent
|
|
1031
|
+
* `colour.system.warning.fill` for warning backgrounds that need to stand out
|
|
1032
|
+
* `colour.system.warning.surface` for warning backgrounds that need to be less prominent
|
|
1033
|
+
* `colour.system.info.fill` for info backgrounds that need to stand out
|
|
1034
|
+
* `colour.system.info.surface` for info backgrounds that need to be less prominent
|
|
1035
|
+
|
|
1036
|
+
ResponsiveProp<ColorToken> | undefined
|
|
1037
|
+
|
|
1038
|
+
| \- | Set object |
|
|
1039
|
+
| borderRadius |
|
|
1040
|
+
|
|
1041
|
+
The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
|
|
1042
|
+
|
|
1043
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1044
|
+
| --- | --- | --- | --- | --- |
|
|
1045
|
+
| **4** | **4** | **5** | **12** | **9** |
|
|
1046
|
+
| 1 _\-x-_ | | 3 _\-x-_ | | |
|
|
1047
|
+
|
|
1048
|
+
ResponsiveProp<RadiusToken> | undefined
|
|
1049
|
+
|
|
1050
|
+
| \- | Set object |
|
|
1051
|
+
| children |
|
|
1052
|
+
|
|
1053
|
+
The content to render within the popover.
|
|
1054
|
+
|
|
1055
|
+
ReactNode
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
| \- | Choose option...nonebasicmenu |
|
|
1060
|
+
| color |
|
|
1061
|
+
|
|
1062
|
+
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`.
|
|
1063
|
+
|
|
1064
|
+
We recommend using the following token values for best color contrast:
|
|
1065
|
+
|
|
1066
|
+
* `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
|
|
1067
|
+
* `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
|
|
1068
|
+
* `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
|
|
1069
|
+
* `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
|
|
1070
|
+
* `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
|
|
1071
|
+
* `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
|
|
1072
|
+
* `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
|
|
1073
|
+
* `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
|
|
1074
|
+
* `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
|
|
1075
|
+
* `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
|
|
1076
|
+
* `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
|
|
1077
|
+
* `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
|
|
1078
|
+
|
|
1079
|
+
ResponsiveProp<ColorToken> | undefined
|
|
1080
|
+
|
|
1081
|
+
| \- | Set object |
|
|
1082
|
+
| container |
|
|
1083
|
+
|
|
1084
|
+
The container element to render the popover into. By default, the popover will render where its parent is rendered.
|
|
1085
|
+
|
|
1086
|
+
**Note:** If the `container` doesn’t exist when the popover is mounted, ensure you pass an element directly (not a ref) and specify null as the default value before it is set. This lets it wait for the root to be available. For example, if you reference the parent element of a popover.
|
|
1087
|
+
|
|
1088
|
+
FloatingUIContainerundefined
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
| \- |
|
|
1093
|
+
|
|
1094
|
+
container : {...} 0 keys
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
|
1101
|
+
| contentClassName |
|
|
1102
|
+
|
|
1103
|
+
Class name of the popover content.
|
|
1104
|
+
|
|
1105
|
+
stringundefined
|
|
1106
|
+
|
|
1107
|
+
<table class="css-3nr4py"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use `contentStyle` instead.</td></tr></tbody></table>
|
|
1108
|
+
|
|
1109
|
+
| \- | Set object |
|
|
1110
|
+
| contentStyle |
|
|
1111
|
+
|
|
1112
|
+
This allows you to customise the content styling specifically, which is the floating element. It accepts an object with any of the styling properties available on `IressCSSProps`, as well as `className` and `style`.
|
|
1113
|
+
|
|
1114
|
+
IressCustomiseSlotundefined
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
| \- | Set object |
|
|
1119
|
+
| defaultShow |
|
|
1120
|
+
|
|
1121
|
+
When set to `true` the popover will be visible by default. Use for uncontrolled popovers.
|
|
1122
|
+
|
|
1123
|
+
booleanundefined
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
| \- | Set object |
|
|
1128
|
+
| displayMode |
|
|
1129
|
+
|
|
1130
|
+
Sets the display mode of popover.
|
|
1131
|
+
|
|
1132
|
+
"overlay""inline"undefined
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
|
|
|
1137
|
+
|
|
1138
|
+
overlay
|
|
1139
|
+
|
|
1140
|
+
| Set object |
|
|
1141
|
+
| focusable |
|
|
1142
|
+
|
|
1143
|
+
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.
|
|
1144
|
+
|
|
1145
|
+
"true""within"undefined
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
| \- | Set object |
|
|
1150
|
+
| focusStartIndex |
|
|
1151
|
+
|
|
1152
|
+
Which index to start the focus on when the popover is opened. Only works with `type` listbox and menu. Note: The index must exist in the list of items, otherwise it will not work.
|
|
1153
|
+
|
|
1154
|
+
numberundefined
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
|
|
|
1159
|
+
|
|
1160
|
+
0
|
|
1161
|
+
|
|
1162
|
+
| Set object |
|
|
1163
|
+
| hide |
|
|
1164
|
+
|
|
1165
|
+
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.
|
|
1166
|
+
|
|
1167
|
+
Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
1168
|
+
|
|
1169
|
+
Notes:
|
|
1170
|
+
|
|
1171
|
+
* If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
|
|
1172
|
+
* Consider if you can conditionally render the element instead of hiding it.
|
|
1173
|
+
|
|
1174
|
+
ResponsiveProp<boolean> | undefined
|
|
1175
|
+
|
|
1176
|
+
| \- | Set object |
|
|
1177
|
+
| layerStyle |
|
|
1178
|
+
|
|
1179
|
+
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.
|
|
1180
|
+
|
|
1181
|
+
* `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.
|
|
1182
|
+
* `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.
|
|
1183
|
+
* `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.
|
|
1184
|
+
|
|
1185
|
+
ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
|
|
1186
|
+
|
|
1187
|
+
| \- | Set object |
|
|
1188
|
+
| m |
|
|
1189
|
+
|
|
1190
|
+
The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
|
|
1191
|
+
|
|
1192
|
+
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.
|
|
1193
|
+
|
|
1194
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1195
|
+
| --- | --- | --- | --- | --- |
|
|
1196
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1197
|
+
|
|
1198
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1199
|
+
|
|
1200
|
+
| \- | Set object |
|
|
1201
|
+
| maxWidth |
|
|
1202
|
+
|
|
1203
|
+
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`.
|
|
1204
|
+
|
|
1205
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1206
|
+
| --- | --- | --- | --- | --- |
|
|
1207
|
+
| **1** | **1** | **1** | **12** | **7** |
|
|
1208
|
+
|
|
1209
|
+
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
|
|
1210
|
+
|
|
1211
|
+
| \- | Set object |
|
|
1212
|
+
| mb |
|
|
1213
|
+
|
|
1214
|
+
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.
|
|
1215
|
+
|
|
1216
|
+
It uses the spacing tokens in the design system.
|
|
1217
|
+
|
|
1218
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1219
|
+
| --- | --- | --- | --- | --- |
|
|
1220
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1221
|
+
|
|
1222
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1223
|
+
|
|
1224
|
+
| \- | Set object |
|
|
1225
|
+
| minLength |
|
|
1226
|
+
|
|
1227
|
+
Min length of input activator before popover is shown, if input activator has minLength prop it will use that as a fallback. Defaults to 1 if not provided and not found in activator.
|
|
1228
|
+
|
|
1229
|
+
numberundefined
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
| \- | Set object |
|
|
1234
|
+
| ml |
|
|
1235
|
+
|
|
1236
|
+
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.
|
|
1237
|
+
|
|
1238
|
+
It uses the spacing tokens in the design system.
|
|
1239
|
+
|
|
1240
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1241
|
+
| --- | --- | --- | --- | --- |
|
|
1242
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1243
|
+
|
|
1244
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1245
|
+
|
|
1246
|
+
| \- | Set object |
|
|
1247
|
+
| mr |
|
|
1248
|
+
|
|
1249
|
+
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.
|
|
1250
|
+
|
|
1251
|
+
It uses the spacing tokens in the design system.
|
|
1252
|
+
|
|
1253
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1254
|
+
| --- | --- | --- | --- | --- |
|
|
1255
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1256
|
+
|
|
1257
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1258
|
+
|
|
1259
|
+
| \- | Set object |
|
|
1260
|
+
| mt |
|
|
1261
|
+
|
|
1262
|
+
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.
|
|
1263
|
+
|
|
1264
|
+
It uses the spacing tokens in the design system.
|
|
1265
|
+
|
|
1266
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1267
|
+
| --- | --- | --- | --- | --- |
|
|
1268
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1269
|
+
|
|
1270
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1271
|
+
|
|
1272
|
+
| \- | Set object |
|
|
1273
|
+
| mx |
|
|
1274
|
+
|
|
1275
|
+
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.
|
|
1276
|
+
|
|
1277
|
+
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.
|
|
1278
|
+
|
|
1279
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1280
|
+
| --- | --- | --- | --- | --- |
|
|
1281
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1282
|
+
|
|
1283
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1284
|
+
|
|
1285
|
+
| \- | Set object |
|
|
1286
|
+
| my |
|
|
1287
|
+
|
|
1288
|
+
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.
|
|
1289
|
+
|
|
1290
|
+
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.
|
|
1291
|
+
|
|
1292
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1293
|
+
| --- | --- | --- | --- | --- |
|
|
1294
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1295
|
+
|
|
1296
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1297
|
+
|
|
1298
|
+
| \- | Set object |
|
|
1299
|
+
| noGutter |
|
|
1300
|
+
|
|
1301
|
+
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.
|
|
1302
|
+
|
|
1303
|
+
booleanundefined
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
| \- | Set object |
|
|
1308
|
+
| onActivated |
|
|
1309
|
+
|
|
1310
|
+
Is called when popover is activated.
|
|
1311
|
+
|
|
1312
|
+
((e?: Event | undefined, reason?: OpenChangeReason | undefined, activeIndex?: number | null | undefined) => void) | undefined
|
|
1313
|
+
|
|
1314
|
+
| \- | \- |
|
|
1315
|
+
| onDeactivated |
|
|
1316
|
+
|
|
1317
|
+
Is called when popover is deactivated.
|
|
1318
|
+
|
|
1319
|
+
((e?: Event | undefined, reason?: OpenChangeReason | undefined, activeIndex?: number | null | undefined) => void) | undefined
|
|
1320
|
+
|
|
1321
|
+
| \- | \- |
|
|
1322
|
+
| onNavigate |
|
|
1323
|
+
|
|
1324
|
+
Is called when registered popover items are navigated using arrow keys. Only works with `type` listbox and menu.
|
|
1325
|
+
|
|
1326
|
+
((activeIndex: number | null) => void) | undefined
|
|
1327
|
+
|
|
1328
|
+
| \- | \- |
|
|
1329
|
+
| p |
|
|
1330
|
+
|
|
1331
|
+
The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
|
|
1332
|
+
|
|
1333
|
+
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.
|
|
1334
|
+
|
|
1335
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1336
|
+
| --- | --- | --- | --- | --- |
|
|
1337
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1338
|
+
|
|
1339
|
+
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
|
|
1340
|
+
|
|
1341
|
+
| \- | Set object |
|
|
1342
|
+
| pb |
|
|
1343
|
+
|
|
1344
|
+
The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
|
|
1345
|
+
|
|
1346
|
+
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.
|
|
1347
|
+
|
|
1348
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1349
|
+
| --- | --- | --- | --- | --- |
|
|
1350
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1351
|
+
|
|
1352
|
+
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
|
|
1353
|
+
|
|
1354
|
+
| \- | Set object |
|
|
1355
|
+
| pl |
|
|
1356
|
+
|
|
1357
|
+
The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
|
|
1358
|
+
|
|
1359
|
+
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.
|
|
1360
|
+
|
|
1361
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1362
|
+
| --- | --- | --- | --- | --- |
|
|
1363
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1364
|
+
|
|
1365
|
+
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
|
|
1366
|
+
|
|
1367
|
+
| \- | Set object |
|
|
1368
|
+
| pr |
|
|
1369
|
+
|
|
1370
|
+
The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
|
|
1371
|
+
|
|
1372
|
+
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.
|
|
1373
|
+
|
|
1374
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1375
|
+
| --- | --- | --- | --- | --- |
|
|
1376
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1377
|
+
|
|
1378
|
+
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
|
|
1379
|
+
|
|
1380
|
+
| \- | Set object |
|
|
1381
|
+
| pt |
|
|
1382
|
+
|
|
1383
|
+
The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
|
|
1384
|
+
|
|
1385
|
+
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.
|
|
1386
|
+
|
|
1387
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1388
|
+
| --- | --- | --- | --- | --- |
|
|
1389
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1390
|
+
|
|
1391
|
+
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
|
|
1392
|
+
|
|
1393
|
+
| \- | Set object |
|
|
1394
|
+
| px |
|
|
1395
|
+
|
|
1396
|
+
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.
|
|
1397
|
+
|
|
1398
|
+
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.
|
|
1399
|
+
|
|
1400
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1401
|
+
| --- | --- | --- | --- | --- |
|
|
1402
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1403
|
+
|
|
1404
|
+
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
|
|
1405
|
+
|
|
1406
|
+
| \- | Set object |
|
|
1407
|
+
| py |
|
|
1408
|
+
|
|
1409
|
+
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.
|
|
1410
|
+
|
|
1411
|
+
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.
|
|
1412
|
+
|
|
1413
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1414
|
+
| --- | --- | --- | --- | --- |
|
|
1415
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1416
|
+
|
|
1417
|
+
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
|
|
1418
|
+
|
|
1419
|
+
| \- | Set object |
|
|
1420
|
+
| rowGap |
|
|
1421
|
+
|
|
1422
|
+
The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
|
|
1423
|
+
|
|
1424
|
+
Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
|
|
1425
|
+
|
|
1426
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1427
|
+
| --- | --- | --- | --- | --- |
|
|
1428
|
+
| **47** | **52** | **10.1** | **16** | No |
|
|
1429
|
+
|
|
1430
|
+
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
|
|
1431
|
+
|
|
1432
|
+
| \- | Set object |
|
|
1433
|
+
| show |
|
|
1434
|
+
|
|
1435
|
+
When set to `true` the modal will be visible. Use for controlled popovers.
|
|
1436
|
+
|
|
1437
|
+
booleanundefined
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
| \- | Set object |
|
|
1442
|
+
| srOnly |
|
|
1443
|
+
|
|
1444
|
+
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.
|
|
1445
|
+
|
|
1446
|
+
Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
1447
|
+
|
|
1448
|
+
ResponsiveProp<boolean> | undefined
|
|
1449
|
+
|
|
1450
|
+
| \- | Set object |
|
|
1451
|
+
| stretch |
|
|
1452
|
+
|
|
1453
|
+
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.
|
|
1454
|
+
|
|
1455
|
+
booleanundefined
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
| \- | Set object |
|
|
1460
|
+
| textAlign |
|
|
1461
|
+
|
|
1462
|
+
The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
|
|
1463
|
+
|
|
1464
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1465
|
+
| --- | --- | --- | --- | --- |
|
|
1466
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1467
|
+
|
|
1468
|
+
ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
|
|
1469
|
+
|
|
1470
|
+
| \- | Set object |
|
|
1471
|
+
| textStyle |
|
|
1472
|
+
|
|
1473
|
+
Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
|
|
1474
|
+
|
|
1475
|
+
* `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
|
|
1476
|
+
* `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.
|
|
1477
|
+
* `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
|
|
1478
|
+
* `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.
|
|
1479
|
+
* `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.
|
|
1480
|
+
* `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.
|
|
1481
|
+
* `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.
|
|
1482
|
+
* `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.
|
|
1483
|
+
* `typography.code` - Used to display code snippets in the product, such as in the API documentation.
|
|
1484
|
+
|
|
1485
|
+
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
|
|
1486
|
+
|
|
1487
|
+
| \- | Set object |
|
|
1488
|
+
| type |
|
|
1489
|
+
|
|
1490
|
+
Describes the type of content contained in the popover. If `listbox`, it will add the combobox role to the popover activator.
|
|
1491
|
+
|
|
1492
|
+
"tree""dialog""menu""grid""listbox"undefined
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
|
|
|
1497
|
+
|
|
1498
|
+
listbox
|
|
1499
|
+
|
|
1500
|
+
| Set object |
|
|
1501
|
+
| width |
|
|
1502
|
+
|
|
1503
|
+
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.
|
|
1504
|
+
|
|
1505
|
+
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.
|
|
1506
|
+
|
|
1507
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1508
|
+
| --- | --- | --- | --- | --- |
|
|
1509
|
+
| **1** | **1** | **1** | **12** | **4** |
|
|
1510
|
+
|
|
1511
|
+
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
|
|
1512
|
+
|
|
1513
|
+
| \- | Set object |
|
|
1514
|
+
|
|
450
1515
|
On this page
|
|
451
1516
|
|
|
452
1517
|
* [Overview](#overview)
|