@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
|
@@ -9,27 +9,6 @@ When an `IressMenu` is used inside `IressPopover`, it adds some additional funct
|
|
|
9
9
|
* `IressPopover` will automatically close the popover when a menu item is clicked.
|
|
10
10
|
* `IressMenu` will automatically focus the first menu item when the popover is opened.
|
|
11
11
|
|
|
12
|
-
role=menu
|
|
13
|
-
|
|
14
|
-
### Application menu behaviour
|
|
15
|
-
|
|
16
|
-
* Once activated, focus is set to the first menu item
|
|
17
|
-
* Menu items can be navigated using the `up` and `down` arrow keys
|
|
18
|
-
* Popover will close when:
|
|
19
|
-
* the `esc` key is pressed
|
|
20
|
-
* the `tab` key is pressed (focus moves to the focusable element in the DOM)
|
|
21
|
-
* a menu item is clicked
|
|
22
|
-
|
|
23
|
-
role=list
|
|
24
|
-
|
|
25
|
-
### Navigation/list menu behaviour
|
|
26
|
-
|
|
27
|
-
* Once activated, focus is set to the popover panel
|
|
28
|
-
* Menu items can be navigated using the `tab` key
|
|
29
|
-
* Popover will close when:
|
|
30
|
-
* the `esc` key is pressed
|
|
31
|
-
* the popover panel loses focus
|
|
32
|
-
|
|
33
12
|
role=listbox
|
|
34
13
|
|
|
35
14
|
Multi-select
|
|
@@ -44,7 +23,18 @@ Multi-select
|
|
|
44
23
|
* a menu item is clicked (except when a listbox menu is in `multiSelect` mode)
|
|
45
24
|
* When user presses the `up` key when the first item is focused
|
|
46
25
|
|
|
47
|
-
role=
|
|
26
|
+
role=menu
|
|
27
|
+
|
|
28
|
+
### Application menu behaviour
|
|
29
|
+
|
|
30
|
+
* Once activated, focus is set to the first menu item
|
|
31
|
+
* Menu items can be navigated using the `up` and `down` arrow keys
|
|
32
|
+
* Popover will close when:
|
|
33
|
+
* the `esc` key is pressed
|
|
34
|
+
* the `tab` key is pressed (focus moves to the focusable element in the DOM)
|
|
35
|
+
* a menu item is clicked
|
|
36
|
+
|
|
37
|
+
role=list
|
|
48
38
|
|
|
49
39
|
### Navigation/list menu behaviour
|
|
50
40
|
|
|
@@ -58,20 +48,25 @@ Hide code
|
|
|
58
48
|
|
|
59
49
|
\[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; }
|
|
60
50
|
|
|
61
|
-
<
|
|
51
|
+
<IressStack
|
|
52
|
+
gap\="md"
|
|
53
|
+
maxWidth\="container.lg"
|
|
54
|
+
mx\="auto"
|
|
55
|
+
px\="lg"
|
|
56
|
+
\>
|
|
62
57
|
<IressRow
|
|
63
58
|
gutter\="lg"
|
|
64
59
|
verticalAlign\="middle"
|
|
65
60
|
\>
|
|
66
|
-
<IressCol span\=
|
|
61
|
+
<IressCol span\={2}\>
|
|
67
62
|
<IressPopover
|
|
68
|
-
activator\={<IressButton fluid\>role=
|
|
63
|
+
activator\={<IressButton fluid\>role=listbox</IressButton\>}
|
|
69
64
|
container\={document.body}
|
|
70
|
-
type\="
|
|
65
|
+
type\="listbox"
|
|
71
66
|
\>
|
|
72
67
|
<IressMenu
|
|
73
68
|
defaultSelected\={3}
|
|
74
|
-
role\="
|
|
69
|
+
role\="listbox"
|
|
75
70
|
\>
|
|
76
71
|
<IressMenuItem value\={0}\>
|
|
77
72
|
New task </IressMenuItem\>
|
|
@@ -85,50 +80,28 @@ Hide code
|
|
|
85
80
|
</IressPopover\>
|
|
86
81
|
</IressCol\>
|
|
87
82
|
<IressCol\>
|
|
88
|
-
<MenuInPopoverRoleDescription role\="
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
gutter\="lg"
|
|
93
|
-
verticalAlign\="middle"
|
|
94
|
-
\>
|
|
95
|
-
<IressCol span\="2"\>
|
|
96
|
-
<IressPopover
|
|
97
|
-
activator\={<IressButton fluid\>role=list</IressButton\>}
|
|
98
|
-
container\={document.body}
|
|
99
|
-
\>
|
|
100
|
-
<IressMenu
|
|
101
|
-
defaultSelected\={3}
|
|
102
|
-
role\="list"
|
|
83
|
+
<MenuInPopoverRoleDescription role\="listbox"\>
|
|
84
|
+
<IressToggle
|
|
85
|
+
mb\="md"
|
|
86
|
+
onChange\={() \=> {}}
|
|
103
87
|
\>
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
<IressMenuItem value\={1}\>
|
|
107
|
-
Send prospect welcome pack </IressMenuItem\>
|
|
108
|
-
<IressMenuItem value\={2}\>
|
|
109
|
-
Book in Discovery meeting </IressMenuItem\>
|
|
110
|
-
<IressMenuItem value\={3}\>
|
|
111
|
-
Prospect proceeding </IressMenuItem\>
|
|
112
|
-
</IressMenu\>
|
|
113
|
-
</IressPopover\>
|
|
114
|
-
</IressCol\>
|
|
115
|
-
<IressCol\>
|
|
116
|
-
<MenuInPopoverRoleDescription role\="list" />
|
|
88
|
+
Multi-select </IressToggle\>
|
|
89
|
+
</MenuInPopoverRoleDescription\>
|
|
117
90
|
</IressCol\>
|
|
118
91
|
</IressRow\>
|
|
119
92
|
<IressRow
|
|
120
93
|
gutter\="lg"
|
|
121
94
|
verticalAlign\="middle"
|
|
122
95
|
\>
|
|
123
|
-
<IressCol span\=
|
|
96
|
+
<IressCol span\={2}\>
|
|
124
97
|
<IressPopover
|
|
125
|
-
activator\={<IressButton fluid\>role=
|
|
98
|
+
activator\={<IressButton fluid\>role=menu</IressButton\>}
|
|
126
99
|
container\={document.body}
|
|
127
|
-
type\="
|
|
100
|
+
type\="menu"
|
|
128
101
|
\>
|
|
129
102
|
<IressMenu
|
|
130
103
|
defaultSelected\={3}
|
|
131
|
-
role\="
|
|
104
|
+
role\="menu"
|
|
132
105
|
\>
|
|
133
106
|
<IressMenuItem value\={0}\>
|
|
134
107
|
New task </IressMenuItem\>
|
|
@@ -142,27 +115,21 @@ Hide code
|
|
|
142
115
|
</IressPopover\>
|
|
143
116
|
</IressCol\>
|
|
144
117
|
<IressCol\>
|
|
145
|
-
<MenuInPopoverRoleDescription role\="
|
|
146
|
-
<IressToggle
|
|
147
|
-
className\="iress-mb--md"
|
|
148
|
-
onChange\={() \=> {}}
|
|
149
|
-
\>
|
|
150
|
-
Multi-select </IressToggle\>
|
|
151
|
-
</MenuInPopoverRoleDescription\>
|
|
118
|
+
<MenuInPopoverRoleDescription role\="menu" />
|
|
152
119
|
</IressCol\>
|
|
153
120
|
</IressRow\>
|
|
154
121
|
<IressRow
|
|
155
122
|
gutter\="lg"
|
|
156
123
|
verticalAlign\="middle"
|
|
157
124
|
\>
|
|
158
|
-
<IressCol span\=
|
|
125
|
+
<IressCol span\={2}\>
|
|
159
126
|
<IressPopover
|
|
160
|
-
activator\={<IressButton fluid\>role=
|
|
127
|
+
activator\={<IressButton fluid\>role=list</IressButton\>}
|
|
161
128
|
container\={document.body}
|
|
162
129
|
\>
|
|
163
130
|
<IressMenu
|
|
164
131
|
defaultSelected\={3}
|
|
165
|
-
role\="
|
|
132
|
+
role\="list"
|
|
166
133
|
\>
|
|
167
134
|
<IressMenuItem value\={0}\>
|
|
168
135
|
New task </IressMenuItem\>
|
|
@@ -176,10 +143,10 @@ Hide code
|
|
|
176
143
|
</IressPopover\>
|
|
177
144
|
</IressCol\>
|
|
178
145
|
<IressCol\>
|
|
179
|
-
<MenuInPopoverRoleDescription role\="
|
|
146
|
+
<MenuInPopoverRoleDescription role\="list" />
|
|
180
147
|
</IressCol\>
|
|
181
148
|
</IressRow\>
|
|
182
|
-
</
|
|
149
|
+
</IressStack\>
|
|
183
150
|
|
|
184
151
|
Copy
|
|
185
152
|
|
|
@@ -213,11 +180,10 @@ const CountButton \= () \=> {
|
|
|
213
180
|
}
|
|
214
181
|
},
|
|
215
182
|
});
|
|
216
|
-
const className \= isActiveInPopover ? ButtonCssClass.Active : '';
|
|
217
183
|
return (
|
|
218
184
|
<IressButton
|
|
219
185
|
{...popoverItemProps}
|
|
220
|
-
|
|
186
|
+
active\={isActiveInPopover}
|
|
221
187
|
mode\="tertiary"
|
|
222
188
|
fluid
|
|
223
189
|
\>
|
|
@@ -6,6 +6,14 @@ Overview
|
|
|
6
6
|
|
|
7
7
|
A progress component is used to indicate to a user the completion of a set of tasks or a process.
|
|
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
|
Hide code
|
|
10
18
|
|
|
11
19
|
\[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; }
|
|
@@ -18,6 +26,462 @@ Hide code
|
|
|
18
26
|
|
|
19
27
|
Copy
|
|
20
28
|
|
|
29
|
+
[](#props)Props
|
|
30
|
+
---------------
|
|
31
|
+
|
|
32
|
+
| Name | Description | Default | Control |
|
|
33
|
+
| --- | --- | --- | --- |
|
|
34
|
+
| bg |
|
|
35
|
+
**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
|
|
36
|
+
|
|
37
|
+
We recommend using the following token values for best background contrast:
|
|
38
|
+
|
|
39
|
+
* `colour.primary.fill` for primary backgrounds that need to stand out
|
|
40
|
+
* `colour.primary.surface` for primary backgrounds that need to be less prominent
|
|
41
|
+
* `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
|
|
42
|
+
* `colour.neutral.20` for a slightly darker background color, used in neutral state components
|
|
43
|
+
* `colour.system.danger.fill` for error backgrounds that need to stand out
|
|
44
|
+
* `colour.system.danger.surface` for error backgrounds that need to be less prominent
|
|
45
|
+
* `colour.system.success.fill` for success backgrounds that need to stand out
|
|
46
|
+
* `colour.system.success.surface` for success backgrounds that need to be less prominent
|
|
47
|
+
* `colour.system.warning.fill` for warning backgrounds that need to stand out
|
|
48
|
+
* `colour.system.warning.surface` for warning backgrounds that need to be less prominent
|
|
49
|
+
* `colour.system.info.fill` for info backgrounds that need to stand out
|
|
50
|
+
* `colour.system.info.surface` for info backgrounds that need to be less prominent
|
|
51
|
+
|
|
52
|
+
"colorPalette""colour.primary.fill""colour.primary.fillHover""colour.primary.onFill""colour.primary.surface""colour.primary.surfaceHover""colour.primary.text"... 33 more ...Show 1 more...
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
| \- | Set object |
|
|
57
|
+
| borderRadius |
|
|
58
|
+
|
|
59
|
+
The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
|
|
60
|
+
|
|
61
|
+
RadiusTokenundefined
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
| \- | Set object |
|
|
66
|
+
| color |
|
|
67
|
+
|
|
68
|
+
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`.
|
|
69
|
+
|
|
70
|
+
We recommend using the following token values for best color contrast:
|
|
71
|
+
|
|
72
|
+
* `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
|
|
73
|
+
* `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
|
|
74
|
+
* `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
|
|
75
|
+
* `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
|
|
76
|
+
* `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
|
|
77
|
+
* `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
|
|
78
|
+
* `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
|
|
79
|
+
* `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
|
|
80
|
+
* `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
|
|
81
|
+
* `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
|
|
82
|
+
* `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
|
|
83
|
+
* `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
|
|
84
|
+
|
|
85
|
+
"colorPalette""colour.primary.fill""colour.primary.fillHover""colour.primary.onFill""colour.primary.surface""colour.primary.surfaceHover""colour.primary.text"... 33 more ...Show 1 more...
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
| \- | Set object |
|
|
90
|
+
| focusable |
|
|
91
|
+
|
|
92
|
+
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.
|
|
93
|
+
|
|
94
|
+
"true""within"undefined
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
| \- | Set object |
|
|
99
|
+
| hide |
|
|
100
|
+
|
|
101
|
+
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.
|
|
102
|
+
|
|
103
|
+
Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
104
|
+
|
|
105
|
+
Notes:
|
|
106
|
+
|
|
107
|
+
* If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
|
|
108
|
+
* Consider if you can conditionally render the element instead of hiding it.
|
|
109
|
+
|
|
110
|
+
boolean | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", boolean>> | undefined
|
|
111
|
+
|
|
112
|
+
| \- | Set object |
|
|
113
|
+
| layerStyle |
|
|
114
|
+
|
|
115
|
+
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.
|
|
116
|
+
|
|
117
|
+
* `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.
|
|
118
|
+
* `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.
|
|
119
|
+
* `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.
|
|
120
|
+
|
|
121
|
+
"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact" | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", "elevation.raised" | ... 3 more ... | "elevation.focusCompact">> | undefined
|
|
122
|
+
|
|
123
|
+
| \- | Set object |
|
|
124
|
+
| m |
|
|
125
|
+
|
|
126
|
+
The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
|
|
127
|
+
|
|
128
|
+
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.
|
|
129
|
+
|
|
130
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
131
|
+
| --- | --- | --- | --- | --- |
|
|
132
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
133
|
+
|
|
134
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
| \- | Set object |
|
|
139
|
+
| max |
|
|
140
|
+
|
|
141
|
+
number
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
| \- | |
|
|
146
|
+
| maxWidth |
|
|
147
|
+
|
|
148
|
+
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`.
|
|
149
|
+
|
|
150
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
151
|
+
| --- | --- | --- | --- | --- |
|
|
152
|
+
| **1** | **1** | **1** | **12** | **7** |
|
|
153
|
+
|
|
154
|
+
"slider.tick""auto""container.xs""container.sm""container.md""container.lg""container.xl""container.xxl"Show 6 more...
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
| \- | Set object |
|
|
159
|
+
| mb |
|
|
160
|
+
|
|
161
|
+
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.
|
|
162
|
+
|
|
163
|
+
It uses the spacing tokens in the design system.
|
|
164
|
+
|
|
165
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
166
|
+
| --- | --- | --- | --- | --- |
|
|
167
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
168
|
+
|
|
169
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
| \- | Set object |
|
|
174
|
+
| min |
|
|
175
|
+
|
|
176
|
+
The minimum value of the progress indicator. If `min` is set, the progress indicator will render as a `<meter />` element instead of a `<progress />` element, thereby changing its role to `meter` instead of `progressbar`.
|
|
177
|
+
|
|
178
|
+
numberundefined
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
|
183
|
+
|
|
184
|
+
0
|
|
185
|
+
|
|
186
|
+
|
|
|
187
|
+
|
|
188
|
+
10
|
|
189
|
+
|
|
190
|
+
|
|
|
191
|
+
| ml |
|
|
192
|
+
|
|
193
|
+
The **`ml`** property is short for `margin-left` and sets the margin area on the left side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
|
|
194
|
+
|
|
195
|
+
It uses the spacing tokens in the design system.
|
|
196
|
+
|
|
197
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
198
|
+
| --- | --- | --- | --- | --- |
|
|
199
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
200
|
+
|
|
201
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
| \- | Set object |
|
|
206
|
+
| mr |
|
|
207
|
+
|
|
208
|
+
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.
|
|
209
|
+
|
|
210
|
+
It uses the spacing tokens in the design system.
|
|
211
|
+
|
|
212
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
213
|
+
| --- | --- | --- | --- | --- |
|
|
214
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
215
|
+
|
|
216
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
| \- | Set object |
|
|
221
|
+
| mt |
|
|
222
|
+
|
|
223
|
+
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.
|
|
224
|
+
|
|
225
|
+
It uses the spacing tokens in the design system.
|
|
226
|
+
|
|
227
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
228
|
+
| --- | --- | --- | --- | --- |
|
|
229
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
230
|
+
|
|
231
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
| \- | Set object |
|
|
236
|
+
| mx |
|
|
237
|
+
|
|
238
|
+
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.
|
|
239
|
+
|
|
240
|
+
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.
|
|
241
|
+
|
|
242
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
243
|
+
| --- | --- | --- | --- | --- |
|
|
244
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
245
|
+
|
|
246
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
| \- | Set object |
|
|
251
|
+
| my |
|
|
252
|
+
|
|
253
|
+
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.
|
|
254
|
+
|
|
255
|
+
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.
|
|
256
|
+
|
|
257
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
258
|
+
| --- | --- | --- | --- | --- |
|
|
259
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
260
|
+
|
|
261
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
| \- | Set object |
|
|
266
|
+
| noGutter |
|
|
267
|
+
|
|
268
|
+
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.
|
|
269
|
+
|
|
270
|
+
booleanundefined
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
| \- | Set object |
|
|
275
|
+
| p |
|
|
276
|
+
|
|
277
|
+
The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
|
|
278
|
+
|
|
279
|
+
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.
|
|
280
|
+
|
|
281
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
282
|
+
| --- | --- | --- | --- | --- |
|
|
283
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
284
|
+
|
|
285
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
| \- | Set object |
|
|
290
|
+
| pb |
|
|
291
|
+
|
|
292
|
+
The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
|
|
293
|
+
|
|
294
|
+
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.
|
|
295
|
+
|
|
296
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
297
|
+
| --- | --- | --- | --- | --- |
|
|
298
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
299
|
+
|
|
300
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
| \- | Set object |
|
|
305
|
+
| pl |
|
|
306
|
+
|
|
307
|
+
The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
|
|
308
|
+
|
|
309
|
+
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.
|
|
310
|
+
|
|
311
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
312
|
+
| --- | --- | --- | --- | --- |
|
|
313
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
314
|
+
|
|
315
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
| \- | Set object |
|
|
320
|
+
| pr |
|
|
321
|
+
|
|
322
|
+
The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
|
|
323
|
+
|
|
324
|
+
It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
|
|
325
|
+
|
|
326
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
327
|
+
| --- | --- | --- | --- | --- |
|
|
328
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
329
|
+
|
|
330
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
| \- | Set object |
|
|
335
|
+
| pt |
|
|
336
|
+
|
|
337
|
+
The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
|
|
338
|
+
|
|
339
|
+
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.
|
|
340
|
+
|
|
341
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
342
|
+
| --- | --- | --- | --- | --- |
|
|
343
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
344
|
+
|
|
345
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
| \- | Set object |
|
|
350
|
+
| px |
|
|
351
|
+
|
|
352
|
+
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.
|
|
353
|
+
|
|
354
|
+
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.
|
|
355
|
+
|
|
356
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
357
|
+
| --- | --- | --- | --- | --- |
|
|
358
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
359
|
+
|
|
360
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
| \- | Set object |
|
|
365
|
+
| py |
|
|
366
|
+
|
|
367
|
+
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.
|
|
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
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
| \- | Set object |
|
|
380
|
+
| rowGap |
|
|
381
|
+
|
|
382
|
+
The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
|
|
383
|
+
|
|
384
|
+
Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
|
|
385
|
+
|
|
386
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
387
|
+
| --- | --- | --- | --- | --- |
|
|
388
|
+
| **47** | **52** | **10.1** | **16** | No |
|
|
389
|
+
|
|
390
|
+
"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
| \- | Set object |
|
|
395
|
+
| sectionTitle |
|
|
396
|
+
|
|
397
|
+
The text that is announced by the screen reader. Should contain a description of the section the progress is being measured for. You can use {{current}} and {{max}} as string replacers for the current value and maximum value respectively.
|
|
398
|
+
|
|
399
|
+
stringundefined
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
| Progress is {{current}} of {{max}} | Set object |
|
|
404
|
+
| srOnly |
|
|
405
|
+
|
|
406
|
+
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.
|
|
407
|
+
|
|
408
|
+
Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
409
|
+
|
|
410
|
+
boolean | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", boolean>> | undefined
|
|
411
|
+
|
|
412
|
+
| \- | Set object |
|
|
413
|
+
| stretch |
|
|
414
|
+
|
|
415
|
+
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.
|
|
416
|
+
|
|
417
|
+
booleanundefined
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
| \- | Set object |
|
|
422
|
+
| textAlign |
|
|
423
|
+
|
|
424
|
+
The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
|
|
425
|
+
|
|
426
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
427
|
+
| --- | --- | --- | --- | --- |
|
|
428
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
429
|
+
|
|
430
|
+
"center" | "left" | "right" | "inherit" | "justify" | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", "center" | "left" | "right" | "inherit" | "justify">> | undefined
|
|
431
|
+
|
|
432
|
+
| \- | Set object |
|
|
433
|
+
| textStyle |
|
|
434
|
+
|
|
435
|
+
Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
|
|
436
|
+
|
|
437
|
+
* `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
|
|
438
|
+
* `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.
|
|
439
|
+
* `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
|
|
440
|
+
* `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.
|
|
441
|
+
* `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.
|
|
442
|
+
* `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.
|
|
443
|
+
* `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.
|
|
444
|
+
* `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.
|
|
445
|
+
* `typography.code` - Used to display code snippets in the product, such as in the API documentation.
|
|
446
|
+
|
|
447
|
+
"typography.heading.1""typography.heading.2""typography.heading.3""typography.heading.4""typography.heading.5""typography.body.sm""typography.body.sm.regular"... 12 more ...Show 1 more...
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
| \- | Set object |
|
|
452
|
+
| value |
|
|
453
|
+
|
|
454
|
+
The current value of the progress indicator.
|
|
455
|
+
|
|
456
|
+
numberundefined
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
|
461
|
+
|
|
462
|
+
0
|
|
463
|
+
|
|
464
|
+
|
|
|
465
|
+
|
|
466
|
+
20
|
|
467
|
+
|
|
468
|
+
|
|
|
469
|
+
| width |
|
|
470
|
+
|
|
471
|
+
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.
|
|
472
|
+
|
|
473
|
+
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.
|
|
474
|
+
|
|
475
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
476
|
+
| --- | --- | --- | --- | --- |
|
|
477
|
+
| **1** | **1** | **1** | **12** | **4** |
|
|
478
|
+
|
|
479
|
+
"slider.tick""auto""container.xs""container.sm""container.md""container.lg""container.xl""container.xxl"Show 6 more...
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
| \- | Set object |
|
|
484
|
+
|
|
21
485
|
[](#usage)Usage
|
|
22
486
|
---------------
|
|
23
487
|
|