@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:* Interaction
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/checkbox
6
- *Captured:* 2026-01-07T12:11:13.513Z
6
+ *Captured:* 2026-02-03T14:04:13.543Z
7
7
 
8
8
  ## Checkbox
9
9
 
@@ -333,32 +333,17 @@ export default () => (
333
333
  </div>
334
334
  ```
335
335
 
336
- #### Props
337
-
338
- | Name | Type | Default | Description |
339
- | --- | --- | --- | --- |
340
- | id | String | — | Passed through as HTML attribute to the underlying input. id. (Uses name otherwise.) |
341
- | name | String | — | Passed through as HTML attribute to the underlying inputname. |
342
- | label | String / Node | — | Define some text as a label. |
343
- | checked | String / Boolean | — | Defines whether the checkbox is checked or not (state cannot be changed). |
344
- | defaultChecked | String / Boolean | — | Defines whether the checkbox is initially checked or not (state can be changed on click). |
345
- | disabled | Boolean | false | Defines whether the checkbox is disabled or not. |
346
- | indeterminate | Boolean | false | Defines if the checkbox is in an indeterminate state with regards to other checkboxes that may be in different selection state. |
347
- | inline | Boolean | false | Defines whether the checkbox is applying an inline style. Use this in combination with other checkboxes. |
348
- | right | Boolean | false | Defines whether the checkbox is on the right side. |
349
- | custom | Boolean | false | Allows for rendering a completely different layout with or without a checkbox tick. |
350
- | onClick | Function | () => {} | Callback function that is invoked when the checkbox is checked or unchecked. |
351
- | onChange | Function | () => {} | Callback function that is invoked when the checkbox value changes. This will also be invoked by a keyboard event. |
352
- | error | Boolean | false | Use "error" to change color of the checkbox. |
353
- | required | Boolean | false | Defines whether the checkbox is required or not. |
354
- | size | String | — | Defines the size of the checkbox. Omitting this prop renders the Checkbox in normal size. Possible values are: 'large' |
355
- | tabIndex | Number | 0 | The tabindex attribute allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation. See tabIndex |
356
- | className | String | — | Additional classes to be set on the input field. |
357
- | children | any | — | Any element to be rendered next to the checkbox. |
358
- | icon | String | — | Define a custom icon for the checkbox by naming a rioglyph icon like "rioglyph-truck". |
359
- | iconSize | Number | — | The icon size in pixel. |
360
- | iconLabelPosition | String | — | The label position for a custom icon checkbox. Using this on a regular checkbox has no effect. Possible values are: "horizontal" or "vertical". |
361
- | inputRef | Ref | — | A react ref assigned to the input itself. |
336
+ #### Props (json)
337
+
338
+ ```json
339
+ <div className='checkbox-text-wrapper display-flex justify-content-between'>
340
+ <div className='margin-right-15'>
341
+ <div className='text-medium text-size-16 text-color-darker'>Option 1</div>
342
+ <div className='text-color-dark'>This option is a first option</div>
343
+ </div>
344
+ <div className='checkbox-text' />
345
+ </div>
346
+ ```
362
347
 
363
348
  ## Controlled example
364
349
 
@@ -430,32 +415,17 @@ export default () => {
430
415
  </div>
431
416
  ```
432
417
 
433
- #### Props
434
-
435
- | Name | Type | Default | Description |
436
- | --- | --- | --- | --- |
437
- | id | String | — | Passed through as HTML attribute to the underlying input. id. (Uses name otherwise.) |
438
- | name | String | — | Passed through as HTML attribute to the underlying inputname. |
439
- | label | String / Node | — | Define some text as a label. |
440
- | checked | String / Boolean | — | Defines whether the checkbox is checked or not (state cannot be changed). |
441
- | defaultChecked | String / Boolean | — | Defines whether the checkbox is initially checked or not (state can be changed on click). |
442
- | disabled | Boolean | false | Defines whether the checkbox is disabled or not. |
443
- | indeterminate | Boolean | false | Defines if the checkbox is in an indeterminate state with regards to other checkboxes that may be in different selection state. |
444
- | inline | Boolean | false | Defines whether the checkbox is applying an inline style. Use this in combination with other checkboxes. |
445
- | right | Boolean | false | Defines whether the checkbox is on the right side. |
446
- | custom | Boolean | false | Allows for rendering a completely different layout with or without a checkbox tick. |
447
- | onClick | Function | () => {} | Callback function that is invoked when the checkbox is checked or unchecked. |
448
- | onChange | Function | () => {} | Callback function that is invoked when the checkbox value changes. This will also be invoked by a keyboard event. |
449
- | error | Boolean | false | Use "error" to change color of the checkbox. |
450
- | required | Boolean | false | Defines whether the checkbox is required or not. |
451
- | size | String | — | Defines the size of the checkbox. Omitting this prop renders the Checkbox in normal size. Possible values are: 'large' |
452
- | tabIndex | Number | 0 | The tabindex attribute allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation. See tabIndex |
453
- | className | String | — | Additional classes to be set on the input field. |
454
- | children | any | — | Any element to be rendered next to the checkbox. |
455
- | icon | String | — | Define a custom icon for the checkbox by naming a rioglyph icon like "rioglyph-truck". |
456
- | iconSize | Number | — | The icon size in pixel. |
457
- | iconLabelPosition | String | — | The label position for a custom icon checkbox. Using this on a regular checkbox has no effect. Possible values are: "horizontal" or "vertical". |
458
- | inputRef | Ref | — | A react ref assigned to the input itself. |
418
+ #### Props (json)
419
+
420
+ ```json
421
+ <div className='checkbox-text-wrapper display-flex justify-content-between'>
422
+ <div className='margin-right-15'>
423
+ <div className='text-medium text-size-16 text-color-darker'>Option 1</div>
424
+ <div className='text-color-dark'>This option is a first option</div>
425
+ </div>
426
+ <div className='checkbox-text' />
427
+ </div>
428
+ ```
459
429
 
460
430
  ## Custom card example
461
431
 
@@ -668,32 +638,17 @@ export default () => {
668
638
  </form>
669
639
  ```
670
640
 
671
- #### Props
672
-
673
- | Name | Type | Default | Description |
674
- | --- | --- | --- | --- |
675
- | id | String | — | Passed through as HTML attribute to the underlying input. id. (Uses name otherwise.) |
676
- | name | String | — | Passed through as HTML attribute to the underlying inputname. |
677
- | label | String / Node | — | Define some text as a label. |
678
- | checked | String / Boolean | — | Defines whether the checkbox is checked or not (state cannot be changed). |
679
- | defaultChecked | String / Boolean | — | Defines whether the checkbox is initially checked or not (state can be changed on click). |
680
- | disabled | Boolean | false | Defines whether the checkbox is disabled or not. |
681
- | indeterminate | Boolean | false | Defines if the checkbox is in an indeterminate state with regards to other checkboxes that may be in different selection state. |
682
- | inline | Boolean | false | Defines whether the checkbox is applying an inline style. Use this in combination with other checkboxes. |
683
- | right | Boolean | false | Defines whether the checkbox is on the right side. |
684
- | custom | Boolean | false | Allows for rendering a completely different layout with or without a checkbox tick. |
685
- | onClick | Function | () => {} | Callback function that is invoked when the checkbox is checked or unchecked. |
686
- | onChange | Function | () => {} | Callback function that is invoked when the checkbox value changes. This will also be invoked by a keyboard event. |
687
- | error | Boolean | false | Use "error" to change color of the checkbox. |
688
- | required | Boolean | false | Defines whether the checkbox is required or not. |
689
- | size | String | — | Defines the size of the checkbox. Omitting this prop renders the Checkbox in normal size. Possible values are: 'large' |
690
- | tabIndex | Number | 0 | The tabindex attribute allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation. See tabIndex |
691
- | className | String | — | Additional classes to be set on the input field. |
692
- | children | any | — | Any element to be rendered next to the checkbox. |
693
- | icon | String | — | Define a custom icon for the checkbox by naming a rioglyph icon like "rioglyph-truck". |
694
- | iconSize | Number | — | The icon size in pixel. |
695
- | iconLabelPosition | String | — | The label position for a custom icon checkbox. Using this on a regular checkbox has no effect. Possible values are: "horizontal" or "vertical". |
696
- | inputRef | Ref | — | A react ref assigned to the input itself. |
641
+ #### Props (json)
642
+
643
+ ```json
644
+ <div className='checkbox-text-wrapper display-flex justify-content-between'>
645
+ <div className='margin-right-15'>
646
+ <div className='text-medium text-size-16 text-color-darker'>Option 1</div>
647
+ <div className='text-color-dark'>This option is a first option</div>
648
+ </div>
649
+ <div className='checkbox-text' />
650
+ </div>
651
+ ```
697
652
 
698
653
  ## Custom list example
699
654
 
@@ -835,32 +790,17 @@ export default () => {
835
790
  </fieldset>
836
791
  ```
837
792
 
838
- #### Props
839
-
840
- | Name | Type | Default | Description |
841
- | --- | --- | --- | --- |
842
- | id | String | — | Passed through as HTML attribute to the underlying input. id. (Uses name otherwise.) |
843
- | name | String | — | Passed through as HTML attribute to the underlying inputname. |
844
- | label | String / Node | — | Define some text as a label. |
845
- | checked | String / Boolean | — | Defines whether the checkbox is checked or not (state cannot be changed). |
846
- | defaultChecked | String / Boolean | — | Defines whether the checkbox is initially checked or not (state can be changed on click). |
847
- | disabled | Boolean | false | Defines whether the checkbox is disabled or not. |
848
- | indeterminate | Boolean | false | Defines if the checkbox is in an indeterminate state with regards to other checkboxes that may be in different selection state. |
849
- | inline | Boolean | false | Defines whether the checkbox is applying an inline style. Use this in combination with other checkboxes. |
850
- | right | Boolean | false | Defines whether the checkbox is on the right side. |
851
- | custom | Boolean | false | Allows for rendering a completely different layout with or without a checkbox tick. |
852
- | onClick | Function | () => {} | Callback function that is invoked when the checkbox is checked or unchecked. |
853
- | onChange | Function | () => {} | Callback function that is invoked when the checkbox value changes. This will also be invoked by a keyboard event. |
854
- | error | Boolean | false | Use "error" to change color of the checkbox. |
855
- | required | Boolean | false | Defines whether the checkbox is required or not. |
856
- | size | String | — | Defines the size of the checkbox. Omitting this prop renders the Checkbox in normal size. Possible values are: 'large' |
857
- | tabIndex | Number | 0 | The tabindex attribute allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation. See tabIndex |
858
- | className | String | — | Additional classes to be set on the input field. |
859
- | children | any | — | Any element to be rendered next to the checkbox. |
860
- | icon | String | — | Define a custom icon for the checkbox by naming a rioglyph icon like "rioglyph-truck". |
861
- | iconSize | Number | — | The icon size in pixel. |
862
- | iconLabelPosition | String | — | The label position for a custom icon checkbox. Using this on a regular checkbox has no effect. Possible values are: "horizontal" or "vertical". |
863
- | inputRef | Ref | — | A react ref assigned to the input itself. |
793
+ #### Props (json)
794
+
795
+ ```json
796
+ <div className='checkbox-text-wrapper display-flex justify-content-between'>
797
+ <div className='margin-right-15'>
798
+ <div className='text-medium text-size-16 text-color-darker'>Option 1</div>
799
+ <div className='text-color-dark'>This option is a first option</div>
800
+ </div>
801
+ <div className='checkbox-text' />
802
+ </div>
803
+ ```
864
804
 
865
805
  ## Checkbox with custom icon
866
806
 
@@ -968,29 +908,14 @@ export default () => (
968
908
  </div>
969
909
  ```
970
910
 
971
- #### Props
972
-
973
- | Name | Type | Default | Description |
974
- | --- | --- | --- | --- |
975
- | id | String | — | Passed through as HTML attribute to the underlying input. id. (Uses name otherwise.) |
976
- | name | String | — | Passed through as HTML attribute to the underlying inputname. |
977
- | label | String / Node | — | Define some text as a label. |
978
- | checked | String / Boolean | — | Defines whether the checkbox is checked or not (state cannot be changed). |
979
- | defaultChecked | String / Boolean | — | Defines whether the checkbox is initially checked or not (state can be changed on click). |
980
- | disabled | Boolean | false | Defines whether the checkbox is disabled or not. |
981
- | indeterminate | Boolean | false | Defines if the checkbox is in an indeterminate state with regards to other checkboxes that may be in different selection state. |
982
- | inline | Boolean | false | Defines whether the checkbox is applying an inline style. Use this in combination with other checkboxes. |
983
- | right | Boolean | false | Defines whether the checkbox is on the right side. |
984
- | custom | Boolean | false | Allows for rendering a completely different layout with or without a checkbox tick. |
985
- | onClick | Function | () => {} | Callback function that is invoked when the checkbox is checked or unchecked. |
986
- | onChange | Function | () => {} | Callback function that is invoked when the checkbox value changes. This will also be invoked by a keyboard event. |
987
- | error | Boolean | false | Use "error" to change color of the checkbox. |
988
- | required | Boolean | false | Defines whether the checkbox is required or not. |
989
- | size | String | — | Defines the size of the checkbox. Omitting this prop renders the Checkbox in normal size. Possible values are: 'large' |
990
- | tabIndex | Number | 0 | The tabindex attribute allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation. See tabIndex |
991
- | className | String | — | Additional classes to be set on the input field. |
992
- | children | any | — | Any element to be rendered next to the checkbox. |
993
- | icon | String | — | Define a custom icon for the checkbox by naming a rioglyph icon like "rioglyph-truck". |
994
- | iconSize | Number | — | The icon size in pixel. |
995
- | iconLabelPosition | String | — | The label position for a custom icon checkbox. Using this on a regular checkbox has no effect. Possible values are: "horizontal" or "vertical". |
996
- | inputRef | Ref | — | A react ref assigned to the input itself. |
911
+ #### Props (json)
912
+
913
+ ```json
914
+ <div className='checkbox-text-wrapper display-flex justify-content-between'>
915
+ <div className='margin-right-15'>
916
+ <div className='text-medium text-size-16 text-color-darker'>Option 1</div>
917
+ <div className='text-color-dark'>This option is a first option</div>
918
+ </div>
919
+ <div className='checkbox-text' />
920
+ </div>
921
+ ```
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Interaction
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/clearableInput
6
- *Captured:* 2026-01-07T12:11:13.639Z
6
+ *Captured:* 2026-02-03T14:04:13.989Z
7
7
 
8
8
  Control, which can be cleared when it has a value.
9
9
 
@@ -374,37 +374,11 @@ export default () => (
374
374
  </div>
375
375
  ```
376
376
 
377
- #### Props
378
-
379
- | Name | Type | Default | Description |
380
- | --- | --- | --- | --- |
381
- | children | Function | — | Providing a function enables the "render props" approach. The function gets the inputProps passed and is responsible for rendering the custom <input> component. |
382
- | defaultValue | String | — | Initial value of the ClearableInput. Pass this prop if you want to use this component as an uncontrolled component. |
383
- | value | String | — | Value of the ClearableInput. Pass this prop if you want to use this component as a controlled component. |
384
- | onChange | Function | () => {} | Callback function for when the value changes. Receives new value as an argument. |
385
- | onClear | Function | () => {} | Callback function for when the value is cleared via the clear button |
386
- | onKeyPress | Function | () => {} | Callback function for every key pressed including "Enter" key |
387
- | onBlur | Function | () => {} | Callback function which gets triggered when the input looses the focus |
388
- | onFocus | Function | () => {} | Callback function which gets triggered when the input gains the focus |
389
- | className | String | — | Additional classes to be set on the wrapper element |
390
- | inputClassName | String | — | Additional classes to be set on the input element |
391
- | placeholder | String | — | The translated text that shall be shown when the input is empty |
392
- | inputRef | Function | — | The callback ref for the underlying input. Alternatively, use can use a forward ref. |
393
- | autoComplete | String | — | Sets autocomplete value for autosuggest forms |
394
- | type | String | "text" | Defines the type of the input itself. There are three types supported: 'text', 'email' and 'password' |
395
- | maxLength | Number | — | Defines the maximum amount of characters that can be entered |
396
- | disabled | Boolean | false | Disables the input component |
397
- | tabIndex | Number | 0 | The tabindex attribute allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation. See tabIndex |
398
- | hasError | Boolean | — | Defined whether or not the input has the error styling |
399
- | mask | string \| (string \| RegExp)[] | — | The mask prop will allow to use the component with an input mask. It defines the pattern that should be followed. For more details on masking, checkout the third party documentation for the input mask here: https://imask.js.org/guide.html Simple masks can be defined as strings. Any format character can be escaped with a backslash. The following characters will define mask format: Character: "0" = allowed input: "0-9" (digit) Character: "a" = allowed input: "a-z, A-Z" (letter) Character: "*" = allowed input: any character Character: "#" = allowed input: "0-9, a-z, A-Z" (digit or letter) Other chars which is not in custom definitions supposed to be fixed: [] - make input optional - include fixed part in unmasked value ` - prevent symbols shift back If definition character should be treated as fixed it should be escaped by \\ (E.g. \\0). Additionally you can provide custom definitions. Examples: "-- *** *** ***" "+49 00 000 00" |
400
- | maskPlaceholder | string \| null | _ | Placeholder to cover unfilled parts of the mask |
401
- | maskVisibility | 'always' \| 'onFocus' \| 'never' | onFocus | Controls when the mask pattern is visible. |
402
- | maskOverwrite | boolean \| 'shift' \| undefined | true | Enable characters overwriting. |
403
- | maskDefinitions | Record<string, string \| RegExp> | — | Custom definitions to have more control over your mask. The defined character will be replaced in your mask. |
404
- | maskDispatch | (appended: string, dynamicMasked: any) => any | — | Chooses the mask for dynamic masking depending on input value. Note, this function may not be an empty function, otherwise the mask selection does not work. |
405
- | min | string \| number \| undefined \| Date | — | Minimum value to be entered. This prop is extended to accept a Date when used with an input mask. |
406
- | max | string \| number \| undefined \| Date | — | Maximum value to be entered. This prop is extended to accept a Date when used with an input mask. |
407
- | Additional props | | — | All additional properties are passed down to the underlying input like the autoComplete prop |
377
+ #### Props (json)
378
+
379
+ ```json
380
+ '-- ### ### ###' or '+49 00 000 00'
381
+ ```
408
382
 
409
383
  ### Example: Example 2
410
384
 
@@ -448,7 +422,7 @@ const ClearableInputControlled = () => {
448
422
  console.log(event.key);
449
423
  };
450
424
 
451
- const handleBlur = (event: React.FocusEvent<HTMLInputElement>) => {
425
+ const handleBlur = (_event: React.FocusEvent<HTMLInputElement>) => {
452
426
  Notification.info('Input lost focus');
453
427
  };
454
428
 
@@ -491,37 +465,11 @@ export default ClearableInputControlled;
491
465
  </div>
492
466
  ```
493
467
 
494
- #### Props
495
-
496
- | Name | Type | Default | Description |
497
- | --- | --- | --- | --- |
498
- | children | Function | — | Providing a function enables the "render props" approach. The function gets the inputProps passed and is responsible for rendering the custom <input> component. |
499
- | defaultValue | String | — | Initial value of the ClearableInput. Pass this prop if you want to use this component as an uncontrolled component. |
500
- | value | String | — | Value of the ClearableInput. Pass this prop if you want to use this component as a controlled component. |
501
- | onChange | Function | () => {} | Callback function for when the value changes. Receives new value as an argument. |
502
- | onClear | Function | () => {} | Callback function for when the value is cleared via the clear button |
503
- | onKeyPress | Function | () => {} | Callback function for every key pressed including "Enter" key |
504
- | onBlur | Function | () => {} | Callback function which gets triggered when the input looses the focus |
505
- | onFocus | Function | () => {} | Callback function which gets triggered when the input gains the focus |
506
- | className | String | — | Additional classes to be set on the wrapper element |
507
- | inputClassName | String | — | Additional classes to be set on the input element |
508
- | placeholder | String | — | The translated text that shall be shown when the input is empty |
509
- | inputRef | Function | — | The callback ref for the underlying input. Alternatively, use can use a forward ref. |
510
- | autoComplete | String | — | Sets autocomplete value for autosuggest forms |
511
- | type | String | "text" | Defines the type of the input itself. There are three types supported: 'text', 'email' and 'password' |
512
- | maxLength | Number | — | Defines the maximum amount of characters that can be entered |
513
- | disabled | Boolean | false | Disables the input component |
514
- | tabIndex | Number | 0 | The tabindex attribute allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation. See tabIndex |
515
- | hasError | Boolean | — | Defined whether or not the input has the error styling |
516
- | mask | string \| (string \| RegExp)[] | — | The mask prop will allow to use the component with an input mask. It defines the pattern that should be followed. For more details on masking, checkout the third party documentation for the input mask here: https://imask.js.org/guide.html Simple masks can be defined as strings. Any format character can be escaped with a backslash. The following characters will define mask format: Character: "0" = allowed input: "0-9" (digit) Character: "a" = allowed input: "a-z, A-Z" (letter) Character: "*" = allowed input: any character Character: "#" = allowed input: "0-9, a-z, A-Z" (digit or letter) Other chars which is not in custom definitions supposed to be fixed: [] - make input optional - include fixed part in unmasked value ` - prevent symbols shift back If definition character should be treated as fixed it should be escaped by \\ (E.g. \\0). Additionally you can provide custom definitions. Examples: "-- *** *** ***" "+49 00 000 00" |
517
- | maskPlaceholder | string \| null | _ | Placeholder to cover unfilled parts of the mask |
518
- | maskVisibility | 'always' \| 'onFocus' \| 'never' | onFocus | Controls when the mask pattern is visible. |
519
- | maskOverwrite | boolean \| 'shift' \| undefined | true | Enable characters overwriting. |
520
- | maskDefinitions | Record<string, string \| RegExp> | — | Custom definitions to have more control over your mask. The defined character will be replaced in your mask. |
521
- | maskDispatch | (appended: string, dynamicMasked: any) => any | — | Chooses the mask for dynamic masking depending on input value. Note, this function may not be an empty function, otherwise the mask selection does not work. |
522
- | min | string \| number \| undefined \| Date | — | Minimum value to be entered. This prop is extended to accept a Date when used with an input mask. |
523
- | max | string \| number \| undefined \| Date | — | Maximum value to be entered. This prop is extended to accept a Date when used with an input mask. |
524
- | Additional props | | — | All additional properties are passed down to the underlying input like the autoComplete prop |
468
+ #### Props (json)
469
+
470
+ ```json
471
+ '-- ### ### ###' or '+49 00 000 00'
472
+ ```
525
473
 
526
474
  ### Example: Example 3
527
475
 
@@ -535,7 +483,7 @@ Controlled component with restriction and used with custom input
535
483
 
536
484
  ```tsx
537
485
  import { useState, useRef, useEffect } from 'react';
538
- import { countBy, isNil, toNumber } from 'es-toolkit/compat';
486
+ import { isNil, toNumber } from 'es-toolkit/compat';
539
487
 
540
488
  import ClearableInput from '@rio-cloud/rio-uikit/ClearableInput';
541
489
 
@@ -596,37 +544,11 @@ export default ClearableInputControlledRestricted;
596
544
  </div>
597
545
  ```
598
546
 
599
- #### Props
600
-
601
- | Name | Type | Default | Description |
602
- | --- | --- | --- | --- |
603
- | children | Function | — | Providing a function enables the "render props" approach. The function gets the inputProps passed and is responsible for rendering the custom <input> component. |
604
- | defaultValue | String | — | Initial value of the ClearableInput. Pass this prop if you want to use this component as an uncontrolled component. |
605
- | value | String | — | Value of the ClearableInput. Pass this prop if you want to use this component as a controlled component. |
606
- | onChange | Function | () => {} | Callback function for when the value changes. Receives new value as an argument. |
607
- | onClear | Function | () => {} | Callback function for when the value is cleared via the clear button |
608
- | onKeyPress | Function | () => {} | Callback function for every key pressed including "Enter" key |
609
- | onBlur | Function | () => {} | Callback function which gets triggered when the input looses the focus |
610
- | onFocus | Function | () => {} | Callback function which gets triggered when the input gains the focus |
611
- | className | String | — | Additional classes to be set on the wrapper element |
612
- | inputClassName | String | — | Additional classes to be set on the input element |
613
- | placeholder | String | — | The translated text that shall be shown when the input is empty |
614
- | inputRef | Function | — | The callback ref for the underlying input. Alternatively, use can use a forward ref. |
615
- | autoComplete | String | — | Sets autocomplete value for autosuggest forms |
616
- | type | String | "text" | Defines the type of the input itself. There are three types supported: 'text', 'email' and 'password' |
617
- | maxLength | Number | — | Defines the maximum amount of characters that can be entered |
618
- | disabled | Boolean | false | Disables the input component |
619
- | tabIndex | Number | 0 | The tabindex attribute allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation. See tabIndex |
620
- | hasError | Boolean | — | Defined whether or not the input has the error styling |
621
- | mask | string \| (string \| RegExp)[] | — | The mask prop will allow to use the component with an input mask. It defines the pattern that should be followed. For more details on masking, checkout the third party documentation for the input mask here: https://imask.js.org/guide.html Simple masks can be defined as strings. Any format character can be escaped with a backslash. The following characters will define mask format: Character: "0" = allowed input: "0-9" (digit) Character: "a" = allowed input: "a-z, A-Z" (letter) Character: "*" = allowed input: any character Character: "#" = allowed input: "0-9, a-z, A-Z" (digit or letter) Other chars which is not in custom definitions supposed to be fixed: [] - make input optional - include fixed part in unmasked value ` - prevent symbols shift back If definition character should be treated as fixed it should be escaped by \\ (E.g. \\0). Additionally you can provide custom definitions. Examples: "-- *** *** ***" "+49 00 000 00" |
622
- | maskPlaceholder | string \| null | _ | Placeholder to cover unfilled parts of the mask |
623
- | maskVisibility | 'always' \| 'onFocus' \| 'never' | onFocus | Controls when the mask pattern is visible. |
624
- | maskOverwrite | boolean \| 'shift' \| undefined | true | Enable characters overwriting. |
625
- | maskDefinitions | Record<string, string \| RegExp> | — | Custom definitions to have more control over your mask. The defined character will be replaced in your mask. |
626
- | maskDispatch | (appended: string, dynamicMasked: any) => any | — | Chooses the mask for dynamic masking depending on input value. Note, this function may not be an empty function, otherwise the mask selection does not work. |
627
- | min | string \| number \| undefined \| Date | — | Minimum value to be entered. This prop is extended to accept a Date when used with an input mask. |
628
- | max | string \| number \| undefined \| Date | — | Maximum value to be entered. This prop is extended to accept a Date when used with an input mask. |
629
- | Additional props | | — | All additional properties are passed down to the underlying input like the autoComplete prop |
547
+ #### Props (json)
548
+
549
+ ```json
550
+ '-- ### ### ###' or '+49 00 000 00'
551
+ ```
630
552
 
631
553
  ## ClearableInput with input mask
632
554
 
@@ -773,34 +695,8 @@ export default () => {
773
695
  </div>
774
696
  ```
775
697
 
776
- #### Props
777
-
778
- | Name | Type | Default | Description |
779
- | --- | --- | --- | --- |
780
- | children | Function | — | Providing a function enables the "render props" approach. The function gets the inputProps passed and is responsible for rendering the custom <input> component. |
781
- | defaultValue | String | — | Initial value of the ClearableInput. Pass this prop if you want to use this component as an uncontrolled component. |
782
- | value | String | — | Value of the ClearableInput. Pass this prop if you want to use this component as a controlled component. |
783
- | onChange | Function | () => {} | Callback function for when the value changes. Receives new value as an argument. |
784
- | onClear | Function | () => {} | Callback function for when the value is cleared via the clear button |
785
- | onKeyPress | Function | () => {} | Callback function for every key pressed including "Enter" key |
786
- | onBlur | Function | () => {} | Callback function which gets triggered when the input looses the focus |
787
- | onFocus | Function | () => {} | Callback function which gets triggered when the input gains the focus |
788
- | className | String | — | Additional classes to be set on the wrapper element |
789
- | inputClassName | String | — | Additional classes to be set on the input element |
790
- | placeholder | String | — | The translated text that shall be shown when the input is empty |
791
- | inputRef | Function | — | The callback ref for the underlying input. Alternatively, use can use a forward ref. |
792
- | autoComplete | String | — | Sets autocomplete value for autosuggest forms |
793
- | type | String | "text" | Defines the type of the input itself. There are three types supported: 'text', 'email' and 'password' |
794
- | maxLength | Number | — | Defines the maximum amount of characters that can be entered |
795
- | disabled | Boolean | false | Disables the input component |
796
- | tabIndex | Number | 0 | The tabindex attribute allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the Tab key, hence the name) and determine their relative ordering for sequential focus navigation. See tabIndex |
797
- | hasError | Boolean | — | Defined whether or not the input has the error styling |
798
- | mask | string \| (string \| RegExp)[] | — | The mask prop will allow to use the component with an input mask. It defines the pattern that should be followed. For more details on masking, checkout the third party documentation for the input mask here: https://imask.js.org/guide.html Simple masks can be defined as strings. Any format character can be escaped with a backslash. The following characters will define mask format: Character: "0" = allowed input: "0-9" (digit) Character: "a" = allowed input: "a-z, A-Z" (letter) Character: "*" = allowed input: any character Character: "#" = allowed input: "0-9, a-z, A-Z" (digit or letter) Other chars which is not in custom definitions supposed to be fixed: [] - make input optional - include fixed part in unmasked value ` - prevent symbols shift back If definition character should be treated as fixed it should be escaped by \\ (E.g. \\0). Additionally you can provide custom definitions. Examples: "-- *** *** ***" "+49 00 000 00" |
799
- | maskPlaceholder | string \| null | _ | Placeholder to cover unfilled parts of the mask |
800
- | maskVisibility | 'always' \| 'onFocus' \| 'never' | onFocus | Controls when the mask pattern is visible. |
801
- | maskOverwrite | boolean \| 'shift' \| undefined | true | Enable characters overwriting. |
802
- | maskDefinitions | Record<string, string \| RegExp> | — | Custom definitions to have more control over your mask. The defined character will be replaced in your mask. |
803
- | maskDispatch | (appended: string, dynamicMasked: any) => any | — | Chooses the mask for dynamic masking depending on input value. Note, this function may not be an empty function, otherwise the mask selection does not work. |
804
- | min | string \| number \| undefined \| Date | — | Minimum value to be entered. This prop is extended to accept a Date when used with an input mask. |
805
- | max | string \| number \| undefined \| Date | — | Maximum value to be entered. This prop is extended to accept a Date when used with an input mask. |
806
- | Additional props | | — | All additional properties are passed down to the underlying input like the autoComplete prop |
698
+ #### Props (json)
699
+
700
+ ```json
701
+ '-- ### ### ###' or '+49 00 000 00'
702
+ ```
@@ -3,7 +3,7 @@
3
3
  *Category:* Components
4
4
  *Section:* Show/Hide
5
5
  *Source:* https://uikit.developers.rio.cloud/#components/collapse
6
- *Captured:* 2026-01-07T12:11:20.254Z
6
+ *Captured:* 2026-02-03T14:04:23.050Z
7
7
 
8
8
  The Collapse component folds and unfolds given content. It is used in some other components such as the ExpanderPanel and ExpanderList.
9
9
 
@@ -83,7 +83,7 @@ export default () => {
83
83
  <div class="margin-bottom-15">
84
84
  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. Fusce ac ligula bibendum, rutrum libero quis, viverra sem. Interdum et malesuada fames ac ante ipsum primis in faucibus. Duis ut hendrerit massa, in molestie elit. Sed vitae orci ac purus volutpat posuere ac ut neque. Mauris ante orci, semper finibus lorem in, fringilla pretium velit.</div>
85
85
  <div class="dropdown btn-group">
86
- <button type="button" id="jibqqhal8ns" class="btn btn-default btn-md btn-component dropdown-toggle" tabindex="0">Dropdown<span class="caret">
86
+ <button type="button" id="6qynxk6hkce" class="btn btn-default btn-md btn-component dropdown-toggle" tabindex="0">Dropdown<span class="caret">
87
87
  </span>
88
88
  </button>
89
89
  </div>
@@ -98,14 +98,13 @@ export default () => {
98
98
 
99
99
  | Name | Type | Default | Description |
100
100
  | --- | --- | --- | --- |
101
- | open | Boolean | false | Show the component and triggers the expand or collapse animation. |
102
- | timeout | Number | 270 | Duration of the collapse animation in milliseconds. |
103
- | appear | Boolean | false | Run the expand animation when the component mounts, if it is initially shown. |
104
- | unmountOnExit | Boolean | false | Unmount the component (remove it from the DOM) when it is collapsed. |
101
+ | open | boolean \| undefined | false | Show the component and triggers the expand or collapse animation. |
102
+ | unmountOnExit | boolean | | Unmount the component (remove it from the DOM) when it is collapsed. |
103
+ | appear | boolean | false | Run the expand animation when the component mounts, if it is initially shown. |
104
+ | timeout | number | 270 | Duration of the collapse animation in milliseconds. |
105
105
  | onEntered | () => void | — | Callback fired after the component has expanded. |
106
- | onExited | () => {} | — | Callback fired after the component has collapsed. |
107
- | onAnimationStart | () => {} | — | Callback fired when the animation starts for either expand or collapse. |
108
- | children | any | — | Any component given to be expanded or collapsed. |
106
+ | onExited | () => void | — | Callback fired after the component has collapsed. |
107
+ | onAnimationStart | () => void | — | Callback fired when the animation starts for either expand or collapse. |
109
108
 
110
109
  ### Example: Content will be removed from the DOM when it is collapsed and mounted again on show
111
110
 
@@ -179,11 +178,10 @@ export default () => {
179
178
 
180
179
  | Name | Type | Default | Description |
181
180
  | --- | --- | --- | --- |
182
- | open | Boolean | false | Show the component and triggers the expand or collapse animation. |
183
- | timeout | Number | 270 | Duration of the collapse animation in milliseconds. |
184
- | appear | Boolean | false | Run the expand animation when the component mounts, if it is initially shown. |
185
- | unmountOnExit | Boolean | false | Unmount the component (remove it from the DOM) when it is collapsed. |
181
+ | open | boolean \| undefined | false | Show the component and triggers the expand or collapse animation. |
182
+ | unmountOnExit | boolean | | Unmount the component (remove it from the DOM) when it is collapsed. |
183
+ | appear | boolean | false | Run the expand animation when the component mounts, if it is initially shown. |
184
+ | timeout | number | 270 | Duration of the collapse animation in milliseconds. |
186
185
  | onEntered | () => void | — | Callback fired after the component has expanded. |
187
- | onExited | () => {} | — | Callback fired after the component has collapsed. |
188
- | onAnimationStart | () => {} | — | Callback fired when the animation starts for either expand or collapse. |
189
- | children | any | — | Any component given to be expanded or collapsed. |
186
+ | onExited | () => void | — | Callback fired after the component has collapsed. |
187
+ | onAnimationStart | () => void | — | Callback fired when the animation starts for either expand or collapse. |