@rio-cloud/uikit-mcp 1.0.0 → 1.1.0

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 (388) hide show
  1. package/README.md +75 -40
  2. package/dist/doc-metadata.json +1872 -0
  3. package/dist/docs/components/accentBar.md +582 -0
  4. package/dist/docs/components/activity.md +330 -0
  5. package/dist/docs/components/animatedNumber.md +88 -0
  6. package/dist/docs/components/animatedTextReveal.md +381 -0
  7. package/dist/docs/components/animations.md +459 -0
  8. package/dist/docs/components/appHeader.md +737 -0
  9. package/dist/docs/components/appLayout.md +2016 -0
  10. package/dist/docs/components/appNavigationBar.md +274 -0
  11. package/dist/docs/components/areaCharts.md +828 -0
  12. package/dist/docs/components/aspectRatioPlaceholder.md +106 -0
  13. package/dist/docs/components/assetTree.md +3223 -0
  14. package/dist/docs/components/autosuggests.md +1177 -0
  15. package/dist/docs/components/avatar.md +206 -0
  16. package/dist/docs/components/banner.md +668 -0
  17. package/dist/docs/components/barCharts.md +2785 -0
  18. package/dist/docs/components/barList.md +517 -0
  19. package/dist/docs/components/basicMap.md +167 -0
  20. package/dist/docs/components/bottomSheet.md +721 -0
  21. package/dist/docs/components/button.md +775 -0
  22. package/dist/docs/components/buttonToolbar.md +134 -0
  23. package/dist/docs/components/calendarStripe.md +525 -0
  24. package/dist/docs/components/card.md +86 -0
  25. package/dist/docs/components/carousel.md +128 -0
  26. package/dist/docs/components/chartColors.md +716 -0
  27. package/dist/docs/components/chartsGettingStarted.md +28 -0
  28. package/dist/docs/components/chat.md +932 -0
  29. package/dist/docs/components/checkbox.md +996 -0
  30. package/dist/docs/components/clearableInput.md +806 -0
  31. package/dist/docs/components/collapse.md +189 -0
  32. package/dist/docs/components/composedCharts.md +424 -0
  33. package/dist/docs/components/contentLoader.md +674 -0
  34. package/dist/docs/components/dataTabs.md +1251 -0
  35. package/dist/docs/components/datepickers.md +2543 -0
  36. package/dist/docs/components/dialogs.md +2244 -0
  37. package/dist/docs/components/divider.md +219 -0
  38. package/dist/docs/components/dropdowns.md +17550 -0
  39. package/dist/docs/components/editableContent.md +1127 -0
  40. package/dist/docs/components/expander.md +970 -0
  41. package/dist/docs/components/fade.md +836 -0
  42. package/dist/docs/components/fadeExpander.md +180 -0
  43. package/dist/docs/components/fadeUp.md +396 -0
  44. package/dist/docs/components/feedback.md +758 -0
  45. package/dist/docs/components/filePickers.md +370 -0
  46. package/dist/docs/components/formLabel.md +251 -0
  47. package/dist/docs/components/fullscreenMap.md +10 -0
  48. package/dist/docs/components/groupedItemList.md +1001 -0
  49. package/dist/docs/components/iconList.md +306 -0
  50. package/dist/docs/components/imagePreloader.md +167 -0
  51. package/dist/docs/components/labeledElement.md +115 -0
  52. package/dist/docs/components/licensePlate.md +412 -0
  53. package/dist/docs/components/lineCharts.md +2014 -0
  54. package/dist/docs/components/listMenu.md +392 -0
  55. package/dist/docs/components/loadMore.md +219 -0
  56. package/dist/docs/components/mainNavigation.md +129 -0
  57. package/dist/docs/components/mapCircle.md +93 -0
  58. package/dist/docs/components/mapCluster.md +337 -0
  59. package/dist/docs/components/mapContext.md +284 -0
  60. package/dist/docs/components/mapDraggableMarker.md +150 -0
  61. package/dist/docs/components/mapGettingStarted.md +39 -0
  62. package/dist/docs/components/mapInfoBubble.md +135 -0
  63. package/dist/docs/components/mapLayerGroup.md +94 -0
  64. package/dist/docs/components/mapMarker.md +1814 -0
  65. package/dist/docs/components/mapPolygon.md +959 -0
  66. package/dist/docs/components/mapRoute.md +3816 -0
  67. package/dist/docs/components/mapRouteGenerator.md +6 -0
  68. package/dist/docs/components/mapSettings.md +1040 -0
  69. package/dist/docs/components/mapUtils.md +132 -0
  70. package/dist/docs/components/multiselects.md +1921 -0
  71. package/dist/docs/components/noData.md +210 -0
  72. package/dist/docs/components/notifications.md +314 -0
  73. package/dist/docs/components/numbercontrol.md +706 -0
  74. package/dist/docs/components/onboarding.md +297 -0
  75. package/dist/docs/components/page.md +241 -0
  76. package/dist/docs/components/pager.md +133 -0
  77. package/dist/docs/components/pieCharts.md +1284 -0
  78. package/dist/docs/components/popover.md +222 -0
  79. package/dist/docs/components/position.md +50 -0
  80. package/dist/docs/components/radialBarCharts.md +3663 -0
  81. package/dist/docs/components/radiobutton.md +1271 -0
  82. package/dist/docs/components/releaseNotes.md +135 -0
  83. package/dist/docs/components/resizer.md +162 -0
  84. package/dist/docs/components/responsiveColumnStripe.md +435 -0
  85. package/dist/docs/components/responsiveVideo.md +71 -0
  86. package/dist/docs/components/rioglyph.md +331 -0
  87. package/dist/docs/components/rules.md +965 -0
  88. package/dist/docs/components/saveableInput.md +1721 -0
  89. package/dist/docs/components/selects.md +1993 -0
  90. package/dist/docs/components/sidebar.md +332 -0
  91. package/dist/docs/components/sliders.md +376 -0
  92. package/dist/docs/components/smoothScrollbars.md +1180 -0
  93. package/dist/docs/components/spinners.md +506 -0
  94. package/dist/docs/components/states.md +1176 -0
  95. package/dist/docs/components/statsWidgets.md +636 -0
  96. package/dist/docs/components/statusBar.md +644 -0
  97. package/dist/docs/components/stepButton.md +61 -0
  98. package/dist/docs/components/steppedProgressBars.md +1064 -0
  99. package/dist/docs/components/subNavigation.md +470 -0
  100. package/dist/docs/components/supportMarker.md +115 -0
  101. package/dist/docs/components/svgImage.md +248 -0
  102. package/dist/docs/components/switch.md +554 -0
  103. package/dist/docs/components/tables.md +8 -0
  104. package/dist/docs/components/tagManager.md +476 -0
  105. package/dist/docs/components/tags.md +785 -0
  106. package/dist/docs/components/teaser.md +925 -0
  107. package/dist/docs/components/timeline.md +514 -0
  108. package/dist/docs/components/timepicker.md +262 -0
  109. package/dist/docs/components/toggleButton.md +178 -0
  110. package/dist/docs/components/tooltip.md +454 -0
  111. package/dist/docs/components/virtualList.md +483 -0
  112. package/dist/docs/foundations.md +20901 -0
  113. package/dist/docs/start/changelog.md +439 -0
  114. package/dist/docs/start/goodtoknow.md +14 -0
  115. package/dist/docs/start/guidelines/color-combinations.md +678 -0
  116. package/dist/docs/start/guidelines/custom-css.md +42 -0
  117. package/dist/docs/start/guidelines/custom-rioglyph.md +35 -0
  118. package/dist/docs/start/guidelines/formatting.md +587 -0
  119. package/dist/docs/start/guidelines/iframe.md +323 -0
  120. package/dist/docs/start/guidelines/obfuscate-data.md +30 -0
  121. package/dist/docs/start/guidelines/print-css.md +36 -0
  122. package/dist/docs/start/guidelines/spinner.md +710 -0
  123. package/dist/docs/start/guidelines/supported-browsers.md +10 -0
  124. package/dist/docs/start/guidelines/writing.md +635 -0
  125. package/dist/docs/start/howto.md +187 -0
  126. package/dist/docs/start/intro.md +43 -0
  127. package/dist/docs/start/responsiveness.md +98 -0
  128. package/dist/docs/templates/common-table.md +1111 -0
  129. package/dist/docs/templates/detail-views.md +942 -0
  130. package/dist/docs/templates/expandable-details.md +228 -0
  131. package/dist/docs/templates/feature-cards.md +549 -0
  132. package/dist/docs/templates/form-summary.md +199 -0
  133. package/dist/docs/templates/form-toggle.md +367 -0
  134. package/dist/docs/templates/list-blocks.md +1021 -0
  135. package/dist/docs/templates/loading-progress.md +109 -0
  136. package/dist/docs/templates/options-panel.md +152 -0
  137. package/dist/docs/templates/panel-variants.md +164 -0
  138. package/dist/docs/templates/progress-cards.md +607 -0
  139. package/dist/docs/templates/progress-success.md +142 -0
  140. package/dist/docs/templates/settings-form.md +434 -0
  141. package/dist/docs/templates/stats-blocks.md +1381 -0
  142. package/dist/docs/templates/table-panel.md +184 -0
  143. package/dist/docs/templates/table-row-animation.md +317 -0
  144. package/dist/docs/templates/usage-cards.md +227 -0
  145. package/dist/docs/utilities/deviceUtils.md +123 -0
  146. package/dist/docs/utilities/featureToggles.md +90 -0
  147. package/dist/docs/utilities/fuelTypeUtils.md +186 -0
  148. package/dist/docs/utilities/routeUtils.md +138 -0
  149. package/dist/docs/utilities/useAfterMount.md +66 -0
  150. package/dist/docs/utilities/useAutoAnimate.md +193 -0
  151. package/dist/docs/utilities/useAverage.md +95 -0
  152. package/dist/docs/utilities/useClickOutside.md +61 -0
  153. package/dist/docs/utilities/useClipboard.md +93 -0
  154. package/dist/docs/utilities/useCount.md +178 -0
  155. package/dist/docs/utilities/useDarkMode.md +49 -0
  156. package/dist/docs/utilities/useDebugInfo.md +126 -0
  157. package/dist/docs/utilities/useEffectOnce.md +58 -0
  158. package/dist/docs/utilities/useElapsedTime.md +58 -0
  159. package/dist/docs/utilities/useElementSize.md +71 -0
  160. package/dist/docs/utilities/useEsc.md +58 -0
  161. package/dist/docs/utilities/useEvent.md +64 -0
  162. package/dist/docs/utilities/useFocusTrap.md +85 -0
  163. package/dist/docs/utilities/useFullscreen.md +198 -0
  164. package/dist/docs/utilities/useHover.md +55 -0
  165. package/dist/docs/utilities/useIncomingPostMessages.md +237 -0
  166. package/dist/docs/utilities/useInterval.md +85 -0
  167. package/dist/docs/utilities/useIsFocusWithin.md +114 -0
  168. package/dist/docs/utilities/useKey.md +151 -0
  169. package/dist/docs/utilities/useLocalStorage.md +91 -0
  170. package/dist/docs/utilities/useLocationSuggestions.md +114 -0
  171. package/dist/docs/utilities/useMax.md +62 -0
  172. package/dist/docs/utilities/useMin.md +78 -0
  173. package/dist/docs/utilities/useMutationObserver.md +113 -0
  174. package/dist/docs/utilities/useOnScreen.md +138 -0
  175. package/dist/docs/utilities/useOnlineStatus.md +49 -0
  176. package/dist/docs/utilities/usePostMessage.md +117 -0
  177. package/dist/docs/utilities/usePostMessageSender.md +257 -0
  178. package/dist/docs/utilities/usePrevious.md +101 -0
  179. package/dist/docs/utilities/useResizeObserver.md +151 -0
  180. package/dist/docs/utilities/useScrollPosition.md +252 -0
  181. package/dist/docs/utilities/useSearch.md +228 -0
  182. package/dist/docs/utilities/useSorting.md +389 -0
  183. package/dist/docs/utilities/useStateWithValidation.md +83 -0
  184. package/dist/docs/utilities/useSum.md +155 -0
  185. package/dist/docs/utilities/useTableExport.md +404 -0
  186. package/dist/docs/utilities/useTableSelection.md +1120 -0
  187. package/dist/docs/utilities/useTimeout.md +55 -0
  188. package/dist/docs/utilities/useToggle.md +115 -0
  189. package/dist/docs/utilities/useWindowResize.md +70 -0
  190. package/dist/index.mjs +271 -0
  191. package/dist/search-synonyms.json +134 -0
  192. package/dist/version.json +4 -0
  193. package/package.json +23 -19
  194. package/bin/uikit-mcp.mjs +0 -23
  195. package/data/pages/Components/components/accentbar.json +0 -207
  196. package/data/pages/Components/components/activity.json +0 -87
  197. package/data/pages/Components/components/animatednumber.json +0 -99
  198. package/data/pages/Components/components/animations.json +0 -87
  199. package/data/pages/Components/components/appheader.json +0 -291
  200. package/data/pages/Components/components/applayout.json +0 -1198
  201. package/data/pages/Components/components/appnavigationbar.json +0 -327
  202. package/data/pages/Components/components/areacharts.json +0 -563
  203. package/data/pages/Components/components/aspectratioplaceholder.json +0 -75
  204. package/data/pages/Components/components/assettree.json +0 -3080
  205. package/data/pages/Components/components/autosuggests.json +0 -710
  206. package/data/pages/Components/components/avatar.json +0 -157
  207. package/data/pages/Components/components/banner.json +0 -599
  208. package/data/pages/Components/components/barcharts.json +0 -1507
  209. package/data/pages/Components/components/barlist.json +0 -223
  210. package/data/pages/Components/components/basicmap.json +0 -68
  211. package/data/pages/Components/components/bottomsheet.json +0 -601
  212. package/data/pages/Components/components/button.json +0 -583
  213. package/data/pages/Components/components/buttontoolbar.json +0 -63
  214. package/data/pages/Components/components/calendarstripe.json +0 -235
  215. package/data/pages/Components/components/card.json +0 -69
  216. package/data/pages/Components/components/carousel.json +0 -39
  217. package/data/pages/Components/components/chartcolors.json +0 -34
  218. package/data/pages/Components/components/chartsgettingstarted.json +0 -32
  219. package/data/pages/Components/components/chat.json +0 -39
  220. package/data/pages/Components/components/checkbox.json +0 -847
  221. package/data/pages/Components/components/clearableinput.json +0 -789
  222. package/data/pages/Components/components/collapse.json +0 -175
  223. package/data/pages/Components/components/composedcharts.json +0 -159
  224. package/data/pages/Components/components/contentloader.json +0 -233
  225. package/data/pages/Components/components/datatabs.json +0 -680
  226. package/data/pages/Components/components/datepickers.json +0 -287
  227. package/data/pages/Components/components/dialogs.json +0 -1492
  228. package/data/pages/Components/components/divider.json +0 -93
  229. package/data/pages/Components/components/dropdowns.json +0 -936
  230. package/data/pages/Components/components/editablecontent.json +0 -1117
  231. package/data/pages/Components/components/expander.json +0 -377
  232. package/data/pages/Components/components/fade.json +0 -403
  233. package/data/pages/Components/components/fadeexpander.json +0 -75
  234. package/data/pages/Components/components/fadeup.json +0 -127
  235. package/data/pages/Components/components/feedback.json +0 -269
  236. package/data/pages/Components/components/filepickers.json +0 -269
  237. package/data/pages/Components/components/formlabel.json +0 -115
  238. package/data/pages/Components/components/fullscreenmap.json +0 -22
  239. package/data/pages/Components/components/groupeditemlist.json +0 -323
  240. package/data/pages/Components/components/iconlist.json +0 -45
  241. package/data/pages/Components/components/imagepreloader.json +0 -81
  242. package/data/pages/Components/components/labeledelement.json +0 -75
  243. package/data/pages/Components/components/licenseplate.json +0 -69
  244. package/data/pages/Components/components/linecharts.json +0 -987
  245. package/data/pages/Components/components/listmenu.json +0 -313
  246. package/data/pages/Components/components/loadmore.json +0 -175
  247. package/data/pages/Components/components/mainnavigation.json +0 -39
  248. package/data/pages/Components/components/mapcircle.json +0 -34
  249. package/data/pages/Components/components/mapcluster.json +0 -51
  250. package/data/pages/Components/components/mapcontext.json +0 -105
  251. package/data/pages/Components/components/mapdraggablemarker.json +0 -34
  252. package/data/pages/Components/components/mapgettingstarted.json +0 -27
  253. package/data/pages/Components/components/mapgroup.json +0 -1198
  254. package/data/pages/Components/components/mapinfobubble.json +0 -34
  255. package/data/pages/Components/components/maplayergroup.json +0 -34
  256. package/data/pages/Components/components/mapmarker.json +0 -700
  257. package/data/pages/Components/components/mappolygon.json +0 -45
  258. package/data/pages/Components/components/maproute.json +0 -623
  259. package/data/pages/Components/components/maproutegenerator.json +0 -16
  260. package/data/pages/Components/components/mapsettings.json +0 -51
  261. package/data/pages/Components/components/maputils.json +0 -34
  262. package/data/pages/Components/components/multiselects.json +0 -1451
  263. package/data/pages/Components/components/nodata.json +0 -139
  264. package/data/pages/Components/components/notifications.json +0 -65
  265. package/data/pages/Components/components/numbercontrol.json +0 -301
  266. package/data/pages/Components/components/onboarding.json +0 -302
  267. package/data/pages/Components/components/page.json +0 -197
  268. package/data/pages/Components/components/pager.json +0 -93
  269. package/data/pages/Components/components/piecharts.json +0 -731
  270. package/data/pages/Components/components/popover.json +0 -251
  271. package/data/pages/Components/components/position.json +0 -69
  272. package/data/pages/Components/components/radialbarcharts.json +0 -1304
  273. package/data/pages/Components/components/radiobutton.json +0 -1105
  274. package/data/pages/Components/components/releasenotes.json +0 -44
  275. package/data/pages/Components/components/resizer.json +0 -93
  276. package/data/pages/Components/components/responsivecolumnstripe.json +0 -123
  277. package/data/pages/Components/components/responsivevideo.json +0 -75
  278. package/data/pages/Components/components/rioglyph.json +0 -93
  279. package/data/pages/Components/components/rules.json +0 -410
  280. package/data/pages/Components/components/saveableinput.json +0 -703
  281. package/data/pages/Components/components/selects.json +0 -701
  282. package/data/pages/Components/components/sidebar.json +0 -243
  283. package/data/pages/Components/components/sliders.json +0 -235
  284. package/data/pages/Components/components/smoothscrollbars.json +0 -335
  285. package/data/pages/Components/components/spinners.json +0 -343
  286. package/data/pages/Components/components/states.json +0 -1705
  287. package/data/pages/Components/components/statswidgets.json +0 -314
  288. package/data/pages/Components/components/statusbar.json +0 -177
  289. package/data/pages/Components/components/stepbutton.json +0 -57
  290. package/data/pages/Components/components/steppedprogressbars.json +0 -417
  291. package/data/pages/Components/components/subnavigation.json +0 -107
  292. package/data/pages/Components/components/supportmarker.json +0 -45
  293. package/data/pages/Components/components/svgimage.json +0 -81
  294. package/data/pages/Components/components/switch.json +0 -111
  295. package/data/pages/Components/components/tables.json +0 -144
  296. package/data/pages/Components/components/tagmanager.json +0 -86
  297. package/data/pages/Components/components/tags.json +0 -146
  298. package/data/pages/Components/components/teaser.json +0 -188
  299. package/data/pages/Components/components/timeline.json +0 -45
  300. package/data/pages/Components/components/timepicker.json +0 -163
  301. package/data/pages/Components/components/togglebutton.json +0 -247
  302. package/data/pages/Components/components/tooltip.json +0 -270
  303. package/data/pages/Components/components/virtuallist.json +0 -175
  304. package/data/pages/Foundations/foundations.json +0 -2475
  305. package/data/pages/Getting-started/start/changelog.json +0 -22
  306. package/data/pages/Getting-started/start/goodtoknow.json +0 -32
  307. package/data/pages/Getting-started/start/guidelines/color-combinations.json +0 -58
  308. package/data/pages/Getting-started/start/guidelines/custom-css.json +0 -27
  309. package/data/pages/Getting-started/start/guidelines/custom-rioglyph.json +0 -22
  310. package/data/pages/Getting-started/start/guidelines/formatting.json +0 -97
  311. package/data/pages/Getting-started/start/guidelines/iframe.json +0 -93
  312. package/data/pages/Getting-started/start/guidelines/obfuscate-data.json +0 -22
  313. package/data/pages/Getting-started/start/guidelines/print-css.json +0 -37
  314. package/data/pages/Getting-started/start/guidelines/spinner.json +0 -144
  315. package/data/pages/Getting-started/start/guidelines/supported-browsers.json +0 -22
  316. package/data/pages/Getting-started/start/guidelines/writing.json +0 -242
  317. package/data/pages/Getting-started/start/howto.json +0 -72
  318. package/data/pages/Getting-started/start/intro.json +0 -37
  319. package/data/pages/Getting-started/start/responsiveness.json +0 -52
  320. package/data/pages/Templates/templates/common-table.json +0 -39
  321. package/data/pages/Templates/templates/detail-views.json +0 -71
  322. package/data/pages/Templates/templates/expandable-details.json +0 -39
  323. package/data/pages/Templates/templates/feature-cards.json +0 -103
  324. package/data/pages/Templates/templates/form-summary.json +0 -39
  325. package/data/pages/Templates/templates/form-toggle.json +0 -39
  326. package/data/pages/Templates/templates/list-blocks.json +0 -119
  327. package/data/pages/Templates/templates/loading-progress.json +0 -39
  328. package/data/pages/Templates/templates/options-panel.json +0 -39
  329. package/data/pages/Templates/templates/panel-variants.json +0 -39
  330. package/data/pages/Templates/templates/progress-cards.json +0 -71
  331. package/data/pages/Templates/templates/progress-success.json +0 -39
  332. package/data/pages/Templates/templates/settings-form.json +0 -39
  333. package/data/pages/Templates/templates/stats-blocks.json +0 -135
  334. package/data/pages/Templates/templates/table-panel.json +0 -39
  335. package/data/pages/Templates/templates/table-row-animation.json +0 -39
  336. package/data/pages/Templates/templates/usage-cards.json +0 -39
  337. package/data/pages/Utilities/utilities/deviceutils.json +0 -39
  338. package/data/pages/Utilities/utilities/featuretoggles.json +0 -42
  339. package/data/pages/Utilities/utilities/fueltypeutils.json +0 -118
  340. package/data/pages/Utilities/utilities/routeutils.json +0 -34
  341. package/data/pages/Utilities/utilities/useaftermount.json +0 -63
  342. package/data/pages/Utilities/utilities/useaverage.json +0 -86
  343. package/data/pages/Utilities/utilities/useclickoutside.json +0 -69
  344. package/data/pages/Utilities/utilities/useclipboard.json +0 -57
  345. package/data/pages/Utilities/utilities/usecount.json +0 -92
  346. package/data/pages/Utilities/utilities/usedarkmode.json +0 -50
  347. package/data/pages/Utilities/utilities/usedebuginfo.json +0 -63
  348. package/data/pages/Utilities/utilities/useeffectonce.json +0 -57
  349. package/data/pages/Utilities/utilities/useelapsedtime.json +0 -57
  350. package/data/pages/Utilities/utilities/useelementsize.json +0 -63
  351. package/data/pages/Utilities/utilities/useesc.json +0 -57
  352. package/data/pages/Utilities/utilities/useevent.json +0 -75
  353. package/data/pages/Utilities/utilities/usefocustrap.json +0 -57
  354. package/data/pages/Utilities/utilities/usefullscreen.json +0 -197
  355. package/data/pages/Utilities/utilities/usehover.json +0 -57
  356. package/data/pages/Utilities/utilities/useinterval.json +0 -63
  357. package/data/pages/Utilities/utilities/useisfocuswithin.json +0 -75
  358. package/data/pages/Utilities/utilities/usekey.json +0 -75
  359. package/data/pages/Utilities/utilities/uselocalstorage.json +0 -69
  360. package/data/pages/Utilities/utilities/uselocationsuggestions.json +0 -110
  361. package/data/pages/Utilities/utilities/usemax.json +0 -86
  362. package/data/pages/Utilities/utilities/usemin.json +0 -86
  363. package/data/pages/Utilities/utilities/usemutationobserver.json +0 -69
  364. package/data/pages/Utilities/utilities/useonlinestatus.json +0 -39
  365. package/data/pages/Utilities/utilities/useonscreen.json +0 -63
  366. package/data/pages/Utilities/utilities/usepostmessage.json +0 -80
  367. package/data/pages/Utilities/utilities/useprevious.json +0 -63
  368. package/data/pages/Utilities/utilities/useresizeobserver.json +0 -65
  369. package/data/pages/Utilities/utilities/usescrollposition.json +0 -103
  370. package/data/pages/Utilities/utilities/usesearch.json +0 -197
  371. package/data/pages/Utilities/utilities/usesorting.json +0 -139
  372. package/data/pages/Utilities/utilities/usestatewithvalidation.json +0 -69
  373. package/data/pages/Utilities/utilities/usesum.json +0 -86
  374. package/data/pages/Utilities/utilities/usetableexport.json +0 -87
  375. package/data/pages/Utilities/utilities/usetableselection.json +0 -311
  376. package/data/pages/Utilities/utilities/usetimeout.json +0 -63
  377. package/data/pages/Utilities/utilities/usetoggle.json +0 -75
  378. package/data/pages/Utilities/utilities/usewindowresize.json +0 -63
  379. package/data/version.json +0 -4
  380. package/docs/content-schema.md +0 -147
  381. package/docs/navigation-inventory.json +0 -1310
  382. package/docs/search-synonyms.json +0 -43
  383. package/server/index.mjs +0 -268
  384. package/server/lib/load-docs.mjs +0 -48
  385. package/server/lib/normalise-doc.mjs +0 -220
  386. package/server/lib/render-markdown.mjs +0 -82
  387. package/server/lib/search-index.mjs +0 -49
  388. package/server/lib/types.js +0 -99
@@ -0,0 +1,668 @@
1
+ # Banner
2
+
3
+ *Category:* Components
4
+ *Section:* Content
5
+ *Source:* https://uikit.developers.rio.cloud/#components/banner
6
+ *Captured:* 2025-12-12T12:38:38.275Z
7
+
8
+ Convey information or prompt action through in-line banners, ideal for educational content, updates, or announcements.
9
+
10
+ ## Banner
11
+
12
+ **Banner with multiple pages**
13
+
14
+ ### Example: Example 1
15
+
16
+ Banner title
17
+ Content highlighting a specific feature or action that users should be aware of or engage with
18
+ Button CTAButton CTA
19
+
20
+ Reset
21
+
22
+ #### Summary
23
+
24
+ Banner title
25
+ Content highlighting a specific feature or action that users should be aware of or engage with
26
+ Button CTAButton CTA
27
+
28
+ Reset
29
+
30
+ #### React (tsx)
31
+
32
+ ```tsx
33
+ import { useState } from 'react';
34
+
35
+ import Banner from '@rio-cloud/rio-uikit/Banner';
36
+ import Button from '@rio-cloud/rio-uikit/Button';
37
+ import DemoIllustration from './DemoIllustration';
38
+
39
+ export default () => {
40
+ const [showBanner, setShowBanner] = useState(true);
41
+
42
+ return (
43
+ <div>
44
+ <Banner show={showBanner} onClose={() => setShowBanner(false)}>
45
+ <Banner.Page>
46
+ <Banner.Icon>
47
+ <DemoIllustration />
48
+ </Banner.Icon>
49
+ <Banner.Content
50
+ title='Banner title'
51
+ actions={
52
+ <Banner.Actions>
53
+ <Button bsStyle='muted-filled'>Button CTA</Button>
54
+ <Button bsStyle='primary'>Button CTA</Button>
55
+ </Banner.Actions>
56
+ }
57
+ >
58
+ Content highlighting a specific feature or action that users should be aware of or engage with
59
+ </Banner.Content>
60
+ </Banner.Page>
61
+ </Banner>
62
+
63
+ <Button bsSize='sm' className='margin-top-25' onClick={() => setShowBanner(true)}>
64
+ Reset
65
+ </Button>
66
+ </div>
67
+ );
68
+ };
69
+ ```
70
+
71
+ #### HTML (html)
72
+
73
+ ```html
74
+ <div>
75
+ <div style="height: 107px; opacity: 1;">
76
+ <div style="position: relative;">
77
+ <div class="bg-white rounded border shadow-default padding-20 Banner display-flex text-color-darker overflow-hidden position-relative">
78
+ <div class="flex-1-1 overflow-hidden">
79
+ <div style="opacity: 0; transform: translateX(17.914px);">
80
+ <div class="display-flex align-items-start align-items-center-ls width-100pct gap-15 ">
81
+ <div class="BannerIcon flex-0 margin-x-5 min-width-25 ">
82
+ <svg xmlns="http://www.w3.org/2000/svg" width="80" height="60" viewBox="0 0 773 612" xmlns:xlink="http://www.w3.org/1999/xlink" role="img" artist="Katerina Limpitsouni" source="https://undraw.co/">
83
+ <path d="M850.4211,442.927l32.63119-35.49645-26.706-21.07259-13.19279,29.16777-59.85542,19.77364a11.99113,11.99113,0,1,0,3.85641,17.25776Z" transform="translate(-213.5 -144)" fill="#ffb6b6">
84
+ </path>
85
+ <path d="M910.23781,362.72613c5.91493,13.18947-30.17271,50.86966-30.17271,50.86966-9.86955,7.98163-11.43422,27.95951-23.66746,30.18374-33,6-12.47561-.27862-21,3-8.02175,3.08529-.63334-23.32158-6-25-3.06911-.95987,14-12,14-12s15.38283-30.16748,24.84111-45.81544a30.64419,30.64419,0,0,1,25.32877-15.25847S904.32285,349.53668,910.23781,362.72613Z" transform="translate(-213.5 -144)" fill="#e6e6e6">
86
+ </path>
87
+ <path d="M757.45673,754.81488H382.499a33.5588,33.5588,0,0,1-33.5209-33.52087V177.5209A33.55882,33.55882,0,0,1,382.499,144H757.45673a33.5588,33.5588,0,0,1,33.52087,33.5209V721.294A33.55885,33.55885,0,0,1,757.45673,754.81488Z" transform="translate(-213.5 -144)" fill="#3f3d56">
88
+ </path>
89
+ <path d="M758.1167,733.4278H381.839a10.345,10.345,0,0,1-10.33319-10.3332V175.72026A10.345,10.345,0,0,1,381.839,165.38707H758.1167a10.345,10.345,0,0,1,10.33319,10.33319V723.0946A10.345,10.345,0,0,1,758.1167,733.4278Z" transform="translate(-213.5 -144)" fill="#fff">
90
+ </path>
91
+ <path d="M400.196,417.2599c1.05037-14.2625,2.78468-31.7964,16.89581-39.41573,6.65845-3.59524,13.70893-2.32332,20.40314.47908,6.46856,2.70794,12.5627,5.93585,19.5296,7.209a56.69026,56.69026,0,0,0,35.241-5.28468,54.16607,54.16607,0,0,0,24.92977-25.51437c2.67184-5.633,4.87982-11.73757,8.81615-16.6538a18.52389,18.52389,0,0,1,17.12456-7.08681c14.79633,1.82667,24.61523,14.7913,36.411,22.42333,5.67289,3.67045,12.18724,6.35048,19.05617,6.02185,7.04576-.33709,13.43255-3.67234,18.8321-8.02664,11.45675-9.23894,17.721-23.52709,29.74471-32.13629a41.19514,41.19514,0,0,1,39.53916-4.20191c12.32294,5.31576,21.04815,17.22645,23.353,30.334a38.96032,38.96032,0,0,1,.42437,9.78081c-.15032,1.92512,2.85044,1.91536,3,0a44.17215,44.17215,0,0,0-15.07446-36.23715c-10.63764-9.177-25.49968-12.15953-39.01706-8.62818a43.23533,43.23533,0,0,0-18.41555,10.1792c-5.56136,5.129-9.94759,11.34335-14.642,17.23377-4.57972,5.74648-9.632,11.2958-16.0599,15.00727a24.80725,24.80725,0,0,1-20.73557,2.35807c-6.93861-2.34062-12.81731-7.16276-18.36864-11.77972-5.72247-4.7593-11.41756-9.52111-18.2958-12.54508-6.39549-2.81172-13.72966-4.17555-20.38691-1.40649-6.00209,2.49655-9.97475,7.67868-12.919,13.28345-2.98866,5.68924-5.11718,11.82387-8.60435,17.249A48.90736,48.90736,0,0,1,498.2217,373.1771a54.78012,54.78012,0,0,1-35.33956,10.097c-6.84117-.486-13.06129-2.64742-19.25621-5.47945-6.83726-3.12568-14.03863-6.37658-21.7318-4.86232-6.63609,1.3062-12.21923,5.8149-16.09561,11.20076-4.47547,6.21822-6.44192,13.84154-7.46832,21.32868-.53695,3.91679-.84393,7.85686-1.13419,11.79815-.14184,1.926,2.85882,1.917,3,0Z" transform="translate(-213.5 -144)" fill="#e4e4e4">
92
+ </path>
93
+ <polygon points="716.987 596.364 702.742 596.363 695.965 541.418 716.989 541.419 716.987 596.364" fill="#ffb6b6">
94
+ </polygon>
95
+ <path d="M930.10726,735.70841l-15.19932-6.174-.44841-.184-8.393,6.358a17.86958,17.86958,0,0,0-17.85526,17.0964c-.023.2529-.023.51739-.023.7818v.58637h45.93151V735.70841Z" transform="translate(-213.5 -144)" fill="#2f2e41">
96
+ </path>
97
+ <polygon points="683.627 583.107 670.189 587.835 645.56 538.254 665.392 531.277 683.627 583.107" fill="#ffb6b6">
98
+ </polygon>
99
+ <path d="M895.22382,722.84182l-16.38691-.77921-.48406-.02474-5.8069,8.7833a17.86958,17.86958,0,0,0-11.1686,22.05356c.06223.24621.15.4957.23777.74512l.19463.55313,43.3277-15.24512L899.00888,721.51Z" transform="translate(-213.5 -144)" fill="#2f2e41">
100
+ </path>
101
+ <path d="M935.52078,503.45349c13.0322-.50537-3.1115,103.34849-3.1115,103.34849s4.7223,91.17944,3.72132,95.96437-.12622,17.69007-.12622,17.69007c-2.55325-4.6471-28.89515-1.13983-28.89515-1.13983l-3.58349-92.41012-18.29605-74.04172-25.3655,49.6313,24.31166,76.18146s9.8455,9.11035,8.79858,12.71055-26.83566,11.71936-31.57464,11.90315-2.5992-5.83187-2.82892-11.75557-22.52965-60.82569-30.3732-79.506-1.74582-45.02029,2.25809-64.16,25.0679-55.05869,25.0679-55.05869C881.67017,463.32037,922.48858,503.95885,935.52078,503.45349Z" transform="translate(-213.5 -144)" fill="#2f2e41">
102
+ </path>
103
+ <circle cx="685.55127" cy="162.05023" r="24.85645" fill="#ffb6b6">
104
+ </circle>
105
+ <path d="M886.623,347.33507c-5.355,3.18356-8.55835,9.03292-10.39722,14.98516a142.0083,142.0083,0,0,0-6.10242,33.92893l-7.07371,68.7046-13.652,33.82577c29.19531-2.53425,93.93828,9.36166,93.93828,9.36166s2.40545-.80179,0-3.20728-4.74722-.27435-2.34176-2.67984.74721.27435-.0546-2.13113,0-.80179.80181-1.60364-6.20727-8.01825-6.20727-8.01825l6.41455-42.13666,8.01819-84.993c-9.62189-12.02731-28.97268-19.11734-28.97268-19.11734l-5-9-25,2Z" transform="translate(-213.5 -144)" fill="#e6e6e6">
106
+ </path>
107
+ <path d="M959.3844,442.358l-6.16847-36.36025L931.75,409.88738l1.88573,31.80434-9.39558,66.20083a11.99112,11.99112,0,1,0,15.6682,8.19816Z" transform="translate(-213.5 -144)" fill="#ffb6b6">
108
+ </path>
109
+ <path d="M941.65067,357.27688c13.89076,3.99945,19.36275,55.88559,19.36275,55.88559,6.292,25.04128-5.616,35.58679-8.638,35.47662-8.58891-.31311-13.34671-7.6646-18.0935-4.65028-2.71462,1.72383-3.22167-18.08506-3.22167-18.08506s-9.74017-18.43066-15.58211-35.75664a30.6442,30.6442,0,0,1,4.7027-29.19336S927.75992,353.27747,941.65067,357.27688Z" transform="translate(-213.5 -144)" fill="#e6e6e6">
110
+ </path>
111
+ <path d="M927.49412,298.45407c-.08172-4.03775-.53943-9.2034-3.36751-13.32291-2.38666-3.46558-7.20091-6.21189-11.68819-4.83874a4.85958,4.85958,0,0,0-2.41939-4.47909,12.76551,12.76551,0,0,0-5.54983-1.3977c-4.55269-.425-9.26885-.8664-13.8787.00818-5.17388.98084-9.40779,3.64538-11.60648,7.31535l-.049.11439-.44953,2.1742a2.0638,2.0638,0,0,1-1.0217,1.38952,2.0281,2.0281,0,0,1-1.72466.12257,1.87211,1.87211,0,0,0-2.50929,2.02708l.12262.86639-1.29957-.24524a1.86654,1.86654,0,0,0-2.10061,2.493l.35964.989a2.00066,2.00066,0,0,0-1.43037.62939,1.82861,1.82861,0,0,0-.24525,2.14147,17.01108,17.01108,0,0,0,5.99942,6.03209,14.143,14.143,0,0,0,3.57184,1.52845q.39234.11038.80918.19616a84.23836,84.23836,0,0,0,30.5283.91544,17.29319,17.29319,0,0,0-.67842,6.17921,6.49,6.49,0,0,0,3.89881,5.4763,8.17511,8.17511,0,0,0,1.42219.34328,8.77312,8.77312,0,0,1,1.365.33514,3.97518,3.97518,0,0,1,1.16063,6.80041s2.14147,1.77365,2.41122,1.68376a5.50348,5.50348,0,0,0,2.51747-2.23955C925.72047,315.82289,927.69028,308.009,927.49412,298.45407Z" transform="translate(-213.5 -144)" fill="#2f2e41">
112
+ </path>
113
+ <path d="M276.29766,673.35948l-2.92,14.65c-.22,1.12-.45,2.26-.7,3.39a14.28762,14.28762,0,0,0-7.34.41,68.51085,68.51085,0,0,1,5.04,8.43c-1.84,5.67-4.54,10.91-9.06,14.7a22.71967,22.71967,0,0,1-21.95,3.86l.13-.58c-4.86-9.43-2.22-21.32,3.82-30.03a58.38488,58.38488,0,0,1,10.85-11.47c4.07995-3.4,8.49-6.45,12.86-9.46A5.99007,5.99007,0,0,1,276.29766,673.35948Z" transform="translate(-213.5 -144)" fill="#e4e4e4">
114
+ </path>
115
+ <path id="a14ee49e-0bc4-4fe7-9ff0-205b8984b39e-1816" data-name="a4b268fa-75d0-4ac1-9d87-14bdca948464-2189" d="M240.40753,754.04932c-1.229-8.953-2.493-18.02-1.631-27.069.766-8.036,3.217-15.885,8.209-22.321a37.13191,37.13191,0,0,1,9.527-8.633c.953-.6,1.829.909.881,1.507a35.29987,35.29987,0,0,0-13.963,16.847c-3.04,7.732-3.528,16.161-3,24.374.317,4.967.988,9.9,1.665,14.83a.9.9,0,0,1-.61,1.074.878.878,0,0,1-1.074-.61Z" transform="translate(-213.5 -144)" fill="#f2f2f2">
116
+ </path>
117
+ <circle cx="355.05203" cy="10.2658" r="2.85162" fill="#fff">
118
+ </circle>
119
+ <path d="M735.275,418.23648H397.033a1.05859,1.05859,0,0,1-1.05853-1.05853l.51373-1.178,338.78677.11938a1.05854,1.05854,0,0,1,.00782,2.11707H735.275Z" transform="translate(-213.5 -144)" fill="#3f3d56">
120
+ </path>
121
+ <rect x="245.79616" y="266.83099" width="2.07614" height="5.91575" fill="#3f3d56">
122
+ </rect>
123
+ <rect x="307.95251" y="232.83099" width="2.07614" height="39.91578" fill="#3f3d56">
124
+ </rect>
125
+ <rect x="370.23685" y="184.83099" width="2.07614" height="87.91575" fill="#3f3d56">
126
+ </rect>
127
+ <rect x="432.52121" y="143.83099" width="2.07614" height="128.91575" fill="#3f3d56">
128
+ </rect>
129
+ <rect x="494.80554" y="237.83099" width="2.07614" height="34.91578" fill="#3f3d56">
130
+ </rect>
131
+ <circle cx="433.68729" cy="130.29436" r="6.35126" fill="#6c63ff">
132
+ </circle>
133
+ <circle cx="372.40295" cy="167.55074" r="6.35126" fill="#6c63ff">
134
+ </circle>
135
+ <circle cx="495.97165" cy="226.13194" r="6.35126" fill="#6c63ff">
136
+ </circle>
137
+ <path id="a2bcaba5-fcc7-43c7-8c54-c107139343be-1817" data-name="ba0cc859-1ca5-421a-9acf-7fb9aa3b4e23-2190" d="M520.83246,638.51V563.57122c0-.96109,1.11786-1.74023,2.49679-1.74023h11.14209c1.37894,0,2.49677.77914,2.49677,1.74023h0v75.13416Z" transform="translate(-213.5 -144)" fill="#3f3d56">
138
+ </path>
139
+ <path id="b02c718b-b277-4e02-ad4f-2608dd9924ba-1818" data-name="a524792d-c043-478e-a7da-ec48af772355-2191" d="M557.63309,638.762V581.50324c0-.92355,1.11789-1.67225,2.49679-1.67225H571.272c1.37891,0,2.49677.7487,2.49677,1.67225h0v57.13553Z" transform="translate(-213.5 -144)" fill="#3f3d56">
140
+ </path>
141
+ <path id="a6f13ee1-90c9-41e9-aa52-bae832a2d909-1819" data-name="fd6a765d-e5c4-40cb-8615-8d176b643a05-2192" d="M631.23431,638.62915V609.50729c-.09747-.34818,1.0163-.64986,2.49677-.6763h11.14209c1.48053.02642,2.59436.32812,2.49676.6763v29.19809Z" transform="translate(-213.5 -144)" fill="#3f3d56">
142
+ </path>
143
+ <path id="fa174473-4e9f-4d8b-98c3-8d6761a9e9bb-1820" data-name="bd64d803-c830-42f7-b93c-47122685f128-2193" d="M484.03156,638.62947V609.50728c0-.37343,1.11788-.67629,2.49679-.67629h11.14209c1.37888,0,2.49677.30316,2.49677.67629v29.1981Z" transform="translate(-213.5 -144)" fill="#3f3d56">
144
+ </path>
145
+ <path id="e966b75a-f3f6-4a21-bd4c-c130f0d0c74e-1821" data-name="f4fc54bd-288c-4bcd-8f44-6b7e88ac2463-2194" d="M594.43341,638.33881V497.71231c0-1.8035,1.11792-3.26562,2.49677-3.26562h11.14209c1.3789,0,2.49676,1.46212,2.49676,3.26562V638.70538Z" transform="translate(-213.5 -144)" fill="#6c63ff">
146
+ </path>
147
+ <path d="M695.38977,640h-252a1,1,0,0,1,0-2h252a1,1,0,0,1,0,2Z" transform="translate(-213.5 -144)" fill="#3f3d56">
148
+ </path>
149
+ <path d="M985.5,756h-771a1,1,0,0,1,0-2h771a1,1,0,0,1,0,2Z" transform="translate(-213.5 -144)" fill="#cacaca">
150
+ </path>
151
+ <circle cx="247.11862" cy="253.9035" r="6.35126" fill="#6c63ff">
152
+ </circle>
153
+ <circle cx="309.11862" cy="218.9035" r="6.35126" fill="#6c63ff">
154
+ </circle>
155
+ </svg>
156
+ </div>
157
+ <div class="flex-1-1 BannerContent display-flex gap-15 flex-row align-items-center">
158
+ <div class="flex-1-1 min-width-100">
159
+ <div class="text-size-16 text-medium">Banner title</div>Content highlighting a specific feature or action that users should be aware of or engage with
160
+ </div>
161
+ <div class="BannerActions flex-0 btn-toolbar ">
162
+ <button type="button" class="btn btn-muted-filled btn-component" tabindex="0">Button CTA</button>
163
+ <button type="button" class="btn btn-primary btn-component" tabindex="0">Button CTA</button>
164
+ </div>
165
+ </div>
166
+ </div>
167
+ </div>
168
+ </div>
169
+ <div class="flex-0 margin-left-10 margin-right--5 margin-top--5 margin-top-0-ls align-self-start align-self-center-ls">
170
+ <button type="button" class="btn btn-muted btn-sm btn-icon-only btn-component" tabindex="0">
171
+ <span class="rioglyph rioglyph-remove">
172
+ </span>
173
+ </button>
174
+ </div>
175
+ </div>
176
+ </div>
177
+ </div>
178
+ <button type="button" class="btn btn-default btn-sm btn-component margin-top-25" tabindex="0">Reset</button>
179
+ </div>
180
+ ```
181
+
182
+ #### Props: Banner
183
+
184
+ ### Banner
185
+
186
+ | Name | Type | Default | Description |
187
+ | --- | --- | --- | --- |
188
+ | show | boolean | true | Defines if the content is shown or not. |
189
+ | dismissible | boolean | true | Defines if a close button is shown or not. You can still add a custom CTA button to the content that handles visibility. |
190
+ | initialAnimation | boolean | true | Enables or disables initial animation. |
191
+ | onClose | () => void | — | Callback when the close button is clicked. |
192
+ | pageTimeout | number | 20_000 | Defines the time when the next page is shown in milliseconds. |
193
+ | showPageNavigation | boolean | true | Defines if the page navigation buttons shall be shown or not. |
194
+ | border | boolean | true | Defines if a border is shown or not. When placed on a white background, please disable the border so it looks better. |
195
+ | className | string | — | Additional classes for the wrapper element. |
196
+ | children | ReactNode \| ReactNode[] | — | The actual banner content. Wrap your content in a <Banner.Page> component. When having multiple pages, usa an array of <Banner.Page> components. |
197
+
198
+ #### Props: Banner.Page
199
+
200
+ ### Banner.Page
201
+
202
+ | Name | Type | Default | Description |
203
+ | --- | --- | --- | --- |
204
+ | className | string | — | Additional classes for the wrapper element. |
205
+
206
+ #### Props: Banner.Icon
207
+
208
+ ### Banner.Icon
209
+
210
+ | Name | Type | Default | Description |
211
+ | --- | --- | --- | --- |
212
+ | className | string | — | Additional classes for the wrapper element. |
213
+
214
+ #### Props: Banner.Content
215
+
216
+ ### Banner.Content
217
+
218
+ | Name | Type | Default | Description |
219
+ | --- | --- | --- | --- |
220
+ | title | string \| React.ReactElement | — | The title for the banner. |
221
+ | actions | React.ReactElement | — | Use this to add the banner call-to-action buttons. Wrap them in a <Banner.Actions> component. |
222
+ | minWidthBreakpoint | number | 400 | Breakpoint in pixels where the action buttons are placed under the banner text. On larger screens, the buttons are next to the text. |
223
+ | className | string | — | Additional classes for the wrapper element. |
224
+
225
+ #### Props: Banner.Actions
226
+
227
+ ### Banner.Actions
228
+
229
+ | Name | Type | Default | Description |
230
+ | --- | --- | --- | --- |
231
+ | className | string | — | Additional classes for the wrapper element. |
232
+
233
+ ### Example: Example 2
234
+
235
+ Customize your experience
236
+ Update your preferences in settings for a tailored experience
237
+ Got it
238
+
239
+ Reset
240
+
241
+ #### Summary
242
+
243
+ Customize your experience
244
+ Update your preferences in settings for a tailored experience
245
+ Got it
246
+
247
+ Reset
248
+
249
+ #### React (tsx)
250
+
251
+ ```tsx
252
+ import { useState } from 'react';
253
+
254
+ import Banner from '@rio-cloud/rio-uikit/Banner';
255
+ import Button from '@rio-cloud/rio-uikit/Button';
256
+
257
+ export default () => {
258
+ const [showBanner, setShowBanner] = useState(true);
259
+
260
+ return (
261
+ <div>
262
+ <Banner show={showBanner} dismissible={false} initialAnimation={false}>
263
+ <Banner.Page>
264
+ <Banner.Icon className='text-size-14'>
265
+ <span className='rioglyph rioglyph-cog text-size-200pct' />
266
+ </Banner.Icon>
267
+ <Banner.Content
268
+ title='Customize your experience'
269
+ actions={
270
+ <Banner.Actions>
271
+ <Button bsStyle='primary' onClick={() => setShowBanner(false)}>
272
+ Got it
273
+ </Button>
274
+ </Banner.Actions>
275
+ }
276
+ >
277
+ Update your preferences in settings for a tailored experience
278
+ </Banner.Content>
279
+ </Banner.Page>
280
+ </Banner>
281
+
282
+ <Button bsSize='sm' className='margin-top-25' onClick={() => setShowBanner(true)}>
283
+ Reset
284
+ </Button>
285
+ </div>
286
+ );
287
+ };
288
+ ```
289
+
290
+ #### HTML (html)
291
+
292
+ ```html
293
+ <div>
294
+ <div style="height: 84.8438px; opacity: 1;">
295
+ <div style="position: relative;">
296
+ <div class="bg-white rounded border shadow-default padding-20 Banner display-flex text-color-darker overflow-hidden position-relative">
297
+ <div class="flex-1-1 overflow-hidden">
298
+ <div style="opacity: 1; transform: none;">
299
+ <div class="display-flex align-items-start align-items-center-ls width-100pct gap-15 ">
300
+ <div class="BannerIcon flex-0 margin-x-5 min-width-25 text-size-14">
301
+ <span class="rioglyph rioglyph-cog text-size-200pct">
302
+ </span>
303
+ </div>
304
+ <div class="flex-1-1 BannerContent display-flex gap-15 flex-row align-items-center">
305
+ <div class="flex-1-1 min-width-100">
306
+ <div class="text-size-16 text-medium">Customize your experience</div>Update your preferences in settings for a tailored experience
307
+ </div>
308
+ <div class="BannerActions flex-0 btn-toolbar ">
309
+ <button type="button" class="btn btn-primary btn-component" tabindex="0">Got it</button>
310
+ </div>
311
+ </div>
312
+ </div>
313
+ </div>
314
+ </div>
315
+ </div>
316
+ </div>
317
+ </div>
318
+ <button type="button" class="btn btn-default btn-sm btn-component margin-top-25" tabindex="0">Reset</button>
319
+ </div>
320
+ ```
321
+
322
+ #### Props: Banner
323
+
324
+ ### Banner
325
+
326
+ | Name | Type | Default | Description |
327
+ | --- | --- | --- | --- |
328
+ | show | boolean | true | Defines if the content is shown or not. |
329
+ | dismissible | boolean | true | Defines if a close button is shown or not. You can still add a custom CTA button to the content that handles visibility. |
330
+ | initialAnimation | boolean | true | Enables or disables initial animation. |
331
+ | onClose | () => void | — | Callback when the close button is clicked. |
332
+ | pageTimeout | number | 20_000 | Defines the time when the next page is shown in milliseconds. |
333
+ | showPageNavigation | boolean | true | Defines if the page navigation buttons shall be shown or not. |
334
+ | border | boolean | true | Defines if a border is shown or not. When placed on a white background, please disable the border so it looks better. |
335
+ | className | string | — | Additional classes for the wrapper element. |
336
+ | children | ReactNode \| ReactNode[] | — | The actual banner content. Wrap your content in a <Banner.Page> component. When having multiple pages, usa an array of <Banner.Page> components. |
337
+
338
+ #### Props: Banner.Page
339
+
340
+ ### Banner.Page
341
+
342
+ | Name | Type | Default | Description |
343
+ | --- | --- | --- | --- |
344
+ | className | string | — | Additional classes for the wrapper element. |
345
+
346
+ #### Props: Banner.Icon
347
+
348
+ ### Banner.Icon
349
+
350
+ | Name | Type | Default | Description |
351
+ | --- | --- | --- | --- |
352
+ | className | string | — | Additional classes for the wrapper element. |
353
+
354
+ #### Props: Banner.Content
355
+
356
+ ### Banner.Content
357
+
358
+ | Name | Type | Default | Description |
359
+ | --- | --- | --- | --- |
360
+ | title | string \| React.ReactElement | — | The title for the banner. |
361
+ | actions | React.ReactElement | — | Use this to add the banner call-to-action buttons. Wrap them in a <Banner.Actions> component. |
362
+ | minWidthBreakpoint | number | 400 | Breakpoint in pixels where the action buttons are placed under the banner text. On larger screens, the buttons are next to the text. |
363
+ | className | string | — | Additional classes for the wrapper element. |
364
+
365
+ #### Props: Banner.Actions
366
+
367
+ ### Banner.Actions
368
+
369
+ | Name | Type | Default | Description |
370
+ | --- | --- | --- | --- |
371
+ | className | string | — | Additional classes for the wrapper element. |
372
+
373
+ ### Example: Example 3
374
+
375
+ Pay attention to borders
376
+ On white background, disable the border prop so the component is more pleasing for the eye
377
+
378
+ Reset
379
+
380
+ #### Summary
381
+
382
+ Pay attention to borders
383
+ On white background, disable the border prop so the component is more pleasing for the eye
384
+
385
+ Reset
386
+
387
+ #### React (tsx)
388
+
389
+ ```tsx
390
+ import { useState } from 'react';
391
+
392
+ import Banner from '@rio-cloud/rio-uikit/Banner';
393
+ import Button from '@rio-cloud/rio-uikit/Button';
394
+
395
+ export default () => {
396
+ const [showBanner, setShowBanner] = useState(true);
397
+
398
+ return (
399
+ <div>
400
+ <Banner show={showBanner} border={false} onClose={() => setShowBanner(false)}>
401
+ <Banner.Page>
402
+ <Banner.Icon className='text-size-14'>
403
+ <span className='rioglyph rioglyph-hand-right text-size-200pct' />
404
+ </Banner.Icon>
405
+ <Banner.Content title='Pay attention to borders'>
406
+ On white background, disable the border prop so the component is more pleasing for the eye
407
+ </Banner.Content>
408
+ </Banner.Page>
409
+ </Banner>
410
+
411
+ <Button bsSize='sm' className='margin-top-25' onClick={() => setShowBanner(true)}>
412
+ Reset
413
+ </Button>
414
+ </div>
415
+ );
416
+ };
417
+ ```
418
+
419
+ #### HTML (html)
420
+
421
+ ```html
422
+ <div>
423
+ <div style="height: 84.8438px; opacity: 1;">
424
+ <div style="position: relative;">
425
+ <div class="bg-white rounded border shadow-default padding-20 Banner display-flex text-color-darker overflow-hidden position-relative border-color-white">
426
+ <div class="flex-1-1 overflow-hidden">
427
+ <div style="opacity: 1; transform: none;">
428
+ <div class="display-flex align-items-start align-items-center-ls width-100pct gap-15 ">
429
+ <div class="BannerIcon flex-0 margin-x-5 min-width-25 text-size-14">
430
+ <span class="rioglyph rioglyph-hand-right text-size-200pct">
431
+ </span>
432
+ </div>
433
+ <div class="flex-1-1">
434
+ <div class="text-size-16 text-medium">Pay attention to borders</div>On white background, disable the border prop so the component is more pleasing for the eye
435
+ </div>
436
+ </div>
437
+ </div>
438
+ </div>
439
+ <div class="flex-0 margin-left-10 margin-right--5 margin-top--5 margin-top-0-ls align-self-start align-self-center-ls">
440
+ <button type="button" class="btn btn-muted btn-sm btn-icon-only btn-component" tabindex="0">
441
+ <span class="rioglyph rioglyph-remove">
442
+ </span>
443
+ </button>
444
+ </div>
445
+ </div>
446
+ </div>
447
+ </div>
448
+ <button type="button" class="btn btn-default btn-sm btn-component margin-top-25" tabindex="0">Reset</button>
449
+ </div>
450
+ ```
451
+
452
+ #### Props: Banner
453
+
454
+ ### Banner
455
+
456
+ | Name | Type | Default | Description |
457
+ | --- | --- | --- | --- |
458
+ | show | boolean | true | Defines if the content is shown or not. |
459
+ | dismissible | boolean | true | Defines if a close button is shown or not. You can still add a custom CTA button to the content that handles visibility. |
460
+ | initialAnimation | boolean | true | Enables or disables initial animation. |
461
+ | onClose | () => void | — | Callback when the close button is clicked. |
462
+ | pageTimeout | number | 20_000 | Defines the time when the next page is shown in milliseconds. |
463
+ | showPageNavigation | boolean | true | Defines if the page navigation buttons shall be shown or not. |
464
+ | border | boolean | true | Defines if a border is shown or not. When placed on a white background, please disable the border so it looks better. |
465
+ | className | string | — | Additional classes for the wrapper element. |
466
+ | children | ReactNode \| ReactNode[] | — | The actual banner content. Wrap your content in a <Banner.Page> component. When having multiple pages, usa an array of <Banner.Page> components. |
467
+
468
+ #### Props: Banner.Page
469
+
470
+ ### Banner.Page
471
+
472
+ | Name | Type | Default | Description |
473
+ | --- | --- | --- | --- |
474
+ | className | string | — | Additional classes for the wrapper element. |
475
+
476
+ #### Props: Banner.Icon
477
+
478
+ ### Banner.Icon
479
+
480
+ | Name | Type | Default | Description |
481
+ | --- | --- | --- | --- |
482
+ | className | string | — | Additional classes for the wrapper element. |
483
+
484
+ #### Props: Banner.Content
485
+
486
+ ### Banner.Content
487
+
488
+ | Name | Type | Default | Description |
489
+ | --- | --- | --- | --- |
490
+ | title | string \| React.ReactElement | — | The title for the banner. |
491
+ | actions | React.ReactElement | — | Use this to add the banner call-to-action buttons. Wrap them in a <Banner.Actions> component. |
492
+ | minWidthBreakpoint | number | 400 | Breakpoint in pixels where the action buttons are placed under the banner text. On larger screens, the buttons are next to the text. |
493
+ | className | string | — | Additional classes for the wrapper element. |
494
+
495
+ #### Props: Banner.Actions
496
+
497
+ ### Banner.Actions
498
+
499
+ | Name | Type | Default | Description |
500
+ | --- | --- | --- | --- |
501
+ | className | string | — | Additional classes for the wrapper element. |
502
+
503
+ ### Example: Example 4
504
+
505
+ Tip 1
506
+
507
+ 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.
508
+
509
+ Reset
510
+
511
+ #### Summary
512
+
513
+ Tip 1
514
+
515
+ 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.
516
+
517
+ Reset
518
+
519
+ #### React (tsx)
520
+
521
+ ```tsx
522
+ import { useState } from 'react';
523
+
524
+ import Banner from '@rio-cloud/rio-uikit/Banner';
525
+ import Button from '@rio-cloud/rio-uikit/Button';
526
+ import { dummyText, dummyTextExtraShort, dummyTextShort } from '../../../utils/data';
527
+
528
+ export default () => {
529
+ const [showBanner, setShowBanner] = useState(true);
530
+
531
+ return (
532
+ <div>
533
+ <Banner show={showBanner} onClose={() => setShowBanner(false)}>
534
+ {[
535
+ <Banner.Page key='page-1'>
536
+ <Banner.Icon className='text-size-14'>
537
+ <span className='rioglyph rioglyph-tasks text-size-200pct' />
538
+ </Banner.Icon>
539
+ <Banner.Content title='Tip 1'>
540
+ <div className='max-width-800'>{dummyText}</div>
541
+ </Banner.Content>
542
+ </Banner.Page>,
543
+ <Banner.Page key='page-2'>
544
+ <Banner.Icon className='text-size-14'>
545
+ <span className='rioglyph rioglyph-carrier text-size-200pct' />
546
+ </Banner.Icon>
547
+ <Banner.Content title='Tip 2'>
548
+ <div className='max-width-800'>{dummyTextShort}</div>
549
+ </Banner.Content>
550
+ </Banner.Page>,
551
+ <Banner.Page key='page-3'>
552
+ <Banner.Icon className='text-size-14'>
553
+ <span className='rioglyph rioglyph-handshake text-size-200pct' />
554
+ </Banner.Icon>
555
+ <Banner.Content title='Tip 3'>
556
+ <div className='max-width-800'>{dummyTextExtraShort}</div>
557
+ </Banner.Content>
558
+ </Banner.Page>,
559
+ ]}
560
+ </Banner>
561
+
562
+ <Button bsSize='sm' className='margin-top-25' onClick={() => setShowBanner(true)}>
563
+ Reset
564
+ </Button>
565
+ </div>
566
+ );
567
+ };
568
+ ```
569
+
570
+ #### HTML (html)
571
+
572
+ ```html
573
+ <div>
574
+ <div style="height: 169.844px; opacity: 1;">
575
+ <div style="position: relative;">
576
+ <div class="bg-white rounded border shadow-default padding-20 Banner display-flex text-color-darker overflow-hidden position-relative">
577
+ <div class="flex-1-1 overflow-hidden">
578
+ <div style="opacity: 1; transform: none;">
579
+ <div class="display-flex align-items-start align-items-center-ls width-100pct gap-15 ">
580
+ <div class="BannerIcon flex-0 margin-x-5 min-width-25 text-size-14">
581
+ <span class="rioglyph rioglyph-tasks text-size-200pct">
582
+ </span>
583
+ </div>
584
+ <div class="flex-1-1">
585
+ <div class="text-size-16 text-medium">Tip 1</div>
586
+ <div class="max-width-800">
587
+ 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>
588
+ </div>
589
+ </div>
590
+ </div>
591
+ <div class="margin-5">
592
+ <div class="position-absolute bottom-5" style="right: 45px;">
593
+ <div class="display-flex">
594
+ <button type="button" class="btn btn-muted btn-xs btn-icon-only btn-component" tabindex="0">
595
+ <span class="rioglyph rioglyph-arrow-left">
596
+ </span>
597
+ </button>
598
+ <button type="button" class="btn btn-muted btn-xs btn-icon-only btn-component" tabindex="0">
599
+ <span class="rioglyph rioglyph-arrow-right">
600
+ </span>
601
+ </button>
602
+ </div>
603
+ </div>
604
+ </div>
605
+ </div>
606
+ <div class="flex-0 margin-left-10 margin-right--5 margin-top--5 margin-top-0-ls align-self-start align-self-center-ls">
607
+ <button type="button" class="btn btn-muted btn-sm btn-icon-only btn-component" tabindex="0">
608
+ <span class="rioglyph rioglyph-remove">
609
+ </span>
610
+ </button>
611
+ </div>
612
+ </div>
613
+ </div>
614
+ </div>
615
+ <button type="button" class="btn btn-default btn-sm btn-component margin-top-25" tabindex="0">Reset</button>
616
+ </div>
617
+ ```
618
+
619
+ #### Props: Banner
620
+
621
+ ### Banner
622
+
623
+ | Name | Type | Default | Description |
624
+ | --- | --- | --- | --- |
625
+ | show | boolean | true | Defines if the content is shown or not. |
626
+ | dismissible | boolean | true | Defines if a close button is shown or not. You can still add a custom CTA button to the content that handles visibility. |
627
+ | initialAnimation | boolean | true | Enables or disables initial animation. |
628
+ | onClose | () => void | — | Callback when the close button is clicked. |
629
+ | pageTimeout | number | 20_000 | Defines the time when the next page is shown in milliseconds. |
630
+ | showPageNavigation | boolean | true | Defines if the page navigation buttons shall be shown or not. |
631
+ | border | boolean | true | Defines if a border is shown or not. When placed on a white background, please disable the border so it looks better. |
632
+ | className | string | — | Additional classes for the wrapper element. |
633
+ | children | ReactNode \| ReactNode[] | — | The actual banner content. Wrap your content in a <Banner.Page> component. When having multiple pages, usa an array of <Banner.Page> components. |
634
+
635
+ #### Props: Banner.Page
636
+
637
+ ### Banner.Page
638
+
639
+ | Name | Type | Default | Description |
640
+ | --- | --- | --- | --- |
641
+ | className | string | — | Additional classes for the wrapper element. |
642
+
643
+ #### Props: Banner.Icon
644
+
645
+ ### Banner.Icon
646
+
647
+ | Name | Type | Default | Description |
648
+ | --- | --- | --- | --- |
649
+ | className | string | — | Additional classes for the wrapper element. |
650
+
651
+ #### Props: Banner.Content
652
+
653
+ ### Banner.Content
654
+
655
+ | Name | Type | Default | Description |
656
+ | --- | --- | --- | --- |
657
+ | title | string \| React.ReactElement | — | The title for the banner. |
658
+ | actions | React.ReactElement | — | Use this to add the banner call-to-action buttons. Wrap them in a <Banner.Actions> component. |
659
+ | minWidthBreakpoint | number | 400 | Breakpoint in pixels where the action buttons are placed under the banner text. On larger screens, the buttons are next to the text. |
660
+ | className | string | — | Additional classes for the wrapper element. |
661
+
662
+ #### Props: Banner.Actions
663
+
664
+ ### Banner.Actions
665
+
666
+ | Name | Type | Default | Description |
667
+ | --- | --- | --- | --- |
668
+ | className | string | — | Additional classes for the wrapper element. |