@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,828 +0,0 @@
1
- [](#slider)Slider
2
- =================
3
-
4
- Overview
5
- --------
6
-
7
- Sliders provide a visual indication of adjustable content, where the user can select a value from a range usually represented on a horizontal track.
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
- 0
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
- <IressSlider />
24
-
25
- Copy
26
-
27
- [](#props)Props
28
- ---------------
29
-
30
- | Name | Description | Default | Control |
31
- | --- | --- | --- | --- |
32
- | bg |
33
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
34
-
35
- We recommend using the following token values for best background contrast:
36
-
37
- * `colour.primary.fill` for primary backgrounds that need to stand out
38
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
39
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
40
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
41
- * `colour.system.danger.fill` for error backgrounds that need to stand out
42
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
43
- * `colour.system.success.fill` for success backgrounds that need to stand out
44
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
45
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
46
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
47
- * `colour.system.info.fill` for info backgrounds that need to stand out
48
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
49
-
50
- ResponsiveProp<ColorToken> | undefined
51
-
52
- | \- | Set object |
53
- | borderRadius |
54
-
55
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
56
-
57
- | Chrome | Firefox | Safari | Edge | IE |
58
- | --- | --- | --- | --- | --- |
59
- | **4** | **4** | **5** | **12** | **9** |
60
- | 1 _\-x-_ | | 3 _\-x-_ | | |
61
-
62
- ResponsiveProp<RadiusToken> | undefined
63
-
64
- | \- | Set object |
65
- | color |
66
-
67
- 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`.
68
-
69
- We recommend using the following token values for best color contrast:
70
-
71
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
72
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
73
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
74
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
75
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
76
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
77
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
78
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
79
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
80
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
81
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
82
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
83
-
84
- ResponsiveProp<ColorToken> | undefined
85
-
86
- | \- | Set object |
87
- | defaultValue |
88
-
89
- Initial value of the slider. Used for uncontrolled sliders.
90
-
91
- numberundefined
92
-
93
-
94
-
95
- | \- | Set object |
96
- | focusable |
97
-
98
- 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.
99
-
100
- "true""within"undefined
101
-
102
-
103
-
104
- | \- | Set object |
105
- | formatValue |
106
-
107
- Format the changed value.
108
-
109
- ((value: number, tick?: SliderTickLabelValue | undefined, readOnly?: boolean | undefined) => ReactNode) | undefined
110
-
111
- | \- | \- |
112
- | hiddenValueTooltip |
113
-
114
- If `true`, the value tooltip will be hidden.
115
-
116
- booleanundefined
117
-
118
-
119
-
120
- | \- | Set object |
121
- | hide |
122
-
123
- 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.
124
-
125
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
126
-
127
- Notes:
128
-
129
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
130
- * Consider if you can conditionally render the element instead of hiding it.
131
-
132
- ResponsiveProp<boolean> | undefined
133
-
134
- | \- | Set object |
135
- | layerStyle |
136
-
137
- 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.
138
-
139
- * `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.
140
- * `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.
141
- * `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.
142
-
143
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
144
-
145
- | \- | Set object |
146
- | m |
147
-
148
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
149
-
150
- 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.
151
-
152
- | Chrome | Firefox | Safari | Edge | IE |
153
- | --- | --- | --- | --- | --- |
154
- | **1** | **1** | **1** | **12** | **3** |
155
-
156
- ResponsiveProp<SpacingToken | "auto"> | undefined
157
-
158
- | \- | Set object |
159
- | max |
160
-
161
- Set the maximum value for the slider.
162
-
163
- numberundefined
164
-
165
-
166
-
167
- |
168
-
169
- 10
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
- | min |
197
-
198
- Sets minimum value for the slider.
199
-
200
- numberundefined
201
-
202
-
203
-
204
- |
205
-
206
- 0
207
-
208
- | Set object |
209
- | ml |
210
-
211
- 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.
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
- | mr |
223
-
224
- 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.
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
- | mt |
236
-
237
- 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.
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
- | mx |
249
-
250
- 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.
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
- | my |
262
-
263
- 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.
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
- | name |
275
-
276
- The name of the control, which is submitted with the form data.
277
-
278
- stringundefined
279
-
280
-
281
-
282
- | \- | Set object |
283
- | noGutter |
284
-
285
- 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.
286
-
287
- booleanundefined
288
-
289
-
290
-
291
- | \- | Set object |
292
- | onChange |
293
-
294
- Emitted when the slider value changes.
295
-
296
- ((e: ChangeEvent<HTMLInputElement>, value?: number | undefined) => void) | undefined
297
-
298
- | \- | \- |
299
- | p |
300
-
301
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
302
-
303
- 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.
304
-
305
- | Chrome | Firefox | Safari | Edge | IE |
306
- | --- | --- | --- | --- | --- |
307
- | **1** | **1** | **1** | **12** | **3** |
308
-
309
- 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
310
-
311
- | \- | Set object |
312
- | pb |
313
-
314
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
315
-
316
- 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.
317
-
318
- | Chrome | Firefox | Safari | Edge | IE |
319
- | --- | --- | --- | --- | --- |
320
- | **1** | **1** | **1** | **12** | **3** |
321
-
322
- 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
323
-
324
- | \- | Set object |
325
- | pl |
326
-
327
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
328
-
329
- 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.
330
-
331
- | Chrome | Firefox | Safari | Edge | IE |
332
- | --- | --- | --- | --- | --- |
333
- | **1** | **1** | **1** | **12** | **3** |
334
-
335
- 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
336
-
337
- | \- | Set object |
338
- | pr |
339
-
340
- The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
341
-
342
- 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.
343
-
344
- | Chrome | Firefox | Safari | Edge | IE |
345
- | --- | --- | --- | --- | --- |
346
- | **1** | **1** | **1** | **12** | **3** |
347
-
348
- 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
349
-
350
- | \- | Set object |
351
- | pt |
352
-
353
- The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
354
-
355
- 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.
356
-
357
- | Chrome | Firefox | Safari | Edge | IE |
358
- | --- | --- | --- | --- | --- |
359
- | **1** | **1** | **1** | **12** | **3** |
360
-
361
- 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
362
-
363
- | \- | Set object |
364
- | px |
365
-
366
- 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.
367
-
368
- 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.
369
-
370
- | Chrome | Firefox | Safari | Edge | IE |
371
- | --- | --- | --- | --- | --- |
372
- | **1** | **1** | **1** | **12** | **3** |
373
-
374
- 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
375
-
376
- | \- | Set object |
377
- | py |
378
-
379
- 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.
380
-
381
- 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.
382
-
383
- | Chrome | Firefox | Safari | Edge | IE |
384
- | --- | --- | --- | --- | --- |
385
- | **1** | **1** | **1** | **12** | **3** |
386
-
387
- 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
388
-
389
- | \- | Set object |
390
- | readOnly |
391
-
392
- If `true`, the user cannot modify the value.
393
-
394
- booleanundefined
395
-
396
-
397
-
398
- | \- | Set object |
399
- | rowGap |
400
-
401
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
402
-
403
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
404
-
405
- | Chrome | Firefox | Safari | Edge | IE |
406
- | --- | --- | --- | --- | --- |
407
- | **47** | **52** | **10.1** | **16** | No |
408
-
409
- 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
410
-
411
- | \- | Set object |
412
- | srOnly |
413
-
414
- 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.
415
-
416
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
417
-
418
- ResponsiveProp<boolean> | undefined
419
-
420
- | \- | Set object |
421
- | step |
422
-
423
- Sets the step value of the slider.
424
-
425
- numberundefined
426
-
427
-
428
-
429
- |
430
-
431
- 1
432
-
433
- | Set object |
434
- | stretch |
435
-
436
- 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.
437
-
438
- booleanundefined
439
-
440
-
441
-
442
- | \- | Set object |
443
- | textAlign |
444
-
445
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
446
-
447
- | Chrome | Firefox | Safari | Edge | IE |
448
- | --- | --- | --- | --- | --- |
449
- | **1** | **1** | **1** | **12** | **3** |
450
-
451
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
452
-
453
- | \- | Set object |
454
- | textStyle |
455
-
456
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
457
-
458
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
459
- * `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.
460
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
461
- * `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.
462
- * `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.
463
- * `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.
464
- * `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.
465
- * `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.
466
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
467
-
468
- 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
469
-
470
- | \- | Set object |
471
- | tickLabels |
472
-
473
- List of labels to be displayed.
474
-
475
- boolean | SliderTickLabel\[\] | undefined
476
-
477
- | \- | Set object |
478
- | value |
479
-
480
- Value of the slider. Used for controlled sliders.
481
-
482
- numberundefined
483
-
484
-
485
-
486
- | \- | Set object |
487
- | width |
488
-
489
- 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.
490
-
491
- 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.
492
-
493
- | Chrome | Firefox | Safari | Edge | IE |
494
- | --- | --- | --- | --- | --- |
495
- | **1** | **1** | **1** | **12** | **4** |
496
-
497
- 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
498
-
499
- | \- | Set object |
500
-
501
- [](#examples)Examples
502
- ---------------------
503
-
504
- ### [](#default-value)Default value
505
-
506
- You can set the initial value of the slider using the `defaultValue` prop. If you would like to use a controlled slider, use the `value` prop and sync it with your state using `onChange`.
507
-
508
- 3
509
-
510
- Hide code
511
-
512
- \[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; }
513
-
514
- <IressSlider defaultValue\={3} />
515
-
516
- Copy
517
-
518
- ### [](#min-max-and-step)Min, max and step
519
-
520
- To change the selectable values of the default slider you can change the `min`, `max` and `step` properties.
521
-
522
- For instance, if you set `min` to 10 and `max` to 100 the user is able to select any number between 10 and 100.
523
-
524
- By setting the `step` property to 10, for example, the user will only be able to select numbers in increments of ten i.e. 10, 20, 30, 40, 50, 60, 70, 80, 90, 100; as shown in the below example.
525
-
526
- 10
527
-
528
- Hide code
529
-
530
- \[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; }
531
-
532
- <IressSlider
533
- max\={100}
534
- min\={10}
535
- step\={10}
536
- />
537
-
538
- Copy
539
-
540
- ### [](#ticks-and-labels)Ticks and labels
541
-
542
- It is also possible to include ticks and labels for selectable values. This can be done by using the `tickLabels` property and providing an array of numbers and/or `TickLabel` objects.
543
-
544
- The `TickLabel` object takes value/label pairs. The value is required, however, an optional label property can be provided. If the label property is not specified, slider will display the value for the label.
545
-
546
- If you provide an array of `TickLabel` objects, the value tooltip (the one that appears above the slider's thumb) will use the label from its matching value.
547
-
548
- The `tickLabels` prop can also be set to true, in which case they will automatically be inferred from `min`, `max` and `step`.
549
-
550
- Zero
551
-
552
- Zero
553
-
554
- 20
555
-
556
- 40
557
-
558
- 60
559
-
560
- 80
561
-
562
- 100
563
-
564
- 120
565
-
566
- 140
567
-
568
- 160
569
-
570
- 180
571
-
572
- All
573
-
574
- Hide code
575
-
576
- \[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; }
577
-
578
- <IressSlider
579
- max\={200}
580
- min\={0}
581
- step\={20}
582
- tickLabels\={\[
583
- {
584
- label: 'Zero',
585
- value: 0
586
- },
587
- {
588
- value: 20
589
- },
590
- {
591
- value: 40
592
- },
593
- {
594
- value: 60
595
- },
596
- {
597
- value: 80
598
- },
599
- {
600
- value: 100
601
- },
602
- {
603
- value: 120
604
- },
605
- {
606
- value: 140
607
- },
608
- {
609
- value: 160
610
- },
611
- {
612
- value: 180
613
- },
614
- {
615
- label: 'All',
616
- value: 200
617
- }
618
- \]}
619
- />
620
-
621
- Copy
622
-
623
- ### [](#flexible-ticks-and-labels)Flexible ticks and labels
624
-
625
- As of version 5, `min`, `max` and `step` is no longer automatically inferred from `tickLabels`, allowing you to have more flexible `tickLabels`.
626
-
627
- You can also use the `formatValue` prop to provide a formatted node to replace the value tooltip.
628
-
629
- \-10°C
630
-
631
- 0°C
632
- Hypothermia
633
-
634
- 37°C
635
- Normal
636
-
637
- 45°C
638
- Wicked witch
639
- of the west
640
-
641
- Hide code
642
-
643
- \[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; }
644
-
645
- <IressSlider
646
- min\={\-10}
647
- max\={50}
648
- formatValue\={(value) \=> \`${value}°C\`}
649
- tickLabels\={\[
650
- { value: 0, label: <\>0°C <br />Hypothermia</\> },
651
- { value: 37, label: <\>37°C <br />Normal</\> },
652
- { value: 45, label: <\>45°C <br />Wicked witch<br />of the west</\> },
653
- \]}
654
- />
655
-
656
- Copy
657
-
658
- ### [](#hidden-labels)Hidden labels
659
-
660
- Specific labels can be hidden for all or specified breakpoints. This can be done by using the `srOnly` property in the `TickLabel` object.
661
-
662
- When a label is set to hide on a certain breakpoint, it will be hidden on the screen from that breakpoint onwards. You can reveal it on a larger breakpoint by setting the larger breakpoint to false.
663
-
664
- 1. To set the label to hide on all breakpoints you can set the xs property to true: `srOnly: { xs: true }`.
665
- 2. To only show on md and above you can `srOnly: { xs: true, md: false }`.
666
-
667
- #### [](#behavior-considerations)Behavior considerations
668
-
669
- * The labels will always be available to screen readers to ensure best accessibility, as screen readers are not confined by screen space.
670
- * The `ticksAndLabels` prop will still be used to match the `value` of the slider, even if its been set to be hidden on the user's screen.
671
-
672
- **xl** breakpoint (1200px - 1499px)
673
-
674
- Zero
675
-
676
- Zero
677
-
678
- 20
679
-
680
- 40
681
-
682
- 60
683
-
684
- 80
685
-
686
- 100
687
-
688
- 120
689
-
690
- 140
691
-
692
- 160
693
-
694
- 180
695
-
696
- All
697
-
698
- Hide code
699
-
700
- \[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; }
701
-
702
- <IressStack gap\="md"\>
703
- <IressPanel bg\="alt"\>
704
- <IressText\>
705
- <CurrentBreakpoint />
706
- </IressText\>
707
- </IressPanel\>
708
- <IressSlider
709
- max\={200}
710
- min\={0}
711
- step\={20}
712
- tickLabels\={\[
713
- {
714
- label: 'Zero',
715
- value: 0
716
- },
717
- {
718
- srOnly: {
719
- base: true,
720
- xl: false
721
- },
722
- value: 20
723
- },
724
- {
725
- srOnly: {
726
- base: true,
727
- xl: false
728
- },
729
- value: 40
730
- },
731
- {
732
- srOnly: {
733
- base: true,
734
- xl: false
735
- },
736
- value: 60
737
- },
738
- {
739
- srOnly: {
740
- base: true,
741
- xl: false
742
- },
743
- value: 80
744
- },
745
- {
746
- value: 100
747
- },
748
- {
749
- srOnly: {
750
- base: true,
751
- xl: false
752
- },
753
- value: 120
754
- },
755
- {
756
- srOnly: {
757
- base: true,
758
- xl: false
759
- },
760
- value: 140
761
- },
762
- {
763
- srOnly: {
764
- base: true,
765
- xl: false
766
- },
767
- value: 160
768
- },
769
- {
770
- srOnly: {
771
- base: true,
772
- xl: false
773
- },
774
- value: 180
775
- },
776
- {
777
- label: 'All',
778
- value: 200
779
- }
780
- \]}
781
- />
782
- </IressStack\>
783
-
784
- Copy
785
-
786
- ### [](#read-only)Read only
787
-
788
- Sliders can be set to read only by using the `readOnly` property. When set to read only the slider will render a read only input and display the specified value.
789
-
790
- If you need more control over the read-only state (for example, rendering a stylised version of the value), you can use the [`IressReadonly` component](?path=/docs/components-readonly--docs).
791
-
792
- Zero
793
-
794
- Hide code
795
-
796
- \[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; }
797
-
798
- <IressSlider
799
- max\={200}
800
- min\={0}
801
- readOnly
802
- step\={20}
803
- tickLabels\={\[
804
- {
805
- label: 'Zero',
806
- value: 0
807
- },
808
- {
809
- label: 'All',
810
- value: 200
811
- }
812
- \]}
813
- value\={0}
814
- />
815
-
816
- Copy
817
-
818
- On this page
819
-
820
- * [Overview](#overview)
821
- * [Props](#props)
822
- * [Examples](#examples)
823
- * [Default value](#default-value)
824
- * [Min, max and step](#min-max-and-step)
825
- * [Ticks and labels](#ticks-and-labels)
826
- * [Flexible ticks and labels](#flexible-ticks-and-labels)
827
- * [Hidden labels](#hidden-labels)
828
- * [Read only](#read-only)