@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:* Misc
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/tags
6
- *Captured:* 2026-01-07T12:12:01.118Z
6
+ *Captured:* 2026-02-03T14:05:08.958Z
7
7
 
8
8
  ## Tag
9
9
 
@@ -755,31 +755,32 @@ export default () => (
755
755
  </div>
756
756
  ```
757
757
 
758
- #### Props: TagList
758
+ #### Props: Tag
759
759
 
760
- ### TagList
760
+ ### Tag
761
761
 
762
762
  | Name | Type | Default | Description |
763
763
  | --- | --- | --- | --- |
764
- | autoTagWidth | Boolean | false | Defines if the tag has the same with as it`s parent container. |
765
- | inline | Boolean | true | Defines if the taglist is rendered inline or vertically. |
766
- | tagsPerRow | Number | | Possible values are: 1, 2, 3, 4, 6 |
764
+ | active | boolean | false | Defines if the tag is active. |
765
+ | clickable | boolean | false | Defines if the tag is clickable. |
766
+ | deletable | boolean | false | Defines if the tag is deletable. |
767
+ | revertable | boolean | false | Defines if the tag is revertable. |
768
+ | disabled | boolean | false | Defines if the tag is disabled. |
769
+ | icon | string | — | Define any rioglyph icon like "rioglyph-truck". |
770
+ | muted | boolean | false | Sets a more subtle style for border and background. |
771
+ | round | boolean | true | Defines if the tag is round. |
772
+ | selectable | boolean | false | Defines if the tag is selectable. |
773
+ | size | 'small' \| 'medium' | — | Defines if you want to render the tag in a different size. Possible values are: 'small' and 'medium' |
774
+ | multiline | boolean | false | Allows to render text on multiple lines. |
775
+ | className | string | — | Additional classes to be set on the wrapper element. |
767
776
 
768
- #### Props: Tag
777
+ #### Props: TagList
769
778
 
770
- ### Tag
779
+ ### TagList
771
780
 
772
781
  | Name | Type | Default | Description |
773
782
  | --- | --- | --- | --- |
774
- | size | String | | Defines if you want to render the tag in a different size. Possible values are: 'small' |
775
- | icon | String | | Define any rioglyph icon like "rioglyph-truck". |
776
- | active | Boolean | false | Defines if the tag is active. |
777
- | clickable | Boolean | false | Defines if the tag is clickable. |
778
- | selectable | Boolean | false | Defines if the tag is selectable. |
779
- | deletable | Boolean | false | Defines if the tag is deletable. |
780
- | revertable | Boolean | false | Defines if the tag is revertable. |
781
- | disabled | Boolean | false | Defines if the tag is disabled. |
782
- | round | Boolean | true | Defines if the tag is round. |
783
- | muted | Boolean | false | Sets a more subtle style for border and background. |
784
- | className | String | — | Additional classes to be set on the wrapper element. |
785
- | children | any | — | Any element to be rendered inside the tag. |
783
+ | inline | boolean | true | Defines if the tag list is rendered inline or vertically. |
784
+ | autoTagWidth | boolean | false | Defines if the tag has the same with as it`s parent container. |
785
+ | tagsPerRow | 1 \| 2 \| 3 \| 4 \| 6 | | Possible values are 1-6 |
786
+ | className | string | | Additional classes to be set on the wrapper element. |
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Content
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/teaser
6
- *Captured:* 2026-01-07T12:11:46.308Z
6
+ *Captured:* 2026-02-03T14:04:52.277Z
7
7
 
8
8
  The teaser component was built to create all kinds of landing and/or single pages. for example, be used in dialogs or sidebars.
9
9
 
@@ -894,10 +894,9 @@ export default () => (
894
894
 
895
895
  | Name | Type | Default | Description |
896
896
  | --- | --- | --- | --- |
897
- | children | any | — | The individual Teaser components. |
898
- | teaserPerRow | Number | — | Defines how many children are rendered into a row. If "teaserPerRow" is not defined the container tries to put all children in a row with regards to the Bootstrap grid. This is done by dividing the amount of children by 12 in order to figure out the col grid classes. It is recommended to define the teaser per row when having more than 4 teaser. Possible values are: 1 2 3 4 6 and 12 |
899
- | columnClassName | String | — | Optional string for additional classes added to each column of a child. |
900
- | className | String | — | Optional string for additional classes added to the row. |
897
+ | teaserPerRow | number | — | Defines how many children are rendered into a row. If "teaserPerRow" is not defined, the container tries to put all children in a row with regard to the Bootstrap grid. This is done by dividing the amount of children by 12 in order to figure out the col grid classes. It is recommended to define "teasersPerRow" when having more than 4 teasers. Possible values are: 1 2 3 4 6 12 |
898
+ | columnClassName | string | — | Optional string for additional classes added to each column of a child. |
899
+ | className | string | — | Optional string for additional classes added to the row. |
901
900
 
902
901
  #### Props: Teaser
903
902
 
@@ -905,21 +904,21 @@ export default () => (
905
904
 
906
905
  | Name | Type | Default | Description |
907
906
  | --- | --- | --- | --- |
908
- | headline | String / Node | — | The headline for the teaser. |
909
- | content | String / Node | — | The actual content to show e.g. some kind of text. |
910
- | image | Object | — | Defines an image to render with the following props. |
911
- | └src | String | — | The src URL for the image. |
912
- | └alt | String | — | The alternate text for the image. |
913
- | └aspectRatio | String | — | Ratio of the transparent image placeholder. Possible value ares: '1:1' '3:1' '3:2' '16:9' |
914
- | └align | String | — | Defines whether the image is on the left or right side of the component. Possible value ares: 'left' 'right' |
915
- | └onClick | Function | — | Callback function for the image. |
916
- | └className | String | — | Additional classes added to the image wrapper. |
917
- | button | Object | — | Defines a button to render with the following props. |
918
- | └text | String / Node | — | The text content for the button. |
919
- | └bsStyle | String | 'primary' | The button style. Please see the Button component definition for possible values. |
920
- | └onClick | Function | — | Callback function for the button. |
921
- | └className | String | — | Additional classes added to the button. |
922
- | verticalAlignment | String | 'top' | Defines where the teaser content is aligned including headerline and image. Possible values are: 'top' 'center' |
923
- | segmentation | String | — | Defines how the teaser content is segmented. Possible value ares: '50' '25:75' '75:25' '100' |
924
- | footer | String / Node | — | Optional content for footer in case the prop "button" is not sufficient. |
925
- | className | String | — | Additional classes added to the wrapper. |
907
+ | headline | string \| React.ReactNode | — | The headline for the teaser. |
908
+ | content | string \| React.ReactNode | — | The actual content to show e.g. some kind of text. |
909
+ | image | TeaserImage | — | Defines an image to render. |
910
+ | └src | string | — | The src URL for the image. |
911
+ | └alt | string | — | The alternate text for the image. |
912
+ | └align | 'left' \| 'right' | — | Defines whether the image is on the left or right side of the component. Possible values are: 'left' and 'right'. |
913
+ | └onClick | VoidFunction | — | Callback function for the image. |
914
+ | └aspectRatio | '1:1' \| '3:1' \| '3:2' \| '16:9' | — | Ratio of the transparent image placeholder. Possible values are '1:1', '3:1', '3:2' and '16:9'. |
915
+ | └className | string | — | Additional classes added to the image wrapper. |
916
+ | button | TeaserButton | — | Defines a button to render with. |
917
+ | └text | string \| React.ReactNode | — | The text content for the button. |
918
+ | └bsStyle | BUTTON_STYLE | 'primary' | The button style. See the button styles definition for possible values. |
919
+ | └onClick | (event: SyntheticEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function for the button. |
920
+ | └className | string | — | Additional classes added to the button. |
921
+ | verticalAlignment | 'top' \| 'center' | 'top' | Defines where the teaser content is aligned including headline and image. Possible values are: 'top' and 'center'. |
922
+ | segmentation | '50' \| '25:75' \| '75:25' \| '100' | — | Defines how the teaser content is segmented. Possible values are: '50', '25:75', '75:25' and '100'. |
923
+ | footer | string \| React.ReactNode | — | Optional content for footer in case the prop "button" is not sufficient. |
924
+ | className | string | — | Additional classes added to the wrapper. |
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* CSS Only
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/timeline
6
- *Captured:* 2026-01-07T12:12:03.009Z
6
+ *Captured:* 2026-02-03T14:05:10.817Z
7
7
 
8
8
  The timeline component is a pure CSS component.
9
9
 
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Pickers
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/timepicker
6
- *Captured:* 2026-01-07T12:11:32.462Z
6
+ *Captured:* 2026-02-03T14:04:35.393Z
7
7
 
8
8
  ## TimePicker
9
9
 
@@ -149,12 +149,14 @@ export default () => {
149
149
  | Name | Type | Default | Description |
150
150
  | --- | --- | --- | --- |
151
151
  | value | string | — | Value of the time as string. Note, when value is given the component is treated as controlled. |
152
- | onChange | Function | () => {} | Callback function when the value changes and is a valid time format. If not it handles the state internally until the time is valid and filled. |
153
- | alwaysShowMask | Boolean | true | Defines whether to always show the input mask placeholder. |
154
- | showIcon | Boolean | false | Defines whether or not to show the input icon. |
155
- | className | String | — | Additional classes to be set on the wrapper element. |
156
- | inputProps | Object | — | Additional props to be passed on to the underlying input component. |
157
- | └className | String | | Additional classes to be set on the input element. |
152
+ | onChange | (value: string) => void | — | Callback function when the value changes and is a valid time format. If not it handles the state internally until the time is valid and filled. |
153
+ | alwaysShowMask | boolean | true | Defines whether to always show the input mask placeholder. |
154
+ | showIcon | boolean | false | Defines whether to show the input icon. |
155
+ | errorMessage | string \| React.ReactNode | — | Input error message. |
156
+ | warningMessage | string \| React.ReactNode | — | Input warning message. |
157
+ | messageWhiteSpace | 'normal' \| 'nowrap' \| 'pre-line' | 'normal' | Feedback message width. |
158
+ | inputProps | Omit<React.InputHTMLAttributes<HTMLInputElement>, 'value' \| 'onChange'> | — | Additional properties to be set on the input element. |
159
+ | className | string | — | Additional classes to be set on the wrapper element. |
158
160
 
159
161
  ### Example: Example 2
160
162
 
@@ -254,9 +256,11 @@ export default () => {
254
256
  | Name | Type | Default | Description |
255
257
  | --- | --- | --- | --- |
256
258
  | value | string | — | Value of the time as string. Note, when value is given the component is treated as controlled. |
257
- | onChange | Function | () => {} | Callback function when the value changes and is a valid time format. If not it handles the state internally until the time is valid and filled. |
258
- | alwaysShowMask | Boolean | true | Defines whether to always show the input mask placeholder. |
259
- | showIcon | Boolean | false | Defines whether or not to show the input icon. |
260
- | className | String | — | Additional classes to be set on the wrapper element. |
261
- | inputProps | Object | — | Additional props to be passed on to the underlying input component. |
262
- | └className | String | | Additional classes to be set on the input element. |
259
+ | onChange | (value: string) => void | — | Callback function when the value changes and is a valid time format. If not it handles the state internally until the time is valid and filled. |
260
+ | alwaysShowMask | boolean | true | Defines whether to always show the input mask placeholder. |
261
+ | showIcon | boolean | false | Defines whether to show the input icon. |
262
+ | errorMessage | string \| React.ReactNode | — | Input error message. |
263
+ | warningMessage | string \| React.ReactNode | — | Input warning message. |
264
+ | messageWhiteSpace | 'normal' \| 'nowrap' \| 'pre-line' | 'normal' | Feedback message width. |
265
+ | inputProps | Omit<React.InputHTMLAttributes<HTMLInputElement>, 'value' \| 'onChange'> | — | Additional properties to be set on the input element. |
266
+ | className | string | — | Additional classes to be set on the wrapper element. |
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Interaction
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/toggleButton
6
- *Captured:* 2026-01-07T12:11:20.239Z
6
+ *Captured:* 2026-02-03T14:04:22.766Z
7
7
 
8
8
  This toggle button is based on the button component that can be used directly.
9
9
 
@@ -89,20 +89,38 @@ export default () => (
89
89
 
90
90
  | Name | Type | Default | Description |
91
91
  | --- | --- | --- | --- |
92
- | disabled | Boolean | false | Set the button disabled. |
93
- | active | Boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
94
- | asToggle | Boolean | false | Use the button as a toggle button. The toggle state can be controlled viw the "active" prop. |
95
- | iconOnly | Boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
96
- | iconName | String | | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
97
- | iconRight | Boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
98
- | multiline | Boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
99
- | block | Boolean | false | Defines whether the button takes up the full width of the parent element. |
100
- | onClick | Function | () => {} | Callback function triggered when clicking the button. |
101
- | bsStyle | String | default | Sets the button style. Possible values are: default, primary, info, warning, danger, success, muted-filled and muted or Button.DEFAULT, Button.PRIMARY, Button.INFO, Button.WARNING, Button.DANGER, Button.SUCCESS, Button.MUTED_FILLED and Button.MUTED |
102
- | bsSize | String | — | Sets the button size. Possible values are: xs, sm, md and lg or Button.XS, Button.SM, Button.MD and Button.LG |
103
- | variant | String | — | Sets the button variant. Possible values are: link, link-inline, outline and action or Button.VARIANT_LINK, Button.VARIANT_LINK_INLINE, Button.VARIANT_OUTLINE and Button.VARIANT_ACTION |
104
- | className | String | | Additional classes to be set on the button element. |
105
- | children | any | — | Any element to be rendered on the button. |
92
+ | disabled | boolean | false | Whether the button should be disabled. |
93
+ | active | boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
94
+ | type | 'button' \| 'submit' | 'button' | Defines the type of the button. This may be used for form submit buttons. |
95
+ | iconOnly | boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
96
+ | iconRight | boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
97
+ | iconName | string | | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
98
+ | multiline | boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
99
+ | block | boolean | false | Defines whether the button takes up the full width of the parent element. |
100
+ | bsStyle | BUTTON_STYLE | "default" | Sets the button style. Possible values are: default, unstyled, primary, secondary, info, warning, danger, success, muted and muted-filled |
101
+ | bsSize | BUTTON_SIZE | | Sets the button size. Possible values are: xs, sm, md and lg |
102
+ | variant | BUTTON_VARIANT | — | Sets the button variant. Possible values are: link, link-inline, outline and action |
103
+ | noRippleEffect | boolean | — | Whether the "ripple" effect should be suppressed on this button. |
104
+ | tabIndex | number | 0 | Number of the index used for keyboard support. |
105
+ | className | string | — | Additional classes to be set on the button element. |
106
+
107
+ #### Props: Regular button
108
+
109
+ ### Regular button
110
+
111
+ | Name | Type | Default | Description |
112
+ | --- | --- | --- | --- |
113
+ | asToggle | false | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
114
+ | onClick | (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function triggered when clicking the button. |
115
+
116
+ #### Props: ToggleButton
117
+
118
+ ### ToggleButton
119
+
120
+ | Name | Type | Default | Description |
121
+ | --- | --- | --- | --- |
122
+ | asToggle | true | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
123
+ | onClick | (value: boolean) => void | — | Callback function triggered when clicking the button. |
106
124
 
107
125
  ### Example: Controlled ToggleButton
108
126
 
@@ -162,17 +180,35 @@ export default () => {
162
180
 
163
181
  | Name | Type | Default | Description |
164
182
  | --- | --- | --- | --- |
165
- | disabled | Boolean | false | Set the button disabled. |
166
- | active | Boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
167
- | asToggle | Boolean | false | Use the button as a toggle button. The toggle state can be controlled viw the "active" prop. |
168
- | iconOnly | Boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
169
- | iconName | String | | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
170
- | iconRight | Boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
171
- | multiline | Boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
172
- | block | Boolean | false | Defines whether the button takes up the full width of the parent element. |
173
- | onClick | Function | () => {} | Callback function triggered when clicking the button. |
174
- | bsStyle | String | default | Sets the button style. Possible values are: default, primary, info, warning, danger, success, muted-filled and muted or Button.DEFAULT, Button.PRIMARY, Button.INFO, Button.WARNING, Button.DANGER, Button.SUCCESS, Button.MUTED_FILLED and Button.MUTED |
175
- | bsSize | String | — | Sets the button size. Possible values are: xs, sm, md and lg or Button.XS, Button.SM, Button.MD and Button.LG |
176
- | variant | String | — | Sets the button variant. Possible values are: link, link-inline, outline and action or Button.VARIANT_LINK, Button.VARIANT_LINK_INLINE, Button.VARIANT_OUTLINE and Button.VARIANT_ACTION |
177
- | className | String | | Additional classes to be set on the button element. |
178
- | children | any | — | Any element to be rendered on the button. |
183
+ | disabled | boolean | false | Whether the button should be disabled. |
184
+ | active | boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
185
+ | type | 'button' \| 'submit' | 'button' | Defines the type of the button. This may be used for form submit buttons. |
186
+ | iconOnly | boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
187
+ | iconRight | boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
188
+ | iconName | string | | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
189
+ | multiline | boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
190
+ | block | boolean | false | Defines whether the button takes up the full width of the parent element. |
191
+ | bsStyle | BUTTON_STYLE | "default" | Sets the button style. Possible values are: default, unstyled, primary, secondary, info, warning, danger, success, muted and muted-filled |
192
+ | bsSize | BUTTON_SIZE | | Sets the button size. Possible values are: xs, sm, md and lg |
193
+ | variant | BUTTON_VARIANT | — | Sets the button variant. Possible values are: link, link-inline, outline and action |
194
+ | noRippleEffect | boolean | — | Whether the "ripple" effect should be suppressed on this button. |
195
+ | tabIndex | number | 0 | Number of the index used for keyboard support. |
196
+ | className | string | — | Additional classes to be set on the button element. |
197
+
198
+ #### Props: Regular button
199
+
200
+ ### Regular button
201
+
202
+ | Name | Type | Default | Description |
203
+ | --- | --- | --- | --- |
204
+ | asToggle | false | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
205
+ | onClick | (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function triggered when clicking the button. |
206
+
207
+ #### Props: ToggleButton
208
+
209
+ ### ToggleButton
210
+
211
+ | Name | Type | Default | Description |
212
+ | --- | --- | --- | --- |
213
+ | asToggle | true | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
214
+ | onClick | (value: boolean) => void | — | Callback function triggered when clicking the button. |
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Misc
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/tooltip
6
- *Captured:* 2026-01-07T12:12:02.752Z
6
+ *Captured:* 2026-02-03T14:05:10.161Z
7
7
 
8
8
  In order to use a Tooltip on an element, wrap it with the OverlayTrigger component or use the SimpleTooltip component.
9
9
 
@@ -300,36 +300,24 @@ export default () => (
300
300
  </div>
301
301
  ```
302
302
 
303
- #### Props: Tooltip
304
-
305
- ### Tooltip
306
-
307
- | Name | Type | Default | Description |
308
- | --- | --- | --- | --- |
309
- | id | String / Number | — | An HTML id attribute, necessary for accessibility. |
310
- | placement | String | — | Sets the direction the Tooltip is positioned towards. This is generally provided by the OverlayTrigger component positioning the tooltip. Possible values are: auto-start, auto, auto-end, top-start, top, top-end, bottom-start, bottom, bottom-end, right-start, right, right-end, left-start, left or left-end |
311
- | tooltipStyle | String | default | Defines the look of the tooltip. Possible values are: default, onboarding |
312
- | textAlignment | String | center | Defines the position of the text content. Possible values are: left, right, center |
313
- | width | String | — | Defines the width of the tooltip. Possible values are: auto, 100, 150, 200, 250, 300, 350, 400, 450, 500 |
314
- | allowOnTouch | bool | false | Render Tooltips on mobile devices. |
315
- | className | String | — | Additional classes to be set on the wrapper element. |
316
- | innerClassName | String | — | Additional classes to be set on the inner element. |
317
- | children | any | — | Any element to be rendered inside the tooltip. |
318
-
319
- #### Props: OverlayTrigger
320
-
321
- ### OverlayTrigger
322
-
323
- | Name | Type | Default | Description |
324
- | --- | --- | --- | --- |
325
- | trigger | 'click' \| 'hover' \| 'focus' | hover | Specify which action or actions trigger Overlay visibility. Possible values are: OverlayTrigger.TRIGGER_CLICK , OverlayTrigger.TRIGGER_HOVER, OverlayTrigger.TRIGGER_HOVER or 'click', 'hover', 'focus' |
326
- | delay | Number / Object | — | A millisecond delay amount to show and hide the Overlay once triggered. |
327
- | └show | Number | — | A millisecond delay amount before showing the Overlay once triggered. |
328
- | └hide | Number | — | A millisecond delay amount before hiding the Overlay once triggered. |
329
- | defaultShow | Boolean | — | The initial visibility state of the Overlay. For more nuanced visibility control, consider using the Overlay component directly. |
330
- | overlay | Node | — | An element or text to overlay next to the target. |
331
- | placement | String | — | Sets the direction the overlay is positioned towards. Possible values are: auto-start, auto, auto-end, top-start, top, top-end, bottom-start, bottom, bottom-end, right-start, right, right-end, left-start, left or left-end |
332
- | popperConfig | Object | — | A Popper.js config object passed to the the underlying popper instance. |
303
+ #### Props (json)
304
+
305
+ ```json
306
+ popperConfig={{
307
+ modifiers: [
308
+ {
309
+ name: 'offset',
310
+ options: {
311
+ offset: [0, 5],
312
+ },
313
+ },
314
+ {
315
+ name: 'arrow',
316
+ options: {},
317
+ },
318
+ ],
319
+ }}
320
+ ```
333
321
 
334
322
  ## SimpleTooltip
335
323
 
@@ -433,22 +421,11 @@ export default () => (
433
421
  </div>
434
422
  ```
435
423
 
436
- #### Props: SimpleTooltip
437
-
438
- ### SimpleTooltip
439
-
440
- | Name | Type | Default | Description |
441
- | --- | --- | --- | --- |
442
- | trigger | String | hover | Specify which action or actions trigger Overlay visibility. Possible values are: 'click', 'hover', 'focus' |
443
- | placement | String | AUTO | Sets the direction the Tooltip is positioned towards. This is generally provided by the OverlayTrigger component positioning the tooltip. Possible values are: auto-start, auto, auto-end, top-start, top, top-end, bottom-start, bottom, bottom-end, right-start, right, right-end, left-start, left or left-end |
444
- | content | String / Node | — | The tooltip content. |
445
- | targetRef | Ref | — | The react ref object assigned to the target of the tooltip. |
446
- | delay | Number / Object | — | A millisecond delay amount to show the Overlay once triggered. |
447
- | └show | Number | — | A millisecond delay amount before showing the Overlay once triggered. |
448
- | └hide | Number | — | A millisecond delay amount before hiding the Overlay once triggered. |
449
- | textAlignment | String | center | Defines the position of the text content. Possible values are: left, right, center |
450
- | width | String | — | Defines the width of the tooltip. Possible values are: auto, 100, 150, 200, 250, 300, 350, 400, 450, 500 |
451
- | className | String | — | Additional classes to be set on the wrapper element. |
452
- | innerClassName | String | — | Additional classes to be set on the inner element. |
453
- | popperConfig | Object | — | A Popper.js config object passed to the the underlying popper instance. |
454
- | children | Node | — | The target node. |
424
+ #### Props (json)
425
+
426
+ ```json
427
+ {
428
+ show: 1_000,
429
+ delay: 500,
430
+ }
431
+ ```