@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,27 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Welcome
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#start/changelog
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:48.579Z
|
|
7
|
+
|
|
8
|
+
## Version 2.1.0 (2026-01-13)
|
|
9
|
+
|
|
10
|
+
- **Fixed** Map context menu Fixed the typing for the ContextMenuItem component.
|
|
11
|
+
|
|
12
|
+
- **Fixed** Map route Fixed the typing for the arrowStyle prop of the Route component.
|
|
13
|
+
|
|
14
|
+
- **Fixed** Map SimpleClusterLayer type Fixed the typings for the SimpleClusterLayer component’s simpleTheme prop. Please use the new SimpleClusterTheme type instead of the ClusterTheme.
|
|
15
|
+
|
|
16
|
+
- **Fixed** Dialog Fixed broken fade animation of Dialogs in Firefox.
|
|
17
|
+
|
|
18
|
+
- **Fixed** TableSettingsDialog Fixed TableSettingsDialog so reset to default remains available after reopening when settings differ from defaults.
|
|
19
|
+
|
|
20
|
+
- **Fixed** Select Fixed select filter regressions where hitting ‘nothing found’ could leave the dropdown stuck or missing options. Backspacing or clearing now restores the full list and keeps keyboard focus/highlights in sync. Dropdown scroll now resets on reopen and keeps the keyboard-focused item in view when navigating up and down with the arrow keys.
|
|
21
|
+
|
|
22
|
+
- **Update** URL feature toggles Replaced the internal "qs" library used for parsing URL search parameters with the native URLSearchParams API, allowing us to remove the external dependency. This also solves the vulnerability issue with the "qs" library for this version.
|
|
23
|
+
|
|
24
|
+
- **Update** Tree Extended the Tree component to support custom external icon and logo URLs.
|
|
25
|
+
|
|
26
|
+
- **Demo** Updated the component prop documentation for most components by deriving it directly from the component type definitions and source files. This ensures more accurate documentation and reduces maintenance effort for the demo pages.
|
|
7
27
|
|
|
8
28
|
## Version 2.0.1 (2025-12-15)
|
|
9
29
|
|
|
@@ -37,6 +57,8 @@
|
|
|
37
57
|
|
|
38
58
|
- **Removed** OnboardingTip Removed deprecated prop "clickflow". Please use the "useOnboardingTour" hook instead.
|
|
39
59
|
|
|
60
|
+
- **Removed** Radiobutton Changed the onChange callback so it is only used in the controlled use case, as already documented in earlier versions. For uncontrolled usage, please use the onClick callback instead.
|
|
61
|
+
|
|
40
62
|
- **Removed** NumberInput / NumberControl Removed deprecated prop "onValueChanged". Please use "onChange" instead.
|
|
41
63
|
|
|
42
64
|
- **Removed** Sidebar Removed deprecated prop "enableNavigationButtons". Please use "headerButtons" instead. Removed deprecated prop "disableFullscreen". Please use "enableFullscreenToggle" instead. Removed deprecated prop "fullscreen". Please use "openInFullscreen" instead.
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Guidelines
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#start/guidelines/color-combinations
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:49.309Z
|
|
7
7
|
|
|
8
8
|
For accessibility purposes, aim for a good color contrast between the foreground color (e.g. text, links, etc.) and the background color. This contrast ensures people with moderately low vision can tell the colors apart and see your content.
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Guidelines
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#start/guidelines/custom-css
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:48.974Z
|
|
7
7
|
|
|
8
8
|
Maintaining CSS will become harder over time due to various reasons like growing amount of styles, old and unknown overwrites, exchange of Team members etc.
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Guidelines
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#start/guidelines/custom-rioglyph
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:48.993Z
|
|
7
7
|
|
|
8
8
|
To use a custom Rioglyph icon, there are two different approaches:
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Guidelines
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#start/guidelines/formatting
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:50.711Z
|
|
7
7
|
|
|
8
8
|
Having a common date formatting guide is crucial to ensure consistency, clarity, and accuracy in documentation, making it easier to understand and interpret dates correctly across different contexts.
|
|
9
9
|
|
|
@@ -3,29 +3,68 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Guidelines
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#start/guidelines/iframe
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:50.652Z
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Web applications can embed smaller SPAs as widgets using an <iframe> to enrich it's functionality provided by other services and teams. This page explains what the parent application (host) and the child application (widget) must do to ensure correct styling, sizing, and communication.
|
|
9
9
|
|
|
10
10
|
## Iframe guidelines
|
|
11
11
|
|
|
12
12
|
## Working with iframes
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
## Terminology
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
- Parent application: the host SPA that renders the <iframe>.
|
|
17
|
+
- Widget (child application): the small SPA running inside the iframe.
|
|
18
|
+
- Iframe integration: layout, sizing, and communication between parent and widget.
|
|
17
19
|
|
|
18
|
-
|
|
20
|
+
## Enable widget-specific styling
|
|
19
21
|
|
|
20
|
-
|
|
22
|
+
If an application is shipped as a widget (i.e., it is meant to be embedded into other applications via an iframe), the widget must mark itself accordingly by adding the classis-iframe-widget to the document’s <html> element.
|
|
23
|
+
|
|
24
|
+
**Who needs to add this?**
|
|
25
|
+
|
|
26
|
+
The child application (widget) must add <html class="is-iframe-widget">. The parent application typically cannot (and should not) modify the widget’s HTML root.
|
|
27
|
+
|
|
28
|
+
## What the window-iframe is and why the RIO Pageloader matters
|
|
29
|
+
|
|
30
|
+
The RIO UIKIT uses the class window-iframe on the <html> element to enable iframe-specific baseline styles. This helps widgets render cleanly when embedded (for example, ensuring the document background behaves correctly in an iframe context).
|
|
31
|
+
|
|
32
|
+
**Who sets window-iframe?**
|
|
33
|
+
|
|
34
|
+
This class is added automatically by the RIO UIKIT, but only if your SPA includes the RIO Pageloader (the initial loading animation shown until the application is ready).
|
|
35
|
+
|
|
36
|
+
**What is the RIO Pageloader?**
|
|
37
|
+
|
|
38
|
+
The RIO Pageloader is the initial loading animation displayed while the application bundles load and the SPA initializes. It is also the recommended place to bootstrap UIKIT early, so iframe-related classes can be applied before the first render to avoid visual flicker.
|
|
39
|
+
|
|
40
|
+
The loader is already part of the RIO frontend template and added to the index.html page inside the body element.
|
|
41
|
+
|
|
42
|
+
For reference:
|
|
43
|
+
|
|
44
|
+
```html
|
|
45
|
+
<link
|
|
46
|
+
rel='stylesheet'
|
|
47
|
+
type='text/css'
|
|
48
|
+
href='https://cdn.rio.cloud/pageLoader/pageLoader.css'
|
|
49
|
+
/>
|
|
50
|
+
<script src='https://cdn.rio.cloud/pageLoader/pageLoader.js'></script>
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Auto-resizing the iframe (recommended)
|
|
54
|
+
|
|
55
|
+
For widgets with dynamic height, scrolling inside the iframe often leads to a poor user experience. To avoid nested scrolling, we recommend using iframe-resizer-react from https://www.npmjs.com/package/iframe-resizer-react. This library adapts the iframe height automatically to the widgets content.
|
|
56
|
+
|
|
57
|
+
**Parent application (host)**
|
|
58
|
+
|
|
59
|
+
The parent initializes the resizer on the iframe element. Use this if you want to embed an iframe into your application.
|
|
21
60
|
|
|
22
61
|
```js
|
|
23
62
|
import IframeResizer from 'iframe-resizer-react';
|
|
24
63
|
```
|
|
25
64
|
|
|
26
|
-
**Child application**
|
|
65
|
+
**Child application (widget)**
|
|
27
66
|
|
|
28
|
-
|
|
67
|
+
The widget must include the resizer content script so it can report size changes to the parent.
|
|
29
68
|
|
|
30
69
|
```js
|
|
31
70
|
npm install iframe-resizer --save
|
|
@@ -82,25 +121,33 @@ export default IFrameWidgetExample;
|
|
|
82
121
|
```html
|
|
83
122
|
<div class="display-flex justify-content-center">
|
|
84
123
|
<div class="iframe-wrapper width-400">
|
|
85
|
-
<iframe title="iframe" src="https://menu.rio.cloud" id="iFrameResizer0" scrolling="no" style="overflow: hidden;">
|
|
124
|
+
<iframe title="iframe" src="https://menu.rio.cloud" id="iFrameResizer0" scrolling="no" style="overflow: hidden; height: 250px;">
|
|
86
125
|
</iframe>
|
|
87
126
|
</div>
|
|
88
127
|
</div>
|
|
89
128
|
```
|
|
90
129
|
|
|
91
|
-
## iframe in
|
|
130
|
+
## Embedding a widget (iframe) in a fullscreen dialog
|
|
131
|
+
|
|
132
|
+
When a widget needs to be displayed as a full page inside a dialog (for example, showing a full-featured SPA), the iframe often requires additional layout and styling adjustments.
|
|
133
|
+
|
|
134
|
+
Rendering a full fledged SPA, there is the need to hide it's main navigation. The best and cleanest way is to hide the navigation in the SPA, when it is loaded in an iframe. Another way is to use our no-application-header class. The iframe then has to be wrapped in a iframe-wrapper element on the host side.
|
|
92
135
|
|
|
93
|
-
|
|
136
|
+
RIO iframes are transparent by default, also the SPA itself. Because of that you have to add the class bg-lighter to the iframe.
|
|
94
137
|
|
|
95
|
-
|
|
138
|
+
**Recommended pattern**
|
|
96
139
|
|
|
97
|
-
|
|
140
|
+
- Wrap the iframe in an .iframe-wrapper to control sizing and overflow.
|
|
141
|
+
- Use utility classes to remove default iframe styling (borders, background) if needed.
|
|
142
|
+
- Prefer hiding parent navigation by not rendering it in the dialog context (instead of compensating with offsets).
|
|
98
143
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
144
|
+
**Common helper classes**
|
|
145
|
+
|
|
146
|
+
- unstyled: removes default iframe border styling (not necessary for widgets when using the iframe-resizer).
|
|
147
|
+
- full-width: makes the iframe take the full width of its container. (not necessary for widgets when using the iframe-resizer)
|
|
148
|
+
- full-window: makes the iframe fill (height/width) the available container space (often for dialogs).
|
|
149
|
+
- no-application-header: compensates for a missing header/navigation area (use carefully). It adds a -50px offset to move the SPA navigation outside the visible area.
|
|
150
|
+
- bg-xxx: set the iframe background color, as the default is transparent.
|
|
104
151
|
|
|
105
152
|
### Example: Example 2
|
|
106
153
|
|
|
@@ -183,7 +230,13 @@ export default IFrameInDialogExample;
|
|
|
183
230
|
|
|
184
231
|
When it comes to opening a modal dialog from within an iframe, there's flexibility in how it can be presented. Depending on the context, the dialog might overlay the iframe content itself or seamlessly cover the entire parent application.
|
|
185
232
|
|
|
186
|
-
|
|
233
|
+
A widget can request the parent application to open a dialog (for example, to present the widget in fullscreen or show another part of it). This is done by sending an event via postMessage from the widget to the parent window.
|
|
234
|
+
|
|
235
|
+
**Recommended event flow**
|
|
236
|
+
|
|
237
|
+
1. Widget sends a message to the parent requesting the dialog to open.
|
|
238
|
+
2. Upon receiving this event, the parent application responds by rendering a simple dialog, such as an InfoDialog, which includes another iframe pointing to a specific route within the widget. This embedded view then displays the dialog content and manages the dialog's close events.
|
|
239
|
+
3. When it's time to close the dialog (via a close button inside the iframe), the embedded view sends another postMessage to the parent application. This event allows the dialog view to send any necessary data back to the originating iframe.
|
|
187
240
|
|
|
188
241
|
### Example: Example 3
|
|
189
242
|
|
|
@@ -199,7 +252,7 @@ For opening a dialog in the parent application, the process typically involves s
|
|
|
199
252
|
import React from 'react';
|
|
200
253
|
import IframeResizer from 'iframe-resizer-react';
|
|
201
254
|
|
|
202
|
-
import FrameDialog from '
|
|
255
|
+
import FrameDialog from '@rio-cloud/rio-uikit/FrameDialog';
|
|
203
256
|
import { PREFIX } from '../../../widgets/WidgetDemo';
|
|
204
257
|
|
|
205
258
|
const IFrameWidgetExample = React.memo(() => {
|
|
@@ -226,9 +279,9 @@ export default IFrameWidgetExample;
|
|
|
226
279
|
// ----------------------------------------------------------
|
|
227
280
|
import { useState } from 'react';
|
|
228
281
|
|
|
229
|
-
import Button from '
|
|
230
|
-
import { OPEN_DIALOG_EVENT, CLOSE_DIALOG_EVENT, type OPEN_DIALOG_EVENT_TYPE } from '
|
|
231
|
-
import usePostMessage, { type RemoteAction } from '
|
|
282
|
+
import Button from '@rio-cloud/rio-uikit/Button';
|
|
283
|
+
import { OPEN_DIALOG_EVENT, CLOSE_DIALOG_EVENT, type OPEN_DIALOG_EVENT_TYPE } from '@rio-cloud/rio-uikit/FrameDialog';
|
|
284
|
+
import usePostMessage, { type RemoteAction } from '@rio-cloud/rio-uikit/usePostMessage';
|
|
232
285
|
|
|
233
286
|
export const PREFIX = 'EVENT_UIKIT_WIDGET_DEMO';
|
|
234
287
|
|
|
@@ -274,10 +327,10 @@ const WidgetDemo = () => {
|
|
|
274
327
|
export default WidgetDemo;
|
|
275
328
|
|
|
276
329
|
// ----------------------------------------------------------
|
|
277
|
-
import Button from '
|
|
278
|
-
import Dialog from '
|
|
279
|
-
import usePostMessage from '
|
|
280
|
-
import { CLOSE_DIALOG_EVENT } from '
|
|
330
|
+
import Button from '@rio-cloud/rio-uikit/Button';
|
|
331
|
+
import Dialog from '@rio-cloud/rio-uikit/Dialog';
|
|
332
|
+
import usePostMessage from '@rio-cloud/rio-uikit/usePostMessage';
|
|
333
|
+
import { CLOSE_DIALOG_EVENT } from '@rio-cloud/rio-uikit/FrameDialog';
|
|
281
334
|
|
|
282
335
|
import { dummyText } from '../../utils/data';
|
|
283
336
|
import { PREFIX } from './WidgetDemo';
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Guidelines
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#start/guidelines/obfuscate-data
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:49.679Z
|
|
7
7
|
|
|
8
8
|
This demo demonstrates how sensitive data marked with the data-pii="visible" attribute can be obfuscated directly in the frontend.
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Getting started
|
|
4
4
|
*Section:* Guidelines
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#start/guidelines/print-css
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:49.661Z
|
|
7
7
|
|
|
8
8
|
The UIKIT supports simple print stylings in order to have printable content. Those print styles are supposed to do basic printing and should not replace server side PDF`s.
|
|
9
9
|
|