@rio-cloud/uikit-mcp 1.1.4 → 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 +80 -80
  3. package/dist/docs/components/accentBar.md +34 -2
  4. package/dist/docs/components/activity.md +13 -2
  5. package/dist/docs/components/animatedNumber.md +16 -3
  6. package/dist/docs/components/animatedTextReveal.md +53 -7
  7. package/dist/docs/components/animations.md +30 -30
  8. package/dist/docs/components/appHeader.md +58 -2
  9. package/dist/docs/components/appLayout.md +543 -38
  10. package/dist/docs/components/appNavigationBar.md +54 -2
  11. package/dist/docs/components/areaCharts.md +4 -4
  12. package/dist/docs/components/aspectRatioPlaceholder.md +10 -2
  13. package/dist/docs/components/assetTree.md +1065 -218
  14. package/dist/docs/components/autosuggests.md +1 -1
  15. package/dist/docs/components/avatar.md +24 -2
  16. package/dist/docs/components/banner.md +2 -2
  17. package/dist/docs/components/barCharts.md +27 -27
  18. package/dist/docs/components/barList.md +21 -9
  19. package/dist/docs/components/basicMap.md +1 -1
  20. package/dist/docs/components/bottomSheet.md +99 -2
  21. package/dist/docs/components/button.md +161 -16
  22. package/dist/docs/components/buttonToolbar.md +9 -2
  23. package/dist/docs/components/calendarStripe.md +84 -110
  24. package/dist/docs/components/card.md +10 -2
  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 +51 -26
  30. package/dist/docs/components/clearableInput.md +17 -17
  31. package/dist/docs/components/collapse.md +27 -3
  32. package/dist/docs/components/composedCharts.md +15 -15
  33. package/dist/docs/components/contentLoader.md +125 -104
  34. package/dist/docs/components/dataTabs.md +189 -9
  35. package/dist/docs/components/datepickers.md +733 -721
  36. package/dist/docs/components/dialogs.md +361 -1
  37. package/dist/docs/components/divider.md +14 -2
  38. package/dist/docs/components/dropdowns.md +4533 -4352
  39. package/dist/docs/components/editableContent.md +186 -2
  40. package/dist/docs/components/expander.md +51 -4
  41. package/dist/docs/components/fade.md +41 -6
  42. package/dist/docs/components/fadeExpander.md +11 -2
  43. package/dist/docs/components/fadeUp.md +21 -3
  44. package/dist/docs/components/feedback.md +43 -2
  45. package/dist/docs/components/filePickers.md +44 -2
  46. package/dist/docs/components/formLabel.md +16 -2
  47. package/dist/docs/components/groupedItemList.md +53 -2
  48. package/dist/docs/components/iconList.md +4 -4
  49. package/dist/docs/components/imagePreloader.md +6 -2
  50. package/dist/docs/components/labeledElement.md +12 -2
  51. package/dist/docs/components/licensePlate.md +10 -2
  52. package/dist/docs/components/lineCharts.md +3 -3
  53. package/dist/docs/components/listMenu.md +72 -2
  54. package/dist/docs/components/loadMore.md +28 -2
  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 +1 -1
  64. package/dist/docs/components/mapPolygon.md +1 -1
  65. package/dist/docs/components/mapRoute.md +1 -1
  66. package/dist/docs/components/mapRouteGenerator.md +1 -1
  67. package/dist/docs/components/mapSettings.md +1 -1
  68. package/dist/docs/components/mapUtils.md +1 -1
  69. package/dist/docs/components/multiselects.md +1 -1
  70. package/dist/docs/components/noData.md +22 -2
  71. package/dist/docs/components/notifications.md +1 -1
  72. package/dist/docs/components/numbercontrol.md +50 -2
  73. package/dist/docs/components/onboarding.md +25 -1
  74. package/dist/docs/components/page.md +32 -2
  75. package/dist/docs/components/pager.md +14 -2
  76. package/dist/docs/components/pieCharts.md +36 -36
  77. package/dist/docs/components/popover.md +39 -1
  78. package/dist/docs/components/position.md +10 -2
  79. package/dist/docs/components/radialBarCharts.md +25 -25
  80. package/dist/docs/components/radiobutton.md +137 -9
  81. package/dist/docs/components/releaseNotes.md +18 -1
  82. package/dist/docs/components/resizer.md +13 -2
  83. package/dist/docs/components/responsiveColumnStripe.md +19 -2
  84. package/dist/docs/components/responsiveVideo.md +11 -2
  85. package/dist/docs/components/rioglyph.md +12 -2
  86. package/dist/docs/components/rules.md +94 -4
  87. package/dist/docs/components/saveableInput.md +399 -275
  88. package/dist/docs/components/selects.md +1 -1
  89. package/dist/docs/components/sidebar.md +38 -2
  90. package/dist/docs/components/sliders.md +37 -2
  91. package/dist/docs/components/smoothScrollbars.md +92 -2
  92. package/dist/docs/components/spinners.md +50 -2
  93. package/dist/docs/components/states.md +216 -1
  94. package/dist/docs/components/statsWidgets.md +122 -2
  95. package/dist/docs/components/statusBar.md +28 -2
  96. package/dist/docs/components/stepButton.md +8 -2
  97. package/dist/docs/components/steppedProgressBars.md +66 -2
  98. package/dist/docs/components/subNavigation.md +8 -1
  99. package/dist/docs/components/supportMarker.md +1 -1
  100. package/dist/docs/components/svgImage.md +12 -38
  101. package/dist/docs/components/switch.md +11 -2
  102. package/dist/docs/components/tables.md +1 -1
  103. package/dist/docs/components/tagManager.md +55 -1
  104. package/dist/docs/components/tags.md +32 -2
  105. package/dist/docs/components/teaser.md +29 -2
  106. package/dist/docs/components/timeline.md +1 -1
  107. package/dist/docs/components/timepicker.md +30 -2
  108. package/dist/docs/components/toggleButton.md +65 -7
  109. package/dist/docs/components/tooltip.md +26 -18
  110. package/dist/docs/components/virtualList.md +103 -77
  111. package/dist/docs/foundations.md +177 -177
  112. package/dist/docs/start/changelog.md +1 -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 +2 -2
  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 +1 -1
  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 +200 -200
  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 +16 -16
  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 +1 -1
  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 +1 -1
  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 +1 -1
  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 +1 -1
  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 +51 -51
  185. package/dist/docs/utilities/useTableSelection.md +87 -87
  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 +1 -1
  191. package/package.json +6 -6
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Content
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/dialogs
6
- *Captured:* 2026-01-14T09:07:37.934Z
6
+ *Captured:* 2026-02-03T14:04:51.877Z
7
7
 
8
8
  This component allows the user to create a generic modal dialog.
9
9
 
@@ -376,6 +376,37 @@ export default () => {
376
376
  </div>
377
377
  ```
378
378
 
379
+ #### Props: Base dialog props
380
+
381
+ ### Base dialog props
382
+
383
+ | Name | Type | Default | Description |
384
+ | --- | --- | --- | --- |
385
+ | show | boolean | false | Opens the dialog when set to true. |
386
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
387
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
388
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
389
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
390
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
391
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
392
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
393
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
394
+ | className | string | — | Additional classes for the modal element. |
395
+
396
+ #### Props: Dialog
397
+
398
+ ### Dialog
399
+
400
+ | Name | Type | Default | Description |
401
+ | --- | --- | --- | --- |
402
+ | body | React.ReactNode | — | The dialog body content. |
403
+ | footer | React.ReactNode | — | The dialog body content. |
404
+ | bodyClassName | string | — | Additional classes for the modal-body element. |
405
+ | footerClassName | string | — | Additional classes for the modal-footer element. |
406
+ | headerButtons | React.ReactNode | — | Allows to add additional buttons to the dialog header. |
407
+ | onEsc | VoidFunction | — | A callback fired when esc key is pressed and the dialog is about to close. |
408
+ | onCloseValidation | () => boolean | () => true | A callback function to be executed before closing the dialog. If the function returns false, the dialog will not be closed |
409
+
379
410
  ## Dialog compound components
380
411
 
381
412
  To accommodate forms within the dialog body and have the submit button in the footer or wrapping individual parts of the dialog, a more flexible approach to rendering its individual components is needed. In this scenario, you can make use of the dialog compound components.
@@ -511,6 +542,33 @@ export default () => {
511
542
  </div>
512
543
  ```
513
544
 
545
+ #### Props: Dialog.Title
546
+
547
+ ### Dialog.Title
548
+
549
+ | Name | Type | Default | Description |
550
+ | --- | --- | --- | --- |
551
+ | title | string \| React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
552
+ | subtitle | string \| React.ReactNode | — | The dialog header subtitle content. |
553
+ | headerButtons | React.ReactNode | — | Allows to add additional buttons to the dialog header. |
554
+ | onCloseButtonClick | () => void | — | — |
555
+
556
+ #### Props: Dialog.Body
557
+
558
+ ### Dialog.Body
559
+
560
+ | Name | Type | Default | Description |
561
+ | --- | --- | --- | --- |
562
+ | className | string | — | Additional classes for the modal-body element. |
563
+
564
+ #### Props: Dialog.Footer
565
+
566
+ ### Dialog.Footer
567
+
568
+ | Name | Type | Default | Description |
569
+ | --- | --- | --- | --- |
570
+ | className | string | — | Additional classes for the modal-footer element. |
571
+
514
572
  ## Dialogs with validation
515
573
 
516
574
  ### Example: Example 3
@@ -622,6 +680,37 @@ export default () => {
622
680
  <button type="button" class="btn btn-primary btn-component" tabindex="0">Open dialog</button>
623
681
  ```
624
682
 
683
+ #### Props: Base dialog props
684
+
685
+ ### Base dialog props
686
+
687
+ | Name | Type | Default | Description |
688
+ | --- | --- | --- | --- |
689
+ | show | boolean | false | Opens the dialog when set to true. |
690
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
691
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
692
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
693
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
694
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
695
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
696
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
697
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
698
+ | className | string | — | Additional classes for the modal element. |
699
+
700
+ #### Props: Dialog
701
+
702
+ ### Dialog
703
+
704
+ | Name | Type | Default | Description |
705
+ | --- | --- | --- | --- |
706
+ | body | React.ReactNode | — | The dialog body content. |
707
+ | footer | React.ReactNode | — | The dialog body content. |
708
+ | bodyClassName | string | — | Additional classes for the modal-body element. |
709
+ | footerClassName | string | — | Additional classes for the modal-footer element. |
710
+ | headerButtons | React.ReactNode | — | Allows to add additional buttons to the dialog header. |
711
+ | onEsc | VoidFunction | — | A callback fired when esc key is pressed and the dialog is about to close. |
712
+ | onCloseValidation | () => boolean | () => true | A callback function to be executed before closing the dialog. If the function returns false, the dialog will not be closed |
713
+
625
714
  ### Example: Example 4
626
715
 
627
716
  Validation with separate validation error dialog
@@ -772,6 +861,37 @@ export default () => {
772
861
  <button type="button" class="btn btn-primary btn-component" tabindex="0">Open dialog</button>
773
862
  ```
774
863
 
864
+ #### Props: Base dialog props
865
+
866
+ ### Base dialog props
867
+
868
+ | Name | Type | Default | Description |
869
+ | --- | --- | --- | --- |
870
+ | show | boolean | false | Opens the dialog when set to true. |
871
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
872
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
873
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
874
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
875
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
876
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
877
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
878
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
879
+ | className | string | — | Additional classes for the modal element. |
880
+
881
+ #### Props: Dialog
882
+
883
+ ### Dialog
884
+
885
+ | Name | Type | Default | Description |
886
+ | --- | --- | --- | --- |
887
+ | body | React.ReactNode | — | The dialog body content. |
888
+ | footer | React.ReactNode | — | The dialog body content. |
889
+ | bodyClassName | string | — | Additional classes for the modal-body element. |
890
+ | footerClassName | string | — | Additional classes for the modal-footer element. |
891
+ | headerButtons | React.ReactNode | — | Allows to add additional buttons to the dialog header. |
892
+ | onEsc | VoidFunction | — | A callback fired when esc key is pressed and the dialog is about to close. |
893
+ | onCloseValidation | () => boolean | () => true | A callback function to be executed before closing the dialog. If the function returns false, the dialog will not be closed |
894
+
775
895
  ## SimpleDialog
776
896
 
777
897
  This component allows the user to create a simple dialog. It uses the dialog component described above.
@@ -839,6 +959,31 @@ export default () => {
839
959
  </div>;
840
960
  ```
841
961
 
962
+ #### Props: Base dialog props
963
+
964
+ ### Base dialog props
965
+
966
+ | Name | Type | Default | Description |
967
+ | --- | --- | --- | --- |
968
+ | show | boolean | false | Opens the dialog when set to true. |
969
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
970
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
971
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
972
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
973
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
974
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
975
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
976
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
977
+ | className | string | — | Additional classes for the modal element. |
978
+
979
+ #### Props: SimpleDialog
980
+
981
+ ### SimpleDialog
982
+
983
+ | Name | Type | Default | Description |
984
+ | --- | --- | --- | --- |
985
+ | content | string \| React.ReactNode | — | The content of the dialog body itself. |
986
+
842
987
  ## ConfirmationDialog
843
988
 
844
989
  This component allows the user to create a confirmation dialog. It uses the dialog component described above.
@@ -917,6 +1062,36 @@ export default () => {
917
1062
  </div>;
918
1063
  ```
919
1064
 
1065
+ #### Props: Base dialog props
1066
+
1067
+ ### Base dialog props
1068
+
1069
+ | Name | Type | Default | Description |
1070
+ | --- | --- | --- | --- |
1071
+ | show | boolean | false | Opens the dialog when set to true. |
1072
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
1073
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
1074
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
1075
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
1076
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
1077
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
1078
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
1079
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
1080
+ | className | string | — | Additional classes for the modal element. |
1081
+
1082
+ #### Props: ConfirmationDialog
1083
+
1084
+ ### ConfirmationDialog
1085
+
1086
+ | Name | Type | Default | Description |
1087
+ | --- | --- | --- | --- |
1088
+ | content | string \| React.ReactNode | — | The content of the dialog body itself |
1089
+ | onClickConfirm | VoidFunction | () => {} | A callback fired when the confirmation button is clicked. |
1090
+ | onClickCancel | VoidFunction | () => {} | A callback fired when the cancel button is clicked or the dialog is closed. |
1091
+ | cancelButtonText | string \| React.ReactNode | — | The content of the cancel button. (Usually a text, can also be a FormattedMessage component). |
1092
+ | confirmButtonText | string \| React.ReactNode | — | The content of the confirmation button. Since it is a node, it can be a simple text or any JSX node like a div element with an icon and a text. |
1093
+ | disableConfirm | boolean | — | When set to true the confirmation button will be disabled. |
1094
+
920
1095
  ## SaveDialog
921
1096
 
922
1097
  This component allows the user to create a save dialog. It uses the dialog component described above.
@@ -1006,6 +1181,37 @@ export default () => {
1006
1181
  </div>;
1007
1182
  ```
1008
1183
 
1184
+ #### Props: Base dialog props
1185
+
1186
+ ### Base dialog props
1187
+
1188
+ | Name | Type | Default | Description |
1189
+ | --- | --- | --- | --- |
1190
+ | show | boolean | false | Opens the dialog when set to true. |
1191
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
1192
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
1193
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
1194
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
1195
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
1196
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
1197
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
1198
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
1199
+ | className | string | — | Additional classes for the modal element. |
1200
+
1201
+ #### Props: SaveDialog
1202
+
1203
+ ### SaveDialog
1204
+
1205
+ | Name | Type | Default | Description |
1206
+ | --- | --- | --- | --- |
1207
+ | content | string \| React.ReactNode | — | The content of the dialog body itself. |
1208
+ | onClickCancel | VoidFunction | — | A callback fired when the cancel button is clicked or the dialog is closed. |
1209
+ | onClickDiscard | VoidFunction | — | A callback fired when the discard button is clicked. |
1210
+ | onClickConfirm | VoidFunction | — | A callback fired when the confirmation button is clicked. |
1211
+ | discardButtonText | string \| React.ReactNode | — | The content of the discard button. (Usually a text, can also be a FormattedMessage component). |
1212
+ | cancelButtonText | string \| React.ReactNode | — | The content of the cancel button. (Usually a text, can also be a FormattedMessage component). |
1213
+ | confirmButtonText | string \| React.ReactNode | — | The content of the confirmation button. Since it is a node, it can be a simple text or any JSX node like a div element with an icon and a text. |
1214
+
1009
1215
  ## SplitDialog
1010
1216
 
1011
1217
  This component allows the user to create a split dialog. It uses the dialog component described above.
@@ -1272,6 +1478,39 @@ const menuItems2 = [
1272
1478
  </div>;
1273
1479
  ```
1274
1480
 
1481
+ #### Props: Base dialog props
1482
+
1483
+ ### Base dialog props
1484
+
1485
+ | Name | Type | Default | Description |
1486
+ | --- | --- | --- | --- |
1487
+ | show | boolean | false | Opens the dialog when set to true. |
1488
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
1489
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
1490
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
1491
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
1492
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
1493
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
1494
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
1495
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
1496
+ | className | string | — | Additional classes for the modal element. |
1497
+
1498
+ #### Props: SplitDialog
1499
+
1500
+ ### SplitDialog
1501
+
1502
+ | Name | Type | Default | Description |
1503
+ | --- | --- | --- | --- |
1504
+ | leftContent | string \| React.ReactNode | — | The content to be shown on the left side. |
1505
+ | leftContentClassName | string | — | Additional classes for the left content element. |
1506
+ | rightContent | string \| React.ReactNode | — | The content to be shown on the right side. |
1507
+ | rightContentClassName | string | — | Additional classes for the right content element. |
1508
+ | footer | React.ReactNode | — | The dialog body content. |
1509
+ | footerClassName | string | — | Additional classes for the modal-footer element. |
1510
+ | onCloseValidation | () => boolean | — | A callback function to be executed before closing the dialog. If the function returns false, the dialog will not be closed |
1511
+ | useOverflow | boolean | true | Enables the modal body to overflow and use inline scrolling if needed. |
1512
+ | showDivider | boolean | true | Allows to disable the divider. |
1513
+
1275
1514
  ## InfoDialog
1276
1515
 
1277
1516
  This component allows the user to create a dialog without title and footer. It uses the dialog component described above.
@@ -1354,6 +1593,31 @@ export default InfoDialogExample;
1354
1593
  </div>;
1355
1594
  ```
1356
1595
 
1596
+ #### Props: Base dialog props
1597
+
1598
+ ### Base dialog props
1599
+
1600
+ | Name | Type | Default | Description |
1601
+ | --- | --- | --- | --- |
1602
+ | show | boolean | false | Opens the dialog when set to true. |
1603
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
1604
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
1605
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
1606
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
1607
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
1608
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
1609
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
1610
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
1611
+ | className | string | — | Additional classes for the modal element. |
1612
+
1613
+ #### Props: InfoDialog
1614
+
1615
+ ### InfoDialog
1616
+
1617
+ | Name | Type | Default | Description |
1618
+ | --- | --- | --- | --- |
1619
+ | content | string \| React.ReactNode | — | The content of the dialog body itself. |
1620
+
1357
1621
  ### Example: Example 10
1358
1622
 
1359
1623
  Feature info dialog
@@ -1474,6 +1738,31 @@ export default InfoDialogFeatureExample;
1474
1738
  </div>;
1475
1739
  ```
1476
1740
 
1741
+ #### Props: Base dialog props
1742
+
1743
+ ### Base dialog props
1744
+
1745
+ | Name | Type | Default | Description |
1746
+ | --- | --- | --- | --- |
1747
+ | show | boolean | false | Opens the dialog when set to true. |
1748
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
1749
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
1750
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
1751
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
1752
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
1753
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
1754
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
1755
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
1756
+ | className | string | — | Additional classes for the modal element. |
1757
+
1758
+ #### Props: InfoDialog
1759
+
1760
+ ### InfoDialog
1761
+
1762
+ | Name | Type | Default | Description |
1763
+ | --- | --- | --- | --- |
1764
+ | content | string \| React.ReactNode | — | The content of the dialog body itself. |
1765
+
1477
1766
  ## OnboardingDialog
1478
1767
 
1479
1768
  The OnboardingDialog component is a customizable dialog designed to guide users through the initial steps of an onboarding tour. It displays a welcome message, a brief description of the onboarding process, and action buttons to either start the tour or skip it.
@@ -1549,6 +1838,15 @@ export default () => {
1549
1838
 
1550
1839
  | Name | Type | Default | Description |
1551
1840
  | --- | --- | --- | --- |
1841
+ | imageSrc | string | — | The source URL of the image to be displayed in the dialog. |
1842
+ | imageAlt | string | — | Alternative text for the image, used for accessibility. |
1843
+ | title | string \| React.ReactNode | — | The title of the dialog. A welcome message. |
1844
+ | description | string \| React.ReactNode | — | A short description of the service and it's onboarding. |
1845
+ | onboardingRestartHint | string \| React.ReactNode | — | Hint text for restarting the onboarding process. |
1846
+ | onboardingRestartDescription | string \| React.ReactNode | — | Detailed description for restarting the onboarding process. |
1847
+ | skipButtonText | string \| React.ReactNode | — | Text for the skip button |
1848
+ | tourButtonText | string \| React.ReactNode | — | Text for the button to start the tour |
1849
+ | onStartTour | () => void | — | Callback function to be called when the tour starts. |
1552
1850
  | show | boolean | false | Opens the dialog when set to true. |
1553
1851
  | onClose | () => void | — | A callback function invoked when the dialog closes. |
1554
1852
  | className | string | — | Additional classes for the modal element. |
@@ -1687,6 +1985,41 @@ export default () => {
1687
1985
  </div>;
1688
1986
  ```
1689
1987
 
1988
+ #### Props: Base dialog props
1989
+
1990
+ ### Base dialog props
1991
+
1992
+ | Name | Type | Default | Description |
1993
+ | --- | --- | --- | --- |
1994
+ | show | boolean | false | Opens the dialog when set to true. |
1995
+ | title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
1996
+ | subtitle | React.ReactNode | — | The dialog header subtitle content. |
1997
+ | showCloseButton | boolean | true | Shows a close button when set to true. |
1998
+ | onClose | () => void | — | A callback function invoked when the dialog closes. |
1999
+ | bsSize | DialogSize | 'md' | Defined how large the dialog will be rendered. By default, the dialog has a medium size, and thus it can be omitted. Possible values are: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
2000
+ | disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
2001
+ | useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
2002
+ | showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
2003
+ | className | string | — | Additional classes for the modal element. |
2004
+
2005
+ #### Props: MediaDialog
2006
+
2007
+ ### MediaDialog
2008
+
2009
+ | Name | Type | Default | Description |
2010
+ | --- | --- | --- | --- |
2011
+ | media | MediaDialogMedia[] | — | List of media objects. |
2012
+ | └type | 'image' \| 'video' | — | Defines the media type that is going to be displayed. Possible values are: image and video. |
2013
+ | └src | string | — | The source location for the media data. |
2014
+ | └title | string \| React.ReactNode | — | The name or title of the media used for the dialogs title. |
2015
+ | └subtitle | string \| React.ReactNode | — | Additional media information used for the dialogs subtitle. |
2016
+ | └aspectRatio | '4by3' \| '16by9' | '16by9' | Only relevant for videos where the aspect of the video is defined. Possible values are: 4by3 and 16by9. |
2017
+ | └className | string | — | Additional classes for the image element. |
2018
+ | previousButtonText | string \| React.ReactNode | — | The button text for switching to the previous media if there are multiple. |
2019
+ | previousButtonCallback | (newIndex: number) => void | — | Callback function for when the previous button is clicked. |
2020
+ | nextButtonText | string \| React.ReactNode | — | The button text for switching to the next media if there are multiple. |
2021
+ | nextButtonCallback | (newIndex: number) => void | — | Callback function for when the next button is clicked. |
2022
+
1690
2023
  ## FrameDialog
1691
2024
 
1692
2025
  This component allows the user to create a dialog in a parent window triggered and controlled by a widget iframe.
@@ -1830,6 +2163,16 @@ export default WidgetDemo;
1830
2163
  </div>
1831
2164
  ```
1832
2165
 
2166
+ #### Props: FrameDialog
2167
+
2168
+ ### FrameDialog
2169
+
2170
+ | Name | Type | Default | Description |
2171
+ | --- | --- | --- | --- |
2172
+ | eventPrefix | string | 'EVENT_FRAME_DIALOG' | A prefix for all event types. |
2173
+ | getSourceFrame | () => HTMLIFrameElement \| null | — | A function to retrieve the iframe DOM element so a message can be sent to it. This is required when sending messages back to the origin widget iframe that triggered the dialog in the first place. |
2174
+ | className | string | — | Additional classes for the modal element. |
2175
+
1833
2176
  ## ReleaseNotesDialog
1834
2177
 
1835
2178
  The ReleaseNotesDialog component is meant to be used for the release notes of a service.Note there exists also a separate ReleaseNotes component.
@@ -1994,4 +2337,21 @@ export default () => {
1994
2337
  </nav>
1995
2338
  </div>
1996
2339
  </div>
2340
+ ```
2341
+
2342
+ #### Props (json)
2343
+
2344
+ ```json
2345
+ {
2346
+ "0.1.2": {
2347
+ date: '20.10.2023',
2348
+ content: (
2349
+ <div className='padding-left-15'>
2350
+ Summary
2351
+ • Feature 1
2352
+ • Feature 2
2353
+ </div>
2354
+ ),
2355
+ }
2356
+ }
1997
2357
  ```
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Misc
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/divider
6
- *Captured:* 2026-01-14T09:07:42.411Z
6
+ *Captured:* 2026-02-03T14:04:57.558Z
7
7
 
8
8
  ## Divider
9
9
 
@@ -204,4 +204,16 @@ export default () => (
204
204
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>
205
205
  </div>
206
206
  </div>
207
- ```
207
+ ```
208
+
209
+ #### Props
210
+
211
+ | Name | Type | Default | Description |
212
+ | --- | --- | --- | --- |
213
+ | spacing | number | 15 | The amount of space to either side |
214
+ | dividerWidth | 1 \| 2 \| 3 | 1 | Defines the width of the divider line |
215
+ | dividerColor | 'darkest' \| 'darker' \| 'dark' \| 'gray' \| 'light' \| 'lighter' \| 'lightest' | 'light' | Defines the color of the divider line |
216
+ | asSpacer | boolean | false | Use the component as a spacer element without the divider line |
217
+ | vertical | boolean | false | Set the orientation for the divider line to vertical. This may be useful for button toolbars or elements on a single row. |
218
+ | titleAlignment | 'left' \| 'center' \| 'right' | 'center' | Defines where the children are aligned on the divider line |
219
+ | className | string | — | Additional classes added to the wrapping element. |