@rio-cloud/uikit-mcp 1.1.3 → 1.1.5

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 (191) hide show
  1. package/README.md +1 -0
  2. package/dist/doc-metadata.json +97 -97
  3. package/dist/docs/components/accentBar.md +5 -5
  4. package/dist/docs/components/activity.md +7 -7
  5. package/dist/docs/components/animatedNumber.md +10 -10
  6. package/dist/docs/components/animatedTextReveal.md +42 -43
  7. package/dist/docs/components/animations.md +42 -34
  8. package/dist/docs/components/appHeader.md +20 -35
  9. package/dist/docs/components/appLayout.md +198 -221
  10. package/dist/docs/components/appNavigationBar.md +21 -21
  11. package/dist/docs/components/areaCharts.md +38 -38
  12. package/dist/docs/components/aspectRatioPlaceholder.md +4 -5
  13. package/dist/docs/components/assetTree.md +887 -614
  14. package/dist/docs/components/autosuggests.md +4 -4
  15. package/dist/docs/components/avatar.md +7 -7
  16. package/dist/docs/components/banner.md +2 -2
  17. package/dist/docs/components/barCharts.md +173 -173
  18. package/dist/docs/components/barList.md +19 -41
  19. package/dist/docs/components/basicMap.md +1 -1
  20. package/dist/docs/components/bottomSheet.md +74 -74
  21. package/dist/docs/components/button.md +161 -71
  22. package/dist/docs/components/buttonToolbar.md +3 -3
  23. package/dist/docs/components/calendarStripe.md +71 -123
  24. package/dist/docs/components/card.md +4 -4
  25. package/dist/docs/components/carousel.md +1 -1
  26. package/dist/docs/components/chartColors.md +1 -1
  27. package/dist/docs/components/chartsGettingStarted.md +1 -1
  28. package/dist/docs/components/chat.md +2 -2
  29. package/dist/docs/components/checkbox.md +56 -131
  30. package/dist/docs/components/clearableInput.md +23 -127
  31. package/dist/docs/components/collapse.md +14 -16
  32. package/dist/docs/components/composedCharts.md +31 -31
  33. package/dist/docs/components/contentLoader.md +125 -122
  34. package/dist/docs/components/dataTabs.md +103 -93
  35. package/dist/docs/components/datepickers.md +734 -764
  36. package/dist/docs/components/dialogs.md +299 -186
  37. package/dist/docs/components/divider.md +4 -4
  38. package/dist/docs/components/dropdowns.md +4555 -4498
  39. package/dist/docs/components/editableContent.md +97 -97
  40. package/dist/docs/components/expander.md +56 -56
  41. package/dist/docs/components/fade.md +41 -41
  42. package/dist/docs/components/fadeExpander.md +4 -4
  43. package/dist/docs/components/fadeUp.md +8 -10
  44. package/dist/docs/components/feedback.md +22 -21
  45. package/dist/docs/components/filePickers.md +25 -25
  46. package/dist/docs/components/formLabel.md +5 -7
  47. package/dist/docs/components/groupedItemList.md +37 -37
  48. package/dist/docs/components/iconList.md +4 -4
  49. package/dist/docs/components/imagePreloader.md +6 -6
  50. package/dist/docs/components/labeledElement.md +4 -3
  51. package/dist/docs/components/licensePlate.md +2 -2
  52. package/dist/docs/components/lineCharts.md +58 -58
  53. package/dist/docs/components/listMenu.md +63 -41
  54. package/dist/docs/components/loadMore.md +17 -17
  55. package/dist/docs/components/mainNavigation.md +1 -1
  56. package/dist/docs/components/mapCircle.md +1 -1
  57. package/dist/docs/components/mapCluster.md +1 -1
  58. package/dist/docs/components/mapContext.md +1 -1
  59. package/dist/docs/components/mapDraggableMarker.md +1 -1
  60. package/dist/docs/components/mapGettingStarted.md +1 -1
  61. package/dist/docs/components/mapInfoBubble.md +1 -1
  62. package/dist/docs/components/mapLayerGroup.md +1 -1
  63. package/dist/docs/components/mapMarker.md +339 -345
  64. package/dist/docs/components/mapPolygon.md +16 -20
  65. package/dist/docs/components/mapRoute.md +14 -20
  66. package/dist/docs/components/mapRouteGenerator.md +1 -1
  67. package/dist/docs/components/mapSettings.md +263 -274
  68. package/dist/docs/components/mapUtils.md +3 -5
  69. package/dist/docs/components/multiselects.md +1 -1
  70. package/dist/docs/components/noData.md +11 -11
  71. package/dist/docs/components/notifications.md +1 -1
  72. package/dist/docs/components/numbercontrol.md +39 -37
  73. package/dist/docs/components/onboarding.md +18 -38
  74. package/dist/docs/components/page.md +16 -16
  75. package/dist/docs/components/pager.md +8 -8
  76. package/dist/docs/components/pieCharts.md +124 -124
  77. package/dist/docs/components/popover.md +37 -53
  78. package/dist/docs/components/position.md +4 -4
  79. package/dist/docs/components/radialBarCharts.md +506 -506
  80. package/dist/docs/components/radiobutton.md +209 -191
  81. package/dist/docs/components/releaseNotes.md +9 -3
  82. package/dist/docs/components/resizer.md +7 -8
  83. package/dist/docs/components/responsiveColumnStripe.md +11 -11
  84. package/dist/docs/components/responsiveVideo.md +5 -5
  85. package/dist/docs/components/rioglyph.md +11 -11
  86. package/dist/docs/components/rules.md +118 -92
  87. package/dist/docs/components/saveableInput.md +366 -356
  88. package/dist/docs/components/selects.md +9996 -15
  89. package/dist/docs/components/sidebar.md +22 -23
  90. package/dist/docs/components/sliders.md +26 -26
  91. package/dist/docs/components/smoothScrollbars.md +61 -25
  92. package/dist/docs/components/spinners.md +32 -30
  93. package/dist/docs/components/states.md +236 -245
  94. package/dist/docs/components/statsWidgets.md +37 -28
  95. package/dist/docs/components/statusBar.md +22 -22
  96. package/dist/docs/components/stepButton.md +2 -2
  97. package/dist/docs/components/steppedProgressBars.md +45 -45
  98. package/dist/docs/components/subNavigation.md +3 -3
  99. package/dist/docs/components/supportMarker.md +1 -1
  100. package/dist/docs/components/svgImage.md +2 -38
  101. package/dist/docs/components/switch.md +11 -11
  102. package/dist/docs/components/tables.md +1 -1
  103. package/dist/docs/components/tagManager.md +40 -40
  104. package/dist/docs/components/tags.md +21 -20
  105. package/dist/docs/components/teaser.md +22 -23
  106. package/dist/docs/components/timeline.md +1 -1
  107. package/dist/docs/components/timepicker.md +17 -13
  108. package/dist/docs/components/toggleButton.md +65 -29
  109. package/dist/docs/components/tooltip.md +27 -50
  110. package/dist/docs/components/virtualList.md +75 -75
  111. package/dist/docs/foundations.md +167 -167
  112. package/dist/docs/start/changelog.md +23 -1
  113. package/dist/docs/start/goodtoknow.md +1 -1
  114. package/dist/docs/start/guidelines/color-combinations.md +1 -1
  115. package/dist/docs/start/guidelines/custom-css.md +1 -1
  116. package/dist/docs/start/guidelines/custom-rioglyph.md +1 -1
  117. package/dist/docs/start/guidelines/formatting.md +1 -1
  118. package/dist/docs/start/guidelines/iframe.md +80 -27
  119. package/dist/docs/start/guidelines/obfuscate-data.md +1 -1
  120. package/dist/docs/start/guidelines/print-css.md +1 -1
  121. package/dist/docs/start/guidelines/spinner.md +81 -81
  122. package/dist/docs/start/guidelines/supported-browsers.md +1 -1
  123. package/dist/docs/start/guidelines/writing.md +1 -1
  124. package/dist/docs/start/howto.md +9 -9
  125. package/dist/docs/start/intro.md +1 -1
  126. package/dist/docs/start/responsiveness.md +1 -1
  127. package/dist/docs/templates/common-table.md +11 -11
  128. package/dist/docs/templates/detail-views.md +2 -2
  129. package/dist/docs/templates/expandable-details.md +1 -1
  130. package/dist/docs/templates/feature-cards.md +55 -55
  131. package/dist/docs/templates/form-summary.md +22 -22
  132. package/dist/docs/templates/form-toggle.md +1 -1
  133. package/dist/docs/templates/list-blocks.md +197 -197
  134. package/dist/docs/templates/loading-progress.md +1 -1
  135. package/dist/docs/templates/options-panel.md +1 -1
  136. package/dist/docs/templates/panel-variants.md +1 -1
  137. package/dist/docs/templates/progress-cards.md +1 -1
  138. package/dist/docs/templates/progress-success.md +1 -1
  139. package/dist/docs/templates/settings-form.md +23 -23
  140. package/dist/docs/templates/stats-blocks.md +41 -41
  141. package/dist/docs/templates/table-panel.md +1 -1
  142. package/dist/docs/templates/table-row-animation.md +1 -1
  143. package/dist/docs/templates/usage-cards.md +1 -1
  144. package/dist/docs/utilities/deviceUtils.md +6 -3
  145. package/dist/docs/utilities/featureToggles.md +1 -1
  146. package/dist/docs/utilities/fuelTypeUtils.md +1 -1
  147. package/dist/docs/utilities/routeUtils.md +59 -23
  148. package/dist/docs/utilities/useAfterMount.md +1 -1
  149. package/dist/docs/utilities/useAutoAnimate.md +1 -1
  150. package/dist/docs/utilities/useAverage.md +1 -1
  151. package/dist/docs/utilities/useClickOutside.md +1 -1
  152. package/dist/docs/utilities/useClipboard.md +2 -2
  153. package/dist/docs/utilities/useCount.md +1 -1
  154. package/dist/docs/utilities/useDarkMode.md +1 -1
  155. package/dist/docs/utilities/useDebugInfo.md +4 -4
  156. package/dist/docs/utilities/useEffectOnce.md +1 -1
  157. package/dist/docs/utilities/useElapsedTime.md +1 -1
  158. package/dist/docs/utilities/useElementSize.md +1 -1
  159. package/dist/docs/utilities/useEsc.md +1 -1
  160. package/dist/docs/utilities/useEvent.md +1 -1
  161. package/dist/docs/utilities/useFocusTrap.md +1 -1
  162. package/dist/docs/utilities/useFullscreen.md +1 -1
  163. package/dist/docs/utilities/useHover.md +1 -1
  164. package/dist/docs/utilities/useIncomingPostMessages.md +1 -1
  165. package/dist/docs/utilities/useInterval.md +1 -1
  166. package/dist/docs/utilities/useIsFocusWithin.md +1 -1
  167. package/dist/docs/utilities/useKey.md +7 -5
  168. package/dist/docs/utilities/useLocalStorage.md +1 -1
  169. package/dist/docs/utilities/useLocationSuggestions.md +1 -1
  170. package/dist/docs/utilities/useMax.md +1 -1
  171. package/dist/docs/utilities/useMin.md +1 -1
  172. package/dist/docs/utilities/useMutationObserver.md +1 -1
  173. package/dist/docs/utilities/useOnScreen.md +1 -1
  174. package/dist/docs/utilities/useOnlineStatus.md +1 -1
  175. package/dist/docs/utilities/usePostMessage.md +58 -2
  176. package/dist/docs/utilities/usePostMessageSender.md +1 -1
  177. package/dist/docs/utilities/usePrevious.md +1 -1
  178. package/dist/docs/utilities/useResizeObserver.md +1 -1
  179. package/dist/docs/utilities/useScrollPosition.md +1 -1
  180. package/dist/docs/utilities/useSearch.md +1 -1
  181. package/dist/docs/utilities/useSorting.md +1 -1
  182. package/dist/docs/utilities/useStateWithValidation.md +1 -1
  183. package/dist/docs/utilities/useSum.md +1 -1
  184. package/dist/docs/utilities/useTableExport.md +54 -54
  185. package/dist/docs/utilities/useTableSelection.md +93 -93
  186. package/dist/docs/utilities/useTimeout.md +1 -1
  187. package/dist/docs/utilities/useToggle.md +1 -1
  188. package/dist/docs/utilities/useWindowResize.md +1 -1
  189. package/dist/index.mjs +8 -8
  190. package/dist/version.json +2 -2
  191. package/package.json +6 -6
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Progress
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/barList
6
- *Captured:* 2026-01-07T12:11:32.933Z
6
+ *Captured:* 2026-02-03T14:04:36.191Z
7
7
 
8
8
  ## BarList
9
9
 
@@ -180,21 +180,21 @@ const transportData = [
180
180
  <div class="display-flex justify-content-between gap-15">
181
181
  <div class="width-100pct space-y-5">
182
182
  <div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
183
- <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 49.4673%;">
183
+ <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 49.7361%;">
184
184
  </div>
185
185
  <div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
186
186
  <a href="https://example.com/metrics/on-time-delivery" class="text-color-darker" target="_blank" rel="noreferrer">On-time delivery</a>
187
187
  </div>
188
188
  </div>
189
189
  <div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
190
- <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 31.4876%;">
190
+ <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 31.7867%;">
191
191
  </div>
192
192
  <div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
193
193
  <div class="text-color-darker">Warehouse efficiency</div>
194
194
  </div>
195
195
  </div>
196
196
  <div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
197
- <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 15.2012%;">
197
+ <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 15.4802%;">
198
198
  </div>
199
199
  <div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
200
200
  <a href="https://example.com/metrics/truck-utilization" class="text-color-darker" target="_blank" rel="noreferrer">Truck utilization</a>
@@ -239,21 +239,21 @@ const transportData = [
239
239
  <div class="display-flex justify-content-between gap-15 flex-row-reverse gap-10">
240
240
  <div class="width-100pct space-y-5">
241
241
  <div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
242
- <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 49.4673%;">
242
+ <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 49.7361%;">
243
243
  </div>
244
244
  <div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
245
245
  <a href="https://example.com/metrics/on-time-delivery" class="text-color-darker" target="_blank" rel="noreferrer">On-time delivery</a>
246
246
  </div>
247
247
  </div>
248
248
  <div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
249
- <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 31.4876%;">
249
+ <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 31.7867%;">
250
250
  </div>
251
251
  <div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
252
252
  <div class="text-color-darker">Warehouse efficiency</div>
253
253
  </div>
254
254
  </div>
255
255
  <div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
256
- <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 15.2012%;">
256
+ <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 15.4802%;">
257
257
  </div>
258
258
  <div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
259
259
  <a href="https://example.com/metrics/truck-utilization" class="text-color-darker" target="_blank" rel="noreferrer">Truck utilization</a>
@@ -307,22 +307,11 @@ const transportData = [
307
307
  </div>
308
308
  ```
309
309
 
310
- #### Props
311
-
312
- | Name | Type | Default | Description |
313
- | --- | --- | --- | --- |
314
- | data | BarListRow<T>[] | — | Array of bar row data to be rendered. |
315
- | valueFormatter | (value: number) => string \| React.ReactElement | — | Optional function to format the numeric value displayed on the right side of each bar. |
316
- | referenceValue | number | max(data.value) | A reference value used to calculate relative widths. If not provided, the maximum value in the data array will be used. |
317
- | showAnimation | boolean | false | Whether to animate the bar width transitions using Framer Motion. |
318
- | onSelectRow | (payload: BarListRow<T>) => void | — | Callback fired when a bar is clicked. Receives the full data object of the selected bar. |
319
- | sortOrder | 'asc' \| 'desc' \| 'none' | 'none' | The sort order for the bars. |
320
- | rowHeight | number | 32 | Height of each bar row in pixels. |
321
- | opacity | number | 0.5 | Opacity applied to non-hovered bars. Value should be between 0 and 1. |
322
- | barColor | string | 'bg-highlight-light' | CSS class or color string used for the active/progress portion of each bar. |
323
- | labelColor | string | 'text-color-darker' | CSS class or color string used for the text labels. |
324
- | background | string | 'bg-transparent' | CSS class or color string used for the bar background. |
325
- | className | string | — | Additional classes for the wrapper element. |
310
+ #### Props (json)
311
+
312
+ ```json
313
+ valueFormatter={(value) => `${value}%`}
314
+ ```
326
315
 
327
316
  ### Example: 95
328
317
 
@@ -454,14 +443,14 @@ const transportData = [
454
443
  </div>
455
444
  </div>
456
445
  <div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-lightest cursor-pointer">
457
- <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-coldplay-moos" role="presentation" style="height: 25px; opacity: 0.5; width: 48.6505%;">
446
+ <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-coldplay-moos" role="presentation" style="height: 25px; opacity: 0.5; width: 48.958%;">
458
447
  </div>
459
448
  <div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
460
449
  <div class="text-color-darker">Stored in warehouse</div>
461
450
  </div>
462
451
  </div>
463
452
  <div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-lightest cursor-pointer">
464
- <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-coldplay-moos" role="presentation" style="height: 25px; opacity: 0.5; width: 92.5858%;">
453
+ <div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-coldplay-moos" role="presentation" style="height: 25px; opacity: 0.5; width: 93.9138%;">
465
454
  </div>
466
455
  <div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
467
456
  <div class="text-color-darker">Shipped packages</div>
@@ -499,19 +488,8 @@ const transportData = [
499
488
  </div>
500
489
  ```
501
490
 
502
- #### Props
503
-
504
- | Name | Type | Default | Description |
505
- | --- | --- | --- | --- |
506
- | data | BarListRow<T>[] | — | Array of bar row data to be rendered. |
507
- | valueFormatter | (value: number) => string \| React.ReactElement | — | Optional function to format the numeric value displayed on the right side of each bar. |
508
- | referenceValue | number | max(data.value) | A reference value used to calculate relative widths. If not provided, the maximum value in the data array will be used. |
509
- | showAnimation | boolean | false | Whether to animate the bar width transitions using Framer Motion. |
510
- | onSelectRow | (payload: BarListRow<T>) => void | — | Callback fired when a bar is clicked. Receives the full data object of the selected bar. |
511
- | sortOrder | 'asc' \| 'desc' \| 'none' | 'none' | The sort order for the bars. |
512
- | rowHeight | number | 32 | Height of each bar row in pixels. |
513
- | opacity | number | 0.5 | Opacity applied to non-hovered bars. Value should be between 0 and 1. |
514
- | barColor | string | 'bg-highlight-light' | CSS class or color string used for the active/progress portion of each bar. |
515
- | labelColor | string | 'text-color-darker' | CSS class or color string used for the text labels. |
516
- | background | string | 'bg-transparent' | CSS class or color string used for the bar background. |
517
- | className | string | — | Additional classes for the wrapper element. |
491
+ #### Props (json)
492
+
493
+ ```json
494
+ valueFormatter={(value) => `${value}%`}
495
+ ```
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Map
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/basicMap
6
- *Captured:* 2026-01-07T12:12:13.590Z
6
+ *Captured:* 2026-02-03T14:05:23.833Z
7
7
 
8
8
  The following map shows labels for locale de
9
9
 
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Application
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/bottomSheet
6
- *Captured:* 2026-01-07T12:11:07.966Z
6
+ *Captured:* 2026-02-03T14:04:08.526Z
7
7
 
8
8
  The TimedBottomSheet is a wrapper component for the BottomSheet that allows to control it's visibility via timers and to use the localStorage to save user interaction for handling it's visibility.
9
9
 
@@ -80,21 +80,21 @@ const content = (
80
80
 
81
81
  | Name | Type | Default | Description |
82
82
  | --- | --- | --- | --- |
83
- | show | Boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
84
- | onClose | Function | () => {}) | Callback for when the sheet closes. |
85
- | width | Number / String | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a "max-width-xxx" via className to control it better. |
86
- | height | Number / String | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
87
- | title | Node / String | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
88
- | showCloseButton | Boolean | true | Defines whether or not the close button is shown. |
89
- | showMaximizeButton | Boolean | false | Defines whether or not the maximize button in the header is shown. |
90
- | onHeightChange | Function | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
91
- | detach | Boolean | false | Set to "true" to detach the bottom sheet from the left side and the bottom and create a little offset. |
92
- | detachOffset | Number | 15 | Defines the amount of pixels for the sheet. |
93
- | hasBackdrop | Boolean | false | Set to "true" to render a modal like backdrop to emphasize the bottom sheet. |
94
- | onBackdropClick | Function | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
95
- | bodyRef | React Ref | — | A react ref added to the bottom sheet body. |
96
- | bodyClassName | String | — | Additional classes to be set on the body element. |
97
- | className | String | — | Additional classes to be set on the wrapping element. |
83
+ | show | boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
84
+ | onClose | (isShown: boolean) => void | — | Callback for when the sheet closes. |
85
+ | width | number \| string | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a max-width-xxx via className to control it better. |
86
+ | height | number \| string | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
87
+ | title | string \| ReactNode | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
88
+ | showCloseButton | boolean | true | Defines whether or not the close button is shown. |
89
+ | showMaximizeButton | boolean | false | Defines whether or not the maximize button in the header is shown. |
90
+ | onHeightChange | VoidFunction | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
91
+ | detach | boolean | false | Set to true to detach the bottom sheet from the left side and the bottom and create a little offset. |
92
+ | detachOffset | number | 15 | Defines the amount of pixels for the sheet. |
93
+ | hasBackdrop | boolean | false | Set to true to render a modal like backdrop to emphasize the bottom sheet. |
94
+ | onBackdropClick | VoidFunction | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
95
+ | bodyRef | MutableRefObject<HTMLDivElement \| null> | — | A react ref added to the bottom sheet body. |
96
+ | bodyClassName | string | — | Additional classes to be set on the body element. |
97
+ | className | string | — | Additional classes to be set on the wrapping element. |
98
98
 
99
99
  ### Example: Example 2
100
100
 
@@ -223,21 +223,21 @@ export default () => {
223
223
 
224
224
  | Name | Type | Default | Description |
225
225
  | --- | --- | --- | --- |
226
- | show | Boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
227
- | onClose | Function | () => {}) | Callback for when the sheet closes. |
228
- | width | Number / String | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a "max-width-xxx" via className to control it better. |
229
- | height | Number / String | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
230
- | title | Node / String | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
231
- | showCloseButton | Boolean | true | Defines whether or not the close button is shown. |
232
- | showMaximizeButton | Boolean | false | Defines whether or not the maximize button in the header is shown. |
233
- | onHeightChange | Function | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
234
- | detach | Boolean | false | Set to "true" to detach the bottom sheet from the left side and the bottom and create a little offset. |
235
- | detachOffset | Number | 15 | Defines the amount of pixels for the sheet. |
236
- | hasBackdrop | Boolean | false | Set to "true" to render a modal like backdrop to emphasize the bottom sheet. |
237
- | onBackdropClick | Function | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
238
- | bodyRef | React Ref | — | A react ref added to the bottom sheet body. |
239
- | bodyClassName | String | — | Additional classes to be set on the body element. |
240
- | className | String | — | Additional classes to be set on the wrapping element. |
226
+ | show | boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
227
+ | onClose | (isShown: boolean) => void | — | Callback for when the sheet closes. |
228
+ | width | number \| string | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a max-width-xxx via className to control it better. |
229
+ | height | number \| string | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
230
+ | title | string \| ReactNode | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
231
+ | showCloseButton | boolean | true | Defines whether or not the close button is shown. |
232
+ | showMaximizeButton | boolean | false | Defines whether or not the maximize button in the header is shown. |
233
+ | onHeightChange | VoidFunction | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
234
+ | detach | boolean | false | Set to true to detach the bottom sheet from the left side and the bottom and create a little offset. |
235
+ | detachOffset | number | 15 | Defines the amount of pixels for the sheet. |
236
+ | hasBackdrop | boolean | false | Set to true to render a modal like backdrop to emphasize the bottom sheet. |
237
+ | onBackdropClick | VoidFunction | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
238
+ | bodyRef | MutableRefObject<HTMLDivElement \| null> | — | A react ref added to the bottom sheet body. |
239
+ | bodyClassName | string | — | Additional classes to be set on the body element. |
240
+ | className | string | — | Additional classes to be set on the wrapping element. |
241
241
 
242
242
  ### Example: Example 3
243
243
 
@@ -340,21 +340,21 @@ export default () => {
340
340
 
341
341
  | Name | Type | Default | Description |
342
342
  | --- | --- | --- | --- |
343
- | show | Boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
344
- | onClose | Function | () => {}) | Callback for when the sheet closes. |
345
- | width | Number / String | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a "max-width-xxx" via className to control it better. |
346
- | height | Number / String | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
347
- | title | Node / String | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
348
- | showCloseButton | Boolean | true | Defines whether or not the close button is shown. |
349
- | showMaximizeButton | Boolean | false | Defines whether or not the maximize button in the header is shown. |
350
- | onHeightChange | Function | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
351
- | detach | Boolean | false | Set to "true" to detach the bottom sheet from the left side and the bottom and create a little offset. |
352
- | detachOffset | Number | 15 | Defines the amount of pixels for the sheet. |
353
- | hasBackdrop | Boolean | false | Set to "true" to render a modal like backdrop to emphasize the bottom sheet. |
354
- | onBackdropClick | Function | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
355
- | bodyRef | React Ref | — | A react ref added to the bottom sheet body. |
356
- | bodyClassName | String | — | Additional classes to be set on the body element. |
357
- | className | String | — | Additional classes to be set on the wrapping element. |
343
+ | show | boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
344
+ | onClose | (isShown: boolean) => void | — | Callback for when the sheet closes. |
345
+ | width | number \| string | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a max-width-xxx via className to control it better. |
346
+ | height | number \| string | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
347
+ | title | string \| ReactNode | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
348
+ | showCloseButton | boolean | true | Defines whether or not the close button is shown. |
349
+ | showMaximizeButton | boolean | false | Defines whether or not the maximize button in the header is shown. |
350
+ | onHeightChange | VoidFunction | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
351
+ | detach | boolean | false | Set to true to detach the bottom sheet from the left side and the bottom and create a little offset. |
352
+ | detachOffset | number | 15 | Defines the amount of pixels for the sheet. |
353
+ | hasBackdrop | boolean | false | Set to true to render a modal like backdrop to emphasize the bottom sheet. |
354
+ | onBackdropClick | VoidFunction | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
355
+ | bodyRef | MutableRefObject<HTMLDivElement \| null> | — | A react ref added to the bottom sheet body. |
356
+ | bodyClassName | string | — | Additional classes to be set on the body element. |
357
+ | className | string | — | Additional classes to be set on the wrapping element. |
358
358
 
359
359
  ### Example: Example 4
360
360
 
@@ -444,21 +444,21 @@ export default () => {
444
444
 
445
445
  | Name | Type | Default | Description |
446
446
  | --- | --- | --- | --- |
447
- | show | Boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
448
- | onClose | Function | () => {}) | Callback for when the sheet closes. |
449
- | width | Number / String | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a "max-width-xxx" via className to control it better. |
450
- | height | Number / String | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
451
- | title | Node / String | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
452
- | showCloseButton | Boolean | true | Defines whether or not the close button is shown. |
453
- | showMaximizeButton | Boolean | false | Defines whether or not the maximize button in the header is shown. |
454
- | onHeightChange | Function | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
455
- | detach | Boolean | false | Set to "true" to detach the bottom sheet from the left side and the bottom and create a little offset. |
456
- | detachOffset | Number | 15 | Defines the amount of pixels for the sheet. |
457
- | hasBackdrop | Boolean | false | Set to "true" to render a modal like backdrop to emphasize the bottom sheet. |
458
- | onBackdropClick | Function | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
459
- | bodyRef | React Ref | — | A react ref added to the bottom sheet body. |
460
- | bodyClassName | String | — | Additional classes to be set on the body element. |
461
- | className | String | — | Additional classes to be set on the wrapping element. |
447
+ | show | boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
448
+ | onClose | (isShown: boolean) => void | — | Callback for when the sheet closes. |
449
+ | width | number \| string | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a max-width-xxx via className to control it better. |
450
+ | height | number \| string | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
451
+ | title | string \| ReactNode | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
452
+ | showCloseButton | boolean | true | Defines whether or not the close button is shown. |
453
+ | showMaximizeButton | boolean | false | Defines whether or not the maximize button in the header is shown. |
454
+ | onHeightChange | VoidFunction | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
455
+ | detach | boolean | false | Set to true to detach the bottom sheet from the left side and the bottom and create a little offset. |
456
+ | detachOffset | number | 15 | Defines the amount of pixels for the sheet. |
457
+ | hasBackdrop | boolean | false | Set to true to render a modal like backdrop to emphasize the bottom sheet. |
458
+ | onBackdropClick | VoidFunction | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
459
+ | bodyRef | MutableRefObject<HTMLDivElement \| null> | — | A react ref added to the bottom sheet body. |
460
+ | bodyClassName | string | — | Additional classes to be set on the body element. |
461
+ | className | string | — | Additional classes to be set on the wrapping element. |
462
462
 
463
463
  ## TimedBottomSheet
464
464
 
@@ -543,7 +543,7 @@ export const FeedbackBottomSheet = ({ onClose }: { onClose: VoidFunction }) => {
543
543
  }, HIDE_AFTER_SUBMIT_IN_MS);
544
544
  };
545
545
 
546
- const sendFeedback = (messageToSend: string, featureRating: number | undefined) => {
546
+ const sendFeedback = (messageToSend: string, _featureRating: number | undefined) => {
547
547
  console.log(`Sending email with message \n${messageToSend}`);
548
548
  };
549
549
 
@@ -707,15 +707,15 @@ export default () => {
707
707
 
708
708
  | Name | Type | Default | Description |
709
709
  | --- | --- | --- | --- |
710
- | dismissed | Boolean | false | The "dismissed" flag can be used to tell this component that the user has clicked on the content of the component like a button or a link. In this case, the bottom sheet will store a flag in the localStorage to hide the bottom sheet for the next time and it will close the sheet right away. |
711
- | featureName | String | 0 | The "featureName" prop is used to name the localStorage flag that is used to control the visibility. It should be unique to avoid conflicts with other timed bottom sheets. |
712
- | localStoragePrefix | String | | A prefix that will be used for the local storage flag to store whether the bottom sheet should be hidden. Use this prefix for your service name for instance. |
713
- | showAfter | Number | 0 | Defines the time in milliseconds when the bottom sheet shall be shown. Default value is 0 to show it right away. |
714
- | hideAfter | Number | 3_600_000 | Defines the time in milliseconds when the bottom sheet hides itself automatically. Default value is 3_600_000 to hide it after 1 hour. In this case, the localStorage flag is not set and the bottom sheet will be shown on the next page load. |
715
- | alwaysOn | Boolean | false | With this enabled, the BottomSheet will not hide automatically. |
716
- | showCloseButton | Boolean | true | Enables or disabled the close button. |
717
- | width | Number | | Optional width of the bottom sheet. Alternatively, you can set a `max-width-xxx` via className instead. |
718
- | cleanupLocalStorage | Boolean | false | Flag to allow to remove the localStorage flag again once the component is not needed anymore. |
719
- | onClose | () => void | | Callback function that gets triggered when the user closed the bottom sheet with the close button. |
720
- | bodyClassName | String | | Optional className to be set on the body. |
721
- | className | String | — | Optional className to be set on the component. Use this to define a max-width value. |
710
+ | dismissed | boolean | false | The dismissed flag can be used to tell this component that the user has clicked on the content of the component like a button or a link. In this case, the bottom sheet will store a flag in the localStorage to hide the bottom sheet for the next time and it will close the sheet right away. |
711
+ | featureName | string | | The featureName prop is used to name the localStorage flag that is used to control the visibility. It should be unique to avoid conflicts with other timed bottom sheets. |
712
+ | showAfter | number | 0 | Defines the time in milliseconds when the bottom sheet shall be shown. Default value is 0 to show it right away. |
713
+ | hideAfter | number | 3_600_000 | Defines the time in milliseconds when the bottom sheet hides itself automatically. Default value is 3_600_000 to hide it after 1 hour. In this case, the localStorage flag is not set and the bottom sheet will be shown on the next page load. |
714
+ | alwaysOn | boolean | false | With this enabled, the BottomSheet will not hide automatically. |
715
+ | showCloseButton | boolean | true | Enables or disabled the close button. |
716
+ | width | number | | Optional width of the bottom sheet. Alternatively, you can set a max-width-xxx via className instead. |
717
+ | cleanupLocalStorage | boolean | false | Flag to allow to remove the localStorage flag again once the component is not needed anymore. |
718
+ | localStoragePrefix | string | | A prefix that will be used for the local storage flag to store whether the bottom sheet should be hidden. Use this prefix for your service name for instance. |
719
+ | onClose | () => void | () => {} | Callback function that gets triggered when the user closed the bottom sheet with the close button. |
720
+ | bodyClassName | string | 'padding-25 margin-right-25' | Optional className to be set on the body. |
721
+ | className | string | — | Optional className to be set on the component. Use this to define a max-width value. |