@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.
Files changed (132) hide show
  1. package/generated/docs/components_components-alert-docs.md +492 -0
  2. package/generated/docs/components_components-autocomplete-docs.md +3485 -0
  3. package/generated/docs/{components-autocomplete-recipes-docs.md → components_components-autocomplete-recipes-docs.md} +32 -14
  4. package/generated/docs/{components-badge-docs.md → components_components-badge-docs.md} +222 -30
  5. package/generated/docs/components_components-button-docs.md +2078 -0
  6. package/generated/docs/components_components-button-recipes-docs.md +37 -0
  7. package/generated/docs/components_components-buttongroup-docs.md +1045 -0
  8. package/generated/docs/components_components-card-docs.md +2276 -0
  9. package/generated/docs/{components-card-recipes-docs.md → components_components-card-recipes-docs.md} +131 -14
  10. package/generated/docs/components_components-checkbox-docs.md +1054 -0
  11. package/generated/docs/{components-checkboxgroup-docs.md → components_components-checkboxgroup-docs.md} +1000 -81
  12. package/generated/docs/{components-checkboxgroup-recipes-docs.md → components_components-checkboxgroup-recipes-docs.md} +101 -11
  13. package/generated/docs/{components-col-docs.md → components_components-col-docs.md} +331 -58
  14. package/generated/docs/components_components-combobox-docs.md +3767 -0
  15. package/generated/docs/{components-container-docs.md → components_components-container-docs.md} +61 -24
  16. package/generated/docs/{components-divider-docs.md → components_components-divider-docs.md} +83 -24
  17. package/generated/docs/{components-expander-docs.md → components_components-expander-docs.md} +264 -33
  18. package/generated/docs/{components-field-docs.md → components_components-field-docs.md} +814 -120
  19. package/generated/docs/components_components-filter-docs.md +4080 -0
  20. package/generated/docs/{components-form-docs.md → components_components-form-docs.md} +1515 -353
  21. package/generated/docs/{components-form-recipes-docs.md → components_components-form-recipes-docs.md} +170 -54
  22. package/generated/docs/components_components-hide-docs.md +293 -0
  23. package/generated/docs/components_components-icon-docs.md +1337 -0
  24. package/generated/docs/{components-inline-docs.md → components_components-inline-docs.md} +462 -42
  25. package/generated/docs/components_components-input-docs.md +1468 -0
  26. package/generated/docs/components_components-input-recipes-docs.md +367 -0
  27. package/generated/docs/components_components-inputcurrency-docs.md +432 -0
  28. package/generated/docs/{components-inputcurrency-recipes-docs.md → components_components-inputcurrency-recipes-docs.md} +110 -17
  29. package/generated/docs/components_components-label-docs.md +323 -0
  30. package/generated/docs/components_components-menu-docs.md +2345 -0
  31. package/generated/docs/components_components-menu-menuitem-docs.md +633 -0
  32. package/generated/docs/{components-modal-docs.md → components_components-modal-docs.md} +1625 -232
  33. package/generated/docs/components_components-navbar-docs.md +1847 -0
  34. package/generated/docs/{components-navbar-recipes-docs.md → components_components-navbar-recipes-docs.md} +697 -39
  35. package/generated/docs/{components-panel-docs.md → components_components-panel-docs.md} +754 -57
  36. package/generated/docs/components_components-placeholder-docs.md +92 -0
  37. package/generated/docs/components_components-popover-docs.md +1641 -0
  38. package/generated/docs/{components-popover-recipes-docs.md → components_components-popover-recipes-docs.md} +347 -17
  39. package/generated/docs/components_components-progress-docs.md +115 -0
  40. package/generated/docs/{components-provider-docs.md → components_components-provider-docs.md} +41 -32
  41. package/generated/docs/components_components-radio-docs.md +491 -0
  42. package/generated/docs/{components-radiogroup-docs.md → components_components-radiogroup-docs.md} +943 -75
  43. package/generated/docs/components_components-readonly-docs.md +263 -0
  44. package/generated/docs/components_components-richselect-docs.md +6497 -0
  45. package/generated/docs/{components-row-docs.md → components_components-row-docs.md} +353 -43
  46. package/generated/docs/{components-select-docs.md → components_components-select-docs.md} +719 -61
  47. package/generated/docs/components_components-skeleton-docs.md +480 -0
  48. package/generated/docs/{components-skeleton-recipes-docs.md → components_components-skeleton-recipes-docs.md} +50 -10
  49. package/generated/docs/{components-skiplink-docs.md → components_components-skiplink-docs.md} +53 -14
  50. package/generated/docs/components_components-slideout-docs.md +2262 -0
  51. package/generated/docs/components_components-slider-docs.md +1276 -0
  52. package/generated/docs/components_components-spinner-docs.md +82 -0
  53. package/generated/docs/{components-stack-docs.md → components_components-stack-docs.md} +223 -40
  54. package/generated/docs/components_components-table-docs.md +3651 -0
  55. package/generated/docs/components_components-tabset-docs.md +772 -0
  56. package/generated/docs/components_components-tabset-tab-docs.md +262 -0
  57. package/generated/docs/components_components-tag-docs.md +259 -0
  58. package/generated/docs/{components-text-docs.md → components_components-text-docs.md} +491 -51
  59. package/generated/docs/{components-toaster-docs.md → components_components-toaster-docs.md} +181 -79
  60. package/generated/docs/components_components-toaster-toast-docs.md +634 -0
  61. package/generated/docs/components_components-toggle-docs.md +461 -0
  62. package/generated/docs/{components-tooltip-docs.md → components_components-tooltip-docs.md} +286 -41
  63. package/generated/docs/{components-validationmessage-docs.md → components_components-validationmessage-docs.md} +230 -61
  64. package/generated/docs/components_contact-us-docs.md +12 -0
  65. package/generated/docs/{foundations-accessibility-docs.md → components_foundations-accessibility-docs.md} +11 -21
  66. package/generated/docs/{foundations-colours-docs.md → components_foundations-colour-030-colours.md} +8 -15
  67. package/generated/docs/{foundations-consistency-docs.md → components_foundations-consistency-docs.md} +12 -20
  68. package/generated/docs/{foundations-content-docs.md → components_foundations-content-docs.md} +6 -11
  69. package/generated/docs/components_foundations-introduction-docs.md +15 -0
  70. package/generated/docs/{foundations-principles-docs.md → components_foundations-principles-docs.md} +14 -24
  71. package/generated/docs/components_foundations-typography-docs.md +608 -0
  72. package/generated/docs/{foundations-user-experience-docs.md → components_foundations-user-experience-docs.md} +16 -26
  73. package/generated/docs/{foundations-visual-design-docs.md → components_foundations-visual-design-docs.md} +10 -17
  74. package/generated/docs/{frequently-asked-questions-docs.md → components_frequently-asked-questions-docs.md} +14 -23
  75. package/generated/docs/components_get-started-develop-docs.md +84 -0
  76. package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
  77. package/generated/docs/components_introduction-docs.md +15 -0
  78. package/generated/docs/{patterns-loading-docs.md → components_patterns-loading-docs.md} +711 -143
  79. package/generated/docs/components_resources-changelog-docs.md +4 -0
  80. package/generated/docs/{resources-code-katas-docs.md → components_resources-code-katas-docs.md} +5 -9
  81. package/generated/docs/{resources-migration-guides-from-v4-to-v5-docs.md → components_resources-migration-guides-from-v4-to-v5-docs.md} +54 -239
  82. package/generated/docs/{versions-docs.md → components_versions-docs.md} +5 -8
  83. package/generated/docs/guidelines.md +484 -200
  84. package/generated/docs/introduction-docs.md +19 -30
  85. package/package.json +41 -45
  86. package/generated/docs/components-alert-docs.md +0 -130
  87. package/generated/docs/components-autocomplete-docs.md +0 -754
  88. package/generated/docs/components-button-docs.md +0 -362
  89. package/generated/docs/components-button-recipes-docs.md +0 -76
  90. package/generated/docs/components-buttongroup-docs.md +0 -310
  91. package/generated/docs/components-card-docs.md +0 -494
  92. package/generated/docs/components-checkbox-docs.md +0 -193
  93. package/generated/docs/components-combobox-docs.md +0 -1016
  94. package/generated/docs/components-filter-docs.md +0 -1109
  95. package/generated/docs/components-hide-docs.md +0 -265
  96. package/generated/docs/components-icon-docs.md +0 -553
  97. package/generated/docs/components-input-docs.md +0 -335
  98. package/generated/docs/components-input-recipes-docs.md +0 -140
  99. package/generated/docs/components-inputcurrency-docs.md +0 -157
  100. package/generated/docs/components-label-docs.md +0 -135
  101. package/generated/docs/components-menu-docs.md +0 -704
  102. package/generated/docs/components-menu-menuitem-docs.md +0 -193
  103. package/generated/docs/components-navbar-docs.md +0 -291
  104. package/generated/docs/components-placeholder-docs.md +0 -27
  105. package/generated/docs/components-popover-docs.md +0 -464
  106. package/generated/docs/components-progress-docs.md +0 -104
  107. package/generated/docs/components-radio-docs.md +0 -107
  108. package/generated/docs/components-readonly-docs.md +0 -89
  109. package/generated/docs/components-richselect-docs.md +0 -2433
  110. package/generated/docs/components-skeleton-docs.md +0 -214
  111. package/generated/docs/components-slideout-docs.md +0 -538
  112. package/generated/docs/components-slider-docs.md +0 -346
  113. package/generated/docs/components-spinner-docs.md +0 -59
  114. package/generated/docs/components-table-ag-grid-docs.md +0 -1074
  115. package/generated/docs/components-table-docs.md +0 -1305
  116. package/generated/docs/components-tabset-docs.md +0 -341
  117. package/generated/docs/components-tabset-tab-docs.md +0 -86
  118. package/generated/docs/components-tag-docs.md +0 -115
  119. package/generated/docs/components-toaster-toast-docs.md +0 -157
  120. package/generated/docs/components-toggle-docs.md +0 -158
  121. package/generated/docs/contact-us-docs.md +0 -27
  122. package/generated/docs/extensions-editor-docs.md +0 -288
  123. package/generated/docs/extensions-editor-recipes-docs.md +0 -39
  124. package/generated/docs/foundations-introduction-docs.md +0 -17
  125. package/generated/docs/foundations-typography-docs.md +0 -191
  126. package/generated/docs/get-started-develop-docs.md +0 -209
  127. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  128. package/generated/docs/resources-changelog-docs.md +0 -6
  129. package/generated/docs/themes-available-themes-docs.md +0 -66
  130. package/generated/docs/themes-introduction-docs.md +0 -121
  131. package/generated/docs/themes-tokens-docs.md +0 -1200
  132. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,22 +1,24 @@
1
- [](#recipes)Recipes
2
- ===================
1
+ Recipes
2
+ =======
3
3
 
4
4
  Experimental
5
5
  ------------
6
6
 
7
7
  This API is experimental. It may change in the future based on usage. The team is testing if these use cases exist and see if its worth maintaining this API. If you have any questions, concerns or feedback, please reach out to the design system team.
8
8
 
9
- [](#useautocompletesearch)`useAutocompleteSearch`
10
- -------------------------------------------------
9
+ `useAutocompleteSearch`
10
+ -----------------------
11
11
 
12
12
  `IressAutocomplete` uses the `useAutocompleteSearch` hook to provide search functionality. If provided an array of `LabelValueMeta`, it will search options based on the `label` property. To fully customise how to search the objects, pass a function instead.
13
13
 
14
14
  It has been exposed in case you need it in your application to provide custom search functionality.
15
15
 
16
- ### [](#use-cases)Use cases
16
+ ### Use cases
17
17
 
18
18
  1. You want to provide filtering in a certain area of the application (eg. a table).
19
19
 
20
+ [](./iframe.html?id=components-autocomplete-recipes--table)
21
+
20
22
  | Name | Gender |
21
23
  | --- | --- |
22
24
  | Person 1 | Male |
@@ -25,9 +27,7 @@ It has been exposed in case you need it in your application to provide custom se
25
27
  | Person 4 | Female |
26
28
  | Person 5 | Male |
27
29
 
28
- Hide code
29
-
30
- \[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; }
30
+ ```
31
31
 
32
32
  const ALL\_ROWS \= \[...Array(5).keys()\].map((number) \=> ({
33
33
  label: \`Person ${number + 1}\`,
@@ -71,9 +71,9 @@ export const AutocompleteSearchTable \= () \=> {
71
71
  );
72
72
  };
73
73
 
74
- Copy
74
+ ```
75
75
 
76
- ### [](#parameters)Parameters
76
+ #### Props
77
77
 
78
78
  | Name | Description | Default | Control |
79
79
  | --- | --- | --- | --- |
@@ -97,8 +97,26 @@ Copy
97
97
 
98
98
  | \- | \- |
99
99
 
100
- On this page
100
+ ### Parameters
101
+
102
+ | Name | Description | Default | Control |
103
+ | --- | --- | --- | --- |
104
+ | debounceThreshold |
105
+ \-
106
+
107
+ | \- | \- |
108
+ | initialOptions |
109
+
110
+ \-
101
111
 
102
- * [useAutocompleteSearch](#useautocompletesearch)
103
- * [Use cases](#use-cases)
104
- * [Parameters](#parameters)
112
+ | \- | \- |
113
+ | options |
114
+
115
+ \-
116
+
117
+ | \- | \- |
118
+ | query |
119
+
120
+ \-
121
+
122
+ | \- | \- |
@@ -1,35 +1,88 @@
1
- [](#badge)Badge
2
- ===============
1
+ Badge
2
+ =====
3
3
 
4
4
  Overview
5
5
  --------
6
6
 
7
7
  Badges are used to highlight an item's status for quick recognition
8
8
 
9
- badge
9
+ [](./iframe.html?id=components-badge--default)
10
10
 
11
- Hide code
11
+ badge
12
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; }
13
+ ```
14
14
 
15
15
  <IressBadge mode\="background-default"\>
16
16
  badge
17
17
  </IressBadge\>
18
18
 
19
- Copy
19
+ ```
20
+
21
+ Props
22
+ -----
23
+
24
+ | Name | Description | Default | Control |
25
+ | --- | --- | --- | --- |
26
+ | children |
27
+ Content of the badge.
28
+
29
+ ReactNode
30
+
31
+
32
+
33
+ | \- |
34
+
35
+ "badge"
36
+
37
+ |
38
+ | host |
39
+
40
+ Element to attach the badge to.
41
+
42
+ ReactElement
43
+
44
+
45
+
46
+ | \- | Set object |
47
+ | mode |
48
+
49
+ Style of the badge.
50
+
51
+ union
52
+
53
+
54
+
55
+ |
56
+
57
+ 'background-default'
58
+
59
+ |
60
+
61
+ "background-default"
62
+
63
+ |
64
+ | pill |
65
+
66
+ Whether the Badge should be styled as a pill.
67
+
68
+ boolean
69
+
70
+
20
71
 
21
- [](#examples)Examples
22
- ---------------------
72
+ | \- | Set boolean |
23
73
 
24
- ### [](#mode)Mode
74
+ Examples
75
+ --------
76
+
77
+ ### Mode
25
78
 
26
79
  The `mode` prop controls the colour scheme of the badge. There are a range of options, including system and brand colours.
27
80
 
28
- successwarningdangerinfopositivenegativebackground-altbackground-default
81
+ [](./iframe.html?id=components-badge--mode)
29
82
 
30
- Hide code
83
+ successwarningdangerinfopositivenegativebackground-altbackground-default
31
84
 
32
- \[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; }
85
+ ```
33
86
 
34
87
  <IressInline gutter\="sm"\>
35
88
  <IressBadge mode\="success"\>
@@ -50,17 +103,65 @@ Hide code
50
103
  background-default </IressBadge\>
51
104
  </IressInline\>
52
105
 
53
- Copy
106
+ ```
107
+
108
+ #### Props
109
+
110
+ | Name | Description | Default | Control |
111
+ | --- | --- | --- | --- |
112
+ | children |
113
+ Content of the badge.
114
+
115
+ ReactNode
116
+
117
+
118
+
119
+ | \- |
120
+
121
+ "badge"
122
+
123
+ |
124
+ | host |
125
+
126
+ Element to attach the badge to.
127
+
128
+ ReactElement
129
+
130
+
131
+
132
+ | \- | Set object |
133
+ | mode |
134
+
135
+ Style of the badge.
136
+
137
+ union
138
+
139
+
140
+
141
+ |
142
+
143
+ 'background-default'
144
+
145
+ | \- |
146
+ | pill |
147
+
148
+ Whether the Badge should be styled as a pill.
149
+
150
+ boolean
151
+
152
+
54
153
 
55
- ### [](#pill)Pill
154
+ | \- | Set boolean |
155
+
156
+ ### Pill
56
157
 
57
158
  Setting the `pill` prop will render the badge with rounded corners. Often used for displaying numbers.
58
159
 
59
- successwarningdangerinfopositivenegativebackground-altbackground-default
160
+ [](./iframe.html?id=components-badge--pill)
60
161
 
61
- Hide code
162
+ successwarningdangerinfopositivenegativebackground-altbackground-default
62
163
 
63
- \[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; }
164
+ ```
64
165
 
65
166
  <IressInline gutter\="sm"\>
66
167
  <IressBadge
@@ -105,21 +206,69 @@ Hide code
105
206
  background-default </IressBadge\>
106
207
  </IressInline\>
107
208
 
108
- Copy
209
+ ```
210
+
211
+ #### Props
212
+
213
+ | Name | Description | Default | Control |
214
+ | --- | --- | --- | --- |
215
+ | children |
216
+ Content of the badge.
217
+
218
+ ReactNode
219
+
220
+
221
+
222
+ | \- |
223
+
224
+ "badge"
225
+
226
+ |
227
+ | host |
228
+
229
+ Element to attach the badge to.
230
+
231
+ ReactElement
232
+
233
+
234
+
235
+ | \- | Set object |
236
+ | mode |
237
+
238
+ Style of the badge.
239
+
240
+ union
241
+
242
+
243
+
244
+ |
245
+
246
+ 'background-default'
247
+
248
+ | \- |
249
+ | pill |
250
+
251
+ Whether the Badge should be styled as a pill.
252
+
253
+ boolean
254
+
255
+
256
+
257
+ | \- | FalseTrue |
109
258
 
110
- ### [](#host)Host
259
+ ### Host
111
260
 
112
261
  You can attach a badge to the top right of any component by passing the component into the badge's `host` prop.
113
262
 
114
263
  **Note:** This is for very simple use cases (eg. with a button or tab). For more complex use cases (eg. with a panel), it will be better if you position the badge yourself using CSS.
115
264
 
265
+ [](./iframe.html?id=components-badge--host)
266
+
116
267
  Host button3
117
268
 
118
269
  Host tab99+
119
270
 
120
- Hide code
121
-
122
- \[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; }
271
+ ```
123
272
 
124
273
  <IressInline gutter\="lg"\>
125
274
  <IressBadge
@@ -136,13 +285,56 @@ Hide code
136
285
  99+ </IressBadge\>
137
286
  </IressInline\>
138
287
 
139
- Copy
288
+ ```
289
+
290
+ #### Props
291
+
292
+ | Name | Description | Default | Control |
293
+ | --- | --- | --- | --- |
294
+ | children |
295
+ Content of the badge.
296
+
297
+ ReactNode
298
+
299
+
300
+
301
+ | \- |
302
+
303
+ "badge"
304
+
305
+ |
306
+ | host |
307
+
308
+ Element to attach the badge to.
309
+
310
+ ReactElement
311
+
312
+
313
+
314
+ | \- | \- |
315
+ | mode |
316
+
317
+ Style of the badge.
318
+
319
+ union
320
+
321
+
322
+
323
+ |
324
+
325
+ 'background-default'
326
+
327
+ |
328
+
329
+ "success"
330
+
331
+ |
332
+ | pill |
333
+
334
+ Whether the Badge should be styled as a pill.
335
+
336
+ boolean
337
+
140
338
 
141
- On this page
142
339
 
143
- * [Overview](#overview)
144
- * [Props](#props)
145
- * [Examples](#examples)
146
- * [Mode](#mode)
147
- * [Pill](#pill)
148
- * [Host](#host)
340
+ | \- | FalseTrue |