@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,597 +0,0 @@
1
- [](#skeleton)Skeleton
2
- =====================
3
-
4
- Overview
5
- --------
6
-
7
- Skeletons can increase perceived performance for users. As opposed to spinners, skeletons make it feel as though things are happening/loading immediately, then the information is incrementally displayed on the screen.
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
- Hide code
18
-
19
- \[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; }
20
-
21
- <IressSkeleton />
22
-
23
- Copy
24
-
25
- [](#props)Props
26
- ---------------
27
-
28
- | Name | Description | Default | Control |
29
- | --- | --- | --- | --- |
30
- | bg |
31
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
32
-
33
- We recommend using the following token values for best background contrast:
34
-
35
- * `colour.primary.fill` for primary backgrounds that need to stand out
36
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
37
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
38
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
39
- * `colour.system.danger.fill` for error backgrounds that need to stand out
40
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
41
- * `colour.system.success.fill` for success backgrounds that need to stand out
42
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
43
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
44
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
45
- * `colour.system.info.fill` for info backgrounds that need to stand out
46
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
47
-
48
- ResponsiveProp<ColorToken> | undefined
49
-
50
- | \- | Set object |
51
- | borderRadius |
52
-
53
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
54
-
55
- | Chrome | Firefox | Safari | Edge | IE |
56
- | --- | --- | --- | --- | --- |
57
- | **4** | **4** | **5** | **12** | **9** |
58
- | 1 _\-x-_ | | 3 _\-x-_ | | |
59
-
60
- ResponsiveProp<RadiusToken> | undefined
61
-
62
- | \- | Set object |
63
- | color |
64
-
65
- 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`.
66
-
67
- We recommend using the following token values for best color contrast:
68
-
69
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
70
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
71
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
72
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
73
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
74
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
75
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
76
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
77
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
78
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
79
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
80
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
81
-
82
- ResponsiveProp<ColorToken> | undefined
83
-
84
- | \- | Set object |
85
- | focusable |
86
-
87
- 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.
88
-
89
- "true""within"undefined
90
-
91
-
92
-
93
- | \- | Set object |
94
- | height |
95
-
96
- Sets the height of the skeleton bones. If no unit is specified it will default to pixels. Not allowed when in `text` mode.
97
-
98
- stringundefined
99
-
100
-
101
-
102
- | \- | Set object |
103
- | hide |
104
-
105
- 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.
106
-
107
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
108
-
109
- Notes:
110
-
111
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
112
- * Consider if you can conditionally render the element instead of hiding it.
113
-
114
- ResponsiveProp<boolean> | undefined
115
-
116
- | \- | Set object |
117
- | layerStyle |
118
-
119
- 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.
120
-
121
- * `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.
122
- * `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.
123
- * `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.
124
-
125
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
126
-
127
- | \- | Set object |
128
- | m |
129
-
130
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
131
-
132
- 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.
133
-
134
- | Chrome | Firefox | Safari | Edge | IE |
135
- | --- | --- | --- | --- | --- |
136
- | **1** | **1** | **1** | **12** | **3** |
137
-
138
- ResponsiveProp<SpacingToken | "auto"> | undefined
139
-
140
- | \- | Set object |
141
- | maxWidth |
142
-
143
- 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`.
144
-
145
- | Chrome | Firefox | Safari | Edge | IE |
146
- | --- | --- | --- | --- | --- |
147
- | **1** | **1** | **1** | **12** | **7** |
148
-
149
- 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
150
-
151
- | \- | Set object |
152
- | mb |
153
-
154
- 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.
155
-
156
- It uses the spacing tokens in the design system.
157
-
158
- | Chrome | Firefox | Safari | Edge | IE |
159
- | --- | --- | --- | --- | --- |
160
- | **1** | **1** | **1** | **12** | **3** |
161
-
162
- ResponsiveProp<SpacingToken | "auto"> | undefined
163
-
164
- | \- | Set object |
165
- | ml |
166
-
167
- 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.
168
-
169
- It uses the spacing tokens in the design system.
170
-
171
- | Chrome | Firefox | Safari | Edge | IE |
172
- | --- | --- | --- | --- | --- |
173
- | **1** | **1** | **1** | **12** | **3** |
174
-
175
- ResponsiveProp<SpacingToken | "auto"> | undefined
176
-
177
- | \- | Set object |
178
- | mode |
179
-
180
- Mode of the skeleton. `rect` and `circle` must have `width` and `height` specified. `text` works with `textStyle`.
181
-
182
- SkeletonModeundefined
183
-
184
-
185
-
186
- |
187
-
188
- text
189
-
190
- | Set object |
191
- | mr |
192
-
193
- 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.
194
-
195
- It uses the spacing tokens in the design system.
196
-
197
- | Chrome | Firefox | Safari | Edge | IE |
198
- | --- | --- | --- | --- | --- |
199
- | **1** | **1** | **1** | **12** | **3** |
200
-
201
- ResponsiveProp<SpacingToken | "auto"> | undefined
202
-
203
- | \- | Set object |
204
- | mt |
205
-
206
- 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.
207
-
208
- It uses the spacing tokens in the design system.
209
-
210
- | Chrome | Firefox | Safari | Edge | IE |
211
- | --- | --- | --- | --- | --- |
212
- | **1** | **1** | **1** | **12** | **3** |
213
-
214
- ResponsiveProp<SpacingToken | "auto"> | undefined
215
-
216
- | \- | Set object |
217
- | mx |
218
-
219
- 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.
220
-
221
- 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.
222
-
223
- | Chrome | Firefox | Safari | Edge | IE |
224
- | --- | --- | --- | --- | --- |
225
- | **1** | **1** | **1** | **12** | **3** |
226
-
227
- ResponsiveProp<SpacingToken | "auto"> | undefined
228
-
229
- | \- | Set object |
230
- | my |
231
-
232
- 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.
233
-
234
- 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.
235
-
236
- | Chrome | Firefox | Safari | Edge | IE |
237
- | --- | --- | --- | --- | --- |
238
- | **1** | **1** | **1** | **12** | **3** |
239
-
240
- ResponsiveProp<SpacingToken | "auto"> | undefined
241
-
242
- | \- | Set object |
243
- | noGutter |
244
-
245
- 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.
246
-
247
- booleanundefined
248
-
249
-
250
-
251
- | \- | Set object |
252
- | p |
253
-
254
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
255
-
256
- 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.
257
-
258
- | Chrome | Firefox | Safari | Edge | IE |
259
- | --- | --- | --- | --- | --- |
260
- | **1** | **1** | **1** | **12** | **3** |
261
-
262
- 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
263
-
264
- | \- | Set object |
265
- | pb |
266
-
267
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
268
-
269
- 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.
270
-
271
- | Chrome | Firefox | Safari | Edge | IE |
272
- | --- | --- | --- | --- | --- |
273
- | **1** | **1** | **1** | **12** | **3** |
274
-
275
- 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
276
-
277
- | \- | Set object |
278
- | pl |
279
-
280
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
281
-
282
- 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.
283
-
284
- | Chrome | Firefox | Safari | Edge | IE |
285
- | --- | --- | --- | --- | --- |
286
- | **1** | **1** | **1** | **12** | **3** |
287
-
288
- 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
289
-
290
- | \- | Set object |
291
- | pr |
292
-
293
- The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
294
-
295
- 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.
296
-
297
- | Chrome | Firefox | Safari | Edge | IE |
298
- | --- | --- | --- | --- | --- |
299
- | **1** | **1** | **1** | **12** | **3** |
300
-
301
- 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
302
-
303
- | \- | Set object |
304
- | pt |
305
-
306
- The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
307
-
308
- 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.
309
-
310
- | Chrome | Firefox | Safari | Edge | IE |
311
- | --- | --- | --- | --- | --- |
312
- | **1** | **1** | **1** | **12** | **3** |
313
-
314
- 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
315
-
316
- | \- | Set object |
317
- | px |
318
-
319
- 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.
320
-
321
- 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.
322
-
323
- | Chrome | Firefox | Safari | Edge | IE |
324
- | --- | --- | --- | --- | --- |
325
- | **1** | **1** | **1** | **12** | **3** |
326
-
327
- 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
328
-
329
- | \- | Set object |
330
- | py |
331
-
332
- 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.
333
-
334
- 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.
335
-
336
- | Chrome | Firefox | Safari | Edge | IE |
337
- | --- | --- | --- | --- | --- |
338
- | **1** | **1** | **1** | **12** | **3** |
339
-
340
- 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
341
-
342
- | \- | Set object |
343
- | rowGap |
344
-
345
- The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
346
-
347
- Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
348
-
349
- | Chrome | Firefox | Safari | Edge | IE |
350
- | --- | --- | --- | --- | --- |
351
- | **47** | **52** | **10.1** | **16** | No |
352
-
353
- 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
354
-
355
- | \- | Set object |
356
- | srOnly |
357
-
358
- 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.
359
-
360
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
361
-
362
- ResponsiveProp<boolean> | undefined
363
-
364
- | \- | Set object |
365
- | stretch |
366
-
367
- 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.
368
-
369
- booleanundefined
370
-
371
-
372
-
373
- | \- | Set object |
374
- | textAlign |
375
-
376
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
377
-
378
- | Chrome | Firefox | Safari | Edge | IE |
379
- | --- | --- | --- | --- | --- |
380
- | **1** | **1** | **1** | **12** | **3** |
381
-
382
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
383
-
384
- | \- | Set object |
385
- | textStyle |
386
-
387
- Use `textStyle` to specify what the Skeleton should emulate. If set to `h1` a non-break space with the same font-size and line-height of a h1 will be rendered.
388
-
389
- 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
390
-
391
- | \- | Set object |
392
- | width |
393
-
394
- Sets the width of the skeleton bones. If no unit is specified it will default to pixels.
395
-
396
- stringundefined
397
-
398
-
399
-
400
- | \- | Set object |
401
-
402
- [](#examples)Examples
403
- ---------------------
404
-
405
- ### [](#modes)Modes
406
-
407
- The `mode` prop can be set to `text` (default), `rect` or `circle`.
408
-
409
- Hide code
410
-
411
- \[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; }
412
-
413
- <IressStack gap\="md"\>
414
- <IressSkeleton mode\="text" />
415
- <IressSkeleton
416
- height\="100px"
417
- mode\="rect"
418
- />
419
- <IressSkeleton
420
- height\="100px"
421
- mode\="circle"
422
- width\="100px"
423
- />
424
- </IressStack\>
425
-
426
- Copy
427
-
428
- ### [](#text)Text
429
-
430
- `text` mode allows you to use `IressSkeleton` in place of `IressText` and keep the same sizing. To achieve this you can use `text` mode in conjunction with the `textVariant` prop.
431
-
432
- `text` also accepts the width prop but does not use the `height` prop like other modes. The height is achieved through font size and line height.
433
-
434
- Toggle load
435
-
436
- Hide code
437
-
438
- \[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; }
439
-
440
- import { useState } from 'react';
441
- import {
442
- IressButton,
443
- IressSkeleton,
444
- IressSkeletonProps,
445
- IressStack,
446
- IressText,
447
- } from '@iress-oss/ids-components';
448
- import { TEXT\_STYLES } from '@theme-preset/tokens/textStyles';
449
- export const SkeletonText \= () \=> {
450
- const \[loading, setLoading\] \= useState(true);
451
- return (
452
- <IressStack gap\="md"\>
453
- <IressButton onClick\={() \=> setLoading(!loading)}\>
454
- Toggle load </IressButton\>
455
- <IressStack gap\="md"\>
456
- {TEXT\_STYLES.map((textStyle) \=> \[
457
- loading && <IressSkeleton {...{
458
- mode: 'text',
459
- }} textStyle\={textStyle} />,
460
- !loading && <IressText textStyle\={textStyle}\>{textStyle}</IressText\>,
461
- \])}
462
- </IressStack\>
463
- </IressStack\>
464
- );
465
- };
466
-
467
- Copy
468
-
469
- ### [](#rect)Rect
470
-
471
- `rect` mode allows you to use `IressSkeleton` in place of block elements, a good example would be in place of images.
472
-
473
- `rect` accepts both `width` and `height` props for sizing. It will default to 100% width and 100px height.
474
-
475
- Toggle load
476
-
477
- Hide code
478
-
479
- \[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; }
480
-
481
- import { useState } from 'react';
482
- import {
483
- IressButton,
484
- IressPlaceholder,
485
- IressSkeleton,
486
- IressSkeletonProps,
487
- IressStack,
488
- } from '@iress-oss/ids-components';
489
- export const SkeletonRect \= (<'rect'\>) \=> {
490
- const \[loading, setLoading\] \= useState(true);
491
- return (
492
- <IressStack gap\="md"\>
493
- <IressButton onClick\={() \=> setLoading(!loading)}\>
494
- Toggle load </IressButton\>
495
- {loading && <IressSkeleton {...{
496
- mode: 'rect',
497
- width: '250',
498
- height: '150',
499
- }} />}
500
- {!loading && <IressPlaceholder {...{
501
- mode: 'rect',
502
- width: '250',
503
- height: '150',
504
- }}\>Image</IressPlaceholder\>}
505
- </IressStack\>
506
- );
507
- };
508
-
509
- Copy
510
-
511
- ### [](#circle)Circle
512
-
513
- `circle` mode allows you to use `IressSkeleton` in place of circular elements, a good example would be for profile images.
514
-
515
- `circle` accepts both `width` and `height` props for sizing. It will default to 100% width and 100px height.
516
-
517
- Toggle load
518
-
519
- Hide code
520
-
521
- \[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; }
522
-
523
- import { useState } from 'react';
524
- import {
525
- IressButton,
526
- IressPlaceholder,
527
- IressSkeleton,
528
- IressSkeletonProps,
529
- IressStack,
530
- } from '@iress-oss/ids-components';
531
- export const SkeletonCircle \= (<'circle'\>) \=> {
532
- const \[loading, setLoading\] \= useState(true);
533
- return (
534
- <IressStack gap\="md"\>
535
- <IressButton onClick\={() \=> setLoading(!loading)}\>
536
- Toggle load </IressButton\>
537
- {loading && <IressSkeleton {...{
538
- mode: 'circle',
539
- width: '150',
540
- height: '150',
541
- }} />}
542
- {!loading && (
543
- <IressPlaceholder {...{
544
- mode: 'circle',
545
- width: '150',
546
- height: '150',
547
- }} style\={{ borderRadius: '50%' }}\>
548
- Image </IressPlaceholder\>
549
- )}
550
- </IressStack\>
551
- );
552
- };
553
-
554
- Copy
555
-
556
- ### [](#size)Size
557
-
558
- `width` and `height` props can be used to match the layout of the loaded content.
559
-
560
- These props accept any unit of dimension, but if no unit is provided it will default to pixels.
561
-
562
- **Note:** `height` will be ignored for text mode as this is calculated using the `IressText` component.
563
-
564
- Hide code
565
-
566
- \[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; }
567
-
568
- <IressInline gap\="md"\>
569
- <IressSkeleton
570
- height\="150"
571
- mode\="rect"
572
- width\="150"
573
- />
574
- <IressSkeleton
575
- height\="150"
576
- mode\="circle"
577
- width\="150"
578
- />
579
- <IressSkeleton
580
- height\="150"
581
- mode\="text"
582
- width\="150"
583
- />
584
- </IressInline\>
585
-
586
- Copy
587
-
588
- On this page
589
-
590
- * [Overview](#overview)
591
- * [Props](#props)
592
- * [Examples](#examples)
593
- * [Modes](#modes)
594
- * [Text](#text)
595
- * [Rect](#rect)
596
- * [Circle](#circle)
597
- * [Size](#size)
@@ -1,76 +0,0 @@
1
- [](#recipes)Recipes
2
- ===================
3
-
4
- [](#iresscard)`IressCard`
5
- -------------------------
6
-
7
- A common use case of the skeleton component is within a card component. Below are some examples of how you might use `IressSkeleton` within `IressCard`.
8
-
9
- Toggle load
10
-
11
- Hide code
12
-
13
- \[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; }
14
-
15
- import { useState } from 'react';
16
- import {
17
- IressButton,
18
- IressCard,
19
- IressSkeleton,
20
- IressStack,
21
- IressText,
22
- } from '@iress-oss/ids-components';
23
- const CARD\_LINE\_SIZES \= \['100%', '91%', '95%', '89%', '83%'\];
24
- const CardLoading \= () \=> (
25
- <IressCard
26
- heading\={<IressSkeleton textStyle\="typography.heading.4" width\="75%" />}
27
- media\={<IressSkeleton mode\="rect" height\="200" />}
28
- stretch
29
- \>
30
- <IressStack gap\="md"\>
31
- <IressStack gap\="xs"\>
32
- {CARD\_LINE\_SIZES.map((size) \=> (
33
- <IressSkeleton key\={\`${size}\-1\`} width\={size} />
34
- ))}
35
- </IressStack\>
36
- <IressStack gap\="xs"\>
37
- {CARD\_LINE\_SIZES.map((size) \=> (
38
- <IressSkeleton key\={\`${size}\-2\`} width\={size} />
39
- ))}
40
- </IressStack\>
41
- </IressStack\>
42
- </IressCard\>
43
- );
44
- const CardItem \= () \=> (
45
- <IressCard
46
- heading\={<h4\>This is the card heading</h4\>}
47
- media\={
48
- <img
49
- src\="https://www.iress.com/media/images/media-contact.width-600.png"
50
- alt\=""
51
- />
52
- }
53
- \>
54
- <IressText element\="p"\>
55
- Non cupiditate, libero ex, voluptates ea ipsum deleniti sequi sed eveniet ab enim sunt itaque qui ullam, adipisci quo expedita laboriosam deserunt? </IressText\>
56
- <IressText element\="p"\>
57
- Impedit, quasi voluptas quae quibusdam officiis corporis. Distinctio et aspernatur quo atque non enim, recusandae at, eum dicta ullam commodi modi debitis. </IressText\>
58
- </IressCard\>
59
- );
60
- export const SkeletonCard \= () \=> {
61
- const \[loading, setLoading\] \= useState(true);
62
- return (
63
- <IressStack gap\="md"\>
64
- <IressButton onClick\={() \=> setLoading(!loading)}\>
65
- Toggle load </IressButton\>
66
- {loading && <CardLoading />}
67
- {!loading && <CardItem />}
68
- </IressStack\>
69
- );
70
- };
71
-
72
- Copy
73
-
74
- On this page
75
-
76
- * [IressCard](#iresscard)