@rio-cloud/uikit-mcp 1.1.9 → 1.1.11
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 +2 -1
- package/dist/doc-metadata.json +334 -94
- package/dist/docs/components/accentBar.md +110 -116
- package/dist/docs/components/activity.md +1 -1
- package/dist/docs/components/analyticsAnalysisOverlay.md +630 -0
- package/dist/docs/components/animatedNumber.md +2 -2
- package/dist/docs/components/animatedTextReveal.md +53 -55
- package/dist/docs/components/animations.md +21 -21
- package/dist/docs/components/appHeader.md +27 -38
- package/dist/docs/components/appLayout.md +23 -77
- package/dist/docs/components/appNavigationBar.md +1 -1
- package/dist/docs/components/areaCharts.md +57 -61
- package/dist/docs/components/aspectRatioPlaceholder.md +1 -1
- package/dist/docs/components/assetTree.md +429 -342
- package/dist/docs/components/autosuggests.md +1 -1
- package/dist/docs/components/avatar.md +1 -1
- package/dist/docs/components/banner.md +2 -2
- package/dist/docs/components/barCharts.md +530 -414
- package/dist/docs/components/barList.md +10 -10
- package/dist/docs/components/basicMap.md +104 -39
- package/dist/docs/components/bottomSheet.md +2 -2
- package/dist/docs/components/button.md +8 -2
- package/dist/docs/components/buttonToolbar.md +1 -1
- package/dist/docs/components/calendarStripe.md +59 -63
- package/dist/docs/components/card.md +1 -1
- package/dist/docs/components/carousel.md +1 -1
- package/dist/docs/components/chartColors.md +1 -1
- package/dist/docs/components/chartsGettingStarted.md +1 -1
- package/dist/docs/components/chat.md +2 -2
- package/dist/docs/components/checkbox.md +15 -10
- package/dist/docs/components/circularProgress.md +6 -6
- package/dist/docs/components/clearableInput.md +1 -1
- package/dist/docs/components/collapse.md +2 -2
- package/dist/docs/components/composedCharts.md +63 -51
- package/dist/docs/components/contentLoader.md +1 -1
- package/dist/docs/components/dataTabs.md +33 -33
- package/dist/docs/components/datepickers.md +693 -685
- package/dist/docs/components/dayPicker.md +5624 -0
- package/dist/docs/components/dayPickerCalendar.md +5289 -0
- package/dist/docs/components/dialogs.md +17 -19
- package/dist/docs/components/divider.md +1 -1
- package/dist/docs/components/dropdowns.md +3264 -3276
- package/dist/docs/components/editableContent.md +91 -91
- package/dist/docs/components/expander.md +4 -1
- package/dist/docs/components/fade.md +1 -1
- package/dist/docs/components/fadeExpander.md +1 -1
- package/dist/docs/components/fadeUp.md +32 -36
- package/dist/docs/components/feedback.md +1 -1
- package/dist/docs/components/filePickers.md +1 -1
- package/dist/docs/components/formLabel.md +29 -31
- package/dist/docs/components/groupedItemList.md +3 -7
- package/dist/docs/components/htmlTable.md +5074 -0
- package/dist/docs/components/iconList.md +4 -4
- package/dist/docs/components/imagePreloader.md +1 -1
- package/dist/docs/components/labeledElement.md +1 -1
- package/dist/docs/components/licensePlate.md +1 -1
- package/dist/docs/components/lineCharts.md +172 -170
- package/dist/docs/components/listMenu.md +15 -12
- package/dist/docs/components/loadMore.md +4 -2
- package/dist/docs/components/mainNavigation.md +1 -1
- package/dist/docs/components/mapCircle.md +10 -1
- package/dist/docs/components/mapCluster.md +25 -1
- package/dist/docs/components/mapContext.md +12 -4
- package/dist/docs/components/mapDraggableMarker.md +12 -1
- package/dist/docs/components/mapGettingStarted.md +39 -1
- package/dist/docs/components/mapInfoBubble.md +129 -2
- package/dist/docs/components/mapLayerGroup.md +10 -1
- package/dist/docs/components/mapMarker.md +10 -1
- package/dist/docs/components/mapPolygon.md +288 -85
- package/dist/docs/components/mapRoute.md +262 -172
- package/dist/docs/components/mapSettings.md +28 -1
- package/dist/docs/components/mapUtils.md +1 -1
- package/dist/docs/components/mapViewportHistory.md +287 -0
- package/dist/docs/components/multiselects.md +217 -18
- package/dist/docs/components/noData.md +1 -1
- package/dist/docs/components/notifications.md +2 -2
- package/dist/docs/components/numbercontrol.md +15 -15
- package/dist/docs/components/onboarding.md +1 -1
- package/dist/docs/components/page.md +1 -1
- package/dist/docs/components/pager.md +1 -1
- package/dist/docs/components/pieCharts.md +237 -211
- package/dist/docs/components/popover.md +1 -1
- package/dist/docs/components/position.md +1 -1
- package/dist/docs/components/radialBarCharts.md +446 -398
- package/dist/docs/components/radioCardGroup.md +1 -1
- package/dist/docs/components/radiobutton.md +98 -98
- package/dist/docs/components/releaseNotes.md +1 -1
- package/dist/docs/components/resizer.md +1 -1
- package/dist/docs/components/responsiveColumnStripe.md +1 -1
- package/dist/docs/components/responsiveVideo.md +1 -1
- package/dist/docs/components/rioglyph.md +1 -1
- package/dist/docs/components/rules.md +41 -47
- package/dist/docs/components/saveableInput.md +252 -252
- package/dist/docs/components/selects.md +332 -161
- package/dist/docs/components/sidebar.md +1 -1
- package/dist/docs/components/sliders.md +1 -1
- package/dist/docs/components/smoothScrollbars.md +19 -13
- package/dist/docs/components/spinners.md +1 -1
- package/dist/docs/components/states.md +15 -1
- package/dist/docs/components/statsWidgets.md +1 -1
- package/dist/docs/components/statusBar.md +3 -1
- package/dist/docs/components/stepButton.md +1 -1
- package/dist/docs/components/steppedProgressBars.md +9 -11
- package/dist/docs/components/subNavigation.md +1 -1
- package/dist/docs/components/supportMarker.md +1 -1
- package/dist/docs/components/svgImage.md +1 -1
- package/dist/docs/components/switch.md +5 -1
- package/dist/docs/components/table.md +21361 -0
- package/dist/docs/components/tableControls.md +982 -0
- package/dist/docs/components/tagManager.md +1 -1
- package/dist/docs/components/tags.md +1 -1
- package/dist/docs/components/teaser.md +1 -1
- package/dist/docs/components/textTruncateMiddle.md +1 -1
- package/dist/docs/components/timeline.md +1 -1
- package/dist/docs/components/timepicker.md +3 -1
- package/dist/docs/components/toggleButton.md +3 -1
- package/dist/docs/components/tooltip.md +8 -2
- package/dist/docs/components/tracker.md +1 -1
- package/dist/docs/components/virtualList.md +60 -60
- package/dist/docs/foundations.md +761 -3077
- package/dist/docs/start/changelog.md +73 -3
- package/dist/docs/start/goodtoknow.md +5 -1
- package/dist/docs/start/guidelines/color-combinations.md +5 -1
- package/dist/docs/start/guidelines/custom-css.md +26 -2
- package/dist/docs/start/guidelines/custom-rioglyph.md +20 -2
- package/dist/docs/start/guidelines/formatting.md +2254 -249
- package/dist/docs/start/guidelines/iframe.md +53 -19
- package/dist/docs/start/guidelines/obfuscate-data.md +24 -2
- package/dist/docs/start/guidelines/print-css.md +16 -2
- package/dist/docs/start/guidelines/spinner.md +1 -1
- package/dist/docs/start/guidelines/state-in-url.md +1138 -11
- package/dist/docs/start/guidelines/supported-browsers.md +9 -2
- package/dist/docs/start/guidelines/writing.md +228 -2
- package/dist/docs/start/howto.md +155 -13
- package/dist/docs/start/intro.md +40 -2
- package/dist/docs/start/responsiveness.md +27 -1
- package/dist/docs/templates/ai-assistant.md +311 -0
- package/dist/docs/templates/common-table.md +814 -0
- package/dist/docs/templates/detail-views.md +846 -0
- package/dist/docs/templates/expandable-details.md +214 -0
- package/dist/docs/templates/feature-cards.md +479 -0
- package/dist/docs/templates/form-summary.md +179 -0
- package/dist/docs/templates/form-toggle.md +329 -0
- package/dist/docs/templates/list-blocks.md +872 -0
- package/dist/docs/templates/loading-progress.md +100 -0
- package/dist/docs/templates/options-panel.md +132 -0
- package/dist/docs/templates/panel-variants.md +137 -0
- package/dist/docs/templates/progress-cards.md +541 -0
- package/dist/docs/templates/progress-success.md +125 -0
- package/dist/docs/templates/settings-form.md +401 -0
- package/dist/docs/templates/stats-blocks.md +1245 -0
- package/dist/docs/templates/table-panel.md +310 -0
- package/dist/docs/templates/usage-cards.md +199 -0
- package/dist/docs/utilities/classNames.md +89 -1
- package/dist/docs/utilities/deviceUtils.md +2 -2
- package/dist/docs/utilities/featureToggles.md +182 -2
- package/dist/docs/utilities/fuelTypeUtils.md +27 -29
- package/dist/docs/utilities/getTrackingAttributes.md +322 -0
- package/dist/docs/utilities/routeUtils.md +211 -3
- package/dist/docs/utilities/useAfterMount.md +1 -1
- package/dist/docs/utilities/useAutoAnimate.md +1 -1
- package/dist/docs/utilities/useAverage.md +1 -1
- package/dist/docs/utilities/useClickOutside.md +1 -1
- package/dist/docs/utilities/useClipboard.md +2 -2
- package/dist/docs/utilities/useCookies.md +1 -1
- package/dist/docs/utilities/useCount.md +1 -1
- package/dist/docs/utilities/useDarkMode.md +5 -4
- package/dist/docs/utilities/useDebugInfo.md +3 -3
- package/dist/docs/utilities/useDraggableElement.md +281 -0
- package/dist/docs/utilities/useEffectOnce.md +1 -1
- package/dist/docs/utilities/useElapsedTime.md +1 -1
- package/dist/docs/utilities/useElementSize.md +1 -1
- package/dist/docs/utilities/useEsc.md +1 -1
- package/dist/docs/utilities/useEvent.md +1 -1
- package/dist/docs/utilities/useFocusTrap.md +1 -1
- package/dist/docs/utilities/useFullscreen.md +1 -1
- package/dist/docs/utilities/useHover.md +1 -1
- package/dist/docs/utilities/useIncomingPostMessages.md +1 -1
- package/dist/docs/utilities/useInterval.md +1 -1
- package/dist/docs/utilities/useIsFocusWithin.md +1 -1
- package/dist/docs/utilities/useKey.md +8 -10
- package/dist/docs/utilities/useLocalStorage.md +1 -1
- package/dist/docs/utilities/useLocationSuggestions.md +1 -1
- package/dist/docs/utilities/useMax.md +1 -1
- package/dist/docs/utilities/useMin.md +1 -1
- package/dist/docs/utilities/useMutationObserver.md +1 -1
- package/dist/docs/utilities/useOnScreen.md +1 -1
- package/dist/docs/utilities/useOnlineStatus.md +1 -1
- package/dist/docs/utilities/usePostMessage.md +2 -2
- package/dist/docs/utilities/usePostMessageSender.md +1 -1
- package/dist/docs/utilities/usePrevious.md +110 -2
- package/dist/docs/utilities/useResizeObserver.md +35 -15
- package/dist/docs/utilities/useRioCookieConsent.md +1 -1
- package/dist/docs/utilities/useScrollPosition.md +3 -6
- package/dist/docs/utilities/useSearch.md +1 -3
- package/dist/docs/utilities/useSearchHighlight.md +1 -1
- package/dist/docs/utilities/useSorting.md +370 -239
- package/dist/docs/utilities/useStateWithValidation.md +1 -1
- package/dist/docs/utilities/useSum.md +1 -1
- package/dist/docs/utilities/useTableExport.md +364 -288
- package/dist/docs/utilities/useTableSelection.md +88 -92
- package/dist/docs/utilities/useTimeout.md +1 -1
- package/dist/docs/utilities/useToggle.md +1 -1
- package/dist/docs/utilities/useUrlState.md +1 -1
- package/dist/docs/utilities/useWindowResize.md +1 -1
- package/dist/index.mjs +173 -69
- package/dist/search-synonyms.json +214 -76
- package/dist/version.json +2 -2
- package/package.json +4 -5
- package/dist/docs/components/mapRouteGenerator.md +0 -6
- package/dist/docs/components/tables.md +0 -8
package/dist/docs/start/howto.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Welcome
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#/start/howto
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-04-27T14:57:04.246Z
|
|
7
7
|
|
|
8
8
|
Install the latest version of the UIKIT (that includes latest beta versions as well) via
|
|
9
9
|
|
|
@@ -26,18 +26,38 @@ Install the latest version of the UIKIT (that includes latest beta versions as w
|
|
|
26
26
|
|
|
27
27
|
## Install the npm package
|
|
28
28
|
|
|
29
|
+
Install the npm package
|
|
30
|
+
|
|
29
31
|
```javascript
|
|
30
32
|
npm install @rio-cloud/rio-uikit
|
|
31
33
|
```
|
|
32
34
|
|
|
35
|
+
-
|
|
36
|
+
|
|
37
|
+
/
|
|
38
|
+
|
|
39
|
+
-
|
|
40
|
+
|
|
33
41
|
Or install a dedicated version via
|
|
34
42
|
|
|
35
43
|
```javascript
|
|
36
|
-
npm install @rio-cloud/rio-uikit@2.
|
|
44
|
+
npm install @rio-cloud/rio-uikit@2.4.0
|
|
37
45
|
```
|
|
38
46
|
|
|
47
|
+
-
|
|
48
|
+
|
|
49
|
+
/
|
|
50
|
+
|
|
51
|
+
-
|
|
52
|
+
|
|
53
|
+
2.4
|
|
54
|
+
|
|
55
|
+
.0
|
|
56
|
+
|
|
39
57
|
## TypeScript
|
|
40
58
|
|
|
59
|
+
TypeScript
|
|
60
|
+
|
|
41
61
|
The UIKIT is built with TypeScript and defines the types inside the components.
|
|
42
62
|
|
|
43
63
|
> 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.
|
|
@@ -48,6 +68,48 @@ import Select, { type SelectOption } from "@rio-cloud/rio-uikit/Select";
|
|
|
48
68
|
import TableViewToggles, { type TableViewTogglesViewType } from "@rio-cloud/rio-uikit/TableViewToggles";
|
|
49
69
|
```
|
|
50
70
|
|
|
71
|
+
import
|
|
72
|
+
|
|
73
|
+
,
|
|
74
|
+
|
|
75
|
+
{
|
|
76
|
+
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
from
|
|
80
|
+
|
|
81
|
+
"@rio-cloud/rio-uikit/AutoSuggest"
|
|
82
|
+
|
|
83
|
+
;
|
|
84
|
+
|
|
85
|
+
import
|
|
86
|
+
|
|
87
|
+
,
|
|
88
|
+
|
|
89
|
+
{
|
|
90
|
+
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
from
|
|
94
|
+
|
|
95
|
+
"@rio-cloud/rio-uikit/Select"
|
|
96
|
+
|
|
97
|
+
;
|
|
98
|
+
|
|
99
|
+
import
|
|
100
|
+
|
|
101
|
+
,
|
|
102
|
+
|
|
103
|
+
{
|
|
104
|
+
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
from
|
|
108
|
+
|
|
109
|
+
"@rio-cloud/rio-uikit/TableViewToggles"
|
|
110
|
+
|
|
111
|
+
;
|
|
112
|
+
|
|
51
113
|
## Document <head /> key meta tags
|
|
52
114
|
|
|
53
115
|
**Mandatory**
|
|
@@ -60,6 +122,8 @@ This not only guarantees proper rendering of your content but also prevents comm
|
|
|
60
122
|
<meta charset="utf-8" />
|
|
61
123
|
```
|
|
62
124
|
|
|
125
|
+
<meta charset="utf-8" />
|
|
126
|
+
|
|
63
127
|
**Best practices**
|
|
64
128
|
|
|
65
129
|
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.
|
|
@@ -70,9 +134,13 @@ By specifying the initial scale and width, this tag guarantees that your content
|
|
|
70
134
|
<meta name="viewport" content="initial-scale=1.0, width=device-width" />
|
|
71
135
|
```
|
|
72
136
|
|
|
137
|
+
<meta name="viewport" content="initial-scale=1.0, width=device-width" />
|
|
138
|
+
|
|
73
139
|
## UIKIT CSS
|
|
74
140
|
|
|
75
|
-
|
|
141
|
+
**Managed**
|
|
142
|
+
|
|
143
|
+
> Recommended
|
|
76
144
|
|
|
77
145
|
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
146
|
|
|
@@ -80,18 +148,24 @@ You no longer need to manually add the CSS style tag to your index.html. Feel fr
|
|
|
80
148
|
|
|
81
149
|
> Note: Please note that every application and every widget must be wrapped with the <ApplicationLayout />, as it executes our init function.
|
|
82
150
|
|
|
83
|
-
|
|
151
|
+
**Manual**
|
|
152
|
+
|
|
153
|
+
Not Recommended
|
|
84
154
|
|
|
85
155
|
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
156
|
|
|
87
157
|
```html
|
|
88
|
-
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.
|
|
158
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/rio-uikit.css">
|
|
89
159
|
```
|
|
90
160
|
|
|
161
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/rio-uikit.css">
|
|
162
|
+
|
|
91
163
|
> 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
164
|
|
|
93
165
|
## Brand themes
|
|
94
166
|
|
|
167
|
+
Brand themes
|
|
168
|
+
|
|
95
169
|
In addition to the RIO theme, the UIKIT offers other brand-specific themes.
|
|
96
170
|
|
|
97
171
|
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.
|
|
@@ -99,18 +173,26 @@ These other themes may only be used for applications or services who don't run o
|
|
|
99
173
|
In order to use such a brand theme, modify the URL in the <link> tag that loads the CSS
|
|
100
174
|
|
|
101
175
|
```html
|
|
102
|
-
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.
|
|
176
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/vw-uikit.css">
|
|
103
177
|
```
|
|
104
178
|
|
|
179
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/vw-uikit.css">
|
|
180
|
+
|
|
105
181
|
```html
|
|
106
|
-
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.
|
|
182
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/man-uikit.css">
|
|
107
183
|
```
|
|
108
184
|
|
|
185
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/man-uikit.css">
|
|
186
|
+
|
|
109
187
|
```html
|
|
110
|
-
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.
|
|
188
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/scania-uikit.css">
|
|
111
189
|
```
|
|
112
190
|
|
|
113
|
-
|
|
191
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/scania-uikit.css">
|
|
192
|
+
|
|
193
|
+
**Managed**
|
|
194
|
+
|
|
195
|
+
> Recommended
|
|
114
196
|
|
|
115
197
|
You can simply omit the <link> tag in your index.html altogether. The UIKIT will automatically load the correct CSS file for you.
|
|
116
198
|
|
|
@@ -118,32 +200,46 @@ You can simply omit the <link> tag in your index.html altogether. The UIKI
|
|
|
118
200
|
<html data-brand="vw">
|
|
119
201
|
```
|
|
120
202
|
|
|
203
|
+
<html data-brand="vw">
|
|
204
|
+
|
|
121
205
|
```html
|
|
122
206
|
<html data-brand="man">
|
|
123
207
|
```
|
|
124
208
|
|
|
209
|
+
<html data-brand="man">
|
|
210
|
+
|
|
125
211
|
```html
|
|
126
212
|
<html data-brand="scania">
|
|
127
213
|
```
|
|
128
214
|
|
|
215
|
+
<html data-brand="scania">
|
|
216
|
+
|
|
129
217
|
## Print styles
|
|
130
218
|
|
|
219
|
+
Print styles
|
|
220
|
+
|
|
131
221
|
The UIKIT supports simple print stylings in order to have printable content. See Print CSS
|
|
132
222
|
|
|
133
223
|
```html
|
|
134
|
-
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.
|
|
224
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/rio-uikit-print-utilities.css">
|
|
135
225
|
```
|
|
136
226
|
|
|
227
|
+
<link rel="stylesheet" type="text/css" href="https://uikit.developers.rio.cloud/2.4.0/rio-uikit-print-utilities.css">
|
|
228
|
+
|
|
137
229
|
## Additional styling information
|
|
138
230
|
|
|
231
|
+
Additional styling information
|
|
232
|
+
|
|
139
233
|
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
234
|
|
|
141
235
|
```html
|
|
142
|
-
https://uikit.developers.rio.cloud/2.
|
|
236
|
+
https://uikit.developers.rio.cloud/2.4.0/rio-uikit-colors.json
|
|
143
237
|
```
|
|
144
238
|
|
|
145
239
|
## Dark mode
|
|
146
240
|
|
|
241
|
+
Dark mode
|
|
242
|
+
|
|
147
243
|
The UIKIT is fully dark mode ready.
|
|
148
244
|
|
|
149
245
|
> Note: Please note that every application and every widget must be wrapped with the <ApplicationLayout /> as it executes our init function.
|
|
@@ -159,18 +255,52 @@ The UIKIT is fully dark mode ready.
|
|
|
159
255
|
</ApplicationLayout>
|
|
160
256
|
```
|
|
161
257
|
|
|
258
|
+
<ApplicationLayout>
|
|
259
|
+
|
|
260
|
+
<ApplicationLayout.Header>
|
|
261
|
+
|
|
262
|
+
<ApplicationHeader label='RIO Service' navItems={navItems} />
|
|
263
|
+
|
|
264
|
+
</ApplicationLayout.Header>
|
|
265
|
+
|
|
266
|
+
<ApplicationLayout.Body>
|
|
267
|
+
|
|
268
|
+
<div>
|
|
269
|
+
|
|
270
|
+
My application
|
|
271
|
+
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
</ApplicationLayout.Body>
|
|
275
|
+
|
|
276
|
+
</ApplicationLayout>
|
|
277
|
+
|
|
162
278
|
```jsx
|
|
163
279
|
<ApplicationLayout>
|
|
164
280
|
<div>My widget</div>
|
|
165
281
|
</ApplicationLayout>
|
|
166
282
|
```
|
|
167
283
|
|
|
284
|
+
<ApplicationLayout>
|
|
285
|
+
|
|
286
|
+
<div>
|
|
287
|
+
|
|
288
|
+
My widget
|
|
289
|
+
|
|
290
|
+
</div>
|
|
291
|
+
|
|
292
|
+
</ApplicationLayout>
|
|
293
|
+
|
|
168
294
|
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
295
|
|
|
170
296
|
```html
|
|
171
|
-
<script src="https://uikit.developers.rio.cloud/2.
|
|
297
|
+
<script src="https://uikit.developers.rio.cloud/2.4.0/rio-darkmode.js"></script>
|
|
172
298
|
```
|
|
173
299
|
|
|
300
|
+
<script src="https://uikit.developers.rio.cloud/2.4.0/rio-darkmode.js">
|
|
301
|
+
|
|
302
|
+
</script>
|
|
303
|
+
|
|
174
304
|
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
305
|
|
|
176
306
|
To manually enable dark mode when testing your application locally, adddata-theme="dark" to the <html> tag.
|
|
@@ -184,4 +314,16 @@ peerDependencies
|
|
|
184
314
|
```javascript
|
|
185
315
|
"react": ">=18.0.0"
|
|
186
316
|
"react-dom": ">=18.0.0"
|
|
187
|
-
```
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
"react"
|
|
320
|
+
|
|
321
|
+
:
|
|
322
|
+
|
|
323
|
+
">=18.0.0"
|
|
324
|
+
|
|
325
|
+
"react-dom"
|
|
326
|
+
|
|
327
|
+
:
|
|
328
|
+
|
|
329
|
+
">=18.0.0"
|
package/dist/docs/start/intro.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Welcome
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#/start/intro
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-04-27T14:57:04.390Z
|
|
7
7
|
|
|
8
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
9
|
|
|
@@ -24,14 +24,38 @@ justify-content: center;
|
|
|
24
24
|
}
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
+
.my-container
|
|
28
|
+
|
|
29
|
+
{
|
|
30
|
+
|
|
31
|
+
display
|
|
32
|
+
|
|
33
|
+
:
|
|
34
|
+
|
|
35
|
+
;
|
|
36
|
+
|
|
37
|
+
justify-content
|
|
38
|
+
|
|
39
|
+
:
|
|
40
|
+
|
|
41
|
+
;
|
|
42
|
+
|
|
43
|
+
}
|
|
44
|
+
|
|
27
45
|
Simply apply the atomic classes:
|
|
28
46
|
|
|
29
47
|
```html
|
|
30
48
|
<div class="display-flex justify-content-center">...</div>
|
|
31
49
|
```
|
|
32
50
|
|
|
51
|
+
<div class="display-flex justify-content-center">
|
|
52
|
+
|
|
53
|
+
</div>
|
|
54
|
+
|
|
33
55
|
## Use React components for structure
|
|
34
56
|
|
|
57
|
+
Our library also includes a range of React components that serve as building blocks for your application. These components are designed to work seamlessly with the CSS classes, allowing you to:
|
|
58
|
+
|
|
35
59
|
- Quickly build UIs using pre-built components like the buttons, selects, and dialogs
|
|
36
60
|
- Combine React components with CSS classes to create complex layouts with minimal custom code
|
|
37
61
|
- Extend your layouts by composing React components while using utility classes to tweak the design where necessary
|
|
@@ -40,4 +64,18 @@ Simply apply the atomic classes:
|
|
|
40
64
|
|
|
41
65
|
- 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
66
|
- 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
|
|
67
|
+
- 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
|
|
68
|
+
|
|
69
|
+
EfficiencyOur 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.
|
|
70
|
+
|
|
71
|
+
Design flexibilityWhen design changes occur, updating the UIKIT, a single CSS class or React component ensures that your entire project is updated without manual intervention
|
|
72
|
+
|
|
73
|
+
Better collaborationBy 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
|
|
74
|
+
|
|
75
|
+
By combining atomic CSS classes and React components, you can create powerful, flexible user interfaces with ease, all while ensuring consistency and maintainability. Happy building!
|
|
76
|
+
|
|
77
|
+
What is new?ChangelogRelease notes for each version of the UIKIT.How can I use it?How to use itInstructions on how to integrate it.Questions about the UIKIT?#rio-uikitPlease post your question on Slack.
|
|
78
|
+
|
|
79
|
+
We welcome any feedback to improve the UIKIT further. Please send it to uxui@rio.cloud
|
|
80
|
+
|
|
81
|
+
The RIO UIKIT is licensed under the Apache 2.0 license by TB Digital Services GmbH | version 2.4.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Guidelines
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#/start/responsiveness
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-04-27T14:57:04.420Z
|
|
7
7
|
|
|
8
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
9
|
|
|
@@ -11,16 +11,32 @@ The UIKIT considers all platforms — both desktop and mobile. We recognize that
|
|
|
11
11
|
|
|
12
12
|
## Principal
|
|
13
13
|
|
|
14
|
+
"We believe that people should have a high-quality experience that scales across all platforms."
|
|
15
|
+
|
|
14
16
|
To build for all platforms, there are a lot of options and tools that can be used.
|
|
15
17
|
|
|
16
18
|
## Layout
|
|
17
19
|
|
|
18
20
|
**Fluid container**
|
|
19
21
|
|
|
22
|
+
The UIKIT used a fluid container by default that adapts to the various screen sizes. It also offers various fluid container sizes that shall suit your needs. Checkout the container documentation.
|
|
23
|
+
|
|
20
24
|
**Responsive grid systems**
|
|
21
25
|
|
|
22
26
|
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
27
|
|
|
28
|
+
Cols
|
|
29
|
+
|
|
30
|
+
For that, the UIKIT offers the twelve-column col system that is derived from Bootstraps col system. The Col documentation also lists all responsive column classes ranging from xs to xl.Responsive col classes and their breakpoints:Responsive...-xs-......-ls-......-sm-......-md-......-lg-......-xl-...Range0to∞480pxto∞768pxto∞992pxto∞1200pxto∞1700pxto∞
|
|
31
|
+
|
|
32
|
+
Grid
|
|
33
|
+
|
|
34
|
+
Additionally, you can also use the responsive classes for the CSS grid that also uses a twelve-column system. GridResponsive grid classes and their breakpoints:Responsive...-xs...-ls...-sm...-md...-lg...-xlRange0to480px480pxto∞768pxto∞992pxto∞1200pxto∞1700pxto∞
|
|
35
|
+
|
|
36
|
+
Flexbox
|
|
37
|
+
|
|
38
|
+
Using Flexbox is pretty common and allows you to handle elements to respect their container size to either shrink or grow. Also pretty useful to wrap elements around onto the next row in tight spaces. Using gap along with flex helps to space the elements evenly. You also might want to switch from flex row to flex column at a certain breakpoint via a simple responsive flex class.Responsive flexbox classes and their breakpoints:Responsive...-xs...-ls...-sm...-md...-lg...-xlRange0to480px480pxto∞768pxto∞992pxto∞1200pxto∞1700pxto∞
|
|
39
|
+
|
|
24
40
|
## Spacings & sizing
|
|
25
41
|
|
|
26
42
|
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.
|
|
@@ -77,6 +93,16 @@ See the full list of container query utilities in the Container queries section.
|
|
|
77
93
|
</div>
|
|
78
94
|
```
|
|
79
95
|
|
|
96
|
+
<div className="cq-container">
|
|
97
|
+
|
|
98
|
+
<div className="cq-300:flex-column cq-600:flex-row cq-300:padding-10">
|
|
99
|
+
|
|
100
|
+
<!-- content -->
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
80
106
|
In this example:
|
|
81
107
|
|
|
82
108
|
- The inner element uses a column layout when its container is at least 300px wide.
|