@rio-cloud/uikit-mcp 1.1.2 → 1.1.4
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/dist/doc-metadata.json +117 -127
- package/dist/docs/components/accentBar.md +2 -34
- package/dist/docs/components/activity.md +2 -13
- package/dist/docs/components/animatedNumber.md +4 -17
- package/dist/docs/components/animatedTextReveal.md +7 -54
- package/dist/docs/components/animations.md +42 -34
- package/dist/docs/components/appHeader.md +2 -73
- package/dist/docs/components/appLayout.md +36 -496
- package/dist/docs/components/appNavigationBar.md +2 -54
- package/dist/docs/components/areaCharts.md +37 -37
- package/dist/docs/components/aspectRatioPlaceholder.md +2 -11
- package/dist/docs/components/assetTree.md +435 -901
- package/dist/docs/components/autosuggests.md +4 -4
- package/dist/docs/components/avatar.md +2 -24
- package/dist/docs/components/banner.md +2 -2
- package/dist/docs/components/barCharts.md +186 -186
- package/dist/docs/components/barList.md +12 -46
- package/dist/docs/components/basicMap.md +7 -7
- package/dist/docs/components/bottomSheet.md +3 -100
- package/dist/docs/components/button.md +16 -71
- package/dist/docs/components/buttonToolbar.md +2 -9
- package/dist/docs/components/calendarStripe.md +95 -121
- package/dist/docs/components/card.md +2 -10
- 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 +4 -1
- package/dist/docs/components/checkbox.md +11 -111
- package/dist/docs/components/clearableInput.md +7 -111
- package/dist/docs/components/collapse.md +3 -29
- package/dist/docs/components/composedCharts.md +31 -31
- package/dist/docs/components/contentLoader.md +104 -122
- package/dist/docs/components/dataTabs.md +24 -194
- package/dist/docs/components/datepickers.md +727 -769
- package/dist/docs/components/dialogs.md +15 -262
- package/dist/docs/components/divider.md +2 -14
- package/dist/docs/components/dropdowns.md +4387 -4550
- package/dist/docs/components/editableContent.md +2 -186
- package/dist/docs/components/expander.md +23 -70
- package/dist/docs/components/fade.md +6 -41
- package/dist/docs/components/fadeExpander.md +2 -11
- package/dist/docs/components/fadeUp.md +3 -23
- package/dist/docs/components/feedback.md +2 -42
- package/dist/docs/components/filePickers.md +2 -44
- package/dist/docs/components/formLabel.md +2 -18
- package/dist/docs/components/groupedItemList.md +2 -53
- package/dist/docs/components/iconList.md +3 -3
- package/dist/docs/components/imagePreloader.md +2 -6
- package/dist/docs/components/labeledElement.md +2 -11
- package/dist/docs/components/licensePlate.md +2 -10
- package/dist/docs/components/lineCharts.md +60 -60
- package/dist/docs/components/listMenu.md +2 -50
- package/dist/docs/components/loadMore.md +2 -28
- package/dist/docs/components/mainNavigation.md +1 -1
- package/dist/docs/components/mapCircle.md +3 -3
- package/dist/docs/components/mapCluster.md +5 -5
- package/dist/docs/components/mapContext.md +3 -3
- package/dist/docs/components/mapDraggableMarker.md +3 -3
- package/dist/docs/components/mapGettingStarted.md +1 -1
- package/dist/docs/components/mapInfoBubble.md +3 -3
- package/dist/docs/components/mapLayerGroup.md +3 -3
- package/dist/docs/components/mapMarker.md +341 -347
- package/dist/docs/components/mapPolygon.md +20 -24
- package/dist/docs/components/mapRoute.md +26 -32
- package/dist/docs/components/mapRouteGenerator.md +1 -1
- package/dist/docs/components/mapSettings.md +273 -284
- package/dist/docs/components/mapUtils.md +3 -5
- package/dist/docs/components/multiselects.md +1 -1
- package/dist/docs/components/noData.md +2 -22
- package/dist/docs/components/notifications.md +1 -1
- package/dist/docs/components/numbercontrol.md +2 -48
- package/dist/docs/components/onboarding.md +2 -46
- package/dist/docs/components/page.md +2 -32
- package/dist/docs/components/pager.md +2 -14
- package/dist/docs/components/pieCharts.md +125 -157
- package/dist/docs/components/popover.md +2 -56
- package/dist/docs/components/position.md +2 -10
- package/dist/docs/components/radialBarCharts.md +506 -506
- package/dist/docs/components/radiobutton.md +81 -191
- package/dist/docs/components/releaseNotes.md +1 -12
- package/dist/docs/components/resizer.md +2 -14
- package/dist/docs/components/responsiveColumnStripe.md +2 -19
- package/dist/docs/components/responsiveVideo.md +2 -11
- package/dist/docs/components/rioglyph.md +2 -12
- package/dist/docs/components/rules.md +69 -133
- package/dist/docs/components/saveableInput.md +279 -393
- package/dist/docs/components/selects.md +9996 -15
- package/dist/docs/components/sidebar.md +2 -39
- package/dist/docs/components/sliders.md +2 -37
- package/dist/docs/components/smoothScrollbars.md +2 -56
- package/dist/docs/components/spinners.md +5 -51
- package/dist/docs/components/states.md +21 -245
- package/dist/docs/components/statsWidgets.md +2 -113
- package/dist/docs/components/statusBar.md +2 -28
- package/dist/docs/components/stepButton.md +2 -8
- package/dist/docs/components/steppedProgressBars.md +2 -66
- package/dist/docs/components/subNavigation.md +1 -8
- package/dist/docs/components/supportMarker.md +1 -1
- package/dist/docs/components/svgImage.md +2 -12
- package/dist/docs/components/switch.md +2 -11
- package/dist/docs/components/tables.md +1 -1
- package/dist/docs/components/tagManager.md +4 -58
- package/dist/docs/components/tags.md +2 -31
- package/dist/docs/components/teaser.md +2 -30
- package/dist/docs/components/timeline.md +1 -1
- package/dist/docs/components/timepicker.md +2 -26
- package/dist/docs/components/toggleButton.md +7 -29
- package/dist/docs/components/tooltip.md +9 -40
- package/dist/docs/components/virtualList.md +73 -99
- package/dist/docs/foundations.md +167 -167
- package/dist/docs/start/changelog.md +23 -1
- package/dist/docs/start/goodtoknow.md +1 -1
- package/dist/docs/start/guidelines/color-combinations.md +1 -1
- package/dist/docs/start/guidelines/custom-css.md +1 -1
- package/dist/docs/start/guidelines/custom-rioglyph.md +1 -1
- package/dist/docs/start/guidelines/formatting.md +1 -1
- package/dist/docs/start/guidelines/iframe.md +80 -27
- package/dist/docs/start/guidelines/obfuscate-data.md +1 -1
- package/dist/docs/start/guidelines/print-css.md +1 -1
- package/dist/docs/start/guidelines/spinner.md +81 -81
- package/dist/docs/start/guidelines/supported-browsers.md +1 -1
- package/dist/docs/start/guidelines/writing.md +1 -1
- package/dist/docs/start/howto.md +9 -9
- package/dist/docs/start/intro.md +1 -1
- package/dist/docs/start/responsiveness.md +1 -1
- package/dist/docs/templates/common-table.md +11 -11
- package/dist/docs/templates/detail-views.md +2 -2
- package/dist/docs/templates/expandable-details.md +1 -1
- package/dist/docs/templates/feature-cards.md +55 -55
- package/dist/docs/templates/form-summary.md +22 -22
- package/dist/docs/templates/form-toggle.md +1 -1
- package/dist/docs/templates/list-blocks.md +200 -200
- package/dist/docs/templates/loading-progress.md +3 -3
- package/dist/docs/templates/options-panel.md +1 -1
- package/dist/docs/templates/panel-variants.md +1 -1
- package/dist/docs/templates/progress-cards.md +1 -1
- package/dist/docs/templates/progress-success.md +1 -1
- package/dist/docs/templates/settings-form.md +23 -23
- package/dist/docs/templates/stats-blocks.md +41 -41
- package/dist/docs/templates/table-panel.md +1 -1
- package/dist/docs/templates/table-row-animation.md +1 -1
- package/dist/docs/templates/usage-cards.md +1 -1
- package/dist/docs/utilities/deviceUtils.md +6 -3
- package/dist/docs/utilities/featureToggles.md +1 -1
- package/dist/docs/utilities/fuelTypeUtils.md +1 -1
- package/dist/docs/utilities/routeUtils.md +59 -23
- 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/useCount.md +1 -1
- package/dist/docs/utilities/useDarkMode.md +1 -1
- package/dist/docs/utilities/useDebugInfo.md +4 -4
- 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 +7 -5
- 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 +1 -1
- package/dist/docs/utilities/useResizeObserver.md +1 -1
- package/dist/docs/utilities/useScrollPosition.md +1 -1
- package/dist/docs/utilities/useSearch.md +1 -1
- package/dist/docs/utilities/useSorting.md +1 -1
- package/dist/docs/utilities/useStateWithValidation.md +1 -1
- package/dist/docs/utilities/useSum.md +1 -1
- package/dist/docs/utilities/useTableExport.md +54 -54
- package/dist/docs/utilities/useTableSelection.md +93 -93
- package/dist/docs/utilities/useTimeout.md +1 -1
- package/dist/docs/utilities/useToggle.md +1 -1
- package/dist/docs/utilities/useWindowResize.md +1 -1
- package/dist/index.mjs +8 -2
- package/dist/version.json +2 -2
- package/package.json +8 -8
- package/dist/docs/components/fullscreenMap.md +0 -10
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Map
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/mapUtils
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:08:14.242Z
|
|
7
7
|
|
|
8
8
|
## Map utils
|
|
9
9
|
|
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
import { useRef, useState } from 'react';
|
|
13
13
|
import { isEqual } from 'es-toolkit/compat';
|
|
14
14
|
|
|
15
|
-
// biome-ignore lint/suspicious/noShadowRestrictedNames: <explanation>
|
|
16
15
|
import Map from '@rio-cloud/rio-uikit/Map';
|
|
17
16
|
import EventUtils from '@rio-cloud/rio-uikit/EventUtils';
|
|
18
17
|
import type { MapApi, MapEvent, Position } from '@rio-cloud/rio-uikit/mapTypes';
|
|
@@ -29,7 +28,7 @@ const eventListenerMap = {
|
|
|
29
28
|
// The View model contains all relevant map data like zoom, position or bounding box.
|
|
30
29
|
// Note: Working with the ViewModel directly requires to round zoom values or to exclude
|
|
31
30
|
// other props from position object. Better, use map utils instead.
|
|
32
|
-
const target = event.currentTarget;
|
|
31
|
+
const target = event.currentTarget as H.Map;
|
|
33
32
|
const lookAtData = target.getViewModel().getLookAtData();
|
|
34
33
|
|
|
35
34
|
console.log({ lookAtData });
|
|
@@ -74,7 +73,6 @@ return null;
|
|
|
74
73
|
import { useRef, useState } from 'react';
|
|
75
74
|
import { isEqual } from 'es-toolkit/compat';
|
|
76
75
|
|
|
77
|
-
// biome-ignore lint/suspicious/noShadowRestrictedNames: <explanation>
|
|
78
76
|
import Map from '@rio-cloud/rio-uikit/Map';
|
|
79
77
|
import EventUtils from '@rio-cloud/rio-uikit/EventUtils';
|
|
80
78
|
import type { MapApi, MapEvent, Position } from '@rio-cloud/rio-uikit/mapTypes';
|
|
@@ -91,7 +89,7 @@ const eventListenerMap = {
|
|
|
91
89
|
// The View model contains all relevant map data like zoom, position or bounding box.
|
|
92
90
|
// Note: Working with the ViewModel directly requires to round zoom values or to exclude
|
|
93
91
|
// other props from position object. Better, use map utils instead.
|
|
94
|
-
const target = event.currentTarget;
|
|
92
|
+
const target = event.currentTarget as H.Map;
|
|
95
93
|
const lookAtData = target.getViewModel().getLookAtData();
|
|
96
94
|
|
|
97
95
|
console.log({ lookAtData });
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Selection
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/multiselects
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:19.246Z
|
|
7
7
|
|
|
8
8
|
The Multiselect component is a form control and is intended to be used within forms. It's designed to be used instead of native HTML Select which cannot be styled and are rendered by each browser differently.
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Content
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/noData
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:33.012Z
|
|
7
7
|
|
|
8
8
|
## NoData
|
|
9
9
|
|
|
@@ -83,16 +83,6 @@ export default () => (
|
|
|
83
83
|
</div>
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
#### Props
|
|
87
|
-
|
|
88
|
-
| Name | Type | Default | Description |
|
|
89
|
-
| --- | --- | --- | --- |
|
|
90
|
-
| text | String / Node | — | The actual translated "No data" text. |
|
|
91
|
-
| tooltip | String / Node | — | Additional explanation shown inside a tooltip. |
|
|
92
|
-
| tooltipPlacement | String | bottom | Sets the direction the Tooltip is positioned towards. Possible values are: auto-start, auto, auto-end, top-start, top, top-end, bottom-start, bottom, bottom-end, right-start, right, right-end, left-start, left or left-end |
|
|
93
|
-
| tooltipWidth | String | auto | Possible values are: auto, 100, 150, 200, 250, 300, 350, 400, 450, 500 |
|
|
94
|
-
| className | String | — | Additional class names to be added to the wrapping element. |
|
|
95
|
-
|
|
96
86
|
### Example: Example 2
|
|
97
87
|
|
|
98
88
|
NoData in tablesColumn 1Column 2Column 3
|
|
@@ -197,14 +187,4 @@ export default () => (
|
|
|
197
187
|
</tr>
|
|
198
188
|
</tbody>
|
|
199
189
|
</table>
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
#### Props
|
|
203
|
-
|
|
204
|
-
| Name | Type | Default | Description |
|
|
205
|
-
| --- | --- | --- | --- |
|
|
206
|
-
| text | String / Node | — | The actual translated "No data" text. |
|
|
207
|
-
| tooltip | String / Node | — | Additional explanation shown inside a tooltip. |
|
|
208
|
-
| tooltipPlacement | String | bottom | Sets the direction the Tooltip is positioned towards. Possible values are: auto-start, auto, auto-end, top-start, top, top-end, bottom-start, bottom, bottom-end, right-start, right, right-end, left-start, left or left-end |
|
|
209
|
-
| tooltipWidth | String | auto | Possible values are: auto, 100, 150, 200, 250, 300, 350, 400, 450, 500 |
|
|
210
|
-
| className | String | — | Additional class names to be added to the wrapping element. |
|
|
190
|
+
```
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/notifications
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:45.676Z
|
|
7
7
|
|
|
8
8
|
Hint:Notifications need to be wrapped by a NotificationsContainer inside your application layout body.
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Interaction
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/numbercontrol
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:03.349Z
|
|
7
7
|
|
|
8
8
|
## NumberInput
|
|
9
9
|
|
|
@@ -321,29 +321,6 @@ export default () => {
|
|
|
321
321
|
</div>
|
|
322
322
|
```
|
|
323
323
|
|
|
324
|
-
#### Props
|
|
325
|
-
|
|
326
|
-
| Name | Type | Default | Description |
|
|
327
|
-
| --- | --- | --- | --- |
|
|
328
|
-
| min | Number | 0 | The minimum value of the input. |
|
|
329
|
-
| max | Number | Number.MAX_VALUE | The maximum value of the input. |
|
|
330
|
-
| value | Number | 0 | The initial value of the input. |
|
|
331
|
-
| step | Number | 1 | The size of increment or decrement (only works with number type). |
|
|
332
|
-
| digitPrecision | Number | 3 | Number of digits after the comma the value should be fixed to. |
|
|
333
|
-
| disabled | Boolean | false | Enables or disabled the input. |
|
|
334
|
-
| onChange | (value?: number) => void | — | Callback function fired when the value of the input changes. |
|
|
335
|
-
| onKeyDown | (event: React.KeyboardEvent<HTMLInputElement>) => void | — | Callback function that gets triggered after filtering out invalid key strokes. |
|
|
336
|
-
| bsSize | 'sm' \| 'md' \| 'lg' | 'md' | Defines the size of the input to be rendered. Possible values are: 'sm' 'md'or 'lg' |
|
|
337
|
-
| unit | String / Node | — | A unit for this value. This will be shown in a dedicated input addon. |
|
|
338
|
-
| errorMessage | String | — | Optional error message. |
|
|
339
|
-
| warningMessage | String | — | Optional warning message. |
|
|
340
|
-
| messageWhiteSpace | 'normal' \| 'prewrap' \| 'nowrap' | 'normal' | Optional warning message white-space. |
|
|
341
|
-
| inputAddon | String | — | A rioglyph icon tio be shown in front of the input. |
|
|
342
|
-
| placeholder | String | — | The input placeholder if no value is given. |
|
|
343
|
-
| noDefault | Boolean | false | Lets you omit the default value of "0" when the vale is not defined. The input will be empty in this case. |
|
|
344
|
-
| ref | React.ref | — | A ref function assigned to the wrapper element. |
|
|
345
|
-
| className | String | — | Additional classes to be set on the component. |
|
|
346
|
-
|
|
347
324
|
## NumberControl
|
|
348
325
|
|
|
349
326
|
### Example: Example 2
|
|
@@ -680,27 +657,4 @@ export default () => (
|
|
|
680
657
|
</div>
|
|
681
658
|
</div>
|
|
682
659
|
</div>
|
|
683
|
-
```
|
|
684
|
-
|
|
685
|
-
#### Props
|
|
686
|
-
|
|
687
|
-
| Name | Type | Default | Description |
|
|
688
|
-
| --- | --- | --- | --- |
|
|
689
|
-
| min | Number | 0 | The minimum value of the input. |
|
|
690
|
-
| max | Number | Number.MAX_VALUE | The maximum value of the input. |
|
|
691
|
-
| value | Number | 0 | The initial value of the input. |
|
|
692
|
-
| step | Number | 1 | The size of increment or decrement (only works with number type). |
|
|
693
|
-
| digitPrecision | Number | 3 | Number of digits after the comma the value should be fixed to. |
|
|
694
|
-
| disabled | Boolean | false | Enables or disabled the input. |
|
|
695
|
-
| onChange | (value?: number) => void | — | Callback function fired when the value of the input changes. |
|
|
696
|
-
| onKeyDown | (event: React.KeyboardEvent<HTMLInputElement>) => void | — | Callback function that gets triggered after filtering out invalid key strokes. |
|
|
697
|
-
| bsSize | 'sm' \| 'md' \| 'lg' | 'md' | Defines the size of the input to be rendered. Possible values are: 'sm' 'md'or 'lg' |
|
|
698
|
-
| unit | String / Node | — | A unit for this value. This will be shown in a dedicated input addon. |
|
|
699
|
-
| errorMessage | String | — | Optional error message. |
|
|
700
|
-
| warningMessage | String | — | Optional warning message. |
|
|
701
|
-
| messageWhiteSpace | 'normal' \| 'prewrap' \| 'nowrap' | 'normal' | Optional warning message white-space. |
|
|
702
|
-
| inputAddon | String | — | A rioglyph icon tio be shown in front of the input. |
|
|
703
|
-
| placeholder | String | — | The input placeholder if no value is given. |
|
|
704
|
-
| noDefault | Boolean | false | Lets you omit the default value of "0" when the vale is not defined. The input will be empty in this case. |
|
|
705
|
-
| ref | React.ref | — | A ref function assigned to the wrapper element. |
|
|
706
|
-
| className | String | — | Additional classes to be set on the component. |
|
|
660
|
+
```
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/onboarding
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:45.796Z
|
|
7
7
|
|
|
8
8
|
Useful when you want to control a single tooltip that highlights a portion of the UI.
|
|
9
9
|
|
|
@@ -83,24 +83,6 @@ export default () => {
|
|
|
83
83
|
};
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
#### Props
|
|
87
|
-
|
|
88
|
-
| Name | Type | Default | Description |
|
|
89
|
-
| --- | --- | --- | --- |
|
|
90
|
-
| id | String | — | The id of the DOM element. |
|
|
91
|
-
| show | Boolean | false | Indicates whether the onboarding tip is shown. |
|
|
92
|
-
| showCloseIcon | Boolean | true | Defines whether to show a close icon. |
|
|
93
|
-
| textAlignment | String | OnboardingTip.TEXT_ALIGNMENT_LEFT | Define how the text should be aligned. Possible values are: OnboardingTip.TEXT_ALIGNMENT_LEFT OnboardingTip.TEXT_ALIGNMENT_CENTER OnboardingTip.TEXT_ALIGNMENT_RIGHT |
|
|
94
|
-
| width | Number | — | Possible values are: auto, 100, 150, 200, 250, 300, 350, 400, 450 or 500 |
|
|
95
|
-
| onHide | Function | () => {} | Callback function for when the component shall be hidden. |
|
|
96
|
-
| useInDialog | Boolean | false | Changes the z-index. |
|
|
97
|
-
| className | String | — | Additional classes to be set on the wrapper element. |
|
|
98
|
-
| title | String / Node | — | The title of the onboarding tip. |
|
|
99
|
-
| content | String / Node | — | The content of the onboarding tip. |
|
|
100
|
-
| preventOverflow | Boolean | true | Prevents Onboarding tips from being cut off horizontally at screen borders. |
|
|
101
|
-
| popperConfig | Object | — | A Popper.js config object passed to the the underlying popper instance. |
|
|
102
|
-
| placement | String | OnboardingTip.BOTTOM | Define how the component should be placed. Possible values are: auto-start, auto, auto-end, top-start, top, top-end, bottom-start, bottom, bottom-end, right-start, right, right-end, left-start, left or left-end |
|
|
103
|
-
|
|
104
86
|
## Onboarding tour
|
|
105
87
|
|
|
106
88
|
When you want to guide the user through a "tour" with multiple steps explaining individual features or UI elements. The behavior of the whole tour and individual steps can be controlled declaratively.
|
|
@@ -268,30 +250,4 @@ export default () => {
|
|
|
268
250
|
</div>
|
|
269
251
|
);
|
|
270
252
|
};
|
|
271
|
-
```
|
|
272
|
-
|
|
273
|
-
#### Props
|
|
274
|
-
|
|
275
|
-
| Name | Type | Default | Description |
|
|
276
|
-
| --- | --- | --- | --- |
|
|
277
|
-
| steps | OnboardingStep[] | — | Array of steps to highlight. This should be passed when setting up a product tour. |
|
|
278
|
-
| └element | String | — | The target element to highlight. This can be a DOM element (ref), a function that returns a DOM element, or a CSS selector (most likely, you want to go with a selector as it's the easiest one to implement). If no element is given, the popover will simply be centered on the screen. |
|
|
279
|
-
| └popover | Object | — | Defines the content and appearance of the popover using those properties: title: Title text to be shown. description: Description text to be shown. side: The position of the popover relative to the target element. align: Where the popover is anchored to the target element. showButtons: The buttons that should be shown in the popover - for this step only. disableButtons: The buttons that should be disabled in the popover - for this step only. disableActiveInteraction: Whether to disable interaction with the highlighted element. popoverClass: Custom class to add to the popover element. prevBtnText: Text to use for the "previous" button - specific for this step only. nextBtnText: Text to use for the "next" button - specific for this step only. doneBtnText: Text to use for the "done" (a.k.a. the final "next") button - specific for this step only. |
|
|
280
|
-
| └onHighlightStarted | Function | — | Callback triggered when the highlighting is about to become visible. |
|
|
281
|
-
| └onHighlighted | Function | — | Callback triggered when the highlight is visible. |
|
|
282
|
-
| └onDeselected | Function | — | Callback triggered when the highlight is about to become invisible. |
|
|
283
|
-
| showButtons | AllowedButtons[] | ["next", "previous", "close"] | Array of buttons to show in the popover. Defaults to ["next", "previous", "close"] for product tours and [] for single element highlighting. |
|
|
284
|
-
| disableButtons | AllowedButtons[] | — | Array of buttons to disable. Useful when you want to show some buttons but disable others. |
|
|
285
|
-
| prevBtnText | String | Previous | Text to use for the "previous" buttons. |
|
|
286
|
-
| nextBtnText | String | Next | Text to use for the "next" buttons. |
|
|
287
|
-
| doneBtnText | String | Done | Text to use for the "done" button. |
|
|
288
|
-
| showProgress | Boolean | true | Indicates whether to show progress in the onboarding popover. |
|
|
289
|
-
| allowClose | Boolean | false | Whether to allow closing the popover by clicking on the backdrop. |
|
|
290
|
-
| stagePadding | Number | 10 | Distance between the highlighted element and the cutout. |
|
|
291
|
-
| stageRadius | Number | 5 | Radius of the cutout around the highlighted element. |
|
|
292
|
-
| allowKeyboardControl | Boolean | true | Whether to allow keyboard navigation. |
|
|
293
|
-
| disableActiveInteraction | Boolean | false | Whether to disable interaction with the highlighted element. Can be configured at the step level as well |
|
|
294
|
-
| noBackdrop | Boolean | false | Option to disable the backdrop. The backdrop element is still there but with 100% opacity and the close on the backdrop is disabled. |
|
|
295
|
-
| popoverClass | String | — | Additional classes set on the popover itself. |
|
|
296
|
-
| onPopoverRender | Function | — | Callback triggered when the onboarding popover renders. |
|
|
297
|
-
| onDestroyed | Function | — | Callback triggered when the onboarding tour is "destroyed" (dismissed). |
|
|
253
|
+
```
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Content
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/page
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:34.589Z
|
|
7
7
|
|
|
8
8
|
## Page
|
|
9
9
|
|
|
@@ -93,16 +93,6 @@ export default () => (
|
|
|
93
93
|
</div>
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
#### Props
|
|
97
|
-
|
|
98
|
-
| Name | Type | Default | Description |
|
|
99
|
-
| --- | --- | --- | --- |
|
|
100
|
-
| width | Number | — | Defines the width in pixel of the page. In landscape mode, the width is set as height. The component uses internally the aspect-ratio of a standard DIN A4 page.Please make sure the element does not get stretched when using flexbox. |
|
|
101
|
-
| orientation | 'portrait' \| 'landscape' | portrait | Defines the layout of the page |
|
|
102
|
-
| shadow | Boolean | true | Defines to use a pre-defined shadow style. May be disabled on white background. |
|
|
103
|
-
| border | Boolean | — | Defines to use a pre-defined border style. This may be used to render the page on a white background of as part of another element like a panel. |
|
|
104
|
-
| className | String | — | Additional classes to be set on the wrapper element |
|
|
105
|
-
|
|
106
96
|
### Example: Page 1
|
|
107
97
|
|
|
108
98
|
Page 1
|
|
@@ -178,16 +168,6 @@ export default () => (
|
|
|
178
168
|
</div>
|
|
179
169
|
```
|
|
180
170
|
|
|
181
|
-
#### Props
|
|
182
|
-
|
|
183
|
-
| Name | Type | Default | Description |
|
|
184
|
-
| --- | --- | --- | --- |
|
|
185
|
-
| width | Number | — | Defines the width in pixel of the page. In landscape mode, the width is set as height. The component uses internally the aspect-ratio of a standard DIN A4 page.Please make sure the element does not get stretched when using flexbox. |
|
|
186
|
-
| orientation | 'portrait' \| 'landscape' | portrait | Defines the layout of the page |
|
|
187
|
-
| shadow | Boolean | true | Defines to use a pre-defined shadow style. May be disabled on white background. |
|
|
188
|
-
| border | Boolean | — | Defines to use a pre-defined border style. This may be used to render the page on a white background of as part of another element like a panel. |
|
|
189
|
-
| className | String | — | Additional classes to be set on the wrapper element |
|
|
190
|
-
|
|
191
171
|
### Example: Portrait
|
|
192
172
|
|
|
193
173
|
Portrait
|
|
@@ -228,14 +208,4 @@ export default () => (
|
|
|
228
208
|
<div class="display-grid place-items-center height-100pct text-size-20 text-color-dark">Landscape</div>
|
|
229
209
|
</div>
|
|
230
210
|
</div>
|
|
231
|
-
```
|
|
232
|
-
|
|
233
|
-
#### Props
|
|
234
|
-
|
|
235
|
-
| Name | Type | Default | Description |
|
|
236
|
-
| --- | --- | --- | --- |
|
|
237
|
-
| width | Number | — | Defines the width in pixel of the page. In landscape mode, the width is set as height. The component uses internally the aspect-ratio of a standard DIN A4 page.Please make sure the element does not get stretched when using flexbox. |
|
|
238
|
-
| orientation | 'portrait' \| 'landscape' | portrait | Defines the layout of the page |
|
|
239
|
-
| shadow | Boolean | true | Defines to use a pre-defined shadow style. May be disabled on white background. |
|
|
240
|
-
| border | Boolean | — | Defines to use a pre-defined border style. This may be used to render the page on a white background of as part of another element like a panel. |
|
|
241
|
-
| className | String | — | Additional classes to be set on the wrapper element |
|
|
211
|
+
```
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Navigation
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/pager
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:56.678Z
|
|
7
7
|
|
|
8
8
|
## Pager
|
|
9
9
|
|
|
@@ -118,16 +118,4 @@ export default () => (
|
|
|
118
118
|
</div>
|
|
119
119
|
</div>
|
|
120
120
|
</div>
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
#### Props
|
|
124
|
-
|
|
125
|
-
| Name | Type | Default | Description |
|
|
126
|
-
| --- | --- | --- | --- |
|
|
127
|
-
| title | String / Node | — | The title or name of the section next/previous section. |
|
|
128
|
-
| label | String / Node | — | The optional label for the full variant. |
|
|
129
|
-
| alignRight | Boolean | false | Set right alignment for "previous" pager content to be aligned to the right side of the pager and the arrow on the left side. |
|
|
130
|
-
| disabled | Boolean | false | Sets the pager disabled. |
|
|
131
|
-
| variant | String | full | Define how large the component should be rendered. Possible values are: Pager.VARIANT_FULL, Pager.VARIANT_COMPACT, full, compact |
|
|
132
|
-
| onClick | Function | () => {} | Callback function for when the component is clicked. |
|
|
133
|
-
| className | String | — | Additional classes for the wrapper element. |
|
|
121
|
+
```
|