@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,586 +0,0 @@
1
- [](#link)Link
2
- =============
3
-
4
- Overview
5
- --------
6
-
7
- A link is used to navigate to another page or location.
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
- Hello, I am a paragraph with an [IressLink](//iress.com) inside.
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
- <IressPanel\>
24
- Hello, I am a paragraph with an{' '}
25
- <IressLink href\="//iress.com"\>
26
- IressLink </IressLink\>
27
- {' '}inside.
28
- </IressPanel\>
29
-
30
- Copy
31
-
32
- [](#props)Props
33
- ---------------
34
-
35
- | Name | Description | Default | Control |
36
- | --- | --- | --- | --- |
37
- | active |
38
- Sets the active state of the link, usually used to indicate the link has activated a modal, popover or slideout.
39
-
40
- booleanundefined
41
-
42
-
43
-
44
- | \- | Set object |
45
- | append |
46
-
47
- Content for the append slot.
48
-
49
- ReactNode
50
-
51
-
52
-
53
- | \- | Set object |
54
- | bg |
55
-
56
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
57
-
58
- We recommend using the following token values for best background contrast:
59
-
60
- * `colour.primary.fill` for primary backgrounds that need to stand out
61
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
62
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
63
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
64
- * `colour.system.danger.fill` for error backgrounds that need to stand out
65
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
66
- * `colour.system.success.fill` for success backgrounds that need to stand out
67
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
68
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
69
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
70
- * `colour.system.info.fill` for info backgrounds that need to stand out
71
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
72
-
73
- ResponsiveProp<ColorToken> | undefined
74
-
75
- | \- | Set object |
76
- | borderRadius |
77
-
78
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
79
-
80
- | Chrome | Firefox | Safari | Edge | IE |
81
- | --- | --- | --- | --- | --- |
82
- | **4** | **4** | **5** | **12** | **9** |
83
- | 1 _\-x-_ | | 3 _\-x-_ | | |
84
-
85
- ResponsiveProp<RadiusToken> | undefined
86
-
87
- | \- | Set object |
88
- | children |
89
-
90
- Content is placed between prepend and append if provided. Used to describe the expected intention of this link.
91
-
92
- ReactNode
93
-
94
-
95
-
96
- | \- |
97
-
98
- "IressLink"
99
-
100
- |
101
- | color |
102
-
103
- 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`.
104
-
105
- We recommend using the following token values for best color contrast:
106
-
107
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
108
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
109
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
110
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
111
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
112
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
113
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
114
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
115
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
116
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
117
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
118
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
119
-
120
- ResponsiveProp<ColorToken> | undefined
121
-
122
- | \- | Set object |
123
- | element |
124
-
125
- Change the component that will be rendered as the link, used for third-party libraries that require a specific element type. By default, it will render a button or an anchor tag based on the `href` prop.
126
-
127
- ElementTypeundefined
128
-
129
-
130
-
131
- | \- | Set object |
132
- | focusable |
133
-
134
- 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.
135
-
136
- "true""within"undefined
137
-
138
-
139
-
140
- | \- | Set object |
141
- | hide |
142
-
143
- 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.
144
-
145
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
146
-
147
- Notes:
148
-
149
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
150
- * Consider if you can conditionally render the element instead of hiding it.
151
-
152
- ResponsiveProp<boolean> | undefined
153
-
154
- | \- | Set object |
155
- | href |
156
-
157
- Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
158
-
159
- stringundefined
160
-
161
-
162
-
163
- | \- |
164
-
165
- "//iress.com"
166
-
167
- |
168
- | layerStyle |
169
-
170
- 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.
171
-
172
- * `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.
173
- * `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.
174
- * `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.
175
-
176
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
177
-
178
- | \- | Set object |
179
- | loading |
180
-
181
- When true, button is in loading state. If provided a string, will be used as the loading text for screen readers.
182
-
183
- stringbooleanundefined
184
-
185
-
186
-
187
- |
188
-
189
- false
190
-
191
- | Set object |
192
- | m |
193
-
194
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
195
-
196
- 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.
197
-
198
- | Chrome | Firefox | Safari | Edge | IE |
199
- | --- | --- | --- | --- | --- |
200
- | **1** | **1** | **1** | **12** | **3** |
201
-
202
- ResponsiveProp<SpacingToken | "auto"> | undefined
203
-
204
- | \- | Set object |
205
- | maxWidth |
206
-
207
- 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`.
208
-
209
- | Chrome | Firefox | Safari | Edge | IE |
210
- | --- | --- | --- | --- | --- |
211
- | **1** | **1** | **1** | **12** | **7** |
212
-
213
- 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
214
-
215
- | \- | Set object |
216
- | mb |
217
-
218
- 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.
219
-
220
- It uses the spacing tokens in the design system.
221
-
222
- | Chrome | Firefox | Safari | Edge | IE |
223
- | --- | --- | --- | --- | --- |
224
- | **1** | **1** | **1** | **12** | **3** |
225
-
226
- ResponsiveProp<SpacingToken | "auto"> | undefined
227
-
228
- | \- | Set object |
229
- | ml |
230
-
231
- 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.
232
-
233
- It uses the spacing tokens in the design system.
234
-
235
- | Chrome | Firefox | Safari | Edge | IE |
236
- | --- | --- | --- | --- | --- |
237
- | **1** | **1** | **1** | **12** | **3** |
238
-
239
- ResponsiveProp<SpacingToken | "auto"> | undefined
240
-
241
- | \- | Set object |
242
- | mr |
243
-
244
- 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.
245
-
246
- It uses the spacing tokens in the design system.
247
-
248
- | Chrome | Firefox | Safari | Edge | IE |
249
- | --- | --- | --- | --- | --- |
250
- | **1** | **1** | **1** | **12** | **3** |
251
-
252
- ResponsiveProp<SpacingToken | "auto"> | undefined
253
-
254
- | \- | Set object |
255
- | mt |
256
-
257
- 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.
258
-
259
- It uses the spacing tokens in the design system.
260
-
261
- | Chrome | Firefox | Safari | Edge | IE |
262
- | --- | --- | --- | --- | --- |
263
- | **1** | **1** | **1** | **12** | **3** |
264
-
265
- ResponsiveProp<SpacingToken | "auto"> | undefined
266
-
267
- | \- | Set object |
268
- | mx |
269
-
270
- 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.
271
-
272
- 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.
273
-
274
- | Chrome | Firefox | Safari | Edge | IE |
275
- | --- | --- | --- | --- | --- |
276
- | **1** | **1** | **1** | **12** | **3** |
277
-
278
- ResponsiveProp<SpacingToken | "auto"> | undefined
279
-
280
- | \- | Set object |
281
- | my |
282
-
283
- 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.
284
-
285
- 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.
286
-
287
- | Chrome | Firefox | Safari | Edge | IE |
288
- | --- | --- | --- | --- | --- |
289
- | **1** | **1** | **1** | **12** | **3** |
290
-
291
- ResponsiveProp<SpacingToken | "auto"> | undefined
292
-
293
- | \- | Set object |
294
- | noGutter |
295
-
296
- 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.
297
-
298
- booleanundefined
299
-
300
-
301
-
302
- | \- | Set object |
303
- | onClick |
304
-
305
- Emitted when the menu item is clicked.
306
-
307
- MouseEventHandler<Exclude<Parameters<Exclude<ButtonRef<C, THref>, undefined>>\[0\], null>> | undefined
308
-
309
- | \- | Set object |
310
- | p |
311
-
312
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
313
-
314
- 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.
315
-
316
- | Chrome | Firefox | Safari | Edge | IE |
317
- | --- | --- | --- | --- | --- |
318
- | **1** | **1** | **1** | **12** | **3** |
319
-
320
- 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
321
-
322
- | \- | Set object |
323
- | pb |
324
-
325
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
326
-
327
- 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.
328
-
329
- | Chrome | Firefox | Safari | Edge | IE |
330
- | --- | --- | --- | --- | --- |
331
- | **1** | **1** | **1** | **12** | **3** |
332
-
333
- 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
334
-
335
- | \- | Set object |
336
- | pl |
337
-
338
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
339
-
340
- 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.
341
-
342
- | Chrome | Firefox | Safari | Edge | IE |
343
- | --- | --- | --- | --- | --- |
344
- | **1** | **1** | **1** | **12** | **3** |
345
-
346
- 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
347
-
348
- | \- | Set object |
349
- | pr |
350
-
351
- The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
352
-
353
- 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.
354
-
355
- | Chrome | Firefox | Safari | Edge | IE |
356
- | --- | --- | --- | --- | --- |
357
- | **1** | **1** | **1** | **12** | **3** |
358
-
359
- 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
360
-
361
- | \- | Set object |
362
- | prepend |
363
-
364
- Content for the prepend slot.
365
-
366
- ReactNode
367
-
368
-
369
-
370
- | \- | Set object |
371
- | pt |
372
-
373
- The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
374
-
375
- 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.
376
-
377
- | Chrome | Firefox | Safari | Edge | IE |
378
- | --- | --- | --- | --- | --- |
379
- | **1** | **1** | **1** | **12** | **3** |
380
-
381
- 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
382
-
383
- | \- | Set object |
384
- | px |
385
-
386
- 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.
387
-
388
- 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.
389
-
390
- | Chrome | Firefox | Safari | Edge | IE |
391
- | --- | --- | --- | --- | --- |
392
- | **1** | **1** | **1** | **12** | **3** |
393
-
394
- 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
395
-
396
- | \- | Set object |
397
- | py |
398
-
399
- 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.
400
-
401
- 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.
402
-
403
- | Chrome | Firefox | Safari | Edge | IE |
404
- | --- | --- | --- | --- | --- |
405
- | **1** | **1** | **1** | **12** | **3** |
406
-
407
- 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
408
-
409
- | \- | Set object |
410
- | ref |
411
-
412
- any
413
-
414
-
415
-
416
- | \- | Set object |
417
- | rowGap |
418
-
419
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
420
-
421
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
422
-
423
- | Chrome | Firefox | Safari | Edge | IE |
424
- | --- | --- | --- | --- | --- |
425
- | **47** | **52** | **10.1** | **16** | No |
426
-
427
- 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
428
-
429
- | \- | Set object |
430
- | srOnly |
431
-
432
- 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.
433
-
434
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
435
-
436
- ResponsiveProp<boolean> | undefined
437
-
438
- | \- | Set object |
439
- | stretch |
440
-
441
- 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.
442
-
443
- booleanundefined
444
-
445
-
446
-
447
- | \- | Set object |
448
- | textAlign |
449
-
450
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
451
-
452
- | Chrome | Firefox | Safari | Edge | IE |
453
- | --- | --- | --- | --- | --- |
454
- | **1** | **1** | **1** | **12** | **3** |
455
-
456
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
457
-
458
- | \- | Set object |
459
- | textStyle |
460
-
461
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
462
-
463
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
464
- * `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.
465
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
466
- * `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.
467
- * `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.
468
- * `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.
469
- * `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.
470
- * `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.
471
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
472
-
473
- 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
474
-
475
- | \- | Set object |
476
- | width |
477
-
478
- 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.
479
-
480
- 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.
481
-
482
- | Chrome | Firefox | Safari | Edge | IE |
483
- | --- | --- | --- | --- | --- |
484
- | **1** | **1** | **1** | **12** | **4** |
485
-
486
- 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
487
-
488
- | \- | Set object |
489
-
490
- [](#usage)Usage
491
- ---------------
492
-
493
- `IressLink` is an alternative to the `IressButton` component, and is used when you want to add interactive text inside a block of static text.
494
-
495
- If you provide a `href`, it will render as an `<a />` element. Otherwise it will render as a `<button />` element. This helps ensure it presents the correct role to assistive technologies for the best accessibility.
496
-
497
- [](#when-to-use)When to use
498
- ---------------------------
499
-
500
- * If you want to include a link alongside static text, use the `IressLink` component.
501
- * If you want to have a call to action at the start or end of a block of contents, use the `IressButton` component instead.
502
-
503
- [](#examples)Examples
504
- ---------------------
505
-
506
- ### [](#loading)Loading
507
-
508
- Loading buttons give the user an indication something is happening (eg. a form submission or extra content being loaded) after they have been triggered.
509
-
510
- The loading state can be activated by setting the `loading` prop to `true` and providing some `loadingText` for screenreaders to announce when in loading state (which defaults to Loading...).
511
-
512
- When the loading state is activated, any click events on the link are disabled.
513
-
514
- Link text
515
-
516
- Hide code
517
-
518
- \[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; }
519
-
520
- <IressLink loading\>
521
- Link text
522
- </IressLink\>
523
-
524
- Copy
525
-
526
- ### [](#slot-props)Slot props
527
-
528
- Use the slots to correctly position icons or badges inside buttons.
529
-
530
- * **Prepend** - Places the element before the text
531
- * **Append** - Places the element after the text
532
-
533
- Prepend iconAppend icon
534
-
535
- Hide code
536
-
537
- \[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; }
538
-
539
- <IressInline gap\="md"\>
540
- <IressLink prepend\={<IressIcon name\="home" />}\>
541
- Prepend icon </IressLink\>
542
- <IressLink append\={<IressIcon name\="home" />}\>
543
- Append icon </IressLink\>
544
- </IressInline\>
545
-
546
- Copy
547
-
548
- ### [](#element)Element
549
-
550
- You can use the `element` prop to render a custom component as the link. This is useful for rendering a component from a third-party library, such as `react-router-dom`.
551
-
552
- [Iress](https://iress.com)
553
-
554
- Hide code
555
-
556
- \[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; }
557
-
558
- /\*\*
559
- \* This could be the \`Link\` component from \`react-router-dom\` or any other routing library. \*/
560
- const Link \= forwardRef<
561
- HTMLAnchorElement,
562
- HTMLAttributes<HTMLAnchorElement\> & { to: string }
563
- \>(({ children, className, to, ...restProps }, ref) \=> (
564
- <div className\={className}\>
565
- <a href\={to} ref\={ref} {...restProps}\>
566
- {children}
567
- </a\>
568
- </div\>
569
- ));
570
- export const RoutingLink \= () \=> (
571
- <IressLink element\={Link} to\="https://iress.com"\>
572
- Iress </IressLink\>
573
- );
574
-
575
- Copy
576
-
577
- On this page
578
-
579
- * [Overview](#overview)
580
- * [Props](#props)
581
- * [Usage](#usage)
582
- * [When to use](#when-to-use)
583
- * [Examples](#examples)
584
- * [Loading](#loading)
585
- * [Slot props](#slot-props)
586
- * [Element](#element)