@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,464 +0,0 @@
1
- [](#popover)Popover
2
- ===================
3
-
4
- Overview
5
- --------
6
-
7
- A popover is panel that is toggled on/off by an activator button or text input. The panel is positioned relative to its activator element.
8
-
9
- Toggle popover
10
-
11
- A little more information about this area.
12
-
13
- Hide code
14
-
15
- \[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; }
16
-
17
- <IressPopover activator\={<IressButton\>Toggle popover</IressButton\>}\>
18
- <IressPanel className\="iress-u-text"\>
19
- A little more information about this area. </IressPanel\>
20
- </IressPopover\>
21
-
22
- Copy
23
-
24
- [](#usage)Usage
25
- ---------------
26
-
27
- ### [](#activator)Activator
28
-
29
- For the popover to render, the `activator` property is required. It is the element used to trigger the popover, and works best with an `IressButton`.
30
-
31
- Anything added as the children of the `IressPopover` component will be displayed in the popover panel.
32
-
33
- Toggle popover
34
-
35
- A little more information about this area.
36
-
37
- Hide code
38
-
39
- \[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; }
40
-
41
- <IressPopover activator\={<IressButton\>Toggle popover</IressButton\>}\>
42
- <IressPanel className\="iress-u-text"\>
43
- A little more information about this area. </IressPanel\>
44
- </IressPopover\>
45
-
46
- Copy
47
-
48
- ### [](#the-show-property)The `show` property
49
-
50
- You can use state to control the popover by setting the `show` property to `true` or `false`. To sync your state with the popover, you can use the `onActivated` and `onDeactivated` prop.
51
-
52
- Show popover using state
53
-
54
- A little more information about this area.
55
-
56
- Hide code
57
-
58
- \[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; }
59
-
60
- import {
61
- IressButton,
62
- IressPanel,
63
- IressPopover,
64
- IressPopoverProps,
65
- } from '@iress-oss/ids-components';
66
- import { useState } from 'react';
67
- export const PopoverUsingState \= () \=> {
68
- const \[show, setShow\] \= useState(false);
69
- return (
70
- <IressPopover
71
-
72
- activator\={
73
- <IressButton onClick\={() \=> setShow(!show)}\>
74
- Show popover using state </IressButton\>
75
- }
76
- show\={show}
77
- onActivated\={() \=> setShow(true)}
78
- onDeactivated\={() \=> setShow(false)}
79
- \>
80
- <IressPanel\>A little more information about this area.</IressPanel\>
81
- </IressPopover\>
82
- );
83
- };
84
-
85
- Copy
86
-
87
- [](#behaviour)Behaviour
88
- -----------------------
89
-
90
- * The popover is opened when the activator is pressed
91
- * Once activated, the popover will set focus to popover content
92
- * When the activator is pressed whilst the popover is open, it will close
93
- * When the escape key is pressed while it is open, it will close
94
- * When the popover panel loses focus, it will close
95
-
96
- [](#examples)Examples
97
- ---------------------
98
-
99
- ### [](#align)Align
100
-
101
- The popover panel can be aligned in one of 12 positions relative to the activator element. The default value is `auto`.
102
-
103
- The popover panel's position will change dynamically based on the amount of space available in it's container window, so that it doesn't overflow.
104
-
105
- top-start
106
-
107
- Hello!
108
-
109
- top
110
-
111
- Hello!
112
-
113
- top-end
114
-
115
- Hello!
116
-
117
- left-start
118
-
119
- Hello!
120
-
121
- left
122
-
123
- Hello!
124
-
125
- left-end
126
-
127
- Hello!
128
-
129
- right-start
130
-
131
- Hello!
132
-
133
- right
134
-
135
- Hello!
136
-
137
- right-end
138
-
139
- Hello!
140
-
141
- bottom-start
142
-
143
- Hello!
144
-
145
- bottom
146
-
147
- Hello!
148
-
149
- bottom-end
150
-
151
- Hello!
152
-
153
- Hide code
154
-
155
- \[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; }
156
-
157
- <div
158
- style\={{
159
- padding: '80px 150px'
160
- }}
161
- \>
162
- <IressStack gutter\="md"\>
163
- <IressInline
164
- gutter\="sm"
165
- horizontalAlign\="center"
166
- \>
167
- <IressPopover
168
- activator\={<IressTooltip align\="bottom-start" tooltipText\="Tooltips and popovers can go together if needed!"\><IressButton\>top-start</IressButton\></IressTooltip\>}
169
- align\="top-start"
170
- \>
171
- <IressPanel className\="iress-u-text"\>
172
- Hello! </IressPanel\>
173
- </IressPopover\>
174
- <IressPopover
175
- activator\={<IressButton\>top</IressButton\>}
176
- align\="top"
177
- \>
178
- <IressPanel className\="iress-u-text"\>
179
- Hello! </IressPanel\>
180
- </IressPopover\>
181
- <IressPopover
182
- activator\={<IressButton\>top-end</IressButton\>}
183
- align\="top-end"
184
- \>
185
- <IressPanel className\="iress-u-text"\>
186
- Hello! </IressPanel\>
187
- </IressPopover\>
188
- </IressInline\>
189
- <IressInline horizontalAlign\="between"\>
190
- <IressStack gutter\="sm"\>
191
- <IressInline horizontalAlign\="left"\>
192
- <IressPopover
193
- activator\={<IressButton\>left-start</IressButton\>}
194
- align\="left-start"
195
- \>
196
- <IressPanel className\="iress-u-text"\>
197
- Hello! </IressPanel\>
198
- </IressPopover\>
199
- </IressInline\>
200
- <IressInline horizontalAlign\="left"\>
201
- <IressPopover
202
- activator\={<IressButton\>left</IressButton\>}
203
- align\="left"
204
- \>
205
- <IressPanel className\="iress-u-text"\>
206
- Hello! </IressPanel\>
207
- </IressPopover\>
208
- </IressInline\>
209
- <IressInline horizontalAlign\="left"\>
210
- <IressPopover
211
- activator\={<IressButton\>left-end</IressButton\>}
212
- align\="left-end"
213
- \>
214
- <IressPanel className\="iress-u-text"\>
215
- Hello! </IressPanel\>
216
- </IressPopover\>
217
- </IressInline\>
218
- </IressStack\>
219
- <IressStack gutter\="sm"\>
220
- <IressInline horizontalAlign\="right"\>
221
- <IressPopover
222
- activator\={<IressButton\>right-start</IressButton\>}
223
- align\="right-start"
224
- \>
225
- <IressPanel className\="iress-u-text"\>
226
- Hello! </IressPanel\>
227
- </IressPopover\>
228
- </IressInline\>
229
- <IressInline horizontalAlign\="right"\>
230
- <IressPopover
231
- activator\={<IressButton\>right</IressButton\>}
232
- align\="right"
233
- \>
234
- <IressPanel className\="iress-u-text"\>
235
- Hello! </IressPanel\>
236
- </IressPopover\>
237
- </IressInline\>
238
- <IressInline horizontalAlign\="right"\>
239
- <IressPopover
240
- activator\={<IressButton\>right-end</IressButton\>}
241
- align\="right-end"
242
- \>
243
- <IressPanel className\="iress-u-text"\>
244
- Hello! </IressPanel\>
245
- </IressPopover\>
246
- </IressInline\>
247
- </IressStack\>
248
- </IressInline\>
249
- <IressInline
250
- gutter\="sm"
251
- horizontalAlign\="center"
252
- \>
253
- <IressPopover
254
- activator\={<IressButton\>bottom-start</IressButton\>}
255
- align\="bottom-start"
256
- \>
257
- <IressPanel className\="iress-u-text"\>
258
- Hello! </IressPanel\>
259
- </IressPopover\>
260
- <IressPopover
261
- activator\={<IressButton\>bottom</IressButton\>}
262
- align\="bottom"
263
- \>
264
- <IressPanel className\="iress-u-text"\>
265
- Hello! </IressPanel\>
266
- </IressPopover\>
267
- <IressPopover
268
- activator\={<IressButton\>bottom-end</IressButton\>}
269
- align\="bottom-end"
270
- \>
271
- <IressPanel className\="iress-u-text"\>
272
- Hello! </IressPanel\>
273
- </IressPopover\>
274
- </IressInline\>
275
- </IressStack\>
276
- </div\>
277
-
278
- Copy
279
-
280
- ### [](#width)Width
281
-
282
- Occasionally, you may have more information to display than the width set by the theme can comfortably show.
283
-
284
- This is where the `--iress-width` CSS token come in, it will allow you to set the width for the popover panel. For better results, its recommended to use it with the `--iress-max-width` CSS token, to allow your popovers to be responsive.
285
-
286
- **Note:** The `width` prop has been deprecated in favour of the CSS tokens.
287
-
288
- Toggle popover
289
-
290
- Hide code
291
-
292
- \[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; }
293
-
294
- <IressPopover
295
- activator\={<IressButton\>Toggle popover</IressButton\>}
296
- container\={document.body}
297
- style\={{
298
- '--iress-max-width': '30rem',
299
- '--iress-width': '100%'
300
- }}
301
- \>
302
- <IressPanel\>
303
- <IressRow\>
304
- <IressCol span\={6}\>
305
- <IressText\>
306
- Client </IressText\>
307
- <IressText noGutter\>
308
- <ul\>
309
- <li\>
310
- Entity id 582323 </li\>
311
- <li\>
312
- Fruit Apple </li\>
313
- <li\>
314
- Preferred email mamaduke@gmail.com </li\>
315
- </ul\>
316
- </IressText\>
317
- </IressCol\>
318
- <IressCol span\={6}\>
319
- <IressText\>
320
- Client </IressText\>
321
- <IressText noGutter\>
322
- <ul\>
323
- <li\>
324
- Entity id 8766 </li\>
325
- <li\>
326
- Fruit Orange </li\>
327
- <li\>
328
- Preferred email felicity@yahoo.com </li\>
329
- </ul\>
330
- </IressText\>
331
- </IressCol\>
332
- </IressRow\>
333
- </IressPanel\>
334
- </IressPopover\>
335
-
336
- Copy
337
-
338
- ### [](#overflow)Overflow
339
-
340
- Popovers can contain a wide variety of different content, including components that use popovers themselves (like Combobox). This can cause issues with overflowing content, so by default we allow popovers to grow in height based on their content.
341
-
342
- If you need to fix the height of a popover, you can set a maximum height using the `--iress-max-height` theme token on your popover. You'll also need to change the overflow behaviour by setting the `--iress-overflow-y` theme token:
343
-
344
- Normal popover
345
-
346
- Fixed height popover
347
-
348
- Hide code
349
-
350
- \[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; }
351
-
352
- <IressInline gutter\="md"\>
353
- <IressPopover
354
- activator\={<IressButton\>Normal popover</IressButton\>}
355
- align\="bottom-start"
356
- container\={document.body}
357
- \>
358
- <IressPanel\>
359
- <IressText noGutter\>
360
- <p\>
361
- His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor. </p\>
362
- </IressText\>
363
- </IressPanel\>
364
- </IressPopover\>
365
- <IressPopover
366
- activator\={<IressButton\>Fixed height popover</IressButton\>}
367
- align\="bottom-start"
368
- container\={document.body}
369
- style\={{
370
- '--iress-max-height': '200px',
371
- '--iress-overflow-y': 'auto'
372
- }}
373
- \>
374
- <IressPanel\>
375
- <IressText noGutter\>
376
- <p\>
377
- His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor. </p\>
378
- </IressText\>
379
- </IressPanel\>
380
- </IressPopover\>
381
- </IressInline\>
382
-
383
- Copy
384
-
385
- ### [](#container)Container
386
-
387
- By default, the popover will be rendered where its parent is rendered. If you need to render the popover in a different container, you can use the `container` prop.
388
-
389
- **Note:** If the `container` doesn’t exist when the portal is mounted, ensure you pass an element directly (not a ref) and specify null as the default value before it is set. This lets it wait for the root to be available.
390
-
391
- This will be the case when you are rendering into its parent container, which is not yet rendered when the popover is mounted. The example below shows how to use state instead of a reference to change where the popover is rendered.
392
-
393
- Toggle
394
-
395
- This content will be rendered in the parent container
396
-
397
- Hide code
398
-
399
- \[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; }
400
-
401
- export const PopoverParentContainer \= () \=> {
402
- const \[parentContainer, setParentContainer\] \= useState<HTMLDivElement | null\>(
403
- null,
404
- );
405
- return (
406
- <div id\="parent" ref\={setParentContainer}\>
407
- <IressPopover
408
- activator\={<IressButton\>Toggle</IressButton\>}
409
- container\={parentContainer}
410
- \>
411
- <IressPanel\>
412
- This content will be rendered in the parent container </IressPanel\>
413
- </IressPopover\>
414
- </div\>
415
- );
416
- };
417
-
418
- Copy
419
-
420
- [](#iressinputpopover)`IressInputPopover`
421
- -----------------------------------------
422
-
423
- If you need a popover that is triggered by input changes, you can use the `IressInputPopover` component. This component has an additional `minLength` prop that allows you to specify the minimum number of characters required before the popover is shown.
424
-
425
- ### [](#behaviour-1)Behaviour
426
-
427
- Input popovers work slightly different to normal popovers, where the focus inside the popover is **virtual**. This means that the popover content will act as if it is in focus, but the input will still be the actual focus.
428
-
429
- * The popover is opened when the input has content that meets the `minLength` requirement
430
- * The popover is closed when the input no longer meets the `minLength` requirement
431
- * Once activated, virtual focus will be set to the popover content if it contains a menu (e.g. items will highlight as if in focus, but the user can still type in the input)
432
- * When the `minLength` is 0, it will open on focus
433
- * When the escape key is pressed while it is open, it will close
434
- * When the input loses focus, it will close
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
- <IressInputPopover
441
- activator\={<IressInput />}
442
- container\={document.body}
443
- \>
444
- <IressPanel className\="iress-u-text"\>
445
- A little more information about this area. </IressPanel\>
446
- </IressInputPopover\>
447
-
448
- Copy
449
-
450
- On this page
451
-
452
- * [Overview](#overview)
453
- * [Props](#props)
454
- * [Usage](#usage)
455
- * [Activator](#activator)
456
- * [The show property](#the-show-property)
457
- * [Behaviour](#behaviour)
458
- * [Examples](#examples)
459
- * [Align](#align)
460
- * [Width](#width)
461
- * [Overflow](#overflow)
462
- * [Container](#container)
463
- * [IressInputPopover](#iressinputpopover)
464
- * [Behaviour](#behaviour-1)
@@ -1,104 +0,0 @@
1
- [](#progress)Progress
2
- =====================
3
-
4
- Overview
5
- --------
6
-
7
- A progress component is used to indicate to a user the completion of a set of tasks or a process.
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
- <IressProgress
14
- max\={30}
15
- min\={10}
16
- value\={20}
17
- />
18
-
19
- Copy
20
-
21
- [](#usage)Usage
22
- ---------------
23
-
24
- Progress shows how far through a task or operation you are in a graphical way. The simplest way to use it to set the `value` to specify how much of the task the user has completed, relative to the `max` value (which defaults to 100).
25
-
26
- ### [](#calculation-to-convert-value-in-to-width)Calculation to convert value in to width
27
-
28
- The following calculation is used to derive the width percentage:
29
-
30
- \[data-radix-scroll-area-viewport\] {
31
- scrollbar-width: none;
32
- -ms-overflow-style: none;
33
- -webkit-overflow-scrolling: touch;
34
- }
35
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
36
- display: none;
37
- }
38
- :where(\[data-radix-scroll-area-viewport\]) {
39
- display: flex;
40
- flex-direction: column;
41
- align-items: stretch;
42
- }
43
- :where(\[data-radix-scroll-area-content\]) {
44
- flex-grow: 1;
45
- }
46
-
47
- Math.round(
48
- ((this.value - this.min) / (this.max - this.min)) \* 100,
49
- )
50
-
51
- Copy
52
-
53
- This caters for those scenarios where the `min` or `max` values change.
54
-
55
- ### [](#boundary-limits)Boundary limits
56
-
57
- There is a danger that the value can exceed the boundaries set in the `min` and `max` values, and cause the percentage width of the bar to overflow the indicator. To prevent this the following rules are applied:
58
-
59
- * If the `value` is less than the `min` prop, it is reset to the `min` prop;
60
- * If the `value` is more than the `max` prop, it is reset to the `max` prop;
61
-
62
- ### [](#section-title)Section Title
63
-
64
- The `section-title` prop is used by assistive technologies and allows you to tailor the message announced when the progress component is selected. This could be to add extra context about where the user is in a process or section with a multi-part form.
65
-
66
- ### [](#use-of-tokens)Use of tokens
67
-
68
- The message supports the use of two tokens within the announcement, which are replaced when the component is rendered. They are:
69
-
70
- * `{{current}}` - replaced with the `value`;
71
- * `{{max}}` - replaced with the maximum limit;
72
-
73
- For example, if the component has been implemented with a max of 10, a value of 6 has been set, and the default section title, the screen reader will announce:
74
-
75
- \[data-radix-scroll-area-viewport\] {
76
- scrollbar-width: none;
77
- -ms-overflow-style: none;
78
- -webkit-overflow-scrolling: touch;
79
- }
80
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
81
- display: none;
82
- }
83
- :where(\[data-radix-scroll-area-viewport\]) {
84
- display: flex;
85
- flex-direction: column;
86
- align-items: stretch;
87
- }
88
- :where(\[data-radix-scroll-area-content\]) {
89
- flex-grow: 1;
90
- }
91
-
92
- Step 6 of 10
93
-
94
- Copy
95
-
96
- On this page
97
-
98
- * [Overview](#overview)
99
- * [Props](#props)
100
- * [Usage](#usage)
101
- * [Calculation to convert value in to width](#calculation-to-convert-value-in-to-width)
102
- * [Boundary limits](#boundary-limits)
103
- * [Section Title](#section-title)
104
- * [Use of tokens](#use-of-tokens)
@@ -1,107 +0,0 @@
1
- [](#radio)Radio
2
- ===============
3
-
4
- Overview
5
- --------
6
-
7
- A radio is a single option presented with a radio button. It is used to select a single option from multiple options. It is typically used in an `IressRadioGroup`.
8
-
9
- Radio button
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
- <IressRadio\>
16
- Radio button
17
- </IressRadio\>
18
-
19
- Copy
20
-
21
- [](#examples)Examples
22
- ---------------------
23
-
24
- ### [](#checked)Checked
25
-
26
- You can set the radio to `checked` by default. This is useful when you want to pre-select an option.
27
-
28
- **Note:** If you are using an `IressRadioGroup`, you should use the `value` prop on the `IressRadioGroup` to set the checked state of its `<IressRadio />` children, as the `checked` prop will be ignored.
29
-
30
- Checked radio button
31
-
32
- Hide code
33
-
34
- \[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; }
35
-
36
- <IressRadio checked\>
37
- Checked radio button
38
- </IressRadio\>
39
-
40
- Copy
41
-
42
- ### [](#hidden-control)Hidden control
43
-
44
- You can hide the radio button and use a custom UI to display the content. Even though the radio button is hidden, it still acts like a radio.
45
-
46
- Hidden radio button
47
-
48
- Hide code
49
-
50
- \[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; }
51
-
52
- <IressRadio hiddenControl\>
53
- <IressPanel\>
54
- Hidden radio button </IressPanel\>
55
- </IressRadio\>
56
-
57
- Copy
58
-
59
- ### [](#readonly)Readonly
60
-
61
- The `readOnly` prop changes how the radio is rendered. It will only render if the radio is checked (alongside a hidden input that contains the `value` if it was set), otherwise it not be rendered.
62
-
63
- It is understandable that this may not be the desired behavior for all use cases. If you need a radio that is not editable, but still visible, simply do not set the `readOnly` prop and set the `checked` prop instead.
64
-
65
- Radio button
66
-
67
- Hide code
68
-
69
- \[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; }
70
-
71
- <IressStack gutter\="sm"\>
72
- <IressRadio
73
- defaultChecked
74
- readOnly
75
- \>
76
- Radio button </IressRadio\>
77
- <IressRadio readOnly\>
78
- Radio button </IressRadio\>
79
- </IressStack\>
80
-
81
- Copy
82
-
83
- ### [](#touch)Touch
84
-
85
- The `touch` prop adds the button-like border and padding to radio.
86
-
87
- Radio button
88
-
89
- Hide code
90
-
91
- \[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; }
92
-
93
- <IressRadio touch\>
94
- Radio button
95
- </IressRadio\>
96
-
97
- Copy
98
-
99
- On this page
100
-
101
- * [Overview](#overview)
102
- * [Props](#props)
103
- * [Examples](#examples)
104
- * [Checked](#checked)
105
- * [Hidden control](#hidden-control)
106
- * [Readonly](#readonly)
107
- * [Touch](#touch)