@iress-oss/ids-mcp-server 6.0.0-alpha.0 → 6.0.0-alpha.1-canary-20251204014525-3f0dce4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/dist/searchHandlers.test.js +8 -2
  2. package/dist/toolHandler.test.js +9 -9
  3. package/dist/utils.test.js +6 -2
  4. package/package.json +32 -30
  5. package/generated/docs/components-alert-docs.md +0 -702
  6. package/generated/docs/components-autocomplete-docs.md +0 -1433
  7. package/generated/docs/components-autocomplete-recipes-docs.md +0 -104
  8. package/generated/docs/components-badge-docs.md +0 -531
  9. package/generated/docs/components-button-docs.md +0 -1442
  10. package/generated/docs/components-buttongroup-docs.md +0 -748
  11. package/generated/docs/components-card-docs.md +0 -944
  12. package/generated/docs/components-checkbox-docs.md +0 -694
  13. package/generated/docs/components-checkboxgroup-docs.md +0 -1087
  14. package/generated/docs/components-checkboxgroup-recipes-docs.md +0 -119
  15. package/generated/docs/components-col-docs.md +0 -881
  16. package/generated/docs/components-container-docs.md +0 -123
  17. package/generated/docs/components-divider-docs.md +0 -576
  18. package/generated/docs/components-expander-docs.md +0 -594
  19. package/generated/docs/components-field-docs.md +0 -2007
  20. package/generated/docs/components-filter-docs.md +0 -1322
  21. package/generated/docs/components-hide-docs.md +0 -702
  22. package/generated/docs/components-icon-docs.md +0 -816
  23. package/generated/docs/components-image-docs.md +0 -493
  24. package/generated/docs/components-inline-docs.md +0 -2003
  25. package/generated/docs/components-input-docs.md +0 -867
  26. package/generated/docs/components-input-recipes-docs.md +0 -140
  27. package/generated/docs/components-inputcurrency-docs.md +0 -689
  28. package/generated/docs/components-inputcurrency-recipes-docs.md +0 -115
  29. package/generated/docs/components-introduction-docs.md +0 -450
  30. package/generated/docs/components-label-docs.md +0 -562
  31. package/generated/docs/components-link-docs.md +0 -586
  32. package/generated/docs/components-menu-docs.md +0 -1146
  33. package/generated/docs/components-menu-menuitem-docs.md +0 -739
  34. package/generated/docs/components-modal-docs.md +0 -1346
  35. package/generated/docs/components-panel-docs.md +0 -600
  36. package/generated/docs/components-placeholder-docs.md +0 -446
  37. package/generated/docs/components-popover-docs.md +0 -1529
  38. package/generated/docs/components-popover-recipes-docs.md +0 -211
  39. package/generated/docs/components-progress-docs.md +0 -568
  40. package/generated/docs/components-provider-docs.md +0 -160
  41. package/generated/docs/components-radio-docs.md +0 -563
  42. package/generated/docs/components-radiogroup-docs.md +0 -1153
  43. package/generated/docs/components-readonly-docs.md +0 -535
  44. package/generated/docs/components-richselect-docs.md +0 -5836
  45. package/generated/docs/components-row-docs.md +0 -2354
  46. package/generated/docs/components-select-docs.md +0 -940
  47. package/generated/docs/components-skeleton-docs.md +0 -597
  48. package/generated/docs/components-skeleton-recipes-docs.md +0 -76
  49. package/generated/docs/components-skiplink-docs.md +0 -587
  50. package/generated/docs/components-slideout-docs.md +0 -1036
  51. package/generated/docs/components-slider-docs.md +0 -828
  52. package/generated/docs/components-spinner-docs.md +0 -450
  53. package/generated/docs/components-stack-docs.md +0 -923
  54. package/generated/docs/components-table-ag-grid-docs.md +0 -1444
  55. package/generated/docs/components-table-docs.md +0 -2327
  56. package/generated/docs/components-tabset-docs.md +0 -768
  57. package/generated/docs/components-tabset-tab-docs.md +0 -550
  58. package/generated/docs/components-tag-docs.md +0 -548
  59. package/generated/docs/components-text-docs.md +0 -585
  60. package/generated/docs/components-toaster-docs.md +0 -755
  61. package/generated/docs/components-toggle-docs.md +0 -614
  62. package/generated/docs/components-tooltip-docs.md +0 -747
  63. package/generated/docs/components-validationmessage-docs.md +0 -1161
  64. package/generated/docs/contact-us-docs.md +0 -27
  65. package/generated/docs/extensions-editor-docs.md +0 -1181
  66. package/generated/docs/extensions-editor-recipes-docs.md +0 -89
  67. package/generated/docs/foundations-accessibility-docs.md +0 -40
  68. package/generated/docs/foundations-consistency-docs.md +0 -52
  69. package/generated/docs/foundations-content-docs.md +0 -23
  70. package/generated/docs/foundations-grid-docs.md +0 -74
  71. package/generated/docs/foundations-introduction-docs.md +0 -19
  72. package/generated/docs/foundations-principles-docs.md +0 -70
  73. package/generated/docs/foundations-responsive-breakpoints-docs.md +0 -193
  74. package/generated/docs/foundations-tokens-colour-docs.md +0 -564
  75. package/generated/docs/foundations-tokens-elevation-docs.md +0 -155
  76. package/generated/docs/foundations-tokens-introduction-docs.md +0 -190
  77. package/generated/docs/foundations-tokens-radius-docs.md +0 -71
  78. package/generated/docs/foundations-tokens-spacing-docs.md +0 -89
  79. package/generated/docs/foundations-tokens-typography-docs.md +0 -322
  80. package/generated/docs/foundations-user-experience-docs.md +0 -63
  81. package/generated/docs/foundations-visual-design-docs.md +0 -46
  82. package/generated/docs/foundations-z-index-stacking-docs.md +0 -31
  83. package/generated/docs/frequently-asked-questions-docs.md +0 -53
  84. package/generated/docs/get-started-develop-docs.md +0 -209
  85. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  86. package/generated/docs/guidelines.md +0 -2054
  87. package/generated/docs/introduction-docs.md +0 -87
  88. package/generated/docs/news-version-6-docs.md +0 -93
  89. package/generated/docs/patterns-form-docs.md +0 -3902
  90. package/generated/docs/patterns-form-recipes-docs.md +0 -1370
  91. package/generated/docs/patterns-introduction-docs.md +0 -24
  92. package/generated/docs/patterns-loading-docs.md +0 -4043
  93. package/generated/docs/resources-code-katas-docs.md +0 -29
  94. package/generated/docs/resources-introduction-docs.md +0 -38
  95. package/generated/docs/resources-mcp-server-docs.md +0 -27
  96. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  97. package/generated/docs/styling-props-colour-docs.md +0 -172
  98. package/generated/docs/styling-props-elevation-docs.md +0 -88
  99. package/generated/docs/styling-props-radius-docs.md +0 -86
  100. package/generated/docs/styling-props-reference-docs.md +0 -160
  101. package/generated/docs/styling-props-screen-readers-docs.md +0 -71
  102. package/generated/docs/styling-props-sizing-docs.md +0 -627
  103. package/generated/docs/styling-props-spacing-docs.md +0 -2282
  104. package/generated/docs/styling-props-typography-docs.md +0 -121
  105. package/generated/docs/themes-available-themes-docs.md +0 -66
  106. package/generated/docs/themes-introduction-docs.md +0 -121
  107. package/generated/docs/versions-docs.md +0 -17
  108. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,702 +0,0 @@
1
- [](#hide)Hide
2
- =============
3
-
4
- Overview
5
- --------
6
-
7
- `IressHide` makes it easier for designers and developers to create adaptive designs that work for all screen sizes.
8
-
9
- * * *
10
-
11
- Caution
12
-
13
- **Use srOnly and hide props instead**
14
-
15
- The design of this component is changing. Please use the new component/props instead.
16
-
17
- Content to hide
18
-
19
- Hide code
20
-
21
- \[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; }
22
-
23
- <IressHide
24
- hiddenOn\={{
25
- lg: false,
26
- xs: true
27
- }}
28
- \>
29
- Content to hide
30
- </IressHide\>
31
-
32
- Copy
33
-
34
- [](#props)Props
35
- ---------------
36
-
37
- | Name | Description | Default | Control |
38
- | --- | --- | --- | --- |
39
- | bg |
40
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
41
-
42
- We recommend using the following token values for best background contrast:
43
-
44
- * `colour.primary.fill` for primary backgrounds that need to stand out
45
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
46
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
47
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
48
- * `colour.system.danger.fill` for error backgrounds that need to stand out
49
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
50
- * `colour.system.success.fill` for success backgrounds that need to stand out
51
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
52
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
53
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
54
- * `colour.system.info.fill` for info backgrounds that need to stand out
55
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
56
-
57
- ResponsiveProp<ColorToken> | undefined
58
-
59
- | \- | Set object |
60
- | borderRadius |
61
-
62
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
63
-
64
- | Chrome | Firefox | Safari | Edge | IE |
65
- | --- | --- | --- | --- | --- |
66
- | **4** | **4** | **5** | **12** | **9** |
67
- | 1 _\-x-_ | | 3 _\-x-_ | | |
68
-
69
- ResponsiveProp<RadiusToken> | undefined
70
-
71
- | \- | Set object |
72
- | children\* |
73
-
74
- Content to hide.
75
-
76
- ReactNode
77
-
78
-
79
-
80
- | \- |
81
-
82
- "Content to hide"
83
-
84
- |
85
- | color |
86
-
87
- 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`.
88
-
89
- We recommend using the following token values for best color contrast:
90
-
91
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
92
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
93
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
94
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
95
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
96
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
97
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
98
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
99
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
100
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
101
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
102
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
103
-
104
- ResponsiveProp<ColorToken> | undefined
105
-
106
- | \- | Set object |
107
- | focusable |
108
-
109
- 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.
110
-
111
- "true""within"undefined
112
-
113
-
114
-
115
- | \- | Set object |
116
- | hiddenOn\* |
117
-
118
- Content will be hidden on any screen sizes that are set to true.
119
-
120
- ResponsiveSizing<boolean>
121
-
122
- | \- |
123
-
124
- RAW
125
-
126
- hiddenOn : {
127
-
128
- * xs : true
129
- * lg : false
130
-
131
- }
132
-
133
-
134
-
135
-
136
-
137
- |
138
- | hide |
139
-
140
- 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.
141
-
142
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
143
-
144
- Notes:
145
-
146
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
147
- * Consider if you can conditionally render the element instead of hiding it.
148
-
149
- ResponsiveProp<boolean> | undefined
150
-
151
- | \- | Set object |
152
- | layerStyle |
153
-
154
- 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.
155
-
156
- * `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.
157
- * `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.
158
- * `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.
159
-
160
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
161
-
162
- | \- | Set object |
163
- | m |
164
-
165
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
166
-
167
- 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.
168
-
169
- | Chrome | Firefox | Safari | Edge | IE |
170
- | --- | --- | --- | --- | --- |
171
- | **1** | **1** | **1** | **12** | **3** |
172
-
173
- ResponsiveProp<SpacingToken | "auto"> | undefined
174
-
175
- | \- | Set object |
176
- | maxWidth |
177
-
178
- 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`.
179
-
180
- | Chrome | Firefox | Safari | Edge | IE |
181
- | --- | --- | --- | --- | --- |
182
- | **1** | **1** | **1** | **12** | **7** |
183
-
184
- 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
185
-
186
- | \- | Set object |
187
- | mb |
188
-
189
- 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.
190
-
191
- It uses the spacing tokens in the design system.
192
-
193
- | Chrome | Firefox | Safari | Edge | IE |
194
- | --- | --- | --- | --- | --- |
195
- | **1** | **1** | **1** | **12** | **3** |
196
-
197
- ResponsiveProp<SpacingToken | "auto"> | undefined
198
-
199
- | \- | Set object |
200
- | ml |
201
-
202
- 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.
203
-
204
- It uses the spacing tokens in the design system.
205
-
206
- | Chrome | Firefox | Safari | Edge | IE |
207
- | --- | --- | --- | --- | --- |
208
- | **1** | **1** | **1** | **12** | **3** |
209
-
210
- ResponsiveProp<SpacingToken | "auto"> | undefined
211
-
212
- | \- | Set object |
213
- | mr |
214
-
215
- 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.
216
-
217
- It uses the spacing tokens in the design system.
218
-
219
- | Chrome | Firefox | Safari | Edge | IE |
220
- | --- | --- | --- | --- | --- |
221
- | **1** | **1** | **1** | **12** | **3** |
222
-
223
- ResponsiveProp<SpacingToken | "auto"> | undefined
224
-
225
- | \- | Set object |
226
- | mt |
227
-
228
- 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.
229
-
230
- It uses the spacing tokens in the design system.
231
-
232
- | Chrome | Firefox | Safari | Edge | IE |
233
- | --- | --- | --- | --- | --- |
234
- | **1** | **1** | **1** | **12** | **3** |
235
-
236
- ResponsiveProp<SpacingToken | "auto"> | undefined
237
-
238
- | \- | Set object |
239
- | mx |
240
-
241
- 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.
242
-
243
- 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.
244
-
245
- | Chrome | Firefox | Safari | Edge | IE |
246
- | --- | --- | --- | --- | --- |
247
- | **1** | **1** | **1** | **12** | **3** |
248
-
249
- ResponsiveProp<SpacingToken | "auto"> | undefined
250
-
251
- | \- | Set object |
252
- | my |
253
-
254
- 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.
255
-
256
- 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.
257
-
258
- | Chrome | Firefox | Safari | Edge | IE |
259
- | --- | --- | --- | --- | --- |
260
- | **1** | **1** | **1** | **12** | **3** |
261
-
262
- ResponsiveProp<SpacingToken | "auto"> | undefined
263
-
264
- | \- | Set object |
265
- | noGutter |
266
-
267
- 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.
268
-
269
- booleanundefined
270
-
271
-
272
-
273
- | \- | Set object |
274
- | p |
275
-
276
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
277
-
278
- 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.
279
-
280
- | Chrome | Firefox | Safari | Edge | IE |
281
- | --- | --- | --- | --- | --- |
282
- | **1** | **1** | **1** | **12** | **3** |
283
-
284
- 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
285
-
286
- | \- | Set object |
287
- | pb |
288
-
289
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
290
-
291
- 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.
292
-
293
- | Chrome | Firefox | Safari | Edge | IE |
294
- | --- | --- | --- | --- | --- |
295
- | **1** | **1** | **1** | **12** | **3** |
296
-
297
- 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
298
-
299
- | \- | Set object |
300
- | pl |
301
-
302
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
303
-
304
- 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.
305
-
306
- | Chrome | Firefox | Safari | Edge | IE |
307
- | --- | --- | --- | --- | --- |
308
- | **1** | **1** | **1** | **12** | **3** |
309
-
310
- 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
311
-
312
- | \- | Set object |
313
- | pr |
314
-
315
- The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
316
-
317
- 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.
318
-
319
- | Chrome | Firefox | Safari | Edge | IE |
320
- | --- | --- | --- | --- | --- |
321
- | **1** | **1** | **1** | **12** | **3** |
322
-
323
- 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
324
-
325
- | \- | Set object |
326
- | pt |
327
-
328
- The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
329
-
330
- 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.
331
-
332
- | Chrome | Firefox | Safari | Edge | IE |
333
- | --- | --- | --- | --- | --- |
334
- | **1** | **1** | **1** | **12** | **3** |
335
-
336
- 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
337
-
338
- | \- | Set object |
339
- | px |
340
-
341
- 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.
342
-
343
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
344
-
345
- | Chrome | Firefox | Safari | Edge | IE |
346
- | --- | --- | --- | --- | --- |
347
- | **1** | **1** | **1** | **12** | **3** |
348
-
349
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
350
-
351
- | \- | Set object |
352
- | py |
353
-
354
- 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.
355
-
356
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
357
-
358
- | Chrome | Firefox | Safari | Edge | IE |
359
- | --- | --- | --- | --- | --- |
360
- | **1** | **1** | **1** | **12** | **3** |
361
-
362
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
363
-
364
- | \- | Set object |
365
- | rowGap |
366
-
367
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
368
-
369
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
370
-
371
- | Chrome | Firefox | Safari | Edge | IE |
372
- | --- | --- | --- | --- | --- |
373
- | **47** | **52** | **10.1** | **16** | No |
374
-
375
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
376
-
377
- | \- | Set object |
378
- | srOnly |
379
-
380
- 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.
381
-
382
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
383
-
384
- ResponsiveProp<boolean> | undefined
385
-
386
- | \- | Set object |
387
- | stretch |
388
-
389
- 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.
390
-
391
- booleanundefined
392
-
393
-
394
-
395
- | \- | Set object |
396
- | textAlign |
397
-
398
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
399
-
400
- | Chrome | Firefox | Safari | Edge | IE |
401
- | --- | --- | --- | --- | --- |
402
- | **1** | **1** | **1** | **12** | **3** |
403
-
404
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
405
-
406
- | \- | Set object |
407
- | textStyle |
408
-
409
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
410
-
411
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
412
- * `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.
413
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
414
- * `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.
415
- * `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.
416
- * `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.
417
- * `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.
418
- * `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.
419
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
420
-
421
- 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
422
-
423
- | \- | Set object |
424
- | visuallyHidden |
425
-
426
- If true, the content will not be visible, but will be available to screen readers
427
-
428
- booleanundefined
429
-
430
-
431
-
432
- | \- | Set object |
433
- | width |
434
-
435
- 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.
436
-
437
- 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.
438
-
439
- | Chrome | Firefox | Safari | Edge | IE |
440
- | --- | --- | --- | --- | --- |
441
- | **1** | **1** | **1** | **12** | **4** |
442
-
443
- 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
444
-
445
- | \- | Set object |
446
-
447
- [](#usage)Usage
448
- ---------------
449
-
450
- ### [](#hiddenon)`hiddenOn`
451
-
452
- The `hiddenOn` prop accepts a `ResponsiveSizing<boolean>` object, which is an object that uses a breakpoint as a key, and a boolean as a value.
453
-
454
- It determines which screen sizes the component's children will be hidden on. It's set up as an object containing the following IDS breakpoints:
455
-
456
- Hide breakpoints
457
- | Breakpoint | Screen Widths |
458
- | --- | --- |
459
- | `xs` | Above 0px (inclusive) |
460
- | `sm` | Above 576px (inclusive) |
461
- | `md` | Above 768px (inclusive) |
462
- | `lg` | Above 1024px (inclusive) |
463
- | `xl` | Above 1200px (inclusive) |
464
- | `xxl` | Above 1500px (inclusive) |
465
-
466
- [](#behaviour)Behaviour
467
- -----------------------
468
-
469
- If the breakpoint in the `hiddenOn` prop is set to true, the content will be hidden for both sighted users and screen reader users. If the value is false, or the breakpoint is omitted, the content will be visible.
470
-
471
- You don't need to include every breakpoint, just the ones where you want content to become hidden. If you want to hide content on medium screens and above, you can set `hiddenOn` like this:
472
-
473
- \[data-radix-scroll-area-viewport\] {
474
- scrollbar-width: none;
475
- -ms-overflow-style: none;
476
- -webkit-overflow-scrolling: touch;
477
- }
478
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
479
- display: none;
480
- }
481
- :where(\[data-radix-scroll-area-viewport\]) {
482
- display: flex;
483
- flex-direction: column;
484
- align-items: stretch;
485
- }
486
- :where(\[data-radix-scroll-area-content\]) {
487
- flex-grow: 1;
488
- }
489
-
490
- <IressHide hiddenOn\={{ md: true }} />
491
-
492
- Copy
493
-
494
- If you want to hide content only on certain screen sizes, you'll need to specify which screen size the content should become visible again on. To set content to be hidden on medium screens, and visible on extra large screens and above, you can do the following:
495
-
496
- \[data-radix-scroll-area-viewport\] {
497
- scrollbar-width: none;
498
- -ms-overflow-style: none;
499
- -webkit-overflow-scrolling: touch;
500
- }
501
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
502
- display: none;
503
- }
504
- :where(\[data-radix-scroll-area-viewport\]) {
505
- display: flex;
506
- flex-direction: column;
507
- align-items: stretch;
508
- }
509
- :where(\[data-radix-scroll-area-content\]) {
510
- flex-grow: 1;
511
- }
512
-
513
- <IressHide hiddenOn\={{ md: true, xl: false }} />
514
-
515
- Copy
516
-
517
- [](#examples)Examples
518
- ---------------------
519
-
520
- ### [](#hidden-on)Hidden on
521
-
522
- Here are a few variations of the `hiddenOn` prop in action.
523
-
524
- **xl** breakpoint (1200px - 1499px)
525
-
526
- * * *
527
-
528
- This text is totally hidden on xs screens and above.
529
-
530
- This text is totally hidden on md screens and above.
531
-
532
- This text is totally hidden on md screens and below.
533
-
534
- This text is totally hidden on xs screens only.
535
-
536
- This text is totally hidden on xl screens only.
537
-
538
- Hide code
539
-
540
- \[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; }
541
-
542
- <IressStack gap\="spacing.100"\>
543
- <IressPanel\>
544
- <CurrentBreakpoint />
545
- </IressPanel\>
546
- <IressDivider />
547
- <IressHide
548
- hiddenOn\={{
549
- xs: true
550
- }}
551
- \>
552
- <IressText\>
553
- This text is totally hidden on xs screens and above. </IressText\>
554
- </IressHide\>
555
- <IressHide
556
- hiddenOn\={{
557
- md: true
558
- }}
559
- \>
560
- <IressText color\="colour.system.success.text"\>
561
- This text is totally hidden on md screens and above. </IressText\>
562
- </IressHide\>
563
- <IressHide
564
- hiddenOn\={{
565
- lg: false,
566
- xs: true
567
- }}
568
- \>
569
- <IressText color\="colour.system.danger.text"\>
570
- This text is totally hidden on md screens and below. </IressText\>
571
- </IressHide\>
572
- <IressHide
573
- hiddenOn\={{
574
- sm: false,
575
- xs: true
576
- }}
577
- \>
578
- <IressText color\="colour.system.info.text"\>
579
- This text is totally hidden on xs screens only. </IressText\>
580
- </IressHide\>
581
- <IressHide
582
- hiddenOn\={{
583
- xl: true,
584
- xxl: false
585
- }}
586
- \>
587
- <IressText color\="colour.neutral.70"\>
588
- This text is totally hidden on xl screens only. </IressText\>
589
- </IressHide\>
590
- </IressStack\>
591
-
592
- Copy
593
-
594
- ### [](#visually-hidden)Visually hidden
595
-
596
- This `visuallyHidden` prop is used if you don't want content to be visible on screen, but you do want it to be available to screen reader users.
597
-
598
- **xl** breakpoint (1200px - 1499px)
599
-
600
- * * *
601
-
602
- This text is visually hidden on xs screens and above.
603
-
604
- This text is visually hidden on md screens and above.
605
-
606
- This text is visually hidden on md screens and below.
607
-
608
- This text is visually hidden on xs screens only.
609
-
610
- This text is visually hidden on xl screens only.
611
-
612
- Hide code
613
-
614
- \[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; }
615
-
616
- <IressStack gap\="spacing.100"\>
617
- <IressPanel\>
618
- <CurrentBreakpoint />
619
- </IressPanel\>
620
- <IressDivider />
621
- <IressHide
622
- hiddenOn\={{
623
- xs: true
624
- }}
625
- visuallyHidden
626
- \>
627
- <IressText\>
628
- This text is visually hidden on xs screens and above. </IressText\>
629
- </IressHide\>
630
- <IressHide
631
- hiddenOn\={{
632
- md: true
633
- }}
634
- visuallyHidden
635
- \>
636
- <IressText color\="colour.system.success.text"\>
637
- This text is visually hidden on md screens and above. </IressText\>
638
- </IressHide\>
639
- <IressHide
640
- hiddenOn\={{
641
- lg: false,
642
- xs: true
643
- }}
644
- visuallyHidden
645
- \>
646
- <IressText color\="colour.system.danger.text"\>
647
- This text is visually hidden on md screens and below. </IressText\>
648
- </IressHide\>
649
- <IressHide
650
- hiddenOn\={{
651
- sm: false,
652
- xs: true
653
- }}
654
- visuallyHidden
655
- \>
656
- <IressText color\="colour.system.info.text"\>
657
- This text is visually hidden on xs screens only. </IressText\>
658
- </IressHide\>
659
- <IressHide
660
- hiddenOn\={{
661
- xl: true,
662
- xxl: false
663
- }}
664
- visuallyHidden
665
- \>
666
- <IressText color\="colour.neutral.70"\>
667
- This text is visually hidden on xl screens only. </IressText\>
668
- </IressHide\>
669
- </IressStack\>
670
-
671
- Copy
672
-
673
- [](#utility-classes)Utility classes
674
- -----------------------------------
675
-
676
- To make it easier for developers to hide content, we've exposed the classes we use for the hide component as part of our global styles.
677
-
678
- This means you can use them without having to use the Hide component. Unlike the Hide component, the utility classes only apply to a single breakpoint:
679
-
680
- Hide breakpoints
681
- | Totally Hidden | Visually Hidden | Screen Widths |
682
- | --- | --- | --- |
683
- | `iress-hidden--xs` | `iress-sr-only--xs` | 0 - 575px |
684
- | `iress-hidden--sm` | `iress-sr-only--sm` | 576px - 767px |
685
- | `iress-hidden--md` | `iress-sr-only--md` | 768px - 1023px |
686
- | `iress-hidden--lg` | `iress-sr-only--lg` | 1024px - 1199px |
687
- | `iress-hidden--xl` | `iress-sr-only--xl` | 1200px - 1499px |
688
- | `iress-hidden--xxl` | `iress-sr-only--xxl` | 1500px and above |
689
-
690
- If you use `iress-hidden` or `iress-sr-only` without the breakpoint suffix, it will apply to all screen sizes.
691
-
692
- On this page
693
-
694
- * [Overview](#overview)
695
- * [Props](#props)
696
- * [Usage](#usage)
697
- * [hiddenOn](#hiddenon)
698
- * [Behaviour](#behaviour)
699
- * [Examples](#examples)
700
- * [Hidden on](#hidden-on)
701
- * [Visually hidden](#visually-hidden)
702
- * [Utility classes](#utility-classes)