@iress-oss/ids-mcp-server 5.15.0 → 6.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/docs/components-alert-docs.md +579 -7
- package/generated/docs/components-autocomplete-docs.md +694 -15
- package/generated/docs/components-autocomplete-recipes-docs.md +1 -1
- package/generated/docs/components-badge-docs.md +442 -59
- package/generated/docs/components-button-docs.md +1150 -70
- package/generated/docs/components-buttongroup-docs.md +441 -3
- package/generated/docs/components-card-docs.md +487 -37
- package/generated/docs/components-checkbox-docs.md +506 -5
- package/generated/docs/components-checkboxgroup-docs.md +586 -191
- package/generated/docs/components-checkboxgroup-recipes-docs.md +3 -3
- package/generated/docs/components-col-docs.md +451 -36
- package/generated/docs/components-container-docs.md +32 -0
- package/generated/docs/components-divider-docs.md +427 -27
- package/generated/docs/components-expander-docs.md +487 -108
- package/generated/docs/components-field-docs.md +1400 -68
- package/generated/docs/components-filter-docs.md +268 -55
- package/generated/docs/components-hide-docs.md +447 -10
- package/generated/docs/components-icon-docs.md +522 -259
- package/generated/docs/components-image-docs.md +493 -0
- package/generated/docs/components-inline-docs.md +1179 -44
- package/generated/docs/components-input-docs.md +544 -12
- package/generated/docs/components-input-recipes-docs.md +4 -4
- package/generated/docs/components-inputcurrency-docs.md +532 -0
- package/generated/docs/components-inputcurrency-recipes-docs.md +4 -5
- package/generated/docs/components-introduction-docs.md +450 -0
- package/generated/docs/components-label-docs.md +454 -27
- package/generated/docs/components-link-docs.md +586 -0
- package/generated/docs/components-menu-docs.md +531 -89
- package/generated/docs/components-menu-menuitem-docs.md +556 -10
- package/generated/docs/components-modal-docs.md +814 -55
- package/generated/docs/components-panel-docs.md +418 -198
- package/generated/docs/components-placeholder-docs.md +420 -1
- package/generated/docs/components-popover-docs.md +1097 -32
- package/generated/docs/components-popover-recipes-docs.md +39 -73
- package/generated/docs/components-progress-docs.md +464 -0
- package/generated/docs/components-provider-docs.md +57 -2
- package/generated/docs/components-radio-docs.md +460 -4
- package/generated/docs/components-radiogroup-docs.md +586 -116
- package/generated/docs/components-readonly-docs.md +450 -4
- package/generated/docs/components-richselect-docs.md +4660 -1257
- package/generated/docs/components-row-docs.md +2065 -588
- package/generated/docs/components-select-docs.md +489 -5
- package/generated/docs/components-skeleton-docs.md +399 -16
- package/generated/docs/components-skeleton-recipes-docs.md +7 -7
- package/generated/docs/components-skiplink-docs.md +548 -27
- package/generated/docs/components-slideout-docs.md +648 -150
- package/generated/docs/components-slider-docs.md +515 -33
- package/generated/docs/components-spinner-docs.md +393 -2
- package/generated/docs/components-stack-docs.md +732 -74
- package/generated/docs/components-table-ag-grid-docs.md +497 -127
- package/generated/docs/components-table-docs.md +1049 -27
- package/generated/docs/components-tabset-docs.md +454 -27
- package/generated/docs/components-tabset-tab-docs.md +464 -0
- package/generated/docs/components-tag-docs.md +452 -19
- package/generated/docs/components-text-docs.md +322 -131
- package/generated/docs/components-toaster-docs.md +463 -53
- package/generated/docs/components-toggle-docs.md +476 -20
- package/generated/docs/components-tooltip-docs.md +443 -7
- package/generated/docs/components-validationmessage-docs.md +933 -13
- package/generated/docs/extensions-editor-docs.md +906 -13
- package/generated/docs/extensions-editor-recipes-docs.md +51 -1
- package/generated/docs/foundations-accessibility-docs.md +1 -23
- package/generated/docs/foundations-grid-docs.md +74 -0
- package/generated/docs/foundations-introduction-docs.md +6 -4
- package/generated/docs/foundations-responsive-breakpoints-docs.md +193 -0
- package/generated/docs/foundations-tokens-colour-docs.md +564 -0
- package/generated/docs/foundations-tokens-elevation-docs.md +155 -0
- package/generated/docs/foundations-tokens-introduction-docs.md +190 -0
- package/generated/docs/foundations-tokens-radius-docs.md +71 -0
- package/generated/docs/foundations-tokens-spacing-docs.md +89 -0
- package/generated/docs/foundations-tokens-typography-docs.md +322 -0
- package/generated/docs/foundations-z-index-stacking-docs.md +31 -0
- package/generated/docs/guidelines.md +1537 -295
- package/generated/docs/introduction-docs.md +65 -21
- package/generated/docs/news-version-6-docs.md +93 -0
- package/generated/docs/patterns-form-docs.md +3902 -0
- package/generated/docs/patterns-form-recipes-docs.md +1370 -0
- package/generated/docs/patterns-introduction-docs.md +24 -0
- package/generated/docs/patterns-loading-docs.md +2940 -201
- package/generated/docs/resources-introduction-docs.md +38 -0
- package/generated/docs/resources-mcp-server-docs.md +27 -0
- package/generated/docs/styling-props-colour-docs.md +172 -0
- package/generated/docs/styling-props-elevation-docs.md +88 -0
- package/generated/docs/styling-props-radius-docs.md +86 -0
- package/generated/docs/styling-props-reference-docs.md +160 -0
- package/generated/docs/styling-props-screen-readers-docs.md +71 -0
- package/generated/docs/styling-props-sizing-docs.md +627 -0
- package/generated/docs/styling-props-spacing-docs.md +2282 -0
- package/generated/docs/styling-props-typography-docs.md +121 -0
- package/generated/docs/themes-available-themes-docs.md +29 -29
- package/generated/docs/themes-introduction-docs.md +1 -1
- package/package.json +3 -22
- package/generated/docs/components-button-recipes-docs.md +0 -76
- package/generated/docs/components-card-recipes-docs.md +0 -89
- package/generated/docs/components-combobox-docs.md +0 -1016
- package/generated/docs/components-form-docs.md +0 -2410
- package/generated/docs/components-form-recipes-docs.md +0 -886
- package/generated/docs/components-navbar-docs.md +0 -291
- package/generated/docs/components-navbar-recipes-docs.md +0 -413
- package/generated/docs/components-toaster-toast-docs.md +0 -157
- package/generated/docs/foundations-colours-docs.md +0 -257
- package/generated/docs/foundations-typography-docs.md +0 -191
- package/generated/docs/resources-changelog-docs.md +0 -6
- package/generated/docs/themes-tokens-docs.md +0 -1200
|
@@ -6,6 +6,14 @@ Overview
|
|
|
6
6
|
|
|
7
7
|
Data driven component for displaying tabular data.
|
|
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
|
My investments
|
|
10
18
|
| Investment Name | Cost | Investment Date | Total Percentage |
|
|
11
19
|
| --- | --- | --- | --- |
|
|
@@ -43,6 +51,520 @@ Hide code
|
|
|
43
51
|
|
|
44
52
|
Copy
|
|
45
53
|
|
|
54
|
+
[](#props)Props
|
|
55
|
+
---------------
|
|
56
|
+
|
|
57
|
+
| Name | Description | Default | Control |
|
|
58
|
+
| --- | --- | --- | --- |
|
|
59
|
+
| alternate |
|
|
60
|
+
If set to true, the table will have alternating row colors. This is useful for improving readability in tables with many rows.
|
|
61
|
+
|
|
62
|
+
booleanundefined
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
|
67
|
+
|
|
68
|
+
false
|
|
69
|
+
|
|
70
|
+
| Set object |
|
|
71
|
+
| bg |
|
|
72
|
+
|
|
73
|
+
**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
|
|
74
|
+
|
|
75
|
+
We recommend using the following token values for best background contrast:
|
|
76
|
+
|
|
77
|
+
* `colour.primary.fill` for primary backgrounds that need to stand out
|
|
78
|
+
* `colour.primary.surface` for primary backgrounds that need to be less prominent
|
|
79
|
+
* `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
|
|
80
|
+
* `colour.neutral.20` for a slightly darker background color, used in neutral state components
|
|
81
|
+
* `colour.system.danger.fill` for error backgrounds that need to stand out
|
|
82
|
+
* `colour.system.danger.surface` for error backgrounds that need to be less prominent
|
|
83
|
+
* `colour.system.success.fill` for success backgrounds that need to stand out
|
|
84
|
+
* `colour.system.success.surface` for success backgrounds that need to be less prominent
|
|
85
|
+
* `colour.system.warning.fill` for warning backgrounds that need to stand out
|
|
86
|
+
* `colour.system.warning.surface` for warning backgrounds that need to be less prominent
|
|
87
|
+
* `colour.system.info.fill` for info backgrounds that need to stand out
|
|
88
|
+
* `colour.system.info.surface` for info backgrounds that need to be less prominent
|
|
89
|
+
|
|
90
|
+
ResponsiveProp<ColorToken> | undefined
|
|
91
|
+
|
|
92
|
+
| \- | Set object |
|
|
93
|
+
| borderRadius |
|
|
94
|
+
|
|
95
|
+
The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
|
|
96
|
+
|
|
97
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
98
|
+
| --- | --- | --- | --- | --- |
|
|
99
|
+
| **4** | **4** | **5** | **12** | **9** |
|
|
100
|
+
| 1 _\-x-_ | | 3 _\-x-_ | | |
|
|
101
|
+
|
|
102
|
+
ResponsiveProp<RadiusToken> | undefined
|
|
103
|
+
|
|
104
|
+
| \- | Set object |
|
|
105
|
+
| caption\* |
|
|
106
|
+
|
|
107
|
+
Caption that describes the data in the table, required for accessibility.
|
|
108
|
+
|
|
109
|
+
ReactNode
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
| \- |
|
|
114
|
+
|
|
115
|
+
"My investments"
|
|
116
|
+
|
|
117
|
+
|
|
|
118
|
+
| children |
|
|
119
|
+
|
|
120
|
+
\-
|
|
121
|
+
|
|
122
|
+
| \- | \- |
|
|
123
|
+
| color |
|
|
124
|
+
|
|
125
|
+
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`.
|
|
126
|
+
|
|
127
|
+
We recommend using the following token values for best color contrast:
|
|
128
|
+
|
|
129
|
+
* `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
|
|
130
|
+
* `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
|
|
131
|
+
* `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
|
|
132
|
+
* `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
|
|
133
|
+
* `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
|
|
134
|
+
* `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
|
|
135
|
+
* `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
|
|
136
|
+
* `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
|
|
137
|
+
* `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
|
|
138
|
+
* `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
|
|
139
|
+
* `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
|
|
140
|
+
* `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
|
|
141
|
+
|
|
142
|
+
ResponsiveProp<ColorToken> | undefined
|
|
143
|
+
|
|
144
|
+
| \- | Set object |
|
|
145
|
+
| columns |
|
|
146
|
+
|
|
147
|
+
A mapping of columns to be displayed in the table. If not provided, it will be automatically regenerated from the row data.
|
|
148
|
+
|
|
149
|
+
TableColumn<TRow, TVal>\[\] | undefined
|
|
150
|
+
|
|
151
|
+
| \- | Set object |
|
|
152
|
+
| compact |
|
|
153
|
+
|
|
154
|
+
Compact view of the table, used for tables with a lot of data.
|
|
155
|
+
|
|
156
|
+
booleanundefined
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
|
161
|
+
|
|
162
|
+
false
|
|
163
|
+
|
|
164
|
+
| Set object |
|
|
165
|
+
| empty |
|
|
166
|
+
|
|
167
|
+
Content to be show when there is no rowData (columns must also be provided).
|
|
168
|
+
|
|
169
|
+
ReactNode
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
| \- | Set object |
|
|
174
|
+
| focusable |
|
|
175
|
+
|
|
176
|
+
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.
|
|
177
|
+
|
|
178
|
+
"true""within"undefined
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
| \- | Set object |
|
|
183
|
+
| hiddenCaption |
|
|
184
|
+
|
|
185
|
+
When set to true, the table caption will be visually hidden.
|
|
186
|
+
|
|
187
|
+
booleanundefined
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
| \- | Set object |
|
|
192
|
+
| hiddenHeader |
|
|
193
|
+
|
|
194
|
+
When set to true, the table header (`<thead></thead>`) will be not be rendered. Only use with very simple tables.
|
|
195
|
+
|
|
196
|
+
booleanundefined
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
| \- | Set object |
|
|
201
|
+
| hide |
|
|
202
|
+
|
|
203
|
+
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.
|
|
204
|
+
|
|
205
|
+
Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
206
|
+
|
|
207
|
+
Notes:
|
|
208
|
+
|
|
209
|
+
* If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
|
|
210
|
+
* Consider if you can conditionally render the element instead of hiding it.
|
|
211
|
+
|
|
212
|
+
ResponsiveProp<boolean> | undefined
|
|
213
|
+
|
|
214
|
+
| \- | Set object |
|
|
215
|
+
| hover |
|
|
216
|
+
|
|
217
|
+
When set to true, hovering over a row will trigger a UI change.
|
|
218
|
+
|
|
219
|
+
booleanundefined
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
| \- | Set object |
|
|
224
|
+
| layerStyle |
|
|
225
|
+
|
|
226
|
+
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.
|
|
227
|
+
|
|
228
|
+
* `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.
|
|
229
|
+
* `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.
|
|
230
|
+
* `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.
|
|
231
|
+
|
|
232
|
+
ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
|
|
233
|
+
|
|
234
|
+
| \- | Set object |
|
|
235
|
+
| m |
|
|
236
|
+
|
|
237
|
+
The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
|
|
238
|
+
|
|
239
|
+
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.
|
|
240
|
+
|
|
241
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
242
|
+
| --- | --- | --- | --- | --- |
|
|
243
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
244
|
+
|
|
245
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
246
|
+
|
|
247
|
+
| \- | Set object |
|
|
248
|
+
| maxWidth |
|
|
249
|
+
|
|
250
|
+
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`.
|
|
251
|
+
|
|
252
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
253
|
+
| --- | --- | --- | --- | --- |
|
|
254
|
+
| **1** | **1** | **1** | **12** | **7** |
|
|
255
|
+
|
|
256
|
+
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
|
|
257
|
+
|
|
258
|
+
| \- | Set object |
|
|
259
|
+
| mb |
|
|
260
|
+
|
|
261
|
+
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.
|
|
262
|
+
|
|
263
|
+
It uses the spacing tokens in the design system.
|
|
264
|
+
|
|
265
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
266
|
+
| --- | --- | --- | --- | --- |
|
|
267
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
268
|
+
|
|
269
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
270
|
+
|
|
271
|
+
| \- | Set object |
|
|
272
|
+
| ml |
|
|
273
|
+
|
|
274
|
+
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.
|
|
275
|
+
|
|
276
|
+
It uses the spacing tokens in the design system.
|
|
277
|
+
|
|
278
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
279
|
+
| --- | --- | --- | --- | --- |
|
|
280
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
281
|
+
|
|
282
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
283
|
+
|
|
284
|
+
| \- | Set object |
|
|
285
|
+
| mr |
|
|
286
|
+
|
|
287
|
+
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.
|
|
288
|
+
|
|
289
|
+
It uses the spacing tokens in the design system.
|
|
290
|
+
|
|
291
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
292
|
+
| --- | --- | --- | --- | --- |
|
|
293
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
294
|
+
|
|
295
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
296
|
+
|
|
297
|
+
| \- | Set object |
|
|
298
|
+
| mt |
|
|
299
|
+
|
|
300
|
+
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.
|
|
301
|
+
|
|
302
|
+
It uses the spacing tokens in the design system.
|
|
303
|
+
|
|
304
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
305
|
+
| --- | --- | --- | --- | --- |
|
|
306
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
307
|
+
|
|
308
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
309
|
+
|
|
310
|
+
| \- | Set object |
|
|
311
|
+
| mx |
|
|
312
|
+
|
|
313
|
+
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.
|
|
314
|
+
|
|
315
|
+
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.
|
|
316
|
+
|
|
317
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
318
|
+
| --- | --- | --- | --- | --- |
|
|
319
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
320
|
+
|
|
321
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
322
|
+
|
|
323
|
+
| \- | Set object |
|
|
324
|
+
| my |
|
|
325
|
+
|
|
326
|
+
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.
|
|
327
|
+
|
|
328
|
+
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.
|
|
329
|
+
|
|
330
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
331
|
+
| --- | --- | --- | --- | --- |
|
|
332
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
333
|
+
|
|
334
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
335
|
+
|
|
336
|
+
| \- | Set object |
|
|
337
|
+
| noGutter |
|
|
338
|
+
|
|
339
|
+
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.
|
|
340
|
+
|
|
341
|
+
booleanundefined
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
| \- | Set object |
|
|
346
|
+
| p |
|
|
347
|
+
|
|
348
|
+
The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
|
|
349
|
+
|
|
350
|
+
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.
|
|
351
|
+
|
|
352
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
353
|
+
| --- | --- | --- | --- | --- |
|
|
354
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
355
|
+
|
|
356
|
+
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
|
|
357
|
+
|
|
358
|
+
| \- | Set object |
|
|
359
|
+
| pb |
|
|
360
|
+
|
|
361
|
+
The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
|
|
362
|
+
|
|
363
|
+
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.
|
|
364
|
+
|
|
365
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
366
|
+
| --- | --- | --- | --- | --- |
|
|
367
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
368
|
+
|
|
369
|
+
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
|
|
370
|
+
|
|
371
|
+
| \- | Set object |
|
|
372
|
+
| pl |
|
|
373
|
+
|
|
374
|
+
The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
|
|
375
|
+
|
|
376
|
+
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.
|
|
377
|
+
|
|
378
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
379
|
+
| --- | --- | --- | --- | --- |
|
|
380
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
381
|
+
|
|
382
|
+
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
|
|
383
|
+
|
|
384
|
+
| \- | Set object |
|
|
385
|
+
| pr |
|
|
386
|
+
|
|
387
|
+
The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
|
|
388
|
+
|
|
389
|
+
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.
|
|
390
|
+
|
|
391
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
392
|
+
| --- | --- | --- | --- | --- |
|
|
393
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
394
|
+
|
|
395
|
+
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
|
|
396
|
+
|
|
397
|
+
| \- | Set object |
|
|
398
|
+
| pt |
|
|
399
|
+
|
|
400
|
+
The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
|
|
401
|
+
|
|
402
|
+
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.
|
|
403
|
+
|
|
404
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
405
|
+
| --- | --- | --- | --- | --- |
|
|
406
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
407
|
+
|
|
408
|
+
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
|
|
409
|
+
|
|
410
|
+
| \- | Set object |
|
|
411
|
+
| px |
|
|
412
|
+
|
|
413
|
+
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.
|
|
414
|
+
|
|
415
|
+
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.
|
|
416
|
+
|
|
417
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
418
|
+
| --- | --- | --- | --- | --- |
|
|
419
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
420
|
+
|
|
421
|
+
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
|
|
422
|
+
|
|
423
|
+
| \- | Set object |
|
|
424
|
+
| py |
|
|
425
|
+
|
|
426
|
+
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.
|
|
427
|
+
|
|
428
|
+
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.
|
|
429
|
+
|
|
430
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
431
|
+
| --- | --- | --- | --- | --- |
|
|
432
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
433
|
+
|
|
434
|
+
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
|
|
435
|
+
|
|
436
|
+
| \- | Set object |
|
|
437
|
+
| removeRowBorders |
|
|
438
|
+
|
|
439
|
+
If set to true, the table will not have borders between rows. This is useful for simpler tables where the row borders are not needed.
|
|
440
|
+
|
|
441
|
+
booleanundefined
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
|
446
|
+
|
|
447
|
+
false
|
|
448
|
+
|
|
449
|
+
| Set object |
|
|
450
|
+
| rowGap |
|
|
451
|
+
|
|
452
|
+
The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
|
|
453
|
+
|
|
454
|
+
Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
|
|
455
|
+
|
|
456
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
457
|
+
| --- | --- | --- | --- | --- |
|
|
458
|
+
| **47** | **52** | **10.1** | **16** | No |
|
|
459
|
+
|
|
460
|
+
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
|
|
461
|
+
|
|
462
|
+
| \- | Set object |
|
|
463
|
+
| rowProps |
|
|
464
|
+
|
|
465
|
+
Add additional props to the row element. Can be a props map or a function that returns an props map. The function is called with the row data.
|
|
466
|
+
|
|
467
|
+
IressStyledProps<"tr"> | ((row: Row<TRow>) => IressStyledProps<"tr">) | undefined
|
|
468
|
+
|
|
469
|
+
| \- | Set object |
|
|
470
|
+
| rows |
|
|
471
|
+
|
|
472
|
+
Each object in the array contains the data for a row.
|
|
473
|
+
|
|
474
|
+
TRow\[\] | undefined
|
|
475
|
+
|
|
476
|
+
| \[\] |
|
|
477
|
+
|
|
478
|
+
RAW
|
|
479
|
+
|
|
480
|
+
rows : \[
|
|
481
|
+
|
|
482
|
+
0 : {...} 4 keys
|
|
483
|
+
|
|
484
|
+
1 : {...} 4 keys
|
|
485
|
+
|
|
486
|
+
2 : {...} 4 keys
|
|
487
|
+
|
|
488
|
+
\]
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
|
495
|
+
| scope |
|
|
496
|
+
|
|
497
|
+
Defaults to 'row' - the first cell in the row is a `<th>`, otherwise it's a `<td>`.
|
|
498
|
+
|
|
499
|
+
"col""row"undefined
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
|
504
|
+
|
|
505
|
+
'row'
|
|
506
|
+
|
|
507
|
+
| Set object |
|
|
508
|
+
| srOnly |
|
|
509
|
+
|
|
510
|
+
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.
|
|
511
|
+
|
|
512
|
+
Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
513
|
+
|
|
514
|
+
ResponsiveProp<boolean> | undefined
|
|
515
|
+
|
|
516
|
+
| \- | Set object |
|
|
517
|
+
| stretch |
|
|
518
|
+
|
|
519
|
+
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.
|
|
520
|
+
|
|
521
|
+
booleanundefined
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
| \- | Set object |
|
|
526
|
+
| textAlign |
|
|
527
|
+
|
|
528
|
+
The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
|
|
529
|
+
|
|
530
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
531
|
+
| --- | --- | --- | --- | --- |
|
|
532
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
533
|
+
|
|
534
|
+
ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
|
|
535
|
+
|
|
536
|
+
| \- | Set object |
|
|
537
|
+
| textStyle |
|
|
538
|
+
|
|
539
|
+
Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
|
|
540
|
+
|
|
541
|
+
* `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
|
|
542
|
+
* `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.
|
|
543
|
+
* `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
|
|
544
|
+
* `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.
|
|
545
|
+
* `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.
|
|
546
|
+
* `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.
|
|
547
|
+
* `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.
|
|
548
|
+
* `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.
|
|
549
|
+
* `typography.code` - Used to display code snippets in the product, such as in the API documentation.
|
|
550
|
+
|
|
551
|
+
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
|
|
552
|
+
|
|
553
|
+
| \- | Set object |
|
|
554
|
+
| width |
|
|
555
|
+
|
|
556
|
+
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.
|
|
557
|
+
|
|
558
|
+
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.
|
|
559
|
+
|
|
560
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
561
|
+
| --- | --- | --- | --- | --- |
|
|
562
|
+
| **1** | **1** | **1** | **12** | **4** |
|
|
563
|
+
|
|
564
|
+
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
|
|
565
|
+
|
|
566
|
+
| \- | Set object |
|
|
567
|
+
|
|
46
568
|
[](#usage)Usage
|
|
47
569
|
---------------
|
|
48
570
|
|
|
@@ -162,7 +684,7 @@ export const TableCustomColumns \= () \=> (
|
|
|
162
684
|
{
|
|
163
685
|
key: 'cost',
|
|
164
686
|
label: 'Cost',
|
|
165
|
-
|
|
687
|
+
textAlign: 'right',
|
|
166
688
|
format: renderColumn,
|
|
167
689
|
},
|
|
168
690
|
\]}
|
|
@@ -246,7 +768,7 @@ To completely customise it, you can also send in a function that returns a React
|
|
|
246
768
|
Available formats
|
|
247
769
|
| String | Number | Date | Short date | ISO Date & Time | Relative time | Currency (AUD) | Percent | Custom |
|
|
248
770
|
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
249
|
-
| Hello, world! | 123456 | 28/06/2020 | 28 Jun 2020 | 2020-06-28 00:00:00 (UTC) |
|
|
771
|
+
| Hello, world! | 123456 | 28/06/2020 | 28 Jun 2020 | 2020-06-28 00:00:00 (UTC) | 15 seconds ago | $123,456.78 | 12% | Custom |
|
|
250
772
|
|
|
251
773
|
Hide code
|
|
252
774
|
|
|
@@ -382,7 +904,7 @@ export const TableSorting \= () \=> (
|
|
|
382
904
|
{
|
|
383
905
|
key: 'cost',
|
|
384
906
|
label: 'Cost',
|
|
385
|
-
|
|
907
|
+
textAlign: 'right',
|
|
386
908
|
sort: true,
|
|
387
909
|
format: renderColumn,
|
|
388
910
|
},
|
|
@@ -451,7 +973,7 @@ const columns: TableColumn<Row\>\[\] \= \[
|
|
|
451
973
|
{
|
|
452
974
|
key: 'cost',
|
|
453
975
|
label: 'Cost (sorts by net cost if available)',
|
|
454
|
-
|
|
976
|
+
textAlign: 'right',
|
|
455
977
|
format: (value: number, row) \=> {
|
|
456
978
|
return (
|
|
457
979
|
<\>
|
|
@@ -608,27 +1130,27 @@ Hide code
|
|
|
608
1130
|
\]}
|
|
609
1131
|
columns\={\[
|
|
610
1132
|
{
|
|
611
|
-
align: 'left',
|
|
612
1133
|
key: 'investment\_name',
|
|
613
|
-
label: 'Investment (left)'
|
|
1134
|
+
label: 'Investment (left)',
|
|
1135
|
+
textAlign: 'left'
|
|
614
1136
|
},
|
|
615
1137
|
{
|
|
616
|
-
align: 'center',
|
|
617
1138
|
format: 'currency',
|
|
618
1139
|
key: 'cost',
|
|
619
|
-
label: 'Cost (center)'
|
|
1140
|
+
label: 'Cost (center)',
|
|
1141
|
+
textAlign: 'center'
|
|
620
1142
|
},
|
|
621
1143
|
{
|
|
622
|
-
align: 'center',
|
|
623
1144
|
format: 'date',
|
|
624
1145
|
key: 'investmentDate',
|
|
625
|
-
label: 'Date (center)'
|
|
1146
|
+
label: 'Date (center)',
|
|
1147
|
+
textAlign: 'center'
|
|
626
1148
|
},
|
|
627
1149
|
{
|
|
628
|
-
align: 'right',
|
|
629
1150
|
format: 'percent',
|
|
630
1151
|
key: 'totalPercentage',
|
|
631
|
-
label: 'Share (right)'
|
|
1152
|
+
label: 'Share (right)',
|
|
1153
|
+
textAlign: 'right'
|
|
632
1154
|
}
|
|
633
1155
|
\]}
|
|
634
1156
|
/>
|
|
@@ -788,7 +1310,7 @@ Copy
|
|
|
788
1310
|
|
|
789
1311
|
For very simple tabular data, you have the option to hide the table header with the `hiddenHeader` prop. When this is set to true, the table header will not be rendered.
|
|
790
1312
|
|
|
791
|
-
<table class="
|
|
1313
|
+
<table class="table__table table__table--compact_false table__table--hover_false table__table--sortButtonNoWrap_false table__table--tableBodyOpen_false table__table--alternate_false table__table--removeRowBorders_false ids-table" id=":rr:"><caption id=":rr:--caption" class="table__caption table__caption--compact_false table__caption--hover_false table__caption--sortButtonNoWrap_false table__caption--tableBodyOpen_false table__caption--alternate_false table__caption--removeRowBorders_false">My investments</caption><tbody><tr id=":rr:--rows--0" class=""><th data-column="investment_name" id=":rr:__0_investment_name" scope="row">Artemis Fund Managers Limited</th><td data-column="cost" headers=":rr:__0_investment_name" id=":rr:__0_cost">23898</td><td data-column="investmentDate" headers=":rr:__0_investment_name" id=":rr:__0_investmentDate">2019-09-23</td><td data-column="totalPercentage" headers=":rr:__0_investment_name" id=":rr:__0_totalPercentage">24.8</td></tr><tr id=":rr:--rows--1" class=""><th data-column="investment_name" id=":rr:__1_investment_name" scope="row">CASH.CASH</th><td data-column="cost" headers=":rr:__1_investment_name" id=":rr:__1_cost">49751.4</td><td data-column="investmentDate" headers=":rr:__1_investment_name" id=":rr:__1_investmentDate">2020-06-28</td><td data-column="totalPercentage" headers=":rr:__1_investment_name" id=":rr:__1_totalPercentage">49</td></tr><tr id=":rr:--rows--2" class=""><th data-column="investment_name" id=":rr:__2_investment_name" scope="row">VODAFONE GRP</th><td data-column="cost" headers=":rr:__2_investment_name" id=":rr:__2_cost">26382.456</td><td data-column="investmentDate" headers=":rr:__2_investment_name" id=":rr:__2_investmentDate">2019-02-05</td><td data-column="totalPercentage" headers=":rr:__2_investment_name" id=":rr:__2_totalPercentage">26.2</td></tr></tbody></table>
|
|
792
1314
|
|
|
793
1315
|
Hide code
|
|
794
1316
|
|
|
@@ -896,10 +1418,10 @@ Hide code
|
|
|
896
1418
|
label: 'Share'
|
|
897
1419
|
},
|
|
898
1420
|
{
|
|
899
|
-
align: 'right',
|
|
900
1421
|
format: 'currency',
|
|
901
1422
|
key: 'cost',
|
|
902
|
-
label: 'Cost'
|
|
1423
|
+
label: 'Cost',
|
|
1424
|
+
textAlign: 'right'
|
|
903
1425
|
}
|
|
904
1426
|
\]}
|
|
905
1427
|
empty\="This table has no data"
|
|
@@ -1014,10 +1536,7 @@ Hide code
|
|
|
1014
1536
|
}
|
|
1015
1537
|
\]}
|
|
1016
1538
|
rowProps\={(row) \=> ({
|
|
1017
|
-
|
|
1018
|
-
"--iress-row-even-background-color": row.original.cost && row.original.cost \> 30000 ? "white" : "lightblue",
|
|
1019
|
-
"--iress-row-odd-background-color": row.original.cost && row.original.cost \> 30000 ? "white" : "lightblue"
|
|
1020
|
-
}
|
|
1539
|
+
bg: row.original.cost && row.original.cost \> 30000 ? "colour.neutral.10" : "colour.system.success.surface"
|
|
1021
1540
|
})}
|
|
1022
1541
|
/>
|
|
1023
1542
|
|
|
@@ -1070,7 +1589,7 @@ Copy
|
|
|
1070
1589
|
|
|
1071
1590
|
In some cases you may have a table with multiple groups of rows inside it, however the columns are the same. For these cases, you can use the `IressTableBody` component.
|
|
1072
1591
|
|
|
1073
|
-
<table class="ids-table
|
|
1592
|
+
<table class="table__table table__table--compact_false table__table--hover_false table__table--sortButtonNoWrap_false table__table--tableBodyOpen_false table__table--alternate_false table__table--removeRowBorders_false ids-table" id=":r3:"><caption id=":r3:--caption" class="table__caption table__caption--compact_false table__caption--hover_false table__caption--sortButtonNoWrap_false table__caption--tableBodyOpen_false table__caption--alternate_false table__caption--removeRowBorders_false">My liabilities</caption><tbody aria-labelledby=":r4:--caption" class=""><tr><th aria-expanded="true" colspan="8" class="table__rowGroupHeader table__rowGroupHeader--compact_false table__rowGroupHeader--hover_false table__rowGroupHeader--sortButtonNoWrap_false table__rowGroupHeader--tableBodyOpen_true" id=":r4:--caption" scope="rowgroup" aria-controls=":r4:--header--0 :r4:--rows--0 :r4:--children"><button class="table__activator table__activator--compact_false table__activator--hover_false table__activator--sortButtonNoWrap_false table__activator--tableBodyOpen_true" type="button">Current liabilities</button></th></tr><tr id=":r4:--header--0"><th id=":r4:__owner" headers=":r4:--caption" class="ta_start" style="width: 75px; min-width: 75px;">Owner</th><th id=":r4:__type" headers=":r4:--caption" class="ta_start" style="width: 100px; min-width: 100px;">Type</th><th id=":r4:__provider" headers=":r4:--caption" class="ta_start">Provider</th><th id=":r4:__status" headers=":r4:--caption" class="ta_start bd-e_table">Status</th><th id=":r4:__frequency" headers=":r4:--caption" class="ta_start">Frequency</th><th id=":r4:__outstanding" headers=":r4:--caption" aria-sort="none" class="ta_start [&&]:ta_end"><button type="button" class="table__sortHeader table__sortHeader--compact_false table__sortHeader--hover_false table__sortHeader--sortButtonNoWrap_true table__sortHeader--tableBodyOpen_false">Outstanding (GBP)<span role="img" class="ids-icon fal fa-sort table__sortIcon table__sortIcon--compact_false table__sortIcon--hover_false table__sortIcon--sortButtonNoWrap_true table__sortIcon--tableBodyOpen_false" aria-hidden="false" aria-label="sortable"></span></button></th><th id=":r4:__interestRate" headers=":r4:--caption" aria-sort="none" class="ta_right"><button type="button" class="table__sortHeader table__sortHeader--compact_false table__sortHeader--hover_false table__sortHeader--sortButtonNoWrap_true table__sortHeader--tableBodyOpen_false">Interest rate p.a.<span role="img" class="ids-icon fal fa-sort table__sortIcon table__sortIcon--compact_false table__sortIcon--hover_false table__sortIcon--sortButtonNoWrap_true table__sortIcon--tableBodyOpen_false" aria-hidden="false" aria-label="sortable"></span></button></th><th id=":r4:__repayment" headers=":r4:--caption" aria-sort="none" class="ta_start [&&]:ta_end"><button type="button" class="table__sortHeader table__sortHeader--compact_false table__sortHeader--hover_false table__sortHeader--sortButtonNoWrap_true table__sortHeader--tableBodyOpen_false">Repayment (GBP)<span role="img" class="ids-icon fal fa-sort table__sortIcon table__sortIcon--compact_false table__sortIcon--hover_false table__sortIcon--sortButtonNoWrap_true table__sortIcon--tableBodyOpen_false" aria-hidden="false" aria-label="sortable"></span></button></th></tr><tr id=":r4:--rows--0" class=""><td data-column="owner" headers=":r4:__owner :r4:--caption" id=":r4:__0_owner" class="ta_start" style="width: 75px; min-width: 75px;">Client</td><td data-column="type" headers=":r4:__type :r4:--caption" id=":r4:__0_type" class="ta_start" style="width: 100px; min-width: 100px;">Credit card</td><td data-column="provider" headers=":r4:__provider :r4:--caption" id=":r4:__0_provider" class="ta_start"></td><td data-column="status" headers=":r4:__status :r4:--caption" id=":r4:__0_status" class="ta_start bd-e_table">Current</td><td data-column="frequency" headers=":r4:__frequency :r4:--caption" id=":r4:__0_frequency" class="ta_start">Monthly</td><td data-column="outstanding" headers=":r4:__outstanding :r4:--caption" id=":r4:__0_outstanding" class="ta_start [&&]:ta_end">$5,000.00</td><td data-column="interestRate" headers=":r4:__interestRate :r4:--caption" id=":r4:__0_interestRate" class="ta_right">0%</td><td data-column="repayment" headers=":r4:__repayment :r4:--caption" id=":r4:__0_repayment" class="ta_start [&&]:ta_end">$300.00</td></tr><tr id=":r4:--children"><td colspan="8"><button type="button" class="iress-form-element iress-form-element__inner button__root button__root--inButtonGroup_false button__root--mode_secondary button__root--loading_false button__root--noWrap_false ids-button"><span class="button__prepend button__prepend--inButtonGroup_false button__prepend--mode_secondary button__prepend--loading_false button__prepend--noWrap_false"><span role="img" class="ids-icon fal fa-plus-circle" aria-hidden="true"></span></span>Add current liability</button></td></tr></tbody><tbody aria-labelledby=":r6:--caption" class=""><tr><th aria-expanded="false" colspan="8" class="table__rowGroupHeader table__rowGroupHeader--compact_false table__rowGroupHeader--hover_false table__rowGroupHeader--sortButtonNoWrap_false table__rowGroupHeader--tableBodyOpen_false" id=":r6:--caption" scope="rowgroup"><button class="table__activator table__activator--compact_false table__activator--hover_false table__activator--sortButtonNoWrap_false table__activator--tableBodyOpen_false" type="button">Long term liabilities</button></th></tr></tbody><tbody aria-labelledby=":r7:--caption" class=""><tr><th aria-expanded="false" colspan="8" class="table__rowGroupHeader table__rowGroupHeader--compact_false table__rowGroupHeader--hover_false table__rowGroupHeader--sortButtonNoWrap_false table__rowGroupHeader--tableBodyOpen_false" id=":r7:--caption" scope="rowgroup"><button class="table__activator table__activator--compact_false table__activator--hover_false table__activator--sortButtonNoWrap_false table__activator--tableBodyOpen_false" type="button">Contingent liabilities</button></th></tr></tbody></table>
|
|
1074
1593
|
|
|
1075
1594
|
Hide code
|
|
1076
1595
|
|
|
@@ -1173,7 +1692,7 @@ const columns: TableColumn<Liability\>\[\] \= \[
|
|
|
1173
1692
|
key: 'interestRate',
|
|
1174
1693
|
label: 'Interest rate p.a.',
|
|
1175
1694
|
format: 'percent',
|
|
1176
|
-
|
|
1695
|
+
textAlign: 'right',
|
|
1177
1696
|
sort: true,
|
|
1178
1697
|
},
|
|
1179
1698
|
{
|
|
@@ -1193,7 +1712,7 @@ export const TableGroupedRows \= () \=> (
|
|
|
1193
1712
|
scope\="col"
|
|
1194
1713
|
open
|
|
1195
1714
|
\>
|
|
1196
|
-
<IressButton
|
|
1715
|
+
<IressButton prepend\={<IressIcon name\="plus-circle" />}\>
|
|
1197
1716
|
Add current liability </IressButton\>
|
|
1198
1717
|
</IressTableBody\>
|
|
1199
1718
|
<IressTableBody
|
|
@@ -1202,7 +1721,7 @@ export const TableGroupedRows \= () \=> (
|
|
|
1202
1721
|
caption\="Long term liabilities"
|
|
1203
1722
|
scope\="col"
|
|
1204
1723
|
\>
|
|
1205
|
-
<IressButton
|
|
1724
|
+
<IressButton prepend\={<IressIcon name\="plus-circle" />}\>
|
|
1206
1725
|
Add long term liability </IressButton\>
|
|
1207
1726
|
</IressTableBody\>
|
|
1208
1727
|
<IressTableBody
|
|
@@ -1211,7 +1730,7 @@ export const TableGroupedRows \= () \=> (
|
|
|
1211
1730
|
caption\="Contingent liabilities"
|
|
1212
1731
|
scope\="col"
|
|
1213
1732
|
\>
|
|
1214
|
-
<IressButton
|
|
1733
|
+
<IressButton prepend\={<IressIcon name\="plus-circle" />}\>
|
|
1215
1734
|
Add contingent liability </IressButton\>
|
|
1216
1735
|
</IressTableBody\>
|
|
1217
1736
|
</IressTable\>
|
|
@@ -1219,6 +1738,473 @@ export const TableGroupedRows \= () \=> (
|
|
|
1219
1738
|
|
|
1220
1739
|
Copy
|
|
1221
1740
|
|
|
1741
|
+
#### [](#table-body-api)Props
|
|
1742
|
+
|
|
1743
|
+
| Name | Description | Default | Control |
|
|
1744
|
+
| --- | --- | --- | --- |
|
|
1745
|
+
| bg |
|
|
1746
|
+
**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
|
|
1747
|
+
|
|
1748
|
+
We recommend using the following token values for best background contrast:
|
|
1749
|
+
|
|
1750
|
+
* `colour.primary.fill` for primary backgrounds that need to stand out
|
|
1751
|
+
* `colour.primary.surface` for primary backgrounds that need to be less prominent
|
|
1752
|
+
* `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
|
|
1753
|
+
* `colour.neutral.20` for a slightly darker background color, used in neutral state components
|
|
1754
|
+
* `colour.system.danger.fill` for error backgrounds that need to stand out
|
|
1755
|
+
* `colour.system.danger.surface` for error backgrounds that need to be less prominent
|
|
1756
|
+
* `colour.system.success.fill` for success backgrounds that need to stand out
|
|
1757
|
+
* `colour.system.success.surface` for success backgrounds that need to be less prominent
|
|
1758
|
+
* `colour.system.warning.fill` for warning backgrounds that need to stand out
|
|
1759
|
+
* `colour.system.warning.surface` for warning backgrounds that need to be less prominent
|
|
1760
|
+
* `colour.system.info.fill` for info backgrounds that need to stand out
|
|
1761
|
+
* `colour.system.info.surface` for info backgrounds that need to be less prominent
|
|
1762
|
+
|
|
1763
|
+
ResponsiveProp<ColorToken> | undefined
|
|
1764
|
+
|
|
1765
|
+
| \- | Set object |
|
|
1766
|
+
| borderRadius |
|
|
1767
|
+
|
|
1768
|
+
The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
|
|
1769
|
+
|
|
1770
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1771
|
+
| --- | --- | --- | --- | --- |
|
|
1772
|
+
| **4** | **4** | **5** | **12** | **9** |
|
|
1773
|
+
| 1 _\-x-_ | | 3 _\-x-_ | | |
|
|
1774
|
+
|
|
1775
|
+
ResponsiveProp<RadiusToken> | undefined
|
|
1776
|
+
|
|
1777
|
+
| \- | Set object |
|
|
1778
|
+
| caption\* |
|
|
1779
|
+
|
|
1780
|
+
Caption that describes the data in the inner table, required for accessibility. Used to open/close the inner table.
|
|
1781
|
+
|
|
1782
|
+
**Note:** Do not include interactive elements inside the caption.
|
|
1783
|
+
|
|
1784
|
+
ReactNode
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
| \- | Set object |
|
|
1789
|
+
| color |
|
|
1790
|
+
|
|
1791
|
+
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`.
|
|
1792
|
+
|
|
1793
|
+
We recommend using the following token values for best color contrast:
|
|
1794
|
+
|
|
1795
|
+
* `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
|
|
1796
|
+
* `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
|
|
1797
|
+
* `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
|
|
1798
|
+
* `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
|
|
1799
|
+
* `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
|
|
1800
|
+
* `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
|
|
1801
|
+
* `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
|
|
1802
|
+
* `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
|
|
1803
|
+
* `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
|
|
1804
|
+
* `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
|
|
1805
|
+
* `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
|
|
1806
|
+
* `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
|
|
1807
|
+
|
|
1808
|
+
ResponsiveProp<ColorToken> | undefined
|
|
1809
|
+
|
|
1810
|
+
| \- | Set object |
|
|
1811
|
+
| columns |
|
|
1812
|
+
|
|
1813
|
+
A mapping of columns to be displayed in the table. If not provided, it will be automatically regenerated from the row data.
|
|
1814
|
+
|
|
1815
|
+
TableColumn<TRow, TVal>\[\] | undefined
|
|
1816
|
+
|
|
1817
|
+
| \- | Set object |
|
|
1818
|
+
| empty |
|
|
1819
|
+
|
|
1820
|
+
Content to be show when there is no rowData (columns must also be provided).
|
|
1821
|
+
|
|
1822
|
+
ReactNode
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
| \- | Set object |
|
|
1827
|
+
| focusable |
|
|
1828
|
+
|
|
1829
|
+
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.
|
|
1830
|
+
|
|
1831
|
+
"true""within"undefined
|
|
1832
|
+
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
| \- | Set object |
|
|
1836
|
+
| hiddenCaption |
|
|
1837
|
+
|
|
1838
|
+
When set to true, the table caption will be visually hidden. If set, the inner table will always be open.
|
|
1839
|
+
|
|
1840
|
+
booleanundefined
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
| \- | Set object |
|
|
1845
|
+
| hiddenHeader |
|
|
1846
|
+
|
|
1847
|
+
When set to true, the table header (`<thead></thead>`) will be not be rendered. Only use with very simple tables.
|
|
1848
|
+
|
|
1849
|
+
booleanundefined
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
| \- | Set object |
|
|
1854
|
+
| hide |
|
|
1855
|
+
|
|
1856
|
+
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.
|
|
1857
|
+
|
|
1858
|
+
Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
1859
|
+
|
|
1860
|
+
Notes:
|
|
1861
|
+
|
|
1862
|
+
* If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
|
|
1863
|
+
* Consider if you can conditionally render the element instead of hiding it.
|
|
1864
|
+
|
|
1865
|
+
ResponsiveProp<boolean> | undefined
|
|
1866
|
+
|
|
1867
|
+
| \- | Set object |
|
|
1868
|
+
| layerStyle |
|
|
1869
|
+
|
|
1870
|
+
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.
|
|
1871
|
+
|
|
1872
|
+
* `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.
|
|
1873
|
+
* `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.
|
|
1874
|
+
* `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.
|
|
1875
|
+
|
|
1876
|
+
ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
|
|
1877
|
+
|
|
1878
|
+
| \- | Set object |
|
|
1879
|
+
| m |
|
|
1880
|
+
|
|
1881
|
+
The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
|
|
1882
|
+
|
|
1883
|
+
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.
|
|
1884
|
+
|
|
1885
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1886
|
+
| --- | --- | --- | --- | --- |
|
|
1887
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1888
|
+
|
|
1889
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1890
|
+
|
|
1891
|
+
| \- | Set object |
|
|
1892
|
+
| maxWidth |
|
|
1893
|
+
|
|
1894
|
+
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`.
|
|
1895
|
+
|
|
1896
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1897
|
+
| --- | --- | --- | --- | --- |
|
|
1898
|
+
| **1** | **1** | **1** | **12** | **7** |
|
|
1899
|
+
|
|
1900
|
+
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
|
|
1901
|
+
|
|
1902
|
+
| \- | Set object |
|
|
1903
|
+
| mb |
|
|
1904
|
+
|
|
1905
|
+
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.
|
|
1906
|
+
|
|
1907
|
+
It uses the spacing tokens in the design system.
|
|
1908
|
+
|
|
1909
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1910
|
+
| --- | --- | --- | --- | --- |
|
|
1911
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1912
|
+
|
|
1913
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1914
|
+
|
|
1915
|
+
| \- | Set object |
|
|
1916
|
+
| ml |
|
|
1917
|
+
|
|
1918
|
+
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.
|
|
1919
|
+
|
|
1920
|
+
It uses the spacing tokens in the design system.
|
|
1921
|
+
|
|
1922
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1923
|
+
| --- | --- | --- | --- | --- |
|
|
1924
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1925
|
+
|
|
1926
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1927
|
+
|
|
1928
|
+
| \- | Set object |
|
|
1929
|
+
| mr |
|
|
1930
|
+
|
|
1931
|
+
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.
|
|
1932
|
+
|
|
1933
|
+
It uses the spacing tokens in the design system.
|
|
1934
|
+
|
|
1935
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1936
|
+
| --- | --- | --- | --- | --- |
|
|
1937
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1938
|
+
|
|
1939
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1940
|
+
|
|
1941
|
+
| \- | Set object |
|
|
1942
|
+
| mt |
|
|
1943
|
+
|
|
1944
|
+
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.
|
|
1945
|
+
|
|
1946
|
+
It uses the spacing tokens in the design system.
|
|
1947
|
+
|
|
1948
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1949
|
+
| --- | --- | --- | --- | --- |
|
|
1950
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1951
|
+
|
|
1952
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1953
|
+
|
|
1954
|
+
| \- | Set object |
|
|
1955
|
+
| mx |
|
|
1956
|
+
|
|
1957
|
+
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.
|
|
1958
|
+
|
|
1959
|
+
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.
|
|
1960
|
+
|
|
1961
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1962
|
+
| --- | --- | --- | --- | --- |
|
|
1963
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1964
|
+
|
|
1965
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1966
|
+
|
|
1967
|
+
| \- | Set object |
|
|
1968
|
+
| my |
|
|
1969
|
+
|
|
1970
|
+
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.
|
|
1971
|
+
|
|
1972
|
+
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.
|
|
1973
|
+
|
|
1974
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
1975
|
+
| --- | --- | --- | --- | --- |
|
|
1976
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
1977
|
+
|
|
1978
|
+
ResponsiveProp<SpacingToken | "auto"> | undefined
|
|
1979
|
+
|
|
1980
|
+
| \- | Set object |
|
|
1981
|
+
| noGutter |
|
|
1982
|
+
|
|
1983
|
+
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.
|
|
1984
|
+
|
|
1985
|
+
booleanundefined
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
| \- | Set object |
|
|
1990
|
+
| onClosed |
|
|
1991
|
+
|
|
1992
|
+
Is called when table is closed.
|
|
1993
|
+
|
|
1994
|
+
(() => void) | undefined
|
|
1995
|
+
|
|
1996
|
+
| \- | \- |
|
|
1997
|
+
| onOpened |
|
|
1998
|
+
|
|
1999
|
+
Is called when table is opened.
|
|
2000
|
+
|
|
2001
|
+
(() => void) | undefined
|
|
2002
|
+
|
|
2003
|
+
| \- | \- |
|
|
2004
|
+
| open |
|
|
2005
|
+
|
|
2006
|
+
When true, all rows will be visible, otherwise they are hidden.
|
|
2007
|
+
|
|
2008
|
+
booleanundefined
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
|
|
|
2013
|
+
|
|
2014
|
+
false
|
|
2015
|
+
|
|
2016
|
+
| Set object |
|
|
2017
|
+
| p |
|
|
2018
|
+
|
|
2019
|
+
The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
|
|
2020
|
+
|
|
2021
|
+
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.
|
|
2022
|
+
|
|
2023
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2024
|
+
| --- | --- | --- | --- | --- |
|
|
2025
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
2026
|
+
|
|
2027
|
+
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
|
|
2028
|
+
|
|
2029
|
+
| \- | Set object |
|
|
2030
|
+
| pb |
|
|
2031
|
+
|
|
2032
|
+
The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
|
|
2033
|
+
|
|
2034
|
+
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.
|
|
2035
|
+
|
|
2036
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2037
|
+
| --- | --- | --- | --- | --- |
|
|
2038
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
2039
|
+
|
|
2040
|
+
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
|
|
2041
|
+
|
|
2042
|
+
| \- | Set object |
|
|
2043
|
+
| pl |
|
|
2044
|
+
|
|
2045
|
+
The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
|
|
2046
|
+
|
|
2047
|
+
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.
|
|
2048
|
+
|
|
2049
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2050
|
+
| --- | --- | --- | --- | --- |
|
|
2051
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
2052
|
+
|
|
2053
|
+
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
|
|
2054
|
+
|
|
2055
|
+
| \- | Set object |
|
|
2056
|
+
| pr |
|
|
2057
|
+
|
|
2058
|
+
The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
|
|
2059
|
+
|
|
2060
|
+
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.
|
|
2061
|
+
|
|
2062
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2063
|
+
| --- | --- | --- | --- | --- |
|
|
2064
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
2065
|
+
|
|
2066
|
+
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
|
|
2067
|
+
|
|
2068
|
+
| \- | Set object |
|
|
2069
|
+
| pt |
|
|
2070
|
+
|
|
2071
|
+
The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
|
|
2072
|
+
|
|
2073
|
+
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.
|
|
2074
|
+
|
|
2075
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2076
|
+
| --- | --- | --- | --- | --- |
|
|
2077
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
2078
|
+
|
|
2079
|
+
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
|
|
2080
|
+
|
|
2081
|
+
| \- | Set object |
|
|
2082
|
+
| px |
|
|
2083
|
+
|
|
2084
|
+
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.
|
|
2085
|
+
|
|
2086
|
+
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.
|
|
2087
|
+
|
|
2088
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2089
|
+
| --- | --- | --- | --- | --- |
|
|
2090
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
2091
|
+
|
|
2092
|
+
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
|
|
2093
|
+
|
|
2094
|
+
| \- | Set object |
|
|
2095
|
+
| py |
|
|
2096
|
+
|
|
2097
|
+
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.
|
|
2098
|
+
|
|
2099
|
+
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.
|
|
2100
|
+
|
|
2101
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2102
|
+
| --- | --- | --- | --- | --- |
|
|
2103
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
2104
|
+
|
|
2105
|
+
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
|
|
2106
|
+
|
|
2107
|
+
| \- | Set object |
|
|
2108
|
+
| rowGap |
|
|
2109
|
+
|
|
2110
|
+
The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
|
|
2111
|
+
|
|
2112
|
+
Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
|
|
2113
|
+
|
|
2114
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2115
|
+
| --- | --- | --- | --- | --- |
|
|
2116
|
+
| **47** | **52** | **10.1** | **16** | No |
|
|
2117
|
+
|
|
2118
|
+
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
|
|
2119
|
+
|
|
2120
|
+
| \- | Set object |
|
|
2121
|
+
| rowProps |
|
|
2122
|
+
|
|
2123
|
+
Add additional props to the row element. Can be a props map or a function that returns an props map. The function is called with the row data.
|
|
2124
|
+
|
|
2125
|
+
IressStyledProps<"tr"> | ((row: Row<TRow>) => IressStyledProps<"tr">) | undefined
|
|
2126
|
+
|
|
2127
|
+
| \- | Set object |
|
|
2128
|
+
| rows |
|
|
2129
|
+
|
|
2130
|
+
Each object in the array contains the data for a row.
|
|
2131
|
+
|
|
2132
|
+
TRow\[\] | undefined
|
|
2133
|
+
|
|
2134
|
+
| \[\] | Set object |
|
|
2135
|
+
| scope |
|
|
2136
|
+
|
|
2137
|
+
Defaults to 'row' - the first cell in the row is a `<th>`, otherwise it's a `<td>`.
|
|
2138
|
+
|
|
2139
|
+
"col""row"undefined
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
|
|
2143
|
+
|
|
|
2144
|
+
|
|
2145
|
+
'row'
|
|
2146
|
+
|
|
2147
|
+
| Set object |
|
|
2148
|
+
| srOnly |
|
|
2149
|
+
|
|
2150
|
+
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.
|
|
2151
|
+
|
|
2152
|
+
Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
2153
|
+
|
|
2154
|
+
ResponsiveProp<boolean> | undefined
|
|
2155
|
+
|
|
2156
|
+
| \- | Set object |
|
|
2157
|
+
| stretch |
|
|
2158
|
+
|
|
2159
|
+
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.
|
|
2160
|
+
|
|
2161
|
+
booleanundefined
|
|
2162
|
+
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
| \- | Set object |
|
|
2166
|
+
| textAlign |
|
|
2167
|
+
|
|
2168
|
+
The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
|
|
2169
|
+
|
|
2170
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2171
|
+
| --- | --- | --- | --- | --- |
|
|
2172
|
+
| **1** | **1** | **1** | **12** | **3** |
|
|
2173
|
+
|
|
2174
|
+
ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
|
|
2175
|
+
|
|
2176
|
+
| \- | Set object |
|
|
2177
|
+
| textStyle |
|
|
2178
|
+
|
|
2179
|
+
Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
|
|
2180
|
+
|
|
2181
|
+
* `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
|
|
2182
|
+
* `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.
|
|
2183
|
+
* `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
|
|
2184
|
+
* `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.
|
|
2185
|
+
* `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.
|
|
2186
|
+
* `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.
|
|
2187
|
+
* `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.
|
|
2188
|
+
* `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.
|
|
2189
|
+
* `typography.code` - Used to display code snippets in the product, such as in the API documentation.
|
|
2190
|
+
|
|
2191
|
+
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
|
|
2192
|
+
|
|
2193
|
+
| \- | Set object |
|
|
2194
|
+
| width |
|
|
2195
|
+
|
|
2196
|
+
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.
|
|
2197
|
+
|
|
2198
|
+
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.
|
|
2199
|
+
|
|
2200
|
+
| Chrome | Firefox | Safari | Edge | IE |
|
|
2201
|
+
| --- | --- | --- | --- | --- |
|
|
2202
|
+
| **1** | **1** | **1** | **12** | **4** |
|
|
2203
|
+
|
|
2204
|
+
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
|
|
2205
|
+
|
|
2206
|
+
| \- | Set object |
|
|
2207
|
+
|
|
1222
2208
|
[](#iresstableformattedvalue)`IressTableFormattedValue`
|
|
1223
2209
|
-------------------------------------------------------
|
|
1224
2210
|
|
|
@@ -1231,9 +2217,9 @@ IressTableFormattedValue
|
|
|
1231
2217
|
| --- | --- |
|
|
1232
2218
|
| string | string |
|
|
1233
2219
|
| number | 10000 |
|
|
1234
|
-
| date |
|
|
1235
|
-
| shortDate |
|
|
1236
|
-
| isoDateTime | 2025-
|
|
2220
|
+
| date | 14/08/2025 |
|
|
2221
|
+
| shortDate | 14 Aug 2025 |
|
|
2222
|
+
| isoDateTime | 2025-08-14 02:54:29 (UTC) |
|
|
1237
2223
|
| relativeTime | now |
|
|
1238
2224
|
| currency | $10,000.00 |
|
|
1239
2225
|
| percent | 50% |
|
|
@@ -1278,6 +2264,42 @@ Hide code
|
|
|
1278
2264
|
|
|
1279
2265
|
Copy
|
|
1280
2266
|
|
|
2267
|
+
#### [](#table-formatted-value-api)Props
|
|
2268
|
+
|
|
2269
|
+
| Name | Description | Default | Control |
|
|
2270
|
+
| --- | --- | --- | --- |
|
|
2271
|
+
| currencyFormatOptions |
|
|
2272
|
+
The currency code to prefix to the value if `format` is set to currency.
|
|
2273
|
+
|
|
2274
|
+
Omit<CurrencyFormatterProps, "value"> | undefined
|
|
2275
|
+
|
|
2276
|
+
| { locale: 'en-AU', currencyCode: 'AUD' } | \- |
|
|
2277
|
+
| format |
|
|
2278
|
+
|
|
2279
|
+
Formats the cell content. To use the in-built formatters, set this to: string, number, date, currency, percent. Use a custom formatter by passing a function that returns a ReactNode.
|
|
2280
|
+
|
|
2281
|
+
"string" | "number" | "percent" | "date" | "currency" | "shortDate" | "isoDateTime" | "relativeTime" | ((value: TVal, row?: TRow | undefined) => ReactNode) | undefined
|
|
2282
|
+
|
|
2283
|
+
| \- | \- |
|
|
2284
|
+
| row |
|
|
2285
|
+
|
|
2286
|
+
The row data.
|
|
2287
|
+
|
|
2288
|
+
objectundefined
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
| \- | \- |
|
|
2293
|
+
| value\* |
|
|
2294
|
+
|
|
2295
|
+
The value to format.
|
|
2296
|
+
|
|
2297
|
+
TVal
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
| \- | \- |
|
|
2302
|
+
|
|
1281
2303
|
On this page
|
|
1282
2304
|
|
|
1283
2305
|
* [Overview](#overview)
|