@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.
- package/README.md +75 -40
- package/dist/doc-metadata.json +1872 -0
- package/dist/docs/components/accentBar.md +582 -0
- package/dist/docs/components/activity.md +330 -0
- package/dist/docs/components/animatedNumber.md +88 -0
- package/dist/docs/components/animatedTextReveal.md +381 -0
- package/dist/docs/components/animations.md +459 -0
- package/dist/docs/components/appHeader.md +737 -0
- package/dist/docs/components/appLayout.md +2016 -0
- package/dist/docs/components/appNavigationBar.md +274 -0
- package/dist/docs/components/areaCharts.md +828 -0
- package/dist/docs/components/aspectRatioPlaceholder.md +106 -0
- package/dist/docs/components/assetTree.md +3223 -0
- package/dist/docs/components/autosuggests.md +1177 -0
- package/dist/docs/components/avatar.md +206 -0
- package/dist/docs/components/banner.md +668 -0
- package/dist/docs/components/barCharts.md +2785 -0
- package/dist/docs/components/barList.md +517 -0
- package/dist/docs/components/basicMap.md +167 -0
- package/dist/docs/components/bottomSheet.md +721 -0
- package/dist/docs/components/button.md +775 -0
- package/dist/docs/components/buttonToolbar.md +134 -0
- package/dist/docs/components/calendarStripe.md +525 -0
- package/dist/docs/components/card.md +86 -0
- package/dist/docs/components/carousel.md +128 -0
- package/dist/docs/components/chartColors.md +716 -0
- package/dist/docs/components/chartsGettingStarted.md +28 -0
- package/dist/docs/components/chat.md +932 -0
- package/dist/docs/components/checkbox.md +996 -0
- package/dist/docs/components/clearableInput.md +806 -0
- package/dist/docs/components/collapse.md +189 -0
- package/dist/docs/components/composedCharts.md +424 -0
- package/dist/docs/components/contentLoader.md +674 -0
- package/dist/docs/components/dataTabs.md +1251 -0
- package/dist/docs/components/datepickers.md +2543 -0
- package/dist/docs/components/dialogs.md +2244 -0
- package/dist/docs/components/divider.md +219 -0
- package/dist/docs/components/dropdowns.md +17550 -0
- package/dist/docs/components/editableContent.md +1127 -0
- package/dist/docs/components/expander.md +970 -0
- package/dist/docs/components/fade.md +836 -0
- package/dist/docs/components/fadeExpander.md +180 -0
- package/dist/docs/components/fadeUp.md +396 -0
- package/dist/docs/components/feedback.md +758 -0
- package/dist/docs/components/filePickers.md +370 -0
- package/dist/docs/components/formLabel.md +251 -0
- package/dist/docs/components/fullscreenMap.md +10 -0
- package/dist/docs/components/groupedItemList.md +1001 -0
- package/dist/docs/components/iconList.md +306 -0
- package/dist/docs/components/imagePreloader.md +167 -0
- package/dist/docs/components/labeledElement.md +115 -0
- package/dist/docs/components/licensePlate.md +412 -0
- package/dist/docs/components/lineCharts.md +2014 -0
- package/dist/docs/components/listMenu.md +392 -0
- package/dist/docs/components/loadMore.md +219 -0
- package/dist/docs/components/mainNavigation.md +129 -0
- package/dist/docs/components/mapCircle.md +93 -0
- package/dist/docs/components/mapCluster.md +337 -0
- package/dist/docs/components/mapContext.md +284 -0
- package/dist/docs/components/mapDraggableMarker.md +150 -0
- package/dist/docs/components/mapGettingStarted.md +39 -0
- package/dist/docs/components/mapInfoBubble.md +135 -0
- package/dist/docs/components/mapLayerGroup.md +94 -0
- package/dist/docs/components/mapMarker.md +1814 -0
- package/dist/docs/components/mapPolygon.md +959 -0
- package/dist/docs/components/mapRoute.md +3816 -0
- package/dist/docs/components/mapRouteGenerator.md +6 -0
- package/dist/docs/components/mapSettings.md +1040 -0
- package/dist/docs/components/mapUtils.md +132 -0
- package/dist/docs/components/multiselects.md +1921 -0
- package/dist/docs/components/noData.md +210 -0
- package/dist/docs/components/notifications.md +314 -0
- package/dist/docs/components/numbercontrol.md +706 -0
- package/dist/docs/components/onboarding.md +297 -0
- package/dist/docs/components/page.md +241 -0
- package/dist/docs/components/pager.md +133 -0
- package/dist/docs/components/pieCharts.md +1284 -0
- package/dist/docs/components/popover.md +222 -0
- package/dist/docs/components/position.md +50 -0
- package/dist/docs/components/radialBarCharts.md +3663 -0
- package/dist/docs/components/radiobutton.md +1271 -0
- package/dist/docs/components/releaseNotes.md +135 -0
- package/dist/docs/components/resizer.md +162 -0
- package/dist/docs/components/responsiveColumnStripe.md +435 -0
- package/dist/docs/components/responsiveVideo.md +71 -0
- package/dist/docs/components/rioglyph.md +331 -0
- package/dist/docs/components/rules.md +965 -0
- package/dist/docs/components/saveableInput.md +1721 -0
- package/dist/docs/components/selects.md +1993 -0
- package/dist/docs/components/sidebar.md +332 -0
- package/dist/docs/components/sliders.md +376 -0
- package/dist/docs/components/smoothScrollbars.md +1180 -0
- package/dist/docs/components/spinners.md +506 -0
- package/dist/docs/components/states.md +1176 -0
- package/dist/docs/components/statsWidgets.md +636 -0
- package/dist/docs/components/statusBar.md +644 -0
- package/dist/docs/components/stepButton.md +61 -0
- package/dist/docs/components/steppedProgressBars.md +1064 -0
- package/dist/docs/components/subNavigation.md +470 -0
- package/dist/docs/components/supportMarker.md +115 -0
- package/dist/docs/components/svgImage.md +248 -0
- package/dist/docs/components/switch.md +554 -0
- package/dist/docs/components/tables.md +8 -0
- package/dist/docs/components/tagManager.md +476 -0
- package/dist/docs/components/tags.md +785 -0
- package/dist/docs/components/teaser.md +925 -0
- package/dist/docs/components/timeline.md +514 -0
- package/dist/docs/components/timepicker.md +262 -0
- package/dist/docs/components/toggleButton.md +178 -0
- package/dist/docs/components/tooltip.md +454 -0
- package/dist/docs/components/virtualList.md +483 -0
- package/dist/docs/foundations.md +20901 -0
- package/dist/docs/start/changelog.md +439 -0
- package/dist/docs/start/goodtoknow.md +14 -0
- package/dist/docs/start/guidelines/color-combinations.md +678 -0
- package/dist/docs/start/guidelines/custom-css.md +42 -0
- package/dist/docs/start/guidelines/custom-rioglyph.md +35 -0
- package/dist/docs/start/guidelines/formatting.md +587 -0
- package/dist/docs/start/guidelines/iframe.md +323 -0
- package/dist/docs/start/guidelines/obfuscate-data.md +30 -0
- package/dist/docs/start/guidelines/print-css.md +36 -0
- package/dist/docs/start/guidelines/spinner.md +710 -0
- package/dist/docs/start/guidelines/supported-browsers.md +10 -0
- package/dist/docs/start/guidelines/writing.md +635 -0
- package/dist/docs/start/howto.md +187 -0
- package/dist/docs/start/intro.md +43 -0
- package/dist/docs/start/responsiveness.md +98 -0
- package/dist/docs/templates/common-table.md +1111 -0
- package/dist/docs/templates/detail-views.md +942 -0
- package/dist/docs/templates/expandable-details.md +228 -0
- package/dist/docs/templates/feature-cards.md +549 -0
- package/dist/docs/templates/form-summary.md +199 -0
- package/dist/docs/templates/form-toggle.md +367 -0
- package/dist/docs/templates/list-blocks.md +1021 -0
- package/dist/docs/templates/loading-progress.md +109 -0
- package/dist/docs/templates/options-panel.md +152 -0
- package/dist/docs/templates/panel-variants.md +164 -0
- package/dist/docs/templates/progress-cards.md +607 -0
- package/dist/docs/templates/progress-success.md +142 -0
- package/dist/docs/templates/settings-form.md +434 -0
- package/dist/docs/templates/stats-blocks.md +1381 -0
- package/dist/docs/templates/table-panel.md +184 -0
- package/dist/docs/templates/table-row-animation.md +317 -0
- package/dist/docs/templates/usage-cards.md +227 -0
- package/dist/docs/utilities/deviceUtils.md +123 -0
- package/dist/docs/utilities/featureToggles.md +90 -0
- package/dist/docs/utilities/fuelTypeUtils.md +186 -0
- package/dist/docs/utilities/routeUtils.md +138 -0
- package/dist/docs/utilities/useAfterMount.md +66 -0
- package/dist/docs/utilities/useAutoAnimate.md +193 -0
- package/dist/docs/utilities/useAverage.md +95 -0
- package/dist/docs/utilities/useClickOutside.md +61 -0
- package/dist/docs/utilities/useClipboard.md +93 -0
- package/dist/docs/utilities/useCount.md +178 -0
- package/dist/docs/utilities/useDarkMode.md +49 -0
- package/dist/docs/utilities/useDebugInfo.md +126 -0
- package/dist/docs/utilities/useEffectOnce.md +58 -0
- package/dist/docs/utilities/useElapsedTime.md +58 -0
- package/dist/docs/utilities/useElementSize.md +71 -0
- package/dist/docs/utilities/useEsc.md +58 -0
- package/dist/docs/utilities/useEvent.md +64 -0
- package/dist/docs/utilities/useFocusTrap.md +85 -0
- package/dist/docs/utilities/useFullscreen.md +198 -0
- package/dist/docs/utilities/useHover.md +55 -0
- package/dist/docs/utilities/useIncomingPostMessages.md +237 -0
- package/dist/docs/utilities/useInterval.md +85 -0
- package/dist/docs/utilities/useIsFocusWithin.md +114 -0
- package/dist/docs/utilities/useKey.md +151 -0
- package/dist/docs/utilities/useLocalStorage.md +91 -0
- package/dist/docs/utilities/useLocationSuggestions.md +114 -0
- package/dist/docs/utilities/useMax.md +62 -0
- package/dist/docs/utilities/useMin.md +78 -0
- package/dist/docs/utilities/useMutationObserver.md +113 -0
- package/dist/docs/utilities/useOnScreen.md +138 -0
- package/dist/docs/utilities/useOnlineStatus.md +49 -0
- package/dist/docs/utilities/usePostMessage.md +117 -0
- package/dist/docs/utilities/usePostMessageSender.md +257 -0
- package/dist/docs/utilities/usePrevious.md +101 -0
- package/dist/docs/utilities/useResizeObserver.md +151 -0
- package/dist/docs/utilities/useScrollPosition.md +252 -0
- package/dist/docs/utilities/useSearch.md +228 -0
- package/dist/docs/utilities/useSorting.md +389 -0
- package/dist/docs/utilities/useStateWithValidation.md +83 -0
- package/dist/docs/utilities/useSum.md +155 -0
- package/dist/docs/utilities/useTableExport.md +404 -0
- package/dist/docs/utilities/useTableSelection.md +1120 -0
- package/dist/docs/utilities/useTimeout.md +55 -0
- package/dist/docs/utilities/useToggle.md +115 -0
- package/dist/docs/utilities/useWindowResize.md +70 -0
- package/dist/index.mjs +271 -0
- package/dist/search-synonyms.json +134 -0
- package/dist/version.json +4 -0
- package/package.json +23 -19
- package/bin/uikit-mcp.mjs +0 -23
- package/data/pages/Components/components/accentbar.json +0 -207
- package/data/pages/Components/components/activity.json +0 -87
- package/data/pages/Components/components/animatednumber.json +0 -99
- package/data/pages/Components/components/animations.json +0 -87
- package/data/pages/Components/components/appheader.json +0 -291
- package/data/pages/Components/components/applayout.json +0 -1198
- package/data/pages/Components/components/appnavigationbar.json +0 -327
- package/data/pages/Components/components/areacharts.json +0 -563
- package/data/pages/Components/components/aspectratioplaceholder.json +0 -75
- package/data/pages/Components/components/assettree.json +0 -3080
- package/data/pages/Components/components/autosuggests.json +0 -710
- package/data/pages/Components/components/avatar.json +0 -157
- package/data/pages/Components/components/banner.json +0 -599
- package/data/pages/Components/components/barcharts.json +0 -1507
- package/data/pages/Components/components/barlist.json +0 -223
- package/data/pages/Components/components/basicmap.json +0 -68
- package/data/pages/Components/components/bottomsheet.json +0 -601
- package/data/pages/Components/components/button.json +0 -583
- package/data/pages/Components/components/buttontoolbar.json +0 -63
- package/data/pages/Components/components/calendarstripe.json +0 -235
- package/data/pages/Components/components/card.json +0 -69
- package/data/pages/Components/components/carousel.json +0 -39
- package/data/pages/Components/components/chartcolors.json +0 -34
- package/data/pages/Components/components/chartsgettingstarted.json +0 -32
- package/data/pages/Components/components/chat.json +0 -39
- package/data/pages/Components/components/checkbox.json +0 -847
- package/data/pages/Components/components/clearableinput.json +0 -789
- package/data/pages/Components/components/collapse.json +0 -175
- package/data/pages/Components/components/composedcharts.json +0 -159
- package/data/pages/Components/components/contentloader.json +0 -233
- package/data/pages/Components/components/datatabs.json +0 -680
- package/data/pages/Components/components/datepickers.json +0 -287
- package/data/pages/Components/components/dialogs.json +0 -1492
- package/data/pages/Components/components/divider.json +0 -93
- package/data/pages/Components/components/dropdowns.json +0 -936
- package/data/pages/Components/components/editablecontent.json +0 -1117
- package/data/pages/Components/components/expander.json +0 -377
- package/data/pages/Components/components/fade.json +0 -403
- package/data/pages/Components/components/fadeexpander.json +0 -75
- package/data/pages/Components/components/fadeup.json +0 -127
- package/data/pages/Components/components/feedback.json +0 -269
- package/data/pages/Components/components/filepickers.json +0 -269
- package/data/pages/Components/components/formlabel.json +0 -115
- package/data/pages/Components/components/fullscreenmap.json +0 -22
- package/data/pages/Components/components/groupeditemlist.json +0 -323
- package/data/pages/Components/components/iconlist.json +0 -45
- package/data/pages/Components/components/imagepreloader.json +0 -81
- package/data/pages/Components/components/labeledelement.json +0 -75
- package/data/pages/Components/components/licenseplate.json +0 -69
- package/data/pages/Components/components/linecharts.json +0 -987
- package/data/pages/Components/components/listmenu.json +0 -313
- package/data/pages/Components/components/loadmore.json +0 -175
- package/data/pages/Components/components/mainnavigation.json +0 -39
- package/data/pages/Components/components/mapcircle.json +0 -34
- package/data/pages/Components/components/mapcluster.json +0 -51
- package/data/pages/Components/components/mapcontext.json +0 -105
- package/data/pages/Components/components/mapdraggablemarker.json +0 -34
- package/data/pages/Components/components/mapgettingstarted.json +0 -27
- package/data/pages/Components/components/mapgroup.json +0 -1198
- package/data/pages/Components/components/mapinfobubble.json +0 -34
- package/data/pages/Components/components/maplayergroup.json +0 -34
- package/data/pages/Components/components/mapmarker.json +0 -700
- package/data/pages/Components/components/mappolygon.json +0 -45
- package/data/pages/Components/components/maproute.json +0 -623
- package/data/pages/Components/components/maproutegenerator.json +0 -16
- package/data/pages/Components/components/mapsettings.json +0 -51
- package/data/pages/Components/components/maputils.json +0 -34
- package/data/pages/Components/components/multiselects.json +0 -1451
- package/data/pages/Components/components/nodata.json +0 -139
- package/data/pages/Components/components/notifications.json +0 -65
- package/data/pages/Components/components/numbercontrol.json +0 -301
- package/data/pages/Components/components/onboarding.json +0 -302
- package/data/pages/Components/components/page.json +0 -197
- package/data/pages/Components/components/pager.json +0 -93
- package/data/pages/Components/components/piecharts.json +0 -731
- package/data/pages/Components/components/popover.json +0 -251
- package/data/pages/Components/components/position.json +0 -69
- package/data/pages/Components/components/radialbarcharts.json +0 -1304
- package/data/pages/Components/components/radiobutton.json +0 -1105
- package/data/pages/Components/components/releasenotes.json +0 -44
- package/data/pages/Components/components/resizer.json +0 -93
- package/data/pages/Components/components/responsivecolumnstripe.json +0 -123
- package/data/pages/Components/components/responsivevideo.json +0 -75
- package/data/pages/Components/components/rioglyph.json +0 -93
- package/data/pages/Components/components/rules.json +0 -410
- package/data/pages/Components/components/saveableinput.json +0 -703
- package/data/pages/Components/components/selects.json +0 -701
- package/data/pages/Components/components/sidebar.json +0 -243
- package/data/pages/Components/components/sliders.json +0 -235
- package/data/pages/Components/components/smoothscrollbars.json +0 -335
- package/data/pages/Components/components/spinners.json +0 -343
- package/data/pages/Components/components/states.json +0 -1705
- package/data/pages/Components/components/statswidgets.json +0 -314
- package/data/pages/Components/components/statusbar.json +0 -177
- package/data/pages/Components/components/stepbutton.json +0 -57
- package/data/pages/Components/components/steppedprogressbars.json +0 -417
- package/data/pages/Components/components/subnavigation.json +0 -107
- package/data/pages/Components/components/supportmarker.json +0 -45
- package/data/pages/Components/components/svgimage.json +0 -81
- package/data/pages/Components/components/switch.json +0 -111
- package/data/pages/Components/components/tables.json +0 -144
- package/data/pages/Components/components/tagmanager.json +0 -86
- package/data/pages/Components/components/tags.json +0 -146
- package/data/pages/Components/components/teaser.json +0 -188
- package/data/pages/Components/components/timeline.json +0 -45
- package/data/pages/Components/components/timepicker.json +0 -163
- package/data/pages/Components/components/togglebutton.json +0 -247
- package/data/pages/Components/components/tooltip.json +0 -270
- package/data/pages/Components/components/virtuallist.json +0 -175
- package/data/pages/Foundations/foundations.json +0 -2475
- package/data/pages/Getting-started/start/changelog.json +0 -22
- package/data/pages/Getting-started/start/goodtoknow.json +0 -32
- package/data/pages/Getting-started/start/guidelines/color-combinations.json +0 -58
- package/data/pages/Getting-started/start/guidelines/custom-css.json +0 -27
- package/data/pages/Getting-started/start/guidelines/custom-rioglyph.json +0 -22
- package/data/pages/Getting-started/start/guidelines/formatting.json +0 -97
- package/data/pages/Getting-started/start/guidelines/iframe.json +0 -93
- package/data/pages/Getting-started/start/guidelines/obfuscate-data.json +0 -22
- package/data/pages/Getting-started/start/guidelines/print-css.json +0 -37
- package/data/pages/Getting-started/start/guidelines/spinner.json +0 -144
- package/data/pages/Getting-started/start/guidelines/supported-browsers.json +0 -22
- package/data/pages/Getting-started/start/guidelines/writing.json +0 -242
- package/data/pages/Getting-started/start/howto.json +0 -72
- package/data/pages/Getting-started/start/intro.json +0 -37
- package/data/pages/Getting-started/start/responsiveness.json +0 -52
- package/data/pages/Templates/templates/common-table.json +0 -39
- package/data/pages/Templates/templates/detail-views.json +0 -71
- package/data/pages/Templates/templates/expandable-details.json +0 -39
- package/data/pages/Templates/templates/feature-cards.json +0 -103
- package/data/pages/Templates/templates/form-summary.json +0 -39
- package/data/pages/Templates/templates/form-toggle.json +0 -39
- package/data/pages/Templates/templates/list-blocks.json +0 -119
- package/data/pages/Templates/templates/loading-progress.json +0 -39
- package/data/pages/Templates/templates/options-panel.json +0 -39
- package/data/pages/Templates/templates/panel-variants.json +0 -39
- package/data/pages/Templates/templates/progress-cards.json +0 -71
- package/data/pages/Templates/templates/progress-success.json +0 -39
- package/data/pages/Templates/templates/settings-form.json +0 -39
- package/data/pages/Templates/templates/stats-blocks.json +0 -135
- package/data/pages/Templates/templates/table-panel.json +0 -39
- package/data/pages/Templates/templates/table-row-animation.json +0 -39
- package/data/pages/Templates/templates/usage-cards.json +0 -39
- package/data/pages/Utilities/utilities/deviceutils.json +0 -39
- package/data/pages/Utilities/utilities/featuretoggles.json +0 -42
- package/data/pages/Utilities/utilities/fueltypeutils.json +0 -118
- package/data/pages/Utilities/utilities/routeutils.json +0 -34
- package/data/pages/Utilities/utilities/useaftermount.json +0 -63
- package/data/pages/Utilities/utilities/useaverage.json +0 -86
- package/data/pages/Utilities/utilities/useclickoutside.json +0 -69
- package/data/pages/Utilities/utilities/useclipboard.json +0 -57
- package/data/pages/Utilities/utilities/usecount.json +0 -92
- package/data/pages/Utilities/utilities/usedarkmode.json +0 -50
- package/data/pages/Utilities/utilities/usedebuginfo.json +0 -63
- package/data/pages/Utilities/utilities/useeffectonce.json +0 -57
- package/data/pages/Utilities/utilities/useelapsedtime.json +0 -57
- package/data/pages/Utilities/utilities/useelementsize.json +0 -63
- package/data/pages/Utilities/utilities/useesc.json +0 -57
- package/data/pages/Utilities/utilities/useevent.json +0 -75
- package/data/pages/Utilities/utilities/usefocustrap.json +0 -57
- package/data/pages/Utilities/utilities/usefullscreen.json +0 -197
- package/data/pages/Utilities/utilities/usehover.json +0 -57
- package/data/pages/Utilities/utilities/useinterval.json +0 -63
- package/data/pages/Utilities/utilities/useisfocuswithin.json +0 -75
- package/data/pages/Utilities/utilities/usekey.json +0 -75
- package/data/pages/Utilities/utilities/uselocalstorage.json +0 -69
- package/data/pages/Utilities/utilities/uselocationsuggestions.json +0 -110
- package/data/pages/Utilities/utilities/usemax.json +0 -86
- package/data/pages/Utilities/utilities/usemin.json +0 -86
- package/data/pages/Utilities/utilities/usemutationobserver.json +0 -69
- package/data/pages/Utilities/utilities/useonlinestatus.json +0 -39
- package/data/pages/Utilities/utilities/useonscreen.json +0 -63
- package/data/pages/Utilities/utilities/usepostmessage.json +0 -80
- package/data/pages/Utilities/utilities/useprevious.json +0 -63
- package/data/pages/Utilities/utilities/useresizeobserver.json +0 -65
- package/data/pages/Utilities/utilities/usescrollposition.json +0 -103
- package/data/pages/Utilities/utilities/usesearch.json +0 -197
- package/data/pages/Utilities/utilities/usesorting.json +0 -139
- package/data/pages/Utilities/utilities/usestatewithvalidation.json +0 -69
- package/data/pages/Utilities/utilities/usesum.json +0 -86
- package/data/pages/Utilities/utilities/usetableexport.json +0 -87
- package/data/pages/Utilities/utilities/usetableselection.json +0 -311
- package/data/pages/Utilities/utilities/usetimeout.json +0 -63
- package/data/pages/Utilities/utilities/usetoggle.json +0 -75
- package/data/pages/Utilities/utilities/usewindowresize.json +0 -63
- package/data/version.json +0 -4
- package/docs/content-schema.md +0 -147
- package/docs/navigation-inventory.json +0 -1310
- package/docs/search-synonyms.json +0 -43
- package/server/index.mjs +0 -268
- package/server/lib/load-docs.mjs +0 -48
- package/server/lib/normalise-doc.mjs +0 -220
- package/server/lib/render-markdown.mjs +0 -82
- package/server/lib/search-index.mjs +0 -49
- package/server/lib/types.js +0 -99
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
# How to use the UIKIT
|
|
2
|
+
|
|
3
|
+
*Category:* Getting started
|
|
4
|
+
*Section:* Welcome
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#start/howto
|
|
6
|
+
*Captured:* 2025-12-12T12:38:01.157Z
|
|
7
|
+
|
|
8
|
+
Install the latest version of the UIKIT (that includes latest beta versions as well) via
|
|
9
|
+
|
|
10
|
+
## How to use the UIKIT
|
|
11
|
+
|
|
12
|
+
- Install the npm package
|
|
13
|
+
- Typescript
|
|
14
|
+
- Document <head /> key meta tags
|
|
15
|
+
- UIKIT CSS
|
|
16
|
+
- Brand themes Print styles Additional styling information Dark mode
|
|
17
|
+
- UIKIT Javascript packages via CDN
|
|
18
|
+
- Dependencies
|
|
19
|
+
|
|
20
|
+
- Typescript
|
|
21
|
+
|
|
22
|
+
- Brand themes
|
|
23
|
+
- Print styles
|
|
24
|
+
- Additional styling information
|
|
25
|
+
- Dark mode
|
|
26
|
+
|
|
27
|
+
## Install the npm package
|
|
28
|
+
|
|
29
|
+
```javascript
|
|
30
|
+
npm install @rio-cloud/rio-uikit
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Or install a dedicated version via
|
|
34
|
+
|
|
35
|
+
```javascript
|
|
36
|
+
npm install @rio-cloud/rio-uikit@2.0.0
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## TypeScript
|
|
40
|
+
|
|
41
|
+
The UIKIT is built with TypeScript and defines the types inside the components.
|
|
42
|
+
|
|
43
|
+
> Note: Do not import types from the ./types.ts file directly as this is an internal file and subject to change. Import enums, constants and types from the declaration file together with the component.
|
|
44
|
+
|
|
45
|
+
```javascript
|
|
46
|
+
import AutoSuggest, { type AutoSuggestSuggestion } from "@rio-cloud/rio-uikit/AutoSuggest";
|
|
47
|
+
import Select, { type SelectOption } from "@rio-cloud/rio-uikit/Select";
|
|
48
|
+
import TableViewToggles, { type TableViewTogglesViewType } from "@rio-cloud/rio-uikit/TableViewToggles";
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Document <head /> key meta tags
|
|
52
|
+
|
|
53
|
+
**Mandatory**
|
|
54
|
+
|
|
55
|
+
The utf-8 meta tag is essential for ensuring that your webpage correctly displays text in a wide range of languages and symbols. By setting the character encoding to UTF-8, this tag enables support for almost all characters, including those used in non-Latin scripts, special symbols, and emojis.
|
|
56
|
+
|
|
57
|
+
This not only guarantees proper rendering of your content but also prevents common issues such as garbled or corrupted text and icons, known as mojibake. Modern web browsers and standards expect UTF-8 encoding by default, making this tag a critical component of any HTML document. Including this tag ensures your webpage is globally accessible and aligns with current best practices in web development.
|
|
58
|
+
|
|
59
|
+
```html
|
|
60
|
+
<meta charset="utf-8" />
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
**Best practices**
|
|
64
|
+
|
|
65
|
+
The viewport meta tag is a cornerstone of responsive web design. It configures the viewport settings to match the device’s screen width, ensuring that your webpage adapts seamlessly to different screen sizes. Without this tag, mobile devices often display pages as a scaled-down version of their desktop layout, requiring users to zoom or scroll horizontally.
|
|
66
|
+
|
|
67
|
+
By specifying the initial scale and width, this tag guarantees that your content is displayed optimally on all devices, from smartphones to tablets to desktops. Additionally, it improves user experience, enhances accessibility, and supports SEO by meeting mobile-friendly standards, making it a crucial inclusion in any modern HTML document.
|
|
68
|
+
|
|
69
|
+
```html
|
|
70
|
+
<meta name="viewport" content="initial-scale=1.0, width=device-width" />
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## UIKIT CSS
|
|
74
|
+
|
|
75
|
+
ManagedRecommended
|
|
76
|
+
|
|
77
|
+
When utilizing the ApplicationLayout component, the UIKIT automatically ensures the inclusion of the necessary CSS style tag within your index.html, providing seamless integration and enhanced functionality.
|
|
78
|
+
|
|
79
|
+
You no longer need to manually add the CSS style tag to your index.html. Feel free to remove it if you prefer to manage it yourself.
|
|
80
|
+
|
|
81
|
+
> Note: Please note that every application and every widget must be wrapped with the <ApplicationLayout />, as it executes our init function.
|
|
82
|
+
|
|
83
|
+
ManualNot Recommended
|
|
84
|
+
|
|
85
|
+
Use the CSS Stylesheet as follows (specify your required version number in the URL) if you need more control on what style you want to use.
|
|
86
|
+
|
|
87
|
+
```html
|
|
88
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.0.0/rio-uikit.css">
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
> Note: Please make sure to use the same UIKIT style version as the npm package, otherwise this will lead to inconsistency and UI bugs.
|
|
92
|
+
|
|
93
|
+
## Brand themes
|
|
94
|
+
|
|
95
|
+
In addition to the RIO theme, the UIKIT offers other brand-specific themes.
|
|
96
|
+
|
|
97
|
+
These other themes may only be used for applications or services who don't run on the RIO platform. All platform services have to use the RIO theme to achieve a distinct look and feel for the user when switching between services and applications.
|
|
98
|
+
|
|
99
|
+
In order to use such a brand theme, modify the URL in the <link> tag that loads the CSS
|
|
100
|
+
|
|
101
|
+
```html
|
|
102
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.0.0/vw-uikit.css">
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
```html
|
|
106
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.0.0/man-uikit.css">
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
```html
|
|
110
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.0.0/scania-uikit.css">
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
ManagedRecommended
|
|
114
|
+
|
|
115
|
+
You can simply omit the <link> tag in your index.html altogether. The UIKIT will automatically load the correct CSS file for you.
|
|
116
|
+
|
|
117
|
+
```html
|
|
118
|
+
<html data-brand="vw">
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
```html
|
|
122
|
+
<html data-brand="man">
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
```html
|
|
126
|
+
<html data-brand="scania">
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Print styles
|
|
130
|
+
|
|
131
|
+
The UIKIT supports simple print stylings in order to have printable content. See Print CSS
|
|
132
|
+
|
|
133
|
+
```html
|
|
134
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.0.0/rio-uikit-print-utilities.css">
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Additional styling information
|
|
138
|
+
|
|
139
|
+
In some cases like using D3 you may need the color variables as .json from the UIKIT provided via CDN. You can fetch the provided file from CDN via the following URL:
|
|
140
|
+
|
|
141
|
+
```html
|
|
142
|
+
https://uikit.developers.rio.cloud/2.0.0/rio-uikit-colors.json
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Dark mode
|
|
146
|
+
|
|
147
|
+
The UIKIT is fully dark mode ready.
|
|
148
|
+
|
|
149
|
+
> Note: Please note that every application and every widget must be wrapped with the <ApplicationLayout /> as it executes our init function.
|
|
150
|
+
|
|
151
|
+
```jsx
|
|
152
|
+
<ApplicationLayout>
|
|
153
|
+
<ApplicationLayout.Header>
|
|
154
|
+
<ApplicationHeader label='RIO Service' navItems={navItems} />
|
|
155
|
+
</ApplicationLayout.Header>
|
|
156
|
+
<ApplicationLayout.Body>
|
|
157
|
+
<div>My application</div>
|
|
158
|
+
</ApplicationLayout.Body>
|
|
159
|
+
</ApplicationLayout>
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
```jsx
|
|
163
|
+
<ApplicationLayout>
|
|
164
|
+
<div>My widget</div>
|
|
165
|
+
</ApplicationLayout>
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
In cases where the React ApplicationLayout component cannot be used, you can import the new darkmode.js from the UIKIT CDN and add it to your index.html. This script will take care of listening to the theme switch for you.
|
|
169
|
+
|
|
170
|
+
```html
|
|
171
|
+
<script src="https://uikit.developers.rio.cloud/2.0.0/rio-darkmode.js"></script>
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
If you want to react on the dark mode for instance to exchange some images or apply some specific utility classes, you can use the custom hook useDarkMode to do so.
|
|
175
|
+
|
|
176
|
+
To manually enable dark mode when testing your application locally, adddata-theme="dark" to the <html> tag.
|
|
177
|
+
|
|
178
|
+
## Dependencies
|
|
179
|
+
|
|
180
|
+
As of version 1.7.0 the RIO UIKIT has the following dependencies:
|
|
181
|
+
|
|
182
|
+
peerDependencies
|
|
183
|
+
|
|
184
|
+
```javascript
|
|
185
|
+
"react": ">=18.0.0"
|
|
186
|
+
"react-dom": ">=18.0.0"
|
|
187
|
+
```
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Getting started with our UI Library
|
|
2
|
+
|
|
3
|
+
*Category:* Getting started
|
|
4
|
+
*Section:* Welcome
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#start/intro
|
|
6
|
+
*Captured:* 2025-12-12T12:38:01.127Z
|
|
7
|
+
|
|
8
|
+
Welcome! This UI library is designed to help you build beautiful, consistent, and maintainable user interfaces with minimal effort. Here’s how you can make the most of it:
|
|
9
|
+
|
|
10
|
+
## Getting started with our UI Library
|
|
11
|
+
|
|
12
|
+
## Use atomic CSS classes for styling
|
|
13
|
+
|
|
14
|
+
- Consistency By using our predefined classes, your UI will have a common look and feel across all components
|
|
15
|
+
- Maintainability When design updates occur, changes to the utility classes automatically propagate across the entire project, making updates easy and seamless
|
|
16
|
+
- No custom styles needed Avoid the overhead of writing custom CSS. Use the tools we’ve already created to keep your codebase lean and manageable.
|
|
17
|
+
|
|
18
|
+
For example, instead of writing custom CSS for a flex container:
|
|
19
|
+
|
|
20
|
+
```css
|
|
21
|
+
.my-container {
|
|
22
|
+
display: flex;
|
|
23
|
+
justify-content: center;
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Simply apply the atomic classes:
|
|
28
|
+
|
|
29
|
+
```html
|
|
30
|
+
<div class="display-flex justify-content-center">...</div>
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Use React components for structure
|
|
34
|
+
|
|
35
|
+
- Quickly build UIs using pre-built components like the buttons, selects, and dialogs
|
|
36
|
+
- Combine React components with CSS classes to create complex layouts with minimal custom code
|
|
37
|
+
- Extend your layouts by composing React components while using utility classes to tweak the design where necessary
|
|
38
|
+
|
|
39
|
+
## Why stick to our CSS classes and components?
|
|
40
|
+
|
|
41
|
+
- Efficiency Our library is optimized to reduce the need for custom styling and component creation. You’ll spend less time on UI design and more time on functionality.
|
|
42
|
+
- Design flexibility When design changes occur, updating the UIKIT, a single CSS class or React component ensures that your entire project is updated without manual intervention
|
|
43
|
+
- Better collaboration By sticking to the predefined patterns, your team will maintain consistency across projects, making it easier for multiple developers to collaborate without the risk of style mismatches
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# Responsiveness - for all platforms
|
|
2
|
+
|
|
3
|
+
*Category:* Getting started
|
|
4
|
+
*Section:* Guidelines
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#start/responsiveness
|
|
6
|
+
*Captured:* 2025-12-12T12:38:01.206Z
|
|
7
|
+
|
|
8
|
+
The UIKIT considers all platforms — both desktop and mobile. We recognize that people work across many different products and often need to support multiple platforms and the UIKIT is a foundation for that with its many responsive building blocks and responsive components.
|
|
9
|
+
|
|
10
|
+
## Responsiveness - for all platforms
|
|
11
|
+
|
|
12
|
+
## Principal
|
|
13
|
+
|
|
14
|
+
To build for all platforms, there are a lot of options and tools that can be used.
|
|
15
|
+
|
|
16
|
+
## Layout
|
|
17
|
+
|
|
18
|
+
**Fluid container**
|
|
19
|
+
|
|
20
|
+
**Responsive grid systems**
|
|
21
|
+
|
|
22
|
+
A responsive grid system allows a layout to change dynamically based on the size of the screen or the surrounding element. This also guarantees consistent layouts across all products.
|
|
23
|
+
|
|
24
|
+
## Spacings & sizing
|
|
25
|
+
|
|
26
|
+
The UIKIT offers also responsive padding and margin classes that allow reducing or increasing the spacing around elements depending on a certain breakpoint. This for example enables to set a smaller margin on mobile devices than on desktops.
|
|
27
|
+
|
|
28
|
+
With our flexible and responsive width and height classes, you have the freedom to define different sizes for different breakpoints or use our min- and max classes.
|
|
29
|
+
|
|
30
|
+
## Container queries
|
|
31
|
+
|
|
32
|
+
While the traditional responsive utilities mentioned above (e.g., --sm--, --md--, --lg--) adapt components based on the viewport width, container queries take a different approach by allowing components to respond to the size of their parent container instead. This enables a more context-aware and flexible design system—especially useful when components live in dynamic or nested layouts (like sidebars, cards, or split views).
|
|
33
|
+
|
|
34
|
+
**Why use container queries?**
|
|
35
|
+
|
|
36
|
+
Sometimes, the screen size alone is not enough to decide how a component should behave. For example:
|
|
37
|
+
|
|
38
|
+
- A card inside a wide layout may want to show content side-by-side.
|
|
39
|
+
- The same card inside a sidebar should stack the content vertically.
|
|
40
|
+
|
|
41
|
+
Container queries let components adapt to these situations without relying on global breakpoints.
|
|
42
|
+
|
|
43
|
+
**Usage**
|
|
44
|
+
|
|
45
|
+
The RIO UIKIT introduces container query utility classes using the following format:
|
|
46
|
+
|
|
47
|
+
```html
|
|
48
|
+
cq-[cq-breakpoint]:[utility-class]
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Where cq-breakpoint is the container width in pixels that triggers the style, such as:
|
|
52
|
+
|
|
53
|
+
- cq-300:padding-10
|
|
54
|
+
- cq-500:flex-column
|
|
55
|
+
- cq-600:grid-cols-2
|
|
56
|
+
|
|
57
|
+
The utility is applied only when the container width is greater than or equal to the breakpoint.
|
|
58
|
+
|
|
59
|
+
**Available utility classes**
|
|
60
|
+
|
|
61
|
+
Container queries support not all, but many of the same utility categories as responsive viewport classes:
|
|
62
|
+
|
|
63
|
+
- Spacing: margin, padding, etc.
|
|
64
|
+
- Layout: display-flex, flex-row, flex-column, gap, display-grid, grid-cols, col-span, etc.
|
|
65
|
+
- Text sizes: text-size, line-height
|
|
66
|
+
- Custom responsive behaviors based on your layout context
|
|
67
|
+
|
|
68
|
+
See the full list of container query utilities in the Container queries section.
|
|
69
|
+
|
|
70
|
+
**Example**
|
|
71
|
+
|
|
72
|
+
```html
|
|
73
|
+
<div className="cq-container">
|
|
74
|
+
<div className="cq-300:flex-column cq-600:flex-row cq-300:padding-10">
|
|
75
|
+
<!-- content -->
|
|
76
|
+
</div>
|
|
77
|
+
</div>
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
In this example:
|
|
81
|
+
|
|
82
|
+
- The inner element uses a column layout when its container is at least 300px wide.
|
|
83
|
+
- It switches to a row layout when the container is at least 600px wide.
|
|
84
|
+
- Padding is also conditionally applied based on container size.
|
|
85
|
+
|
|
86
|
+
> Note: Make sure the container element has cq-container applied, as it sets up the container context required for the styles to react correctly.
|
|
87
|
+
|
|
88
|
+
## Device utils
|
|
89
|
+
|
|
90
|
+
We also offer a set of device utility functions such as hasTouch, isMobile, and isDesktop. This allows to hide or show elements for mobile or to switch settings for some components how to behave. For instance, you might want to show the table card view when a page is rendered on mobile. Or you might want to expand or collapse information depending on your device.
|
|
91
|
+
|
|
92
|
+
Furthermore, we offer some hooks like the useWindowResize hook that helps to react to the user changing his window size and to react accordingly. The useOnlineStatus lets you show a message to the user when his device is offline or online again or to react to that event.
|
|
93
|
+
|
|
94
|
+
## There is more...
|
|
95
|
+
|
|
96
|
+
Many of our atomic classes are also available for different breakpoints. All classes are listed below the individual demos in the "CLASSES" section of the Design page.
|
|
97
|
+
|
|
98
|
+
We constantly strive to improve the UIKIT to make it easier to use. If you have questions about the correct usage of these classes or feedback on components, please ask them in the UIKIT Slack channel.
|