@iress-oss/ids-mcp-server 5.15.0 → 5.20.1
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.
- package/generated/docs/components_components-alert-docs.md +492 -0
- package/generated/docs/components_components-autocomplete-docs.md +3485 -0
- package/generated/docs/{components-autocomplete-recipes-docs.md → components_components-autocomplete-recipes-docs.md} +32 -14
- package/generated/docs/{components-badge-docs.md → components_components-badge-docs.md} +222 -30
- package/generated/docs/components_components-button-docs.md +2078 -0
- package/generated/docs/components_components-button-recipes-docs.md +37 -0
- package/generated/docs/components_components-buttongroup-docs.md +1045 -0
- package/generated/docs/components_components-card-docs.md +2276 -0
- package/generated/docs/{components-card-recipes-docs.md → components_components-card-recipes-docs.md} +131 -14
- package/generated/docs/components_components-checkbox-docs.md +1054 -0
- package/generated/docs/{components-checkboxgroup-docs.md → components_components-checkboxgroup-docs.md} +1000 -81
- package/generated/docs/{components-checkboxgroup-recipes-docs.md → components_components-checkboxgroup-recipes-docs.md} +101 -11
- package/generated/docs/{components-col-docs.md → components_components-col-docs.md} +331 -58
- package/generated/docs/components_components-combobox-docs.md +3767 -0
- package/generated/docs/{components-container-docs.md → components_components-container-docs.md} +61 -24
- package/generated/docs/{components-divider-docs.md → components_components-divider-docs.md} +83 -24
- package/generated/docs/{components-expander-docs.md → components_components-expander-docs.md} +264 -33
- package/generated/docs/{components-field-docs.md → components_components-field-docs.md} +814 -120
- package/generated/docs/components_components-filter-docs.md +4080 -0
- package/generated/docs/{components-form-docs.md → components_components-form-docs.md} +1515 -353
- package/generated/docs/{components-form-recipes-docs.md → components_components-form-recipes-docs.md} +170 -54
- package/generated/docs/components_components-hide-docs.md +293 -0
- package/generated/docs/components_components-icon-docs.md +1337 -0
- package/generated/docs/{components-inline-docs.md → components_components-inline-docs.md} +462 -42
- package/generated/docs/components_components-input-docs.md +1468 -0
- package/generated/docs/components_components-input-recipes-docs.md +367 -0
- package/generated/docs/components_components-inputcurrency-docs.md +432 -0
- package/generated/docs/{components-inputcurrency-recipes-docs.md → components_components-inputcurrency-recipes-docs.md} +110 -17
- package/generated/docs/components_components-label-docs.md +323 -0
- package/generated/docs/components_components-menu-docs.md +2345 -0
- package/generated/docs/components_components-menu-menuitem-docs.md +633 -0
- package/generated/docs/{components-modal-docs.md → components_components-modal-docs.md} +1625 -232
- package/generated/docs/components_components-navbar-docs.md +1847 -0
- package/generated/docs/{components-navbar-recipes-docs.md → components_components-navbar-recipes-docs.md} +697 -39
- package/generated/docs/{components-panel-docs.md → components_components-panel-docs.md} +754 -57
- package/generated/docs/components_components-placeholder-docs.md +92 -0
- package/generated/docs/components_components-popover-docs.md +1641 -0
- package/generated/docs/{components-popover-recipes-docs.md → components_components-popover-recipes-docs.md} +347 -17
- package/generated/docs/components_components-progress-docs.md +115 -0
- package/generated/docs/{components-provider-docs.md → components_components-provider-docs.md} +41 -32
- package/generated/docs/components_components-radio-docs.md +491 -0
- package/generated/docs/{components-radiogroup-docs.md → components_components-radiogroup-docs.md} +943 -75
- package/generated/docs/components_components-readonly-docs.md +263 -0
- package/generated/docs/components_components-richselect-docs.md +6497 -0
- package/generated/docs/{components-row-docs.md → components_components-row-docs.md} +353 -43
- package/generated/docs/{components-select-docs.md → components_components-select-docs.md} +719 -61
- package/generated/docs/components_components-skeleton-docs.md +480 -0
- package/generated/docs/{components-skeleton-recipes-docs.md → components_components-skeleton-recipes-docs.md} +50 -10
- package/generated/docs/{components-skiplink-docs.md → components_components-skiplink-docs.md} +53 -14
- package/generated/docs/components_components-slideout-docs.md +2262 -0
- package/generated/docs/components_components-slider-docs.md +1276 -0
- package/generated/docs/components_components-spinner-docs.md +82 -0
- package/generated/docs/{components-stack-docs.md → components_components-stack-docs.md} +223 -40
- package/generated/docs/components_components-table-docs.md +3651 -0
- package/generated/docs/components_components-tabset-docs.md +772 -0
- package/generated/docs/components_components-tabset-tab-docs.md +262 -0
- package/generated/docs/components_components-tag-docs.md +259 -0
- package/generated/docs/{components-text-docs.md → components_components-text-docs.md} +491 -51
- package/generated/docs/{components-toaster-docs.md → components_components-toaster-docs.md} +181 -79
- package/generated/docs/components_components-toaster-toast-docs.md +634 -0
- package/generated/docs/components_components-toggle-docs.md +461 -0
- package/generated/docs/{components-tooltip-docs.md → components_components-tooltip-docs.md} +286 -41
- package/generated/docs/{components-validationmessage-docs.md → components_components-validationmessage-docs.md} +230 -61
- package/generated/docs/components_contact-us-docs.md +12 -0
- package/generated/docs/{foundations-accessibility-docs.md → components_foundations-accessibility-docs.md} +11 -21
- package/generated/docs/{foundations-colours-docs.md → components_foundations-colour-030-colours.md} +8 -15
- package/generated/docs/{foundations-consistency-docs.md → components_foundations-consistency-docs.md} +12 -20
- package/generated/docs/{foundations-content-docs.md → components_foundations-content-docs.md} +6 -11
- package/generated/docs/components_foundations-introduction-docs.md +15 -0
- package/generated/docs/{foundations-principles-docs.md → components_foundations-principles-docs.md} +14 -24
- package/generated/docs/components_foundations-typography-docs.md +608 -0
- package/generated/docs/{foundations-user-experience-docs.md → components_foundations-user-experience-docs.md} +16 -26
- package/generated/docs/{foundations-visual-design-docs.md → components_foundations-visual-design-docs.md} +10 -17
- package/generated/docs/{frequently-asked-questions-docs.md → components_frequently-asked-questions-docs.md} +14 -23
- package/generated/docs/components_get-started-develop-docs.md +84 -0
- package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
- package/generated/docs/components_introduction-docs.md +15 -0
- package/generated/docs/{patterns-loading-docs.md → components_patterns-loading-docs.md} +711 -143
- package/generated/docs/components_resources-changelog-docs.md +4 -0
- package/generated/docs/{resources-code-katas-docs.md → components_resources-code-katas-docs.md} +5 -9
- package/generated/docs/{resources-migration-guides-from-v4-to-v5-docs.md → components_resources-migration-guides-from-v4-to-v5-docs.md} +54 -239
- package/generated/docs/{versions-docs.md → components_versions-docs.md} +5 -8
- package/generated/docs/guidelines.md +484 -200
- package/generated/docs/introduction-docs.md +19 -30
- package/package.json +41 -45
- package/generated/docs/components-alert-docs.md +0 -130
- package/generated/docs/components-autocomplete-docs.md +0 -754
- package/generated/docs/components-button-docs.md +0 -362
- package/generated/docs/components-button-recipes-docs.md +0 -76
- package/generated/docs/components-buttongroup-docs.md +0 -310
- package/generated/docs/components-card-docs.md +0 -494
- package/generated/docs/components-checkbox-docs.md +0 -193
- package/generated/docs/components-combobox-docs.md +0 -1016
- package/generated/docs/components-filter-docs.md +0 -1109
- package/generated/docs/components-hide-docs.md +0 -265
- package/generated/docs/components-icon-docs.md +0 -553
- package/generated/docs/components-input-docs.md +0 -335
- package/generated/docs/components-input-recipes-docs.md +0 -140
- package/generated/docs/components-inputcurrency-docs.md +0 -157
- package/generated/docs/components-label-docs.md +0 -135
- package/generated/docs/components-menu-docs.md +0 -704
- package/generated/docs/components-menu-menuitem-docs.md +0 -193
- package/generated/docs/components-navbar-docs.md +0 -291
- package/generated/docs/components-placeholder-docs.md +0 -27
- package/generated/docs/components-popover-docs.md +0 -464
- package/generated/docs/components-progress-docs.md +0 -104
- package/generated/docs/components-radio-docs.md +0 -107
- package/generated/docs/components-readonly-docs.md +0 -89
- package/generated/docs/components-richselect-docs.md +0 -2433
- package/generated/docs/components-skeleton-docs.md +0 -214
- package/generated/docs/components-slideout-docs.md +0 -538
- package/generated/docs/components-slider-docs.md +0 -346
- package/generated/docs/components-spinner-docs.md +0 -59
- package/generated/docs/components-table-ag-grid-docs.md +0 -1074
- package/generated/docs/components-table-docs.md +0 -1305
- package/generated/docs/components-tabset-docs.md +0 -341
- package/generated/docs/components-tabset-tab-docs.md +0 -86
- package/generated/docs/components-tag-docs.md +0 -115
- package/generated/docs/components-toaster-toast-docs.md +0 -157
- package/generated/docs/components-toggle-docs.md +0 -158
- package/generated/docs/contact-us-docs.md +0 -27
- package/generated/docs/extensions-editor-docs.md +0 -288
- package/generated/docs/extensions-editor-recipes-docs.md +0 -39
- package/generated/docs/foundations-introduction-docs.md +0 -17
- package/generated/docs/foundations-typography-docs.md +0 -191
- package/generated/docs/get-started-develop-docs.md +0 -209
- package/generated/docs/get-started-using-storybook-docs.md +0 -68
- package/generated/docs/resources-changelog-docs.md +0 -6
- package/generated/docs/themes-available-themes-docs.md +0 -66
- package/generated/docs/themes-introduction-docs.md +0 -121
- package/generated/docs/themes-tokens-docs.md +0 -1200
- /package/{LICENSE.txt → LICENSE} +0 -0
|
@@ -1,214 +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
|
-
Hide code
|
|
10
|
-
|
|
11
|
-
\[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; }
|
|
12
|
-
|
|
13
|
-
<IressSkeleton />
|
|
14
|
-
|
|
15
|
-
Copy
|
|
16
|
-
|
|
17
|
-
[](#examples)Examples
|
|
18
|
-
---------------------
|
|
19
|
-
|
|
20
|
-
### [](#modes)Modes
|
|
21
|
-
|
|
22
|
-
The `mode` prop can be set to `text` (default), `rect` or `circle`.
|
|
23
|
-
|
|
24
|
-
Hide code
|
|
25
|
-
|
|
26
|
-
\[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; }
|
|
27
|
-
|
|
28
|
-
<IressStack gutter\="md"\>
|
|
29
|
-
<IressSkeleton mode\="text" />
|
|
30
|
-
<IressSkeleton
|
|
31
|
-
height\="100px"
|
|
32
|
-
mode\="rect"
|
|
33
|
-
/>
|
|
34
|
-
<IressSkeleton
|
|
35
|
-
height\="100px"
|
|
36
|
-
mode\="circle"
|
|
37
|
-
width\="100px"
|
|
38
|
-
/>
|
|
39
|
-
</IressStack\>
|
|
40
|
-
|
|
41
|
-
Copy
|
|
42
|
-
|
|
43
|
-
### [](#text)Text
|
|
44
|
-
|
|
45
|
-
`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.
|
|
46
|
-
|
|
47
|
-
`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.
|
|
48
|
-
|
|
49
|
-
Toggle load
|
|
50
|
-
|
|
51
|
-
Hide code
|
|
52
|
-
|
|
53
|
-
\[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; }
|
|
54
|
-
|
|
55
|
-
import { useState } from 'react';
|
|
56
|
-
import {
|
|
57
|
-
IressButton,
|
|
58
|
-
IressSkeleton,
|
|
59
|
-
IressSkeletonProps,
|
|
60
|
-
IressStack,
|
|
61
|
-
IressText,
|
|
62
|
-
TEXT\_VARIANTS,
|
|
63
|
-
} from '@iress-oss/ids-components';
|
|
64
|
-
export const SkeletonText \= () \=> {
|
|
65
|
-
const \[loading, setLoading\] \= useState(true);
|
|
66
|
-
return (
|
|
67
|
-
<IressStack gutter\={IressStack.Gutter.Md}\>
|
|
68
|
-
<IressButton onClick\={() \=> setLoading(!loading)}\>
|
|
69
|
-
Toggle load </IressButton\>
|
|
70
|
-
<IressStack gutter\={IressStack.Gutter.Xs}\>
|
|
71
|
-
{TEXT\_VARIANTS.map((textVariant) \=> \[
|
|
72
|
-
loading && <IressSkeleton {...{
|
|
73
|
-
mode: 'text',
|
|
74
|
-
}} textVariant\={textVariant} />,
|
|
75
|
-
!loading && (
|
|
76
|
-
<IressText variant\={textVariant}\>{textVariant}</IressText\>
|
|
77
|
-
),
|
|
78
|
-
\])}
|
|
79
|
-
</IressStack\>
|
|
80
|
-
</IressStack\>
|
|
81
|
-
);
|
|
82
|
-
};
|
|
83
|
-
|
|
84
|
-
Copy
|
|
85
|
-
|
|
86
|
-
### [](#rect)Rect
|
|
87
|
-
|
|
88
|
-
`rect` mode allows you to use `IressSkeleton` in place of block elements, a good example would be in place of images.
|
|
89
|
-
|
|
90
|
-
`rect` accepts both `width` and `height` props for sizing. It will default to 100% and a theme defined fallback height (`--iress-skeleton-bone-fallback-height`).
|
|
91
|
-
|
|
92
|
-
Toggle load
|
|
93
|
-
|
|
94
|
-
Hide code
|
|
95
|
-
|
|
96
|
-
\[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; }
|
|
97
|
-
|
|
98
|
-
import { useState } from 'react';
|
|
99
|
-
import {
|
|
100
|
-
IressButton,
|
|
101
|
-
IressPlaceholder,
|
|
102
|
-
IressSkeleton,
|
|
103
|
-
IressSkeletonProps,
|
|
104
|
-
IressStack,
|
|
105
|
-
} from '@iress-oss/ids-components';
|
|
106
|
-
export const SkeletonRect \= () \=> {
|
|
107
|
-
const \[loading, setLoading\] \= useState(true);
|
|
108
|
-
return (
|
|
109
|
-
<IressStack gutter\={IressStack.Gutter.Md}\>
|
|
110
|
-
<IressButton onClick\={() \=> setLoading(!loading)}\>
|
|
111
|
-
Toggle load </IressButton\>
|
|
112
|
-
{loading && <IressSkeleton {...{
|
|
113
|
-
mode: 'rect',
|
|
114
|
-
width: '250',
|
|
115
|
-
height: '150',
|
|
116
|
-
}} />}
|
|
117
|
-
{!loading && <IressPlaceholder {...{
|
|
118
|
-
mode: 'rect',
|
|
119
|
-
width: '250',
|
|
120
|
-
height: '150',
|
|
121
|
-
}}\>Image</IressPlaceholder\>}
|
|
122
|
-
</IressStack\>
|
|
123
|
-
);
|
|
124
|
-
};
|
|
125
|
-
|
|
126
|
-
Copy
|
|
127
|
-
|
|
128
|
-
### [](#circle)Circle
|
|
129
|
-
|
|
130
|
-
`circle` mode allows you to use `IressSkeleton` in place of circular elements, a good example would be for profile images.
|
|
131
|
-
|
|
132
|
-
`circle` accepts both `width` and `height` props for sizing. It will default to 100% and a theme defined fallback height (`--iress-skeleton-bone-fallback-height`).
|
|
133
|
-
|
|
134
|
-
Toggle load
|
|
135
|
-
|
|
136
|
-
Hide code
|
|
137
|
-
|
|
138
|
-
\[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; }
|
|
139
|
-
|
|
140
|
-
import { useState } from 'react';
|
|
141
|
-
import {
|
|
142
|
-
IressButton,
|
|
143
|
-
IressPlaceholder,
|
|
144
|
-
IressSkeleton,
|
|
145
|
-
IressSkeletonProps,
|
|
146
|
-
IressStack,
|
|
147
|
-
} from '@iress-oss/ids-components';
|
|
148
|
-
export const SkeletonCircle \= () \=> {
|
|
149
|
-
const \[loading, setLoading\] \= useState(true);
|
|
150
|
-
return (
|
|
151
|
-
<IressStack gutter\={IressStack.Gutter.Md}\>
|
|
152
|
-
<IressButton onClick\={() \=> setLoading(!loading)}\>
|
|
153
|
-
Toggle load </IressButton\>
|
|
154
|
-
{loading && <IressSkeleton {...{
|
|
155
|
-
mode: 'circle',
|
|
156
|
-
width: '150',
|
|
157
|
-
height: '150',
|
|
158
|
-
}} />}
|
|
159
|
-
{!loading && (
|
|
160
|
-
<IressPlaceholder {...{
|
|
161
|
-
mode: 'circle',
|
|
162
|
-
width: '150',
|
|
163
|
-
height: '150',
|
|
164
|
-
}} style\={{ borderRadius: '50%' }}\>
|
|
165
|
-
Image </IressPlaceholder\>
|
|
166
|
-
)}
|
|
167
|
-
</IressStack\>
|
|
168
|
-
);
|
|
169
|
-
};
|
|
170
|
-
|
|
171
|
-
Copy
|
|
172
|
-
|
|
173
|
-
### [](#size)Size
|
|
174
|
-
|
|
175
|
-
`width` and `height` props can be used to match the layout of the loaded content.
|
|
176
|
-
|
|
177
|
-
These props accept any unit of dimension, but if no unit is provided it will default to pixels.
|
|
178
|
-
|
|
179
|
-
**Note:** `height` will be ignored for text mode as this is calculated using the `IressText` component.
|
|
180
|
-
|
|
181
|
-
Hide code
|
|
182
|
-
|
|
183
|
-
\[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; }
|
|
184
|
-
|
|
185
|
-
<IressInline gutter\="md"\>
|
|
186
|
-
<IressSkeleton
|
|
187
|
-
height\="150"
|
|
188
|
-
mode\="rect"
|
|
189
|
-
width\="150"
|
|
190
|
-
/>
|
|
191
|
-
<IressSkeleton
|
|
192
|
-
height\="150"
|
|
193
|
-
mode\="circle"
|
|
194
|
-
width\="150"
|
|
195
|
-
/>
|
|
196
|
-
<IressSkeleton
|
|
197
|
-
height\="150"
|
|
198
|
-
mode\="text"
|
|
199
|
-
width\="150"
|
|
200
|
-
/>
|
|
201
|
-
</IressInline\>
|
|
202
|
-
|
|
203
|
-
Copy
|
|
204
|
-
|
|
205
|
-
On this page
|
|
206
|
-
|
|
207
|
-
* [Overview](#overview)
|
|
208
|
-
* [Props](#props)
|
|
209
|
-
* [Examples](#examples)
|
|
210
|
-
* [Modes](#modes)
|
|
211
|
-
* [Text](#text)
|
|
212
|
-
* [Rect](#rect)
|
|
213
|
-
* [Circle](#circle)
|
|
214
|
-
* [Size](#size)
|