@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
@@ -1,417 +0,0 @@
1
- {
2
- "metadata": {
3
- "captured_at": "2025-11-21T12:07:33.674Z",
4
- "source": "https://uikit.developers.rio.cloud/#components/steppedProgressBars",
5
- "category": "Components",
6
- "section": "Progress",
7
- "slug": "components/steppedprogressbars",
8
- "version": "v1.13.2",
9
- "hash_algorithm": "sha256",
10
- "hash": "1031cb5de243152dbeb249eeda3ac7dfb65ffd05bbef4e56e347bd39d2443074"
11
- },
12
- "title": "SteppedProgressBar - Circle",
13
- "lead": null,
14
- "content": [
15
- {
16
- "heading": "SteppedProgressBar - Circle",
17
- "body": "",
18
- "examples": [
19
- {
20
- "caption": "Example 1",
21
- "rendered_html": "<div class=\"playground-content bg-lighter padding-20 padding-bottom-25\" style=\"width: 100%;\"><div class=\"steppedProgressBarExample\"><div class=\"margin-bottom-25\"><div class=\"stepped-progress-bar variant-circle nav\"><a data-rb-event-key=\"0\" class=\"step-tab nav-link\"><div class=\"step-tab-content\"><div class=\"item-icon\">1</div><div class=\"item-label\">Label for step 1</div></div></a><a data-rb-event-key=\"1\" class=\"step-tab nav-link active\"><div class=\"step-tab-content\"><div class=\"item-icon\">2</div><div class=\"item-label\">Label for step 2</div></div></a><a disabled=\"\" data-rb-event-key=\"2\" class=\"step-tab nav-link disabled\"><div class=\"step-tab-content\"><div class=\"item-icon\"><i class=\"rioglyph rioglyph-ok\"></i></div><div class=\"item-label\">Label for final step</div></div></a></div></div><div class=\"panel panel-default panel-body padding-25\"><div class=\"text-size-h3\">Content of page 2</div><div class=\"padding-y-20\">\nLorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div><label class=\"checkbox padding-15 border rounded margin-bottom-20 \" tabindex=\"0\"><input type=\"checkbox\" class=\"padding-15 border rounded margin-bottom-20 \"><span class=\"checkbox-text\"><span>Click here to complete this step. There is no other way forward.</span></span></label><div class=\"btn-toolbar justify-content-between\"><button type=\"button\" class=\"btn btn-default btn-component\" tabindex=\"0\"><span class=\"rioglyph rioglyph-chevron-left\"></span>Previous</button><button type=\"button\" class=\"btn btn-default btn-component btn-icon-right\" disabled=\"\" tabindex=\"0\"><span class=\"rioglyph rioglyph-chevron-right\"></span>Next</button></div></div></div></div>",
22
- "tabs": [
23
- {
24
- "label": "React",
25
- "language": "tsx",
26
- "code": "import { type ChangeEvent, useState } from 'react';\n\nimport SteppedProgressBar from '@rio-cloud/rio-uikit/SteppedProgressBar';\nimport Button from '@rio-cloud/rio-uikit/Button';\nimport { dummyText, dummyTextShort } from '../../../utils/data';\nimport Checkbox from '@rio-cloud/rio-uikit/components/checkbox/Checkbox';\n\nconst SteppedProgressBarExampleDefault = () => {\n const [selectedStep, setSelectedStep] = useState(1);\n const [disableFollowingPages, setDisableFollowingPages] = useState<number>();\n\n const handlePageNext = () => {\n setSelectedStep(selectedStep + 1);\n setDisableFollowingPages(3);\n };\n\n const handlePagePrevious = () => setSelectedStep(selectedStep - 1);\n const handleSelectedChanged = (selectedKey: number) => setSelectedStep(selectedKey);\n const handleDisableFollowingPages = (pageNumber: number) => setDisableFollowingPages(pageNumber);\n\n const pageContent = [\n <FirstPageContent key='firstStep' pageNumber={1} onClickNext={handlePageNext} />,\n <SecondPageContent\n key='secondStep'\n pageNumber={2}\n onClickNext={handlePageNext}\n onClickPrevious={handlePagePrevious}\n onDisableFollowingPages={handleDisableFollowingPages}\n />,\n <ThirdPageContent key='thirdStep' pageNumber={3} onClickPrevious={handlePagePrevious} />,\n ];\n\n return (\n <div className='steppedProgressBarExample'>\n <div className='margin-bottom-25'>\n <SteppedProgressBar\n variant='circle'\n selectedStepNumber={selectedStep}\n onSelectedChanged={handleSelectedChanged}\n disableFollowingPages={disableFollowingPages}\n mobileBreakpoint={false}\n labels={[\n { icon: '1', label: 'Label for step 1' },\n { icon: '2', label: 'Label for step 2' },\n { icon: <i className='rioglyph rioglyph-ok' />, label: 'Label for final step' },\n ]}\n />\n </div>\n {pageContent[selectedStep]}\n </div>\n );\n};\n\nexport default SteppedProgressBarExampleDefault;\n\ntype FirstPageContentProps = { pageNumber: number; onClickNext: VoidFunction };\n\nconst FirstPageContent = ({ pageNumber, onClickNext }: FirstPageContentProps) => (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h2'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-25'>{dummyText}</div>\n <div className='btn-toolbar justify-content-end'>\n <Button className='btn-icon-right' iconName='rioglyph-chevron-right' onClick={onClickNext}>\n Next\n </Button>\n </div>\n </div>\n);\n\ntype SecondPageContentProps = {\n pageNumber: number;\n onClickNext: VoidFunction;\n onClickPrevious: VoidFunction;\n onDisableFollowingPages: (pageNumber: number) => void;\n};\n\nconst SecondPageContent = (props: SecondPageContentProps) => {\n const { pageNumber, onClickNext, onClickPrevious, onDisableFollowingPages } = props;\n\n const [isAccepted, setIsAccepted] = useState(false);\n\n const handleNext = () => isAccepted && onClickNext();\n\n const handleAccept = (event: ChangeEvent<HTMLInputElement>) => {\n setIsAccepted(event.target.checked);\n if (!event.target.checked) {\n onDisableFollowingPages(pageNumber);\n }\n };\n\n return (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h3'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-20'>{dummyTextShort}</div>\n <Checkbox\n onChange={handleAccept}\n checked={isAccepted}\n className={`padding-15 border rounded margin-bottom-20 ${isAccepted ? 'border-color-highlight' : ''}`}\n >\n Click here to complete this step. There is no other way forward.\n </Checkbox>\n <div className='btn-toolbar justify-content-between'>\n <Button iconName='rioglyph-chevron-left' onClick={onClickPrevious}>\n Previous\n </Button>\n <Button\n className='btn-icon-right'\n iconName='rioglyph-chevron-right'\n onClick={handleNext}\n disabled={!isAccepted}\n >\n Next\n </Button>\n </div>\n </div>\n );\n};\n\ntype ThirdPageContentProps = {\n pageNumber: number;\n onClickPrevious: VoidFunction;\n};\n\nconst ThirdPageContent = ({ pageNumber, onClickPrevious }: ThirdPageContentProps) => (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h2'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-25'>{dummyText}</div>\n <div className='btn-toolbar'>\n <Button iconName='rioglyph-chevron-left' onClick={onClickPrevious}>\n Previous\n </Button>\n </div>\n </div>\n);"
27
- },
28
- {
29
- "label": "HTML",
30
- "language": "html",
31
- "code": "<div class=\"steppedProgressBarExample\">\n <div class=\"margin-bottom-25\">\n <div class=\"stepped-progress-bar variant-circle nav\">\n <a data-rb-event-key=\"0\" class=\"step-tab nav-link\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">1</div>\n <div class=\"item-label\">Label for step 1</div>\n </div>\n </a>\n <a data-rb-event-key=\"1\" class=\"step-tab nav-link active\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">2</div>\n <div class=\"item-label\">Label for step 2</div>\n </div>\n </a>\n <a disabled=\"\" data-rb-event-key=\"2\" class=\"step-tab nav-link disabled\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n <i class=\"rioglyph rioglyph-ok\">\n </i>\n </div>\n <div class=\"item-label\">Label for final step</div>\n </div>\n </a>\n </div>\n </div>\n <div class=\"panel panel-default panel-body padding-25\">\n <div class=\"text-size-h3\">Content of page 2</div>\n <div class=\"padding-y-20\">\n Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>\n <label class=\"checkbox padding-15 border rounded margin-bottom-20 \" tabindex=\"0\">\n <input type=\"checkbox\" class=\"padding-15 border rounded margin-bottom-20 \">\n <span class=\"checkbox-text\">\n <span>Click here to complete this step. There is no other way forward.</span>\n </span>\n </label>\n <div class=\"btn-toolbar justify-content-between\">\n <button type=\"button\" class=\"btn btn-default btn-component\" tabindex=\"0\">\n <span class=\"rioglyph rioglyph-chevron-left\">\n </span>Previous</button>\n <button type=\"button\" class=\"btn btn-default btn-component btn-icon-right\" disabled=\"\" tabindex=\"0\">\n <span class=\"rioglyph rioglyph-chevron-right\">\n </span>Next</button>\n </div>\n </div>\n</div>"
32
- },
33
- {
34
- "label": "Props",
35
- "language": "json",
36
- "code": null,
37
- "props": [
38
- {
39
- "heading": null,
40
- "rows": [
41
- {
42
- "name": "labels",
43
- "type": "Array of Objects",
44
- "default": "",
45
- "description": "Objects to define the icon and the label of the navigation items. The icon can be a string or an icon."
46
- },
47
- {
48
- "name": "└icon",
49
- "type": "String / Node",
50
- "default": "",
51
- "description": "The element shown in the step element. This can be a single step number or an icon element."
52
- },
53
- {
54
- "name": "└label",
55
- "type": "String / Node",
56
- "default": "",
57
- "description": "The label shown below the step element."
58
- },
59
- {
60
- "name": "└labelClassName",
61
- "type": "String",
62
- "default": "",
63
- "description": "Additional classes to be set on the label element."
64
- },
65
- {
66
- "name": "└labelWrapperClassName",
67
- "type": "String",
68
- "default": "",
69
- "description": "Additional classes to be set on the label wrapping element."
70
- },
71
- {
72
- "name": "selectedStepNumber",
73
- "type": "Number",
74
- "default": "",
75
- "description": "Index of the selected navigation item."
76
- },
77
- {
78
- "name": "onSelectedChanged",
79
- "type": "Function",
80
- "default": "() => {}",
81
- "description": "Called with the new selected index after the user clicked a nav item."
82
- },
83
- {
84
- "name": "variant",
85
- "type": "String",
86
- "default": "circle",
87
- "description": "The SteppedProgressBar Variant. One of \"circle\", \"rectangle\" or \"roadsign\"."
88
- },
89
- {
90
- "name": "disableFollowingPages",
91
- "type": "Number",
92
- "default": "",
93
- "description": "All navigation items with a higher index than this will be disabled."
94
- },
95
- {
96
- "name": "mobileBreakpoint",
97
- "type": "Boolean",
98
- "default": "true",
99
- "description": "Deactivating the Wrapping of bubbles on mobile"
100
- },
101
- {
102
- "name": "className",
103
- "type": "String",
104
- "default": "",
105
- "description": "Additional classes to be set on the wrapper element."
106
- }
107
- ]
108
- }
109
- ]
110
- }
111
- ]
112
- }
113
- ]
114
- },
115
- {
116
- "heading": "SteppedProgressBar - Rectangle",
117
- "body": "",
118
- "examples": [
119
- {
120
- "caption": "Example 2",
121
- "rendered_html": "<div class=\"playground-content bg-lighter padding-20 padding-bottom-25\" style=\"width: 100%;\"><div class=\"steppedProgressBarExample\"><div class=\"margin-bottom-25\"><div class=\"stepped-progress-bar variant-rectangle nav\"><a data-rb-event-key=\"0\" class=\"step-tab flex-1-1-0 nav-link\"><div class=\"step-tab-content\"><div class=\"item-icon\"><i class=\"rioglyph rioglyph-document\"></i></div><div class=\"item-label\">Label for step 1</div></div></a><a data-rb-event-key=\"1\" class=\"step-tab flex-1-1-0 nav-link active\"><div class=\"step-tab-content\"><div class=\"item-icon\"><i class=\"rioglyph rioglyph-pdf-file\"></i></div><div class=\"item-label\">Label for step 2</div></div></a><a disabled=\"\" data-rb-event-key=\"2\" class=\"step-tab flex-1-1-0 nav-link disabled\"><div class=\"step-tab-content\"><div class=\"item-icon\"><i class=\"rioglyph rioglyph-print\"></i></div><div class=\"item-label\">Label for final step</div></div></a></div></div><div class=\"panel panel-default panel-body padding-25\"><div class=\"text-size-h3\">Content of page 2</div><div class=\"padding-y-20\">\nLorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div><label class=\"checkbox padding-15 border rounded margin-bottom-20 \" tabindex=\"0\"><input type=\"checkbox\" class=\"padding-15 border rounded margin-bottom-20 \"><span class=\"checkbox-text\"><span>Click here to complete this step. There is no other way forward.</span></span></label><div class=\"btn-toolbar justify-content-between\"><button type=\"button\" class=\"btn btn-default btn-component\" tabindex=\"0\"><span class=\"rioglyph rioglyph-chevron-left\"></span>Previous</button><button type=\"button\" class=\"btn btn-default btn-component btn-icon-right\" disabled=\"\" tabindex=\"0\"><span class=\"rioglyph rioglyph-chevron-right\"></span>Next</button></div></div></div></div>",
122
- "tabs": [
123
- {
124
- "label": "React",
125
- "language": "tsx",
126
- "code": "import { type ChangeEvent, useState } from 'react';\n\nimport SteppedProgressBar from '@rio-cloud/rio-uikit/SteppedProgressBar';\nimport Checkbox from '@rio-cloud/rio-uikit/Checkbox';\nimport Button from '@rio-cloud/rio-uikit/Button';\nimport { dummyText, dummyTextShort } from '../../../utils/data';\n\nconst SteppedProgressBarExampleDefault = () => {\n const [selectedStep, setSelectedStep] = useState(1);\n const [disableFollowingPages, setDisableFollowingPages] = useState<number>();\n\n const handlePageNext = () => {\n setSelectedStep(selectedStep + 1);\n setDisableFollowingPages(3);\n };\n\n const handlePagePrevious = () => setSelectedStep(selectedStep - 1);\n const handleSelectedChanged = (selectedKey: number) => setSelectedStep(selectedKey);\n const handleDisableFollowingPages = (pageNumber: number) => setDisableFollowingPages(pageNumber - 1);\n\n const pageContent = [\n <FirstPageContent key='firstStep' pageNumber={1} onClickNext={handlePageNext} />,\n <SecondPageContent\n key='secondStep'\n pageNumber={2}\n onClickNext={handlePageNext}\n onClickPrevious={handlePagePrevious}\n onDisableFollowingPages={handleDisableFollowingPages}\n />,\n <ThirdPageContent key='thirdStep' pageNumber={3} onClickPrevious={handlePagePrevious} />,\n ];\n\n return (\n <div className='steppedProgressBarExample'>\n <div className='margin-bottom-25'>\n <SteppedProgressBar\n variant={SteppedProgressBar.VARIANT_RECTANGLE}\n selectedStepNumber={selectedStep}\n onSelectedChanged={handleSelectedChanged}\n disableFollowingPages={disableFollowingPages}\n mobileBreakpoint={false}\n labels={[\n {\n icon: <i className='rioglyph rioglyph-document' />,\n label: 'Label for step 1',\n labelWrapperClassName: 'flex-1-1-0',\n },\n {\n icon: <i className='rioglyph rioglyph-pdf-file' />,\n label: 'Label for step 2',\n labelWrapperClassName: 'flex-1-1-0',\n },\n {\n icon: <i className='rioglyph rioglyph-print' />,\n label: 'Label for final step',\n labelWrapperClassName: 'flex-1-1-0',\n },\n ]}\n />\n </div>\n {pageContent[selectedStep]}\n </div>\n );\n};\n\nexport default SteppedProgressBarExampleDefault;\n\ntype FirstPageContentProps = { pageNumber: number; onClickNext: VoidFunction };\n\nconst FirstPageContent = ({ pageNumber, onClickNext }: FirstPageContentProps) => (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h2'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-25'>{dummyText}</div>\n <div className='btn-toolbar justify-content-end'>\n <Button className='btn-icon-right' iconName='rioglyph-chevron-right' onClick={onClickNext}>\n Next\n </Button>\n </div>\n </div>\n);\n\ntype SecondPageContentProps = {\n pageNumber: number;\n onClickNext: VoidFunction;\n onClickPrevious: VoidFunction;\n onDisableFollowingPages: (pageNumber: number) => void;\n};\n\nconst SecondPageContent = (props: SecondPageContentProps) => {\n const { pageNumber, onClickNext, onClickPrevious, onDisableFollowingPages } = props;\n\n const [isAccepted, setIsAccepted] = useState(false);\n\n const handleNext = () => isAccepted && onClickNext();\n\n const handleAccept = (event: ChangeEvent<HTMLInputElement>) => {\n setIsAccepted(event.target.checked);\n if (!event.target.checked) {\n onDisableFollowingPages(pageNumber);\n }\n };\n\n return (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h3'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-20'>{dummyTextShort}</div>\n <Checkbox\n onChange={handleAccept}\n checked={isAccepted}\n className={`padding-15 border rounded margin-bottom-20 ${isAccepted ? 'border-color-highlight' : ''}`}\n >\n Click here to complete this step. There is no other way forward.\n </Checkbox>\n <div className='btn-toolbar justify-content-between'>\n <Button iconName='rioglyph-chevron-left' onClick={onClickPrevious}>\n Previous\n </Button>\n <Button\n className='btn-icon-right'\n iconName='rioglyph-chevron-right'\n onClick={handleNext}\n disabled={!isAccepted}\n >\n Next\n </Button>\n </div>\n </div>\n );\n};\n\ntype ThirdPageContentProps = {\n pageNumber: number;\n onClickPrevious: VoidFunction;\n};\n\nconst ThirdPageContent = ({ pageNumber, onClickPrevious }: ThirdPageContentProps) => (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h2'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-25'>{dummyText}</div>\n <div className='btn-toolbar'>\n <Button iconName='rioglyph-chevron-left' onClick={onClickPrevious}>\n Previous\n </Button>\n </div>\n </div>\n);"
127
- },
128
- {
129
- "label": "HTML",
130
- "language": "html",
131
- "code": "<div class=\"steppedProgressBarExample\">\n <div class=\"margin-bottom-25\">\n <div class=\"stepped-progress-bar variant-rectangle nav\">\n <a data-rb-event-key=\"0\" class=\"step-tab flex-1-1-0 nav-link\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n <i class=\"rioglyph rioglyph-document\">\n </i>\n </div>\n <div class=\"item-label\">Label for step 1</div>\n </div>\n </a>\n <a data-rb-event-key=\"1\" class=\"step-tab flex-1-1-0 nav-link active\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n <i class=\"rioglyph rioglyph-pdf-file\">\n </i>\n </div>\n <div class=\"item-label\">Label for step 2</div>\n </div>\n </a>\n <a disabled=\"\" data-rb-event-key=\"2\" class=\"step-tab flex-1-1-0 nav-link disabled\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n <i class=\"rioglyph rioglyph-print\">\n </i>\n </div>\n <div class=\"item-label\">Label for final step</div>\n </div>\n </a>\n </div>\n </div>\n <div class=\"panel panel-default panel-body padding-25\">\n <div class=\"text-size-h3\">Content of page 2</div>\n <div class=\"padding-y-20\">\n Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>\n <label class=\"checkbox padding-15 border rounded margin-bottom-20 \" tabindex=\"0\">\n <input type=\"checkbox\" class=\"padding-15 border rounded margin-bottom-20 \">\n <span class=\"checkbox-text\">\n <span>Click here to complete this step. There is no other way forward.</span>\n </span>\n </label>\n <div class=\"btn-toolbar justify-content-between\">\n <button type=\"button\" class=\"btn btn-default btn-component\" tabindex=\"0\">\n <span class=\"rioglyph rioglyph-chevron-left\">\n </span>Previous</button>\n <button type=\"button\" class=\"btn btn-default btn-component btn-icon-right\" disabled=\"\" tabindex=\"0\">\n <span class=\"rioglyph rioglyph-chevron-right\">\n </span>Next</button>\n </div>\n </div>\n</div>"
132
- },
133
- {
134
- "label": "Props",
135
- "language": "json",
136
- "code": null,
137
- "props": [
138
- {
139
- "heading": null,
140
- "rows": [
141
- {
142
- "name": "labels",
143
- "type": "Array of Objects",
144
- "default": "",
145
- "description": "Objects to define the icon and the label of the navigation items. The icon can be a string or an icon."
146
- },
147
- {
148
- "name": "└icon",
149
- "type": "String / Node",
150
- "default": "",
151
- "description": "The element shown in the step element. This can be a single step number or an icon element."
152
- },
153
- {
154
- "name": "└label",
155
- "type": "String / Node",
156
- "default": "",
157
- "description": "The label shown below the step element."
158
- },
159
- {
160
- "name": "└labelClassName",
161
- "type": "String",
162
- "default": "",
163
- "description": "Additional classes to be set on the label element."
164
- },
165
- {
166
- "name": "└labelWrapperClassName",
167
- "type": "String",
168
- "default": "",
169
- "description": "Additional classes to be set on the label wrapping element."
170
- },
171
- {
172
- "name": "selectedStepNumber",
173
- "type": "Number",
174
- "default": "",
175
- "description": "Index of the selected navigation item."
176
- },
177
- {
178
- "name": "onSelectedChanged",
179
- "type": "Function",
180
- "default": "() => {}",
181
- "description": "Called with the new selected index after the user clicked a nav item."
182
- },
183
- {
184
- "name": "variant",
185
- "type": "String",
186
- "default": "circle",
187
- "description": "The SteppedProgressBar Variant. One of \"circle\", \"rectangle\" or \"roadsign\"."
188
- },
189
- {
190
- "name": "disableFollowingPages",
191
- "type": "Number",
192
- "default": "",
193
- "description": "All navigation items with a higher index than this will be disabled."
194
- },
195
- {
196
- "name": "mobileBreakpoint",
197
- "type": "Boolean",
198
- "default": "true",
199
- "description": "Deactivating the Wrapping of bubbles on mobile"
200
- },
201
- {
202
- "name": "className",
203
- "type": "String",
204
- "default": "",
205
- "description": "Additional classes to be set on the wrapper element."
206
- }
207
- ]
208
- }
209
- ]
210
- }
211
- ]
212
- }
213
- ]
214
- },
215
- {
216
- "heading": "SteppedProgressBar - Rectangle with custom content",
217
- "body": "",
218
- "examples": [
219
- {
220
- "caption": "Example 3",
221
- "rendered_html": "<div class=\"playground-content bg-lighter padding-20 padding-bottom-25\" style=\"width: 100%;\"><div class=\"steppedProgressBarExample\"><div class=\"margin-bottom-25\"><div class=\"stepped-progress-bar variant-rectangle nav\"><a data-rb-event-key=\"0\" class=\"step-tab flex-1-1-0 nav-link\"><div class=\"step-tab-content\"><div class=\"item-icon\"></div><div class=\"item-label width-100pct text-left\"><div class=\"display-flex align-items-center gap-10\"><span class=\"rioglyph rioglyph-ok text-color-success margin-x-10 text-size-h2\"></span><div><div class=\"text-colot-darkest text-medium\">Initial step</div><div class=\"text-color-darker\">Lorem ipsum dolor</div></div></div></div></div></a><a data-rb-event-key=\"1\" class=\"step-tab flex-1-1-0 nav-link active\"><div class=\"step-tab-content\"><div class=\"item-icon\"></div><div class=\"item-label width-100pct text-left\"><div class=\"display-flex align-items-center gap-10\"><span class=\"rioglyph rioglyph-parcel margin-x-10 text-size-h2\"></span><div><div class=\"text-colot-darkest text-medium\">Second step</div><div class=\"text-color-darker\">Lorem ipsum dolor</div></div></div></div></div></a><a disabled=\"\" data-rb-event-key=\"2\" class=\"step-tab flex-1-1-0 nav-link disabled\"><div class=\"step-tab-content\"><div class=\"item-icon\"></div><div class=\"item-label width-100pct text-left\"><div class=\"display-flex align-items-center gap-10\"><span class=\"rioglyph rioglyph-print margin-x-10 text-size-h2\"></span><div><div class=\"text-colot-darkest text-medium\">Final step</div><div class=\"text-color-darker\">Lorem ipsum dolor</div></div></div></div></div></a></div></div><div class=\"panel panel-default panel-body padding-25\"><div class=\"text-size-h3\">Content of page 2</div><div class=\"padding-y-20\">\nLorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div><label class=\"checkbox padding-15 border rounded margin-bottom-20 \" tabindex=\"0\"><input type=\"checkbox\" class=\"padding-15 border rounded margin-bottom-20 \"><span class=\"checkbox-text\"><span>Click here to complete this step. There is no other way forward.</span></span></label><div class=\"btn-toolbar justify-content-between\"><button type=\"button\" class=\"btn btn-default btn-component\" tabindex=\"0\"><span class=\"rioglyph rioglyph-chevron-left\"></span>Previous</button><button type=\"button\" class=\"btn btn-default btn-component btn-icon-right\" disabled=\"\" tabindex=\"0\"><span class=\"rioglyph rioglyph-chevron-right\"></span>Next</button></div></div></div></div>",
222
- "tabs": [
223
- {
224
- "label": "React",
225
- "language": "tsx",
226
- "code": "import { type ChangeEvent, useState } from 'react';\n\nimport SteppedProgressBar from '@rio-cloud/rio-uikit/SteppedProgressBar';\nimport Checkbox from '@rio-cloud/rio-uikit/Checkbox';\nimport Button from '@rio-cloud/rio-uikit/Button';\nimport { dummyText, dummyTextShort } from '../../../utils/data';\n\nconst SteppedProgressBarExampleDefault = () => {\n const [selectedStep, setSelectedStep] = useState(1);\n const [disableFollowingPages, setDisableFollowingPages] = useState<number>();\n\n const handlePageNext = () => {\n setSelectedStep(selectedStep + 1);\n setDisableFollowingPages(3);\n };\n\n const handlePagePrevious = () => setSelectedStep(selectedStep - 1);\n const handleSelectedChanged = (selectedKey: number) => setSelectedStep(selectedKey);\n const handleDisableFollowingPages = (pageNumber: number) => setDisableFollowingPages(pageNumber - 1);\n\n const pageContent = [\n <FirstPageContent key='firstStep' pageNumber={1} onClickNext={handlePageNext} />,\n <SecondPageContent\n key='secondStep'\n pageNumber={2}\n onClickNext={handlePageNext}\n onClickPrevious={handlePagePrevious}\n onDisableFollowingPages={handleDisableFollowingPages}\n />,\n <ThirdPageContent key='thirdStep' pageNumber={3} onClickPrevious={handlePagePrevious} />,\n ];\n\n return (\n <div className='steppedProgressBarExample'>\n <div className='margin-bottom-25'>\n <SteppedProgressBar\n variant={SteppedProgressBar.VARIANT_RECTANGLE}\n selectedStepNumber={selectedStep}\n onSelectedChanged={handleSelectedChanged}\n disableFollowingPages={disableFollowingPages}\n mobileBreakpoint={false}\n labels={[\n {\n label: (\n <StepLabelContent\n label='Initial step'\n description='Lorem ipsum dolor'\n icon='rioglyph rioglyph-clipboard'\n done={selectedStep > 0}\n />\n ),\n labelClassName: 'width-100pct text-left',\n labelWrapperClassName: 'flex-1-1-0',\n },\n {\n label: (\n <StepLabelContent\n label='Second step'\n description='Lorem ipsum dolor'\n icon='rioglyph rioglyph-parcel'\n done={selectedStep > 1}\n />\n ),\n labelClassName: 'width-100pct text-left',\n labelWrapperClassName: 'flex-1-1-0',\n },\n {\n label: (\n <StepLabelContent\n label='Final step'\n description='Lorem ipsum dolor'\n icon='rioglyph rioglyph-print'\n done={selectedStep > 2}\n />\n ),\n labelClassName: 'width-100pct text-left',\n labelWrapperClassName: 'flex-1-1-0',\n },\n ]}\n />\n </div>\n {pageContent[selectedStep]}\n </div>\n );\n};\n\nexport default SteppedProgressBarExampleDefault;\n\ntype StepLabelContentProps = {\n label: string;\n description: string;\n icon: string;\n done: boolean;\n};\n\nconst StepLabelContent = ({ label, description, icon, done }: StepLabelContentProps) => {\n return (\n <div className='display-flex align-items-center gap-10'>\n <span className={`${done ? 'rioglyph rioglyph-ok text-color-success' : icon} margin-x-10 text-size-h2`} />\n <div>\n <div className='text-colot-darkest text-medium'>{label}</div>\n <div className='text-color-darker'>{description}</div>\n </div>\n </div>\n );\n};\n\ntype FirstPageContentProps = { pageNumber: number; onClickNext: VoidFunction };\n\nconst FirstPageContent = ({ pageNumber, onClickNext }: FirstPageContentProps) => (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h2'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-25'>{dummyText}</div>\n <div className='btn-toolbar justify-content-end'>\n <Button className='btn-icon-right' iconName='rioglyph-chevron-right' onClick={onClickNext}>\n Next\n </Button>\n </div>\n </div>\n);\n\ntype SecondPageContentProps = {\n pageNumber: number;\n onClickNext: VoidFunction;\n onClickPrevious: VoidFunction;\n onDisableFollowingPages: (pageNumber: number) => void;\n};\n\nconst SecondPageContent = (props: SecondPageContentProps) => {\n const { pageNumber, onClickNext, onClickPrevious, onDisableFollowingPages } = props;\n\n const [isAccepted, setIsAccepted] = useState(false);\n\n const handleNext = () => isAccepted && onClickNext();\n\n const handleAccept = (event: ChangeEvent<HTMLInputElement>) => {\n setIsAccepted(event.target.checked);\n if (!event.target.checked) {\n onDisableFollowingPages(pageNumber);\n }\n };\n\n return (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h3'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-20'>{dummyTextShort}</div>\n <Checkbox\n onChange={handleAccept}\n checked={isAccepted}\n className={`padding-15 border rounded margin-bottom-20 ${isAccepted ? 'border-color-highlight' : ''}`}\n >\n Click here to complete this step. There is no other way forward.\n </Checkbox>\n <div className='btn-toolbar justify-content-between'>\n <Button iconName='rioglyph-chevron-left' onClick={onClickPrevious}>\n Previous\n </Button>\n <Button\n className='btn-icon-right'\n iconName='rioglyph-chevron-right'\n onClick={handleNext}\n disabled={!isAccepted}\n >\n Next\n </Button>\n </div>\n </div>\n );\n};\n\ntype ThirdPageContentProps = {\n pageNumber: number;\n onClickPrevious: VoidFunction;\n};\n\nconst ThirdPageContent = ({ pageNumber, onClickPrevious }: ThirdPageContentProps) => (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h2'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-25'>{dummyText}</div>\n <div className='btn-toolbar'>\n <Button iconName='rioglyph-chevron-left' onClick={onClickPrevious}>\n Previous\n </Button>\n </div>\n </div>\n);"
227
- },
228
- {
229
- "label": "HTML",
230
- "language": "html",
231
- "code": "<div class=\"steppedProgressBarExample\">\n <div class=\"margin-bottom-25\">\n <div class=\"stepped-progress-bar variant-rectangle nav\">\n <a data-rb-event-key=\"0\" class=\"step-tab flex-1-1-0 nav-link\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n </div>\n <div class=\"item-label width-100pct text-left\">\n <div class=\"display-flex align-items-center gap-10\">\n <span class=\"rioglyph rioglyph-ok text-color-success margin-x-10 text-size-h2\">\n </span>\n <div>\n <div class=\"text-colot-darkest text-medium\">Initial step</div>\n <div class=\"text-color-darker\">Lorem ipsum dolor</div>\n </div>\n </div>\n </div>\n </div>\n </a>\n <a data-rb-event-key=\"1\" class=\"step-tab flex-1-1-0 nav-link active\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n </div>\n <div class=\"item-label width-100pct text-left\">\n <div class=\"display-flex align-items-center gap-10\">\n <span class=\"rioglyph rioglyph-parcel margin-x-10 text-size-h2\">\n </span>\n <div>\n <div class=\"text-colot-darkest text-medium\">Second step</div>\n <div class=\"text-color-darker\">Lorem ipsum dolor</div>\n </div>\n </div>\n </div>\n </div>\n </a>\n <a disabled=\"\" data-rb-event-key=\"2\" class=\"step-tab flex-1-1-0 nav-link disabled\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n </div>\n <div class=\"item-label width-100pct text-left\">\n <div class=\"display-flex align-items-center gap-10\">\n <span class=\"rioglyph rioglyph-print margin-x-10 text-size-h2\">\n </span>\n <div>\n <div class=\"text-colot-darkest text-medium\">Final step</div>\n <div class=\"text-color-darker\">Lorem ipsum dolor</div>\n </div>\n </div>\n </div>\n </div>\n </a>\n </div>\n </div>\n <div class=\"panel panel-default panel-body padding-25\">\n <div class=\"text-size-h3\">Content of page 2</div>\n <div class=\"padding-y-20\">\n Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>\n <label class=\"checkbox padding-15 border rounded margin-bottom-20 \" tabindex=\"0\">\n <input type=\"checkbox\" class=\"padding-15 border rounded margin-bottom-20 \">\n <span class=\"checkbox-text\">\n <span>Click here to complete this step. There is no other way forward.</span>\n </span>\n </label>\n <div class=\"btn-toolbar justify-content-between\">\n <button type=\"button\" class=\"btn btn-default btn-component\" tabindex=\"0\">\n <span class=\"rioglyph rioglyph-chevron-left\">\n </span>Previous</button>\n <button type=\"button\" class=\"btn btn-default btn-component btn-icon-right\" disabled=\"\" tabindex=\"0\">\n <span class=\"rioglyph rioglyph-chevron-right\">\n </span>Next</button>\n </div>\n </div>\n</div>"
232
- },
233
- {
234
- "label": "Props",
235
- "language": "json",
236
- "code": null,
237
- "props": [
238
- {
239
- "heading": null,
240
- "rows": [
241
- {
242
- "name": "labels",
243
- "type": "Array of Objects",
244
- "default": "",
245
- "description": "Objects to define the icon and the label of the navigation items. The icon can be a string or an icon."
246
- },
247
- {
248
- "name": "└icon",
249
- "type": "String / Node",
250
- "default": "",
251
- "description": "The element shown in the step element. This can be a single step number or an icon element."
252
- },
253
- {
254
- "name": "└label",
255
- "type": "String / Node",
256
- "default": "",
257
- "description": "The label shown below the step element."
258
- },
259
- {
260
- "name": "└labelClassName",
261
- "type": "String",
262
- "default": "",
263
- "description": "Additional classes to be set on the label element."
264
- },
265
- {
266
- "name": "└labelWrapperClassName",
267
- "type": "String",
268
- "default": "",
269
- "description": "Additional classes to be set on the label wrapping element."
270
- },
271
- {
272
- "name": "selectedStepNumber",
273
- "type": "Number",
274
- "default": "",
275
- "description": "Index of the selected navigation item."
276
- },
277
- {
278
- "name": "onSelectedChanged",
279
- "type": "Function",
280
- "default": "() => {}",
281
- "description": "Called with the new selected index after the user clicked a nav item."
282
- },
283
- {
284
- "name": "variant",
285
- "type": "String",
286
- "default": "circle",
287
- "description": "The SteppedProgressBar Variant. One of \"circle\", \"rectangle\" or \"roadsign\"."
288
- },
289
- {
290
- "name": "disableFollowingPages",
291
- "type": "Number",
292
- "default": "",
293
- "description": "All navigation items with a higher index than this will be disabled."
294
- },
295
- {
296
- "name": "mobileBreakpoint",
297
- "type": "Boolean",
298
- "default": "true",
299
- "description": "Deactivating the Wrapping of bubbles on mobile"
300
- },
301
- {
302
- "name": "className",
303
- "type": "String",
304
- "default": "",
305
- "description": "Additional classes to be set on the wrapper element."
306
- }
307
- ]
308
- }
309
- ]
310
- }
311
- ]
312
- }
313
- ]
314
- },
315
- {
316
- "heading": "SteppedProgressBar - Road Sign",
317
- "body": "",
318
- "examples": [
319
- {
320
- "caption": "Example 4",
321
- "rendered_html": "<div class=\"playground-content bg-lighter padding-20 padding-bottom-25\" style=\"width: 100%;\"><div class=\"steppedProgressBarExample\"><div class=\"margin-bottom-25\"><div class=\"stepped-progress-bar variant-roadsign nav\"><a data-rb-event-key=\"0\" class=\"step-tab nav-link\"><div class=\"step-tab-content\"><div class=\"item-icon\"><i class=\"rioglyph rioglyph-document\"></i></div><div class=\"item-label\">Label for step 1</div></div></a><a data-rb-event-key=\"1\" class=\"step-tab nav-link active\"><div class=\"step-tab-content\"><div class=\"item-icon\"><i class=\"rioglyph rioglyph-pdf-file\"></i></div><div class=\"item-label\">Label for step 2</div></div></a><a disabled=\"\" data-rb-event-key=\"2\" class=\"step-tab nav-link disabled\"><div class=\"step-tab-content\"><div class=\"item-icon\"><i class=\"rioglyph rioglyph-print\"></i></div><div class=\"item-label\">Label for final step</div></div></a></div></div><div class=\"panel panel-default panel-body padding-25\"><div class=\"text-size-h3\">Content of page 2</div><div class=\"padding-y-20\">\nLorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div><label class=\"checkbox padding-15 border rounded margin-bottom-20 \" tabindex=\"0\"><input type=\"checkbox\" class=\"padding-15 border rounded margin-bottom-20 \"><span class=\"checkbox-text\"><span>Click here to complete this step. There is no other way forward.</span></span></label><div class=\"btn-toolbar justify-content-between\"><button type=\"button\" class=\"btn btn-default btn-component\" tabindex=\"0\"><span class=\"rioglyph rioglyph-chevron-left\"></span>Previous</button><button type=\"button\" class=\"btn btn-default btn-component btn-icon-right\" disabled=\"\" tabindex=\"0\"><span class=\"rioglyph rioglyph-chevron-right\"></span>Next</button></div></div></div></div>",
322
- "tabs": [
323
- {
324
- "label": "React",
325
- "language": "tsx",
326
- "code": "import { type ChangeEvent, useState } from 'react';\n\nimport SteppedProgressBar from '@rio-cloud/rio-uikit/SteppedProgressBar';\nimport Checkbox from '@rio-cloud/rio-uikit/Checkbox';\nimport Button from '@rio-cloud/rio-uikit/Button';\nimport { dummyText, dummyTextShort } from '../../../utils/data';\n\nconst SteppedProgressBarExampleDefault = () => {\n const [selectedStep, setSelectedStep] = useState(1);\n const [disableFollowingPages, setDisableFollowingPages] = useState<number>();\n\n const handlePageNext = () => {\n setSelectedStep(selectedStep + 1);\n setDisableFollowingPages(3);\n };\n\n const handlePagePrevious = () => setSelectedStep(selectedStep - 1);\n const handleSelectedChanged = (selectedKey: number) => setSelectedStep(selectedKey);\n const handleDisableFollowingPages = (pageNumber: number) => setDisableFollowingPages(pageNumber - 1);\n\n const pageContent = [\n <FirstPageContent key='firstStep' pageNumber={1} onClickNext={handlePageNext} />,\n <SecondPageContent\n key='secondStep'\n pageNumber={2}\n onClickNext={handlePageNext}\n onClickPrevious={handlePagePrevious}\n onDisableFollowingPages={handleDisableFollowingPages}\n />,\n <ThirdPageContent key='thirdStep' pageNumber={3} onClickPrevious={handlePagePrevious} />,\n ];\n\n return (\n <div className='steppedProgressBarExample'>\n <div className='margin-bottom-25'>\n <SteppedProgressBar\n variant={SteppedProgressBar.VARIANT_ROADSIGN}\n selectedStepNumber={selectedStep}\n onSelectedChanged={handleSelectedChanged}\n disableFollowingPages={disableFollowingPages}\n mobileBreakpoint={false}\n labels={[\n {\n icon: <i className='rioglyph rioglyph-document' />,\n label: 'Label for step 1',\n },\n {\n icon: <i className='rioglyph rioglyph-pdf-file' />,\n label: 'Label for step 2',\n },\n {\n icon: <i className='rioglyph rioglyph-print' />,\n label: 'Label for final step',\n },\n ]}\n />\n </div>\n {pageContent[selectedStep]}\n </div>\n );\n};\n\nexport default SteppedProgressBarExampleDefault;\n\ntype FirstPageContentProps = { pageNumber: number; onClickNext: VoidFunction };\n\nconst FirstPageContent = ({ pageNumber, onClickNext }: FirstPageContentProps) => (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h2'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-25'>{dummyText}</div>\n <div className='btn-toolbar justify-content-end'>\n <Button className='btn-icon-right' iconName='rioglyph-chevron-right' onClick={onClickNext}>\n Next\n </Button>\n </div>\n </div>\n);\n\ntype SecondPageContentProps = {\n pageNumber: number;\n onClickNext: VoidFunction;\n onClickPrevious: VoidFunction;\n onDisableFollowingPages: (pageNumber: number) => void;\n};\n\nconst SecondPageContent = (props: SecondPageContentProps) => {\n const { pageNumber, onClickNext, onClickPrevious, onDisableFollowingPages } = props;\n\n const [isAccepted, setIsAccepted] = useState(false);\n\n const handleNext = () => isAccepted && onClickNext();\n\n const handleAccept = (event: ChangeEvent<HTMLInputElement>) => {\n setIsAccepted(event.target.checked);\n if (!event.target.checked) {\n onDisableFollowingPages(pageNumber);\n }\n };\n\n return (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h3'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-20'>{dummyTextShort}</div>\n <Checkbox\n onChange={handleAccept}\n checked={isAccepted}\n className={`padding-15 border rounded margin-bottom-20 ${isAccepted ? 'border-color-highlight' : ''}`}\n >\n Click here to complete this step. There is no other way forward.\n </Checkbox>\n <div className='btn-toolbar justify-content-between'>\n <Button iconName='rioglyph-chevron-left' onClick={onClickPrevious}>\n Previous\n </Button>\n <Button\n className='btn-icon-right'\n iconName='rioglyph-chevron-right'\n onClick={handleNext}\n disabled={!isAccepted}\n >\n Next\n </Button>\n </div>\n </div>\n );\n};\n\ntype ThirdPageContentProps = {\n pageNumber: number;\n onClickPrevious: VoidFunction;\n};\n\nconst ThirdPageContent = ({ pageNumber, onClickPrevious }: ThirdPageContentProps) => (\n <div className='panel panel-default panel-body padding-25'>\n <div className='text-size-h2'>{`Content of page ${pageNumber}`}</div>\n <div className='padding-y-25'>{dummyText}</div>\n <div className='btn-toolbar'>\n <Button iconName='rioglyph-chevron-left' onClick={onClickPrevious}>\n Previous\n </Button>\n </div>\n </div>\n);"
327
- },
328
- {
329
- "label": "HTML",
330
- "language": "html",
331
- "code": "<div class=\"steppedProgressBarExample\">\n <div class=\"margin-bottom-25\">\n <div class=\"stepped-progress-bar variant-roadsign nav\">\n <a data-rb-event-key=\"0\" class=\"step-tab nav-link\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n <i class=\"rioglyph rioglyph-document\">\n </i>\n </div>\n <div class=\"item-label\">Label for step 1</div>\n </div>\n </a>\n <a data-rb-event-key=\"1\" class=\"step-tab nav-link active\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n <i class=\"rioglyph rioglyph-pdf-file\">\n </i>\n </div>\n <div class=\"item-label\">Label for step 2</div>\n </div>\n </a>\n <a disabled=\"\" data-rb-event-key=\"2\" class=\"step-tab nav-link disabled\">\n <div class=\"step-tab-content\">\n <div class=\"item-icon\">\n <i class=\"rioglyph rioglyph-print\">\n </i>\n </div>\n <div class=\"item-label\">Label for final step</div>\n </div>\n </a>\n </div>\n </div>\n <div class=\"panel panel-default panel-body padding-25\">\n <div class=\"text-size-h3\">Content of page 2</div>\n <div class=\"padding-y-20\">\n Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>\n <label class=\"checkbox padding-15 border rounded margin-bottom-20 \" tabindex=\"0\">\n <input type=\"checkbox\" class=\"padding-15 border rounded margin-bottom-20 \">\n <span class=\"checkbox-text\">\n <span>Click here to complete this step. There is no other way forward.</span>\n </span>\n </label>\n <div class=\"btn-toolbar justify-content-between\">\n <button type=\"button\" class=\"btn btn-default btn-component\" tabindex=\"0\">\n <span class=\"rioglyph rioglyph-chevron-left\">\n </span>Previous</button>\n <button type=\"button\" class=\"btn btn-default btn-component btn-icon-right\" disabled=\"\" tabindex=\"0\">\n <span class=\"rioglyph rioglyph-chevron-right\">\n </span>Next</button>\n </div>\n </div>\n</div>"
332
- },
333
- {
334
- "label": "Props",
335
- "language": "json",
336
- "code": null,
337
- "props": [
338
- {
339
- "heading": null,
340
- "rows": [
341
- {
342
- "name": "labels",
343
- "type": "Array of Objects",
344
- "default": "",
345
- "description": "Objects to define the icon and the label of the navigation items. The icon can be a string or an icon."
346
- },
347
- {
348
- "name": "└icon",
349
- "type": "String / Node",
350
- "default": "",
351
- "description": "The element shown in the step element. This can be a single step number or an icon element."
352
- },
353
- {
354
- "name": "└label",
355
- "type": "String / Node",
356
- "default": "",
357
- "description": "The label shown below the step element."
358
- },
359
- {
360
- "name": "└labelClassName",
361
- "type": "String",
362
- "default": "",
363
- "description": "Additional classes to be set on the label element."
364
- },
365
- {
366
- "name": "└labelWrapperClassName",
367
- "type": "String",
368
- "default": "",
369
- "description": "Additional classes to be set on the label wrapping element."
370
- },
371
- {
372
- "name": "selectedStepNumber",
373
- "type": "Number",
374
- "default": "",
375
- "description": "Index of the selected navigation item."
376
- },
377
- {
378
- "name": "onSelectedChanged",
379
- "type": "Function",
380
- "default": "() => {}",
381
- "description": "Called with the new selected index after the user clicked a nav item."
382
- },
383
- {
384
- "name": "variant",
385
- "type": "String",
386
- "default": "circle",
387
- "description": "The SteppedProgressBar Variant. One of \"circle\", \"rectangle\" or \"roadsign\"."
388
- },
389
- {
390
- "name": "disableFollowingPages",
391
- "type": "Number",
392
- "default": "",
393
- "description": "All navigation items with a higher index than this will be disabled."
394
- },
395
- {
396
- "name": "mobileBreakpoint",
397
- "type": "Boolean",
398
- "default": "true",
399
- "description": "Deactivating the Wrapping of bubbles on mobile"
400
- },
401
- {
402
- "name": "className",
403
- "type": "String",
404
- "default": "",
405
- "description": "Additional classes to be set on the wrapper element."
406
- }
407
- ]
408
- }
409
- ]
410
- }
411
- ]
412
- }
413
- ]
414
- }
415
- ],
416
- "see_also": []
417
- }