@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,747 +0,0 @@
1
- [](#tooltip)Tooltip
2
- ===================
3
-
4
- Overview
5
- --------
6
-
7
- A component that shows concise, informative text about an element when focussed upon, hovered over or on a long touch.
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
-
17
- Hover me
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
- <IressTooltip tooltipText\="Hello! This is a really long tooltip to try and see if it goes behind the scrollbar"\>
24
- <IressButton\>
25
- Hover me </IressButton\>
26
- </IressTooltip\>
27
-
28
- Copy
29
-
30
- [](#props)Props
31
- ---------------
32
-
33
- | Name | Description | Default | Control |
34
- | --- | --- | --- | --- |
35
- | align |
36
- Sets the alignment of the popover relative to the activator element.
37
-
38
- "bottom""left""right""top""auto""bottom-start""bottom-end""top-start"Show 6 more...
39
-
40
-
41
-
42
- |
43
-
44
- top
45
-
46
- | Set object |
47
- | bg |
48
-
49
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
50
-
51
- We recommend using the following token values for best background contrast:
52
-
53
- * `colour.primary.fill` for primary backgrounds that need to stand out
54
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
55
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
56
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
57
- * `colour.system.danger.fill` for error backgrounds that need to stand out
58
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
59
- * `colour.system.success.fill` for success backgrounds that need to stand out
60
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
61
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
62
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
63
- * `colour.system.info.fill` for info backgrounds that need to stand out
64
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
65
-
66
- ResponsiveProp<ColorToken> | undefined
67
-
68
- | \- | Set object |
69
- | borderRadius |
70
-
71
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
72
-
73
- | Chrome | Firefox | Safari | Edge | IE |
74
- | --- | --- | --- | --- | --- |
75
- | **4** | **4** | **5** | **12** | **9** |
76
- | 1 _\-x-_ | | 3 _\-x-_ | | |
77
-
78
- ResponsiveProp<RadiusToken> | undefined
79
-
80
- | \- | Set object |
81
- | children\* |
82
-
83
- The element to add a tooltip to.
84
-
85
- ReactNode
86
-
87
-
88
-
89
- | \- | \- |
90
- | color |
91
-
92
- 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`.
93
-
94
- We recommend using the following token values for best color contrast:
95
-
96
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
97
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
98
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
99
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
100
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
101
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
102
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
103
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
104
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
105
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
106
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
107
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
108
-
109
- ResponsiveProp<ColorToken> | undefined
110
-
111
- | \- | Set object |
112
- | delay |
113
-
114
- Sets the tooltip display delay in milliseconds.
115
-
116
- numberundefined
117
-
118
-
119
-
120
- |
121
-
122
- 500
123
-
124
- | Set object |
125
- | focusable |
126
-
127
- 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.
128
-
129
- "true""within"undefined
130
-
131
-
132
-
133
- | \- | Set object |
134
- | hide |
135
-
136
- 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.
137
-
138
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
139
-
140
- Notes:
141
-
142
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
143
- * Consider if you can conditionally render the element instead of hiding it.
144
-
145
- ResponsiveProp<boolean> | undefined
146
-
147
- | \- | Set object |
148
- | layerStyle |
149
-
150
- 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.
151
-
152
- * `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.
153
- * `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.
154
- * `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.
155
-
156
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
157
-
158
- | \- | Set object |
159
- | m |
160
-
161
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
162
-
163
- 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.
164
-
165
- | Chrome | Firefox | Safari | Edge | IE |
166
- | --- | --- | --- | --- | --- |
167
- | **1** | **1** | **1** | **12** | **3** |
168
-
169
- ResponsiveProp<SpacingToken | "auto"> | undefined
170
-
171
- | \- | Set object |
172
- | maxWidth |
173
-
174
- 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`.
175
-
176
- | Chrome | Firefox | Safari | Edge | IE |
177
- | --- | --- | --- | --- | --- |
178
- | **1** | **1** | **1** | **12** | **7** |
179
-
180
- 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
181
-
182
- | \- | Set object |
183
- | mb |
184
-
185
- 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.
186
-
187
- It uses the spacing tokens in the design system.
188
-
189
- | Chrome | Firefox | Safari | Edge | IE |
190
- | --- | --- | --- | --- | --- |
191
- | **1** | **1** | **1** | **12** | **3** |
192
-
193
- ResponsiveProp<SpacingToken | "auto"> | undefined
194
-
195
- | \- | Set object |
196
- | ml |
197
-
198
- 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.
199
-
200
- It uses the spacing tokens in the design system.
201
-
202
- | Chrome | Firefox | Safari | Edge | IE |
203
- | --- | --- | --- | --- | --- |
204
- | **1** | **1** | **1** | **12** | **3** |
205
-
206
- ResponsiveProp<SpacingToken | "auto"> | undefined
207
-
208
- | \- | Set object |
209
- | mr |
210
-
211
- 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.
212
-
213
- It uses the spacing tokens in the design system.
214
-
215
- | Chrome | Firefox | Safari | Edge | IE |
216
- | --- | --- | --- | --- | --- |
217
- | **1** | **1** | **1** | **12** | **3** |
218
-
219
- ResponsiveProp<SpacingToken | "auto"> | undefined
220
-
221
- | \- | Set object |
222
- | mt |
223
-
224
- 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.
225
-
226
- It uses the spacing tokens in the design system.
227
-
228
- | Chrome | Firefox | Safari | Edge | IE |
229
- | --- | --- | --- | --- | --- |
230
- | **1** | **1** | **1** | **12** | **3** |
231
-
232
- ResponsiveProp<SpacingToken | "auto"> | undefined
233
-
234
- | \- | Set object |
235
- | mx |
236
-
237
- 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.
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
- | my |
249
-
250
- 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.
251
-
252
- 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.
253
-
254
- | Chrome | Firefox | Safari | Edge | IE |
255
- | --- | --- | --- | --- | --- |
256
- | **1** | **1** | **1** | **12** | **3** |
257
-
258
- ResponsiveProp<SpacingToken | "auto"> | undefined
259
-
260
- | \- | Set object |
261
- | noGutter |
262
-
263
- 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.
264
-
265
- booleanundefined
266
-
267
-
268
-
269
- | \- | Set object |
270
- | open |
271
-
272
- Only used for internal testing.
273
-
274
- booleanundefined
275
-
276
-
277
-
278
- |
279
-
280
- false
281
-
282
- | \- |
283
- | p |
284
-
285
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
286
-
287
- 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.
288
-
289
- | Chrome | Firefox | Safari | Edge | IE |
290
- | --- | --- | --- | --- | --- |
291
- | **1** | **1** | **1** | **12** | **3** |
292
-
293
- 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
294
-
295
- | \- | Set object |
296
- | pb |
297
-
298
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
299
-
300
- 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.
301
-
302
- | Chrome | Firefox | Safari | Edge | IE |
303
- | --- | --- | --- | --- | --- |
304
- | **1** | **1** | **1** | **12** | **3** |
305
-
306
- 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
307
-
308
- | \- | Set object |
309
- | pl |
310
-
311
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
312
-
313
- 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.
314
-
315
- | Chrome | Firefox | Safari | Edge | IE |
316
- | --- | --- | --- | --- | --- |
317
- | **1** | **1** | **1** | **12** | **3** |
318
-
319
- 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
320
-
321
- | \- | Set object |
322
- | pr |
323
-
324
- The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
325
-
326
- 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.
327
-
328
- | Chrome | Firefox | Safari | Edge | IE |
329
- | --- | --- | --- | --- | --- |
330
- | **1** | **1** | **1** | **12** | **3** |
331
-
332
- 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
333
-
334
- | \- | Set object |
335
- | pt |
336
-
337
- The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
338
-
339
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
340
-
341
- | Chrome | Firefox | Safari | Edge | IE |
342
- | --- | --- | --- | --- | --- |
343
- | **1** | **1** | **1** | **12** | **3** |
344
-
345
- 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
346
-
347
- | \- | Set object |
348
- | px |
349
-
350
- 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.
351
-
352
- 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.
353
-
354
- | Chrome | Firefox | Safari | Edge | IE |
355
- | --- | --- | --- | --- | --- |
356
- | **1** | **1** | **1** | **12** | **3** |
357
-
358
- 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
359
-
360
- | \- | Set object |
361
- | py |
362
-
363
- 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.
364
-
365
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
366
-
367
- | Chrome | Firefox | Safari | Edge | IE |
368
- | --- | --- | --- | --- | --- |
369
- | **1** | **1** | **1** | **12** | **3** |
370
-
371
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
372
-
373
- | \- | Set object |
374
- | rowGap |
375
-
376
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
377
-
378
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
379
-
380
- | Chrome | Firefox | Safari | Edge | IE |
381
- | --- | --- | --- | --- | --- |
382
- | **47** | **52** | **10.1** | **16** | No |
383
-
384
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
385
-
386
- | \- | Set object |
387
- | srOnly |
388
-
389
- 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.
390
-
391
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
392
-
393
- ResponsiveProp<boolean> | undefined
394
-
395
- | \- | Set object |
396
- | stretch |
397
-
398
- 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.
399
-
400
- booleanundefined
401
-
402
-
403
-
404
- | \- | Set object |
405
- | textAlign |
406
-
407
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
408
-
409
- | Chrome | Firefox | Safari | Edge | IE |
410
- | --- | --- | --- | --- | --- |
411
- | **1** | **1** | **1** | **12** | **3** |
412
-
413
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
414
-
415
- | \- | Set object |
416
- | textStyle |
417
-
418
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
419
-
420
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
421
- * `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.
422
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
423
- * `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.
424
- * `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.
425
- * `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.
426
- * `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.
427
- * `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.
428
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
429
-
430
- 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
431
-
432
- | \- | Set object |
433
- | tooltipText\* |
434
-
435
- Sets the tooltip text. Can accept a string or an array of strings - if given an array, will output each string on a new line.
436
-
437
- string | string\[\]
438
-
439
- | \- |
440
-
441
- "Hello! This is a really long tooltip to try and see if it goes behind the scrollbar"
442
-
443
- |
444
- | width |
445
-
446
- 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.
447
-
448
- 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.
449
-
450
- | Chrome | Firefox | Safari | Edge | IE |
451
- | --- | --- | --- | --- | --- |
452
- | **1** | **1** | **1** | **12** | **4** |
453
-
454
- 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
455
-
456
- | \- | Set object |
457
-
458
- [](#usage)Usage
459
- ---------------
460
-
461
- The content that will be displayed in the tooltip is passed using the `tooltipText` prop.
462
-
463
- This content can only be plain text; there is no parsing of any markup or styling. This is by design as we do not allow complex structures in a tooltip as they are meant to be concise, informative pieces of text.
464
-
465
- Text content will wrap on to a new line if it exceeds the tooltip's maximum width. You can also manually format your content into multiple lines by passing an array of strings into the `tooltipText` prop.
466
-
467
- Single line
468
-
469
- Multi line
470
-
471
- Hide code
472
-
473
- \[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; }
474
-
475
- <div
476
- style\={{
477
- paddingTop: '30px'
478
- }}
479
- \>
480
- <IressInline gap\="md"\>
481
- <IressTooltip tooltipText\="Single line Hello! This is a really long tooltip to try and see if it goes behind the scrollbar"\>
482
- <IressButton\>
483
- Single line </IressButton\>
484
- </IressTooltip\>
485
- <IressTooltip
486
- tooltipText\={\[
487
- 'This tooltip',
488
- 'has multiple lines'
489
- \]}
490
- \>
491
- <IressButton\>
492
- Multi line </IressButton\>
493
- </IressTooltip\>
494
- </IressInline\>
495
- </div\>
496
-
497
- Copy
498
-
499
- [](#behaviour)Behaviour
500
- -----------------------
501
-
502
- The behaviour of tooltips varies according to how they're shown:
503
-
504
- * When a pointer is moved over the activator the tooltip will be shown, and will remain visible for a short period of time after the pointer has moved away (500ms is the default time)
505
- * If the activator receives keyboard focus the tooltip will be visible. The tooltip will hide immediately after the focus moves away from the activator.
506
- * If the user long presses on the activator (on a touch device). The tooltip will remain visible until the user taps somewhere else on the screen
507
-
508
- If the user activates a tooltip via a pointing device and then moves the pointer over the tooltip, it will remain on screen until the pointer is moved away. This is for accessibility purposes where a user may be using magnifying software for example.
509
-
510
- [](#accessibility)Accessibility
511
- -------------------------------
512
-
513
- The WCAG guidelines for content that is displayed on hover or focus can be found here: [WCAG 2.1 - 1.4.13 (AA)](https://www.w3.org/TR/WCAG21/#content-on-hover-or-focus).
514
-
515
- Other things to keep in mind:
516
-
517
- * For best accessibility, you should only use tooltips on focusable items (eg. `IressButton` and `IressMenuItem`), allowing them to be seen when navigating to the tooltip activator by keyboard
518
-
519
- **Notes:**
520
-
521
- * If the text you wish to display is more than a handful of words then consider using an IressModal with an information button.
522
- * Tooltips must not be used for help text as they are not immediately visible to the user. We suggest adding hint text to assist the user when filling out forms.
523
- * Also think about placement using the align prop. The tooltip should not obscure any critical screen content. Another reason to keep them short.
524
-
525
- [](#examples)Examples
526
- ---------------------
527
-
528
- ### [](#align)Align
529
-
530
- The tooltip can be aligned in one of 12 positions relative to the activator element.
531
-
532
- The tooltip's position will change dynamically based on the amount of space available in its container window, so that it doesn't overflow the edge. For example, if the tooltip is about to scroll off the top of the screen, it will change its position to bottom. Likewise with left and right scrolling.
533
-
534
- Top Start
535
-
536
- Top
537
-
538
- Top End
539
-
540
- Left Start
541
-
542
- Left
543
-
544
- Left End
545
-
546
- Right Start
547
-
548
- Right
549
-
550
- Right End
551
-
552
- Bottom Start
553
-
554
- Bottom
555
-
556
- Bottom End
557
-
558
- Hide code
559
-
560
- \[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; }
561
-
562
- <div
563
- style\={{
564
- padding: '80px 150px'
565
- }}
566
- \>
567
- <IressStack gap\="md"\>
568
- <IressInline
569
- gap\="sm"
570
- horizontalAlign\="center"
571
- \>
572
- <IressTooltip
573
- align\="top-start"
574
- tooltipText\="Hello!"
575
- \>
576
- <IressButton\>
577
- Top Start </IressButton\>
578
- </IressTooltip\>
579
- <IressTooltip
580
- align\="top"
581
- tooltipText\="Hello!"
582
- \>
583
- <IressButton\>
584
- Top </IressButton\>
585
- </IressTooltip\>
586
- <IressTooltip
587
- align\="top-end"
588
- tooltipText\="Hello!"
589
- \>
590
- <IressButton\>
591
- Top End </IressButton\>
592
- </IressTooltip\>
593
- </IressInline\>
594
- <IressInline horizontalAlign\="between"\>
595
- <IressStack gap\="sm"\>
596
- <IressInline horizontalAlign\="left"\>
597
- <IressTooltip
598
- align\="left-start"
599
- tooltipText\="Hello!"
600
- \>
601
- <IressButton\>
602
- Left Start </IressButton\>
603
- </IressTooltip\>
604
- </IressInline\>
605
- <IressInline horizontalAlign\="left"\>
606
- <IressTooltip
607
- align\="left"
608
- tooltipText\="Hello!"
609
- \>
610
- <IressButton\>
611
- Left </IressButton\>
612
- </IressTooltip\>
613
- </IressInline\>
614
- <IressInline horizontalAlign\="left"\>
615
- <IressTooltip
616
- align\="left-end"
617
- tooltipText\="Hello!"
618
- \>
619
- <IressButton\>
620
- Left End </IressButton\>
621
- </IressTooltip\>
622
- </IressInline\>
623
- </IressStack\>
624
- <IressStack gap\="sm"\>
625
- <IressInline horizontalAlign\="right"\>
626
- <IressTooltip
627
- align\="right-start"
628
- tooltipText\="Hello!"
629
- \>
630
- <IressButton\>
631
- Right Start </IressButton\>
632
- </IressTooltip\>
633
- </IressInline\>
634
- <IressInline horizontalAlign\="right"\>
635
- <IressTooltip
636
- align\="right"
637
- tooltipText\="Hello!"
638
- \>
639
- <IressButton\>
640
- Right </IressButton\>
641
- </IressTooltip\>
642
- </IressInline\>
643
- <IressInline horizontalAlign\="right"\>
644
- <IressTooltip
645
- align\="right-end"
646
- tooltipText\="Hello!"
647
- \>
648
- <IressButton\>
649
- Right End </IressButton\>
650
- </IressTooltip\>
651
- </IressInline\>
652
- </IressStack\>
653
- </IressInline\>
654
- <IressInline
655
- gap\="sm"
656
- horizontalAlign\="center"
657
- \>
658
- <IressTooltip
659
- align\="bottom-start"
660
- tooltipText\="Hello!"
661
- \>
662
- <IressButton\>
663
- Bottom Start </IressButton\>
664
- </IressTooltip\>
665
- <IressTooltip
666
- align\="bottom"
667
- tooltipText\="Hello!"
668
- \>
669
- <IressButton\>
670
- Bottom </IressButton\>
671
- </IressTooltip\>
672
- <IressTooltip
673
- align\="bottom-end"
674
- tooltipText\="Hello!"
675
- \>
676
- <IressButton\>
677
- Bottom End </IressButton\>
678
- </IressTooltip\>
679
- </IressInline\>
680
- </IressStack\>
681
- </div\>
682
-
683
- Copy
684
-
685
- ### [](#delay)Delay
686
-
687
- The `delay` prop requires a number that is the number of milliseconds that pass after the activator has received a `mouseEnter` event and the display of the tooltip.
688
-
689
- 0ms (no delay)
690
-
691
- 500ms (default)
692
-
693
- 2000ms
694
-
695
- Hide code
696
-
697
- \[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; }
698
-
699
- <div
700
- style\={{
701
- paddingTop: '30px'
702
- }}
703
- \>
704
- <IressInline
705
- gap\="sm"
706
- horizontalAlign\="center"
707
- \>
708
- <IressTooltip
709
- delay\={0}
710
- tooltipText\="Hello!"
711
- \>
712
- <IressButton\>
713
- 0ms (no delay) </IressButton\>
714
- </IressTooltip\>
715
- <IressTooltip tooltipText\="Hello!"\>
716
- <IressButton\>
717
- 500ms (default) </IressButton\>
718
- </IressTooltip\>
719
- <IressTooltip
720
- delay\={2000}
721
- tooltipText\="Hello!"
722
- \>
723
- <IressButton\>
724
- 2000ms </IressButton\>
725
- </IressTooltip\>
726
- </IressInline\>
727
- </div\>
728
-
729
- Copy
730
-
731
- ### [](#the-title-attribute)The title attribute
732
-
733
- The component will not make any provision for existing title HTML attributes. If one exists, it will be activated along with the tooltip, potentially overlaying it making it difficult to ascertain the information being imparted. The title could also contain different content to the tooltip increasing the chance of confusing the end user.
734
-
735
- We suggest removing the title attribute on elements that will use tooltip.
736
-
737
- On this page
738
-
739
- * [Overview](#overview)
740
- * [Props](#props)
741
- * [Usage](#usage)
742
- * [Behaviour](#behaviour)
743
- * [Accessibility](#accessibility)
744
- * [Examples](#examples)
745
- * [Align](#align)
746
- * [Delay](#delay)
747
- * [The title attribute](#the-title-attribute)