@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,614 +0,0 @@
1
- [](#toggle)Toggle
2
- =================
3
-
4
- Overview
5
- --------
6
-
7
- Toggles allow users to turn things on or off. When toggled, the associated change happens straight away.
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
- Toggle
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
- <IressToggle
24
- layout\="inline"
25
- \>
26
- Toggle
27
- </IressToggle\>
28
-
29
- Copy
30
-
31
- [](#props)Props
32
- ---------------
33
-
34
- | Name | Description | Default | Control |
35
- | --- | --- | --- | --- |
36
- | bg |
37
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
38
-
39
- We recommend using the following token values for best background contrast:
40
-
41
- * `colour.primary.fill` for primary backgrounds that need to stand out
42
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
43
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
44
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
45
- * `colour.system.danger.fill` for error backgrounds that need to stand out
46
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
47
- * `colour.system.success.fill` for success backgrounds that need to stand out
48
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
49
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
50
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
51
- * `colour.system.info.fill` for info backgrounds that need to stand out
52
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
53
-
54
- ResponsiveProp<ColorToken> | undefined
55
-
56
- | \- | Set object |
57
- | borderRadius |
58
-
59
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
60
-
61
- | Chrome | Firefox | Safari | Edge | IE |
62
- | --- | --- | --- | --- | --- |
63
- | **4** | **4** | **5** | **12** | **9** |
64
- | 1 _\-x-_ | | 3 _\-x-_ | | |
65
-
66
- ResponsiveProp<RadiusToken> | undefined
67
-
68
- | \- | Set object |
69
- | checked |
70
-
71
- Sets the checked state of the Toggle.
72
-
73
- booleanundefined
74
-
75
-
76
-
77
- |
78
-
79
- false
80
-
81
- |
82
-
83
- false
84
-
85
- |
86
- | children\* |
87
-
88
- Provides the label for the Toggle.
89
-
90
- ReactNode
91
-
92
-
93
-
94
- | \- |
95
-
96
- "Toggle"
97
-
98
- |
99
- | color |
100
-
101
- 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`.
102
-
103
- We recommend using the following token values for best color contrast:
104
-
105
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
106
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
107
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
108
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
109
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
110
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
111
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
112
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
113
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
114
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
115
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
116
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
117
-
118
- ResponsiveProp<ColorToken> | undefined
119
-
120
- | \- | Set object |
121
- | focusable |
122
-
123
- 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.
124
-
125
- "true""within"undefined
126
-
127
-
128
-
129
- | \- | Set object |
130
- | hiddenLabel |
131
-
132
- Hides the label if true (label will still be read out by screen readers).
133
-
134
- booleanundefined
135
-
136
-
137
-
138
- | \- |
139
-
140
- false
141
-
142
- |
143
- | hide |
144
-
145
- 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.
146
-
147
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
148
-
149
- Notes:
150
-
151
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
152
- * Consider if you can conditionally render the element instead of hiding it.
153
-
154
- ResponsiveProp<boolean> | undefined
155
-
156
- | \- | Set object |
157
- | layerStyle |
158
-
159
- 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.
160
-
161
- * `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.
162
- * `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.
163
- * `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.
164
-
165
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
166
-
167
- | \- | Set object |
168
- | layout |
169
-
170
- Determines the layout of the label with respect to the control.
171
-
172
- "inline""stack""inline-between""inline-reverse"undefined
173
-
174
-
175
-
176
- |
177
-
178
- inline
179
-
180
- |
181
-
182
- "inline"
183
-
184
- |
185
- | m |
186
-
187
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
188
-
189
- 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.
190
-
191
- | Chrome | Firefox | Safari | Edge | IE |
192
- | --- | --- | --- | --- | --- |
193
- | **1** | **1** | **1** | **12** | **3** |
194
-
195
- ResponsiveProp<SpacingToken | "auto"> | undefined
196
-
197
- | \- | Set object |
198
- | maxWidth |
199
-
200
- 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`.
201
-
202
- | Chrome | Firefox | Safari | Edge | IE |
203
- | --- | --- | --- | --- | --- |
204
- | **1** | **1** | **1** | **12** | **7** |
205
-
206
- 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
207
-
208
- | \- | Set object |
209
- | mb |
210
-
211
- 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.
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
- | ml |
223
-
224
- 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.
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
- | mr |
236
-
237
- 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.
238
-
239
- It uses the spacing tokens in the design system.
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
- | mt |
249
-
250
- 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.
251
-
252
- It uses the spacing tokens in the design system.
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
- | mx |
262
-
263
- 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.
264
-
265
- 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.
266
-
267
- | Chrome | Firefox | Safari | Edge | IE |
268
- | --- | --- | --- | --- | --- |
269
- | **1** | **1** | **1** | **12** | **3** |
270
-
271
- ResponsiveProp<SpacingToken | "auto"> | undefined
272
-
273
- | \- | Set object |
274
- | my |
275
-
276
- 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.
277
-
278
- 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.
279
-
280
- | Chrome | Firefox | Safari | Edge | IE |
281
- | --- | --- | --- | --- | --- |
282
- | **1** | **1** | **1** | **12** | **3** |
283
-
284
- ResponsiveProp<SpacingToken | "auto"> | undefined
285
-
286
- | \- | Set object |
287
- | noGutter |
288
-
289
- 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.
290
-
291
- booleanundefined
292
-
293
-
294
-
295
- | \- | Set object |
296
- | onChange |
297
-
298
- Emitted when the checked state changes.
299
-
300
- ((checked: boolean, event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) | undefined
301
-
302
- | \- | \- |
303
- | p |
304
-
305
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
306
-
307
- 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.
308
-
309
- | Chrome | Firefox | Safari | Edge | IE |
310
- | --- | --- | --- | --- | --- |
311
- | **1** | **1** | **1** | **12** | **3** |
312
-
313
- 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
314
-
315
- | \- | Set object |
316
- | pb |
317
-
318
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
319
-
320
- 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.
321
-
322
- | Chrome | Firefox | Safari | Edge | IE |
323
- | --- | --- | --- | --- | --- |
324
- | **1** | **1** | **1** | **12** | **3** |
325
-
326
- 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
327
-
328
- | \- | Set object |
329
- | pl |
330
-
331
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
332
-
333
- 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.
334
-
335
- | Chrome | Firefox | Safari | Edge | IE |
336
- | --- | --- | --- | --- | --- |
337
- | **1** | **1** | **1** | **12** | **3** |
338
-
339
- 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
340
-
341
- | \- | Set object |
342
- | pr |
343
-
344
- The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
345
-
346
- 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.
347
-
348
- | Chrome | Firefox | Safari | Edge | IE |
349
- | --- | --- | --- | --- | --- |
350
- | **1** | **1** | **1** | **12** | **3** |
351
-
352
- 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
353
-
354
- | \- | Set object |
355
- | pt |
356
-
357
- The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
358
-
359
- 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.
360
-
361
- | Chrome | Firefox | Safari | Edge | IE |
362
- | --- | --- | --- | --- | --- |
363
- | **1** | **1** | **1** | **12** | **3** |
364
-
365
- 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
366
-
367
- | \- | Set object |
368
- | px |
369
-
370
- 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.
371
-
372
- 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.
373
-
374
- | Chrome | Firefox | Safari | Edge | IE |
375
- | --- | --- | --- | --- | --- |
376
- | **1** | **1** | **1** | **12** | **3** |
377
-
378
- 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
379
-
380
- | \- | Set object |
381
- | py |
382
-
383
- 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.
384
-
385
- 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.
386
-
387
- | Chrome | Firefox | Safari | Edge | IE |
388
- | --- | --- | --- | --- | --- |
389
- | **1** | **1** | **1** | **12** | **3** |
390
-
391
- 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
392
-
393
- | \- | Set object |
394
- | rowGap |
395
-
396
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
397
-
398
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
399
-
400
- | Chrome | Firefox | Safari | Edge | IE |
401
- | --- | --- | --- | --- | --- |
402
- | **47** | **52** | **10.1** | **16** | No |
403
-
404
- 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
405
-
406
- | \- | Set object |
407
- | srOnly |
408
-
409
- 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.
410
-
411
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
412
-
413
- ResponsiveProp<boolean> | undefined
414
-
415
- | \- | Set object |
416
- | stretch |
417
-
418
- 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.
419
-
420
- booleanundefined
421
-
422
-
423
-
424
- | \- | Set object |
425
- | textAlign |
426
-
427
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
428
-
429
- | Chrome | Firefox | Safari | Edge | IE |
430
- | --- | --- | --- | --- | --- |
431
- | **1** | **1** | **1** | **12** | **3** |
432
-
433
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
434
-
435
- | \- | Set object |
436
- | textStyle |
437
-
438
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
439
-
440
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
441
- * `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.
442
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
443
- * `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.
444
- * `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.
445
- * `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.
446
- * `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.
447
- * `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.
448
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
449
-
450
- 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
451
-
452
- | \- | Set object |
453
- | width |
454
-
455
- 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.
456
-
457
- 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.
458
-
459
- | Chrome | Firefox | Safari | Edge | IE |
460
- | --- | --- | --- | --- | --- |
461
- | **1** | **1** | **1** | **12** | **4** |
462
-
463
- 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
464
-
465
- | \- | Set object |
466
-
467
- [](#usage)Usage
468
- ---------------
469
-
470
- Toggles are typically on / off switches, similar to a household light switch. They allow users to choose between two mutually exclusive options, and will always have a default value.
471
-
472
- The `IressToggle` component should only be used for actions that happen immediately, for example switching a device's WiFi connection on or off.
473
-
474
- Don't use Toggles in forms
475
- --------------------------
476
-
477
- Toggles shouldn’t be used as part of a form as they don’t have the correct semantics, and won’t submit a value when the form data is submitted. If you need a toggleable component in a form, use a checkbox or radio group instead.
478
-
479
- ### [](#labels)Labels
480
-
481
- Toggles should always have a label, which is set via its `children`.
482
-
483
- Toggle
484
-
485
- Hide code
486
-
487
- \[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; }
488
-
489
- <IressToggle
490
- layout\="inline"
491
- \>
492
- Toggle
493
- </IressToggle\>
494
-
495
- Copy
496
-
497
- ### [](#hidden-labels)Hidden labels
498
-
499
- Labels can be hidden via the `hiddenLabel` prop; this will hide the label from view, but it'll still be available to screen reader users.
500
-
501
- Toggle
502
-
503
- Hide code
504
-
505
- \[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; }
506
-
507
- <IressToggle
508
- hiddenLabel
509
- layout\="inline"
510
- \>
511
- Toggle
512
- </IressToggle\>
513
-
514
- Copy
515
-
516
- ### [](#checked)Checked
517
-
518
- The on / off state of the toggle can be controlled by setting the `checked` prop.
519
-
520
- Toggle
521
-
522
- Hide code
523
-
524
- \[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; }
525
-
526
- <IressToggle
527
- checked
528
- layout\="inline"
529
- \>
530
- Toggle
531
- </IressToggle\>
532
-
533
- Copy
534
-
535
- ### [](#layout)Layout
536
-
537
- The `layout` prop allows you to control the position of the label in relation to the control. The default layout is `inline`, but you can also choose the following options:',
538
-
539
- * `inline-between` similar to inline, but this positions the label and control at opposite ends of their container
540
- * `inline-reverse` renders the label after the control instead of before the control
541
- * `stack` positions the label above the control
542
-
543
- ### inline
544
-
545
- Toggle
546
-
547
- ### inline-between
548
-
549
- Toggle
550
-
551
- ### inline-reverse
552
-
553
- Toggle
554
-
555
- ### stack
556
-
557
- Toggle
558
-
559
- Hide code
560
-
561
- \[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; }
562
-
563
- <IressStack gap\="lg"\>
564
- <IressText\>
565
- <h3\>
566
- inline </h3\>
567
- <IressPanel bg\="alt"\>
568
- <IressToggle layout\="inline"\>
569
- Toggle </IressToggle\>
570
- </IressPanel\>
571
- </IressText\>
572
- <IressText\>
573
- <h3\>
574
- inline-between </h3\>
575
- <IressPanel bg\="alt"\>
576
- <IressToggle
577
- checked
578
- layout\="inline-between"
579
- \>
580
- Toggle </IressToggle\>
581
- </IressPanel\>
582
- </IressText\>
583
- <IressText\>
584
- <h3\>
585
- inline-reverse </h3\>
586
- <IressPanel bg\="alt"\>
587
- <IressToggle layout\="inline-reverse"\>
588
- Toggle </IressToggle\>
589
- </IressPanel\>
590
- </IressText\>
591
- <IressText\>
592
- <h3\>
593
- stack </h3\>
594
- <IressPanel bg\="alt"\>
595
- <IressToggle
596
- checked
597
- layout\="stack"
598
- \>
599
- Toggle </IressToggle\>
600
- </IressPanel\>
601
- </IressText\>
602
- </IressStack\>
603
-
604
- Copy
605
-
606
- On this page
607
-
608
- * [Overview](#overview)
609
- * [Props](#props)
610
- * [Usage](#usage)
611
- * [Labels](#labels)
612
- * [Hidden labels](#hidden-labels)
613
- * [Checked](#checked)
614
- * [Layout](#layout)