@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:* Content
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/dialogs
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:37.934Z
|
|
7
7
|
|
|
8
8
|
This component allows the user to create a generic modal dialog.
|
|
9
9
|
|
|
@@ -376,27 +376,6 @@ export default () => {
|
|
|
376
376
|
</div>
|
|
377
377
|
```
|
|
378
378
|
|
|
379
|
-
#### Props
|
|
380
|
-
|
|
381
|
-
| Name | Type | Default | Description |
|
|
382
|
-
| --- | --- | --- | --- |
|
|
383
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
384
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
385
|
-
| subtitle | Node | — | The subtitle content |
|
|
386
|
-
| body | Node | — | The dialog body content |
|
|
387
|
-
| footer | Node | — | The dialog footer content |
|
|
388
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
389
|
-
| onCloseValidation | Function | () => true | A callback function to be executed before closing the dialog. If the function returns false the dialog will not be closed. |
|
|
390
|
-
| showCloseButton | Boolean | true | Shows a close button when set to true |
|
|
391
|
-
| disableEsc | Boolean | false | Enables or disabled closing the dialog via esc key |
|
|
392
|
-
| onEsc | Function | () => {} | A callback fired when esc key is pressed and the dialog is about to close |
|
|
393
|
-
| useOverflow | Boolean | false | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
394
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
395
|
-
| headerButtons | ReactNode | — | Allows to add additional buttons to the dialog header |
|
|
396
|
-
| className | String | — | Additional classes for the modal element |
|
|
397
|
-
| bodyClassName | String | — | Additional classes for the modal-body element |
|
|
398
|
-
| footerClassName | String | — | Additional classes for the modal-footer element |
|
|
399
|
-
|
|
400
379
|
## Dialog compound components
|
|
401
380
|
|
|
402
381
|
To accommodate forms within the dialog body and have the submit button in the footer or wrapping individual parts of the dialog, a more flexible approach to rendering its individual components is needed. In this scenario, you can make use of the dialog compound components.
|
|
@@ -532,32 +511,6 @@ export default () => {
|
|
|
532
511
|
</div>
|
|
533
512
|
```
|
|
534
513
|
|
|
535
|
-
#### Props: Dialog.Title
|
|
536
|
-
|
|
537
|
-
### Dialog.Title
|
|
538
|
-
|
|
539
|
-
| Name | Type | Default | Description |
|
|
540
|
-
| --- | --- | --- | --- |
|
|
541
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
542
|
-
| subtitle | Node | — | The subtitle content |
|
|
543
|
-
| headerButtons | ReactNode | — | Allows to add additional buttons to the dialog header |
|
|
544
|
-
|
|
545
|
-
#### Props: Dialog.Body
|
|
546
|
-
|
|
547
|
-
### Dialog.Body
|
|
548
|
-
|
|
549
|
-
| Name | Type | Default | Description |
|
|
550
|
-
| --- | --- | --- | --- |
|
|
551
|
-
| className | String | — | Additional classes set on the wrapper element |
|
|
552
|
-
|
|
553
|
-
#### Props: Dialog.Footer
|
|
554
|
-
|
|
555
|
-
### Dialog.Footer
|
|
556
|
-
|
|
557
|
-
| Name | Type | Default | Description |
|
|
558
|
-
| --- | --- | --- | --- |
|
|
559
|
-
| className | String | — | Additional classes set on the wrapper element |
|
|
560
|
-
|
|
561
514
|
## Dialogs with validation
|
|
562
515
|
|
|
563
516
|
### Example: Example 3
|
|
@@ -669,27 +622,6 @@ export default () => {
|
|
|
669
622
|
<button type="button" class="btn btn-primary btn-component" tabindex="0">Open dialog</button>
|
|
670
623
|
```
|
|
671
624
|
|
|
672
|
-
#### Props
|
|
673
|
-
|
|
674
|
-
| Name | Type | Default | Description |
|
|
675
|
-
| --- | --- | --- | --- |
|
|
676
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
677
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
678
|
-
| subtitle | Node | — | The subtitle content |
|
|
679
|
-
| body | Node | — | The dialog body content |
|
|
680
|
-
| footer | Node | — | The dialog footer content |
|
|
681
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
682
|
-
| onCloseValidation | Function | () => true | A callback function to be executed before closing the dialog. If the function returns false the dialog will not be closed. |
|
|
683
|
-
| showCloseButton | Boolean | true | Shows a close button when set to true |
|
|
684
|
-
| disableEsc | Boolean | false | Enables or disabled closing the dialog via esc key |
|
|
685
|
-
| onEsc | Function | () => {} | A callback fired when esc key is pressed and the dialog is about to close |
|
|
686
|
-
| useOverflow | Boolean | false | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
687
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
688
|
-
| headerButtons | ReactNode | — | Allows to add additional buttons to the dialog header |
|
|
689
|
-
| className | String | — | Additional classes for the modal element |
|
|
690
|
-
| bodyClassName | String | — | Additional classes for the modal-body element |
|
|
691
|
-
| footerClassName | String | — | Additional classes for the modal-footer element |
|
|
692
|
-
|
|
693
625
|
### Example: Example 4
|
|
694
626
|
|
|
695
627
|
Validation with separate validation error dialog
|
|
@@ -840,27 +772,6 @@ export default () => {
|
|
|
840
772
|
<button type="button" class="btn btn-primary btn-component" tabindex="0">Open dialog</button>
|
|
841
773
|
```
|
|
842
774
|
|
|
843
|
-
#### Props
|
|
844
|
-
|
|
845
|
-
| Name | Type | Default | Description |
|
|
846
|
-
| --- | --- | --- | --- |
|
|
847
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
848
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
849
|
-
| subtitle | Node | — | The subtitle content |
|
|
850
|
-
| body | Node | — | The dialog body content |
|
|
851
|
-
| footer | Node | — | The dialog footer content |
|
|
852
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
853
|
-
| onCloseValidation | Function | () => true | A callback function to be executed before closing the dialog. If the function returns false the dialog will not be closed. |
|
|
854
|
-
| showCloseButton | Boolean | true | Shows a close button when set to true |
|
|
855
|
-
| disableEsc | Boolean | false | Enables or disabled closing the dialog via esc key |
|
|
856
|
-
| onEsc | Function | () => {} | A callback fired when esc key is pressed and the dialog is about to close |
|
|
857
|
-
| useOverflow | Boolean | false | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
858
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
859
|
-
| headerButtons | ReactNode | — | Allows to add additional buttons to the dialog header |
|
|
860
|
-
| className | String | — | Additional classes for the modal element |
|
|
861
|
-
| bodyClassName | String | — | Additional classes for the modal-body element |
|
|
862
|
-
| footerClassName | String | — | Additional classes for the modal-footer element |
|
|
863
|
-
|
|
864
775
|
## SimpleDialog
|
|
865
776
|
|
|
866
777
|
This component allows the user to create a simple dialog. It uses the dialog component described above.
|
|
@@ -928,26 +839,6 @@ export default () => {
|
|
|
928
839
|
</div>;
|
|
929
840
|
```
|
|
930
841
|
|
|
931
|
-
#### Props
|
|
932
|
-
|
|
933
|
-
| Name | Type | Default | Description |
|
|
934
|
-
| --- | --- | --- | --- |
|
|
935
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
936
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
937
|
-
| subtitle | Node | — | The subtitle content |
|
|
938
|
-
| content | Node | — | The content of the dialog body itself |
|
|
939
|
-
| footer | Node | — | The dialog footer content |
|
|
940
|
-
| footerClassName | String | — | Additional classes for the modal-footer element |
|
|
941
|
-
| bodyClassName | String | — | Additional classes for the modal-body element |
|
|
942
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
943
|
-
| onCloseValidation | Function | () => true | A callback function to be executed before closing the dialog. If the function returns false the dialog will not be closed. |
|
|
944
|
-
| showCloseButton | Boolean | true | Shows a close button when set to true |
|
|
945
|
-
| disableEsc | Boolean | false | Enables or disabled closing the dialog via esc key |
|
|
946
|
-
| onEsc | Function | () => {} | A callback fired when esc key is pressed and the dialog is about to close |
|
|
947
|
-
| useOverflow | Boolean | false | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
948
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
949
|
-
| className | String | — | Additional classes for the modal element |
|
|
950
|
-
|
|
951
842
|
## ConfirmationDialog
|
|
952
843
|
|
|
953
844
|
This component allows the user to create a confirmation dialog. It uses the dialog component described above.
|
|
@@ -1026,22 +917,6 @@ export default () => {
|
|
|
1026
917
|
</div>;
|
|
1027
918
|
```
|
|
1028
919
|
|
|
1029
|
-
#### Props
|
|
1030
|
-
|
|
1031
|
-
| Name | Type | Default | Description |
|
|
1032
|
-
| --- | --- | --- | --- |
|
|
1033
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
1034
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
1035
|
-
| subtitle | Node | — | The subtitle content |
|
|
1036
|
-
| content | Node | — | The content of the dialog body itself |
|
|
1037
|
-
| useOverflow | Boolean | false | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
1038
|
-
| onClickConfirm | Function | () => {} | A callback fired when the confirmation button is clicked. |
|
|
1039
|
-
| onClickCancel | Function | () => {} | A callback fired when the cancel button is clicked or the dialog is closed. |
|
|
1040
|
-
| cancelButtonText | Node | — | The content of the cancel button. (Usually a text, can also be a FormattedMessage component). |
|
|
1041
|
-
| confirmButtonText | Node | — | The content of the confirmation button. Since it is a node, it can be a simple text or any JSX node like a div element with an icon and a text. |
|
|
1042
|
-
| disableConfirm | Boolean | — | When set to true the confirmation button will be disabled |
|
|
1043
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
1044
|
-
|
|
1045
920
|
## SaveDialog
|
|
1046
921
|
|
|
1047
922
|
This component allows the user to create a save dialog. It uses the dialog component described above.
|
|
@@ -1131,27 +1006,6 @@ export default () => {
|
|
|
1131
1006
|
</div>;
|
|
1132
1007
|
```
|
|
1133
1008
|
|
|
1134
|
-
#### Props
|
|
1135
|
-
|
|
1136
|
-
| Name | Type | Default | Description |
|
|
1137
|
-
| --- | --- | --- | --- |
|
|
1138
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
1139
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
1140
|
-
| subtitle | Node | — | The subtitle content |
|
|
1141
|
-
| content | Node | — | The content of the dialog body itself |
|
|
1142
|
-
| onClickCancel | Function | () => {} | A callback fired when the cancel button is clicked or the dialog is closed. |
|
|
1143
|
-
| onClickDiscard | Function | () => {} | A callback fired when the discard button is clicked. |
|
|
1144
|
-
| onClickConfirm | Function | () => {} | A callback fired when the confirmation button is clicked. |
|
|
1145
|
-
| discardButtonText | Node | — | The content of the discard button. (Usually a text, can also be a FormattedMessage component). |
|
|
1146
|
-
| cancelButtonText | Node | — | The content of the cancel button. (Usually a text, can also be a FormattedMessage component). |
|
|
1147
|
-
| confirmButtonText | Node | — | The content of the confirmation button. Since it is a node, it can be a simple text or any JSX node like a div element with an icon and a text. |
|
|
1148
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
1149
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
1150
|
-
| onCloseValidation | Function | () => true | A callback function to be executed before closing the dialog. If the function returns false the dialog will not be closed. |
|
|
1151
|
-
| showCloseButton | Boolean | true | Shows a close button when set to true |
|
|
1152
|
-
| useOverflow | Boolean | false | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
1153
|
-
| className | String | — | Additional classes for the modal element |
|
|
1154
|
-
|
|
1155
1009
|
## SplitDialog
|
|
1156
1010
|
|
|
1157
1011
|
This component allows the user to create a split dialog. It uses the dialog component described above.
|
|
@@ -1418,28 +1272,6 @@ const menuItems2 = [
|
|
|
1418
1272
|
</div>;
|
|
1419
1273
|
```
|
|
1420
1274
|
|
|
1421
|
-
#### Props
|
|
1422
|
-
|
|
1423
|
-
| Name | Type | Default | Description |
|
|
1424
|
-
| --- | --- | --- | --- |
|
|
1425
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
1426
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
1427
|
-
| subtitle | Node | — | The subtitle content |
|
|
1428
|
-
| leftContent | Node | — | The content to be shown on the left side. |
|
|
1429
|
-
| leftContentClassName | String | — | Additional classes for the left content element. |
|
|
1430
|
-
| rightContent | Node | — | The content to be shown on the right side. |
|
|
1431
|
-
| rightContentClassName | String | — | Additional classes for the right content element. |
|
|
1432
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
1433
|
-
| onCloseValidation | Function | () => true | A callback function to be executed before closing the dialog. If the function returns false the dialog will not be closed. |
|
|
1434
|
-
| showCloseButton | Boolean | true | Shows a close button when set to true |
|
|
1435
|
-
| disableEsc | Boolean | false | Enables or disabled closing the dialog via esc key |
|
|
1436
|
-
| onEsc | Function | () => {} | A callback fired when esc key is pressed and the dialog is about to close |
|
|
1437
|
-
| useOverflow | Boolean | true | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
1438
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
1439
|
-
| className | String | — | Additional classes for the modal element |
|
|
1440
|
-
| footerClassName | String | — | Additional classes for the modal-footer element |
|
|
1441
|
-
| footer | Node | — | The dialog footer content |
|
|
1442
|
-
|
|
1443
1275
|
## InfoDialog
|
|
1444
1276
|
|
|
1445
1277
|
This component allows the user to create a dialog without title and footer. It uses the dialog component described above.
|
|
@@ -1522,26 +1354,6 @@ export default InfoDialogExample;
|
|
|
1522
1354
|
</div>;
|
|
1523
1355
|
```
|
|
1524
1356
|
|
|
1525
|
-
#### Props
|
|
1526
|
-
|
|
1527
|
-
| Name | Type | Default | Description |
|
|
1528
|
-
| --- | --- | --- | --- |
|
|
1529
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
1530
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
1531
|
-
| subtitle | Node | — | The subtitle content |
|
|
1532
|
-
| content | Node | — | The content of the dialog body itself |
|
|
1533
|
-
| footer | Node | — | The dialog footer content |
|
|
1534
|
-
| footerClassName | String | — | Additional classes for the modal-footer element |
|
|
1535
|
-
| bodyClassName | String | — | Additional classes for the modal-body element |
|
|
1536
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
1537
|
-
| onCloseValidation | Function | () => true | A callback function to be executed before closing the dialog. If the function returns false the dialog will not be closed. |
|
|
1538
|
-
| showCloseButton | Boolean | true | Shows a close button when set to true |
|
|
1539
|
-
| disableEsc | Boolean | false | Enables or disabled closing the dialog via esc key |
|
|
1540
|
-
| onEsc | Function | () => {} | A callback fired when esc key is pressed and the dialog is about to close |
|
|
1541
|
-
| useOverflow | Boolean | false | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
1542
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
1543
|
-
| className | String | — | Additional classes for the modal element |
|
|
1544
|
-
|
|
1545
1357
|
### Example: Example 10
|
|
1546
1358
|
|
|
1547
1359
|
Feature info dialog
|
|
@@ -1662,26 +1474,6 @@ export default InfoDialogFeatureExample;
|
|
|
1662
1474
|
</div>;
|
|
1663
1475
|
```
|
|
1664
1476
|
|
|
1665
|
-
#### Props
|
|
1666
|
-
|
|
1667
|
-
| Name | Type | Default | Description |
|
|
1668
|
-
| --- | --- | --- | --- |
|
|
1669
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
1670
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
1671
|
-
| subtitle | Node | — | The subtitle content |
|
|
1672
|
-
| content | Node | — | The content of the dialog body itself |
|
|
1673
|
-
| footer | Node | — | The dialog footer content |
|
|
1674
|
-
| footerClassName | String | — | Additional classes for the modal-footer element |
|
|
1675
|
-
| bodyClassName | String | — | Additional classes for the modal-body element |
|
|
1676
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
1677
|
-
| onCloseValidation | Function | () => true | A callback function to be executed before closing the dialog. If the function returns false the dialog will not be closed. |
|
|
1678
|
-
| showCloseButton | Boolean | true | Shows a close button when set to true |
|
|
1679
|
-
| disableEsc | Boolean | false | Enables or disabled closing the dialog via esc key |
|
|
1680
|
-
| onEsc | Function | () => {} | A callback fired when esc key is pressed and the dialog is about to close |
|
|
1681
|
-
| useOverflow | Boolean | false | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
1682
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
1683
|
-
| className | String | — | Additional classes for the modal element |
|
|
1684
|
-
|
|
1685
1477
|
## OnboardingDialog
|
|
1686
1478
|
|
|
1687
1479
|
The OnboardingDialog component is a customizable dialog designed to guide users through the initial steps of an onboarding tour. It displays a welcome message, a brief description of the onboarding process, and action buttons to either start the tour or skip it.
|
|
@@ -1751,22 +1543,15 @@ export default () => {
|
|
|
1751
1543
|
</div>
|
|
1752
1544
|
```
|
|
1753
1545
|
|
|
1754
|
-
#### Props
|
|
1546
|
+
#### Props: OnboardingDialog
|
|
1547
|
+
|
|
1548
|
+
### OnboardingDialog
|
|
1755
1549
|
|
|
1756
1550
|
| Name | Type | Default | Description |
|
|
1757
1551
|
| --- | --- | --- | --- |
|
|
1758
|
-
| show |
|
|
1759
|
-
|
|
|
1760
|
-
|
|
|
1761
|
-
| title | string \| React.ReactNode | — | The title of the dialog. A welcome message. |
|
|
1762
|
-
| description | string \| React.ReactNode | — | A short description of the service and its onboarding. |
|
|
1763
|
-
| onboardingRestartHint | string \| React.ReactNode | — | Hint text for restarting the onboarding process. |
|
|
1764
|
-
| onboardingRestartDescription | string \| React.ReactNode | — | Detailed description for restarting the onboarding process. |
|
|
1765
|
-
| skipButtonText | string \| React.ReactNode | — | Text for the skip button. |
|
|
1766
|
-
| tourButtonText | string \| React.ReactNode | — | Text for the button to start the tour. |
|
|
1767
|
-
| onStartTour | () => void | — | Callback function to be called when the tour starts. |
|
|
1768
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
1769
|
-
| className | String | — | Additional classes for the modal element |
|
|
1552
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
1553
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
1554
|
+
| className | string | — | Additional classes for the modal element. |
|
|
1770
1555
|
|
|
1771
1556
|
## MediaDialog
|
|
1772
1557
|
|
|
@@ -1902,27 +1687,6 @@ export default () => {
|
|
|
1902
1687
|
</div>;
|
|
1903
1688
|
```
|
|
1904
1689
|
|
|
1905
|
-
#### Props
|
|
1906
|
-
|
|
1907
|
-
| Name | Type | Default | Description |
|
|
1908
|
-
| --- | --- | --- | --- |
|
|
1909
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
1910
|
-
| title | Node | — | The dialog title (can also be a FormattedMessage component) |
|
|
1911
|
-
| subtitle | Node | — | The subtitle content |
|
|
1912
|
-
| useOverflow | Boolean | false | Enables the modal body to overflow and use inline scrolling if needed.Set the class "no-overflow-gradient" to remove the overflow gradient in case it is problematic like when the background is gray. |
|
|
1913
|
-
| onClose | Function | () => {} | A callback function invoked when the dialog closes |
|
|
1914
|
-
| disableEsc | Boolean | false | Enables or disabled closing the dialog via esc key |
|
|
1915
|
-
| bsSize | String | md | Defined how large the dialog will be rendered. By default, the dialog has a medium size and thus it can be omitted. Possible values are: Dialog.SIZE_XS, Dialog.SIZE_SM, Dialog.SIZE_LG, Dialog.SIZE_XL, Dialog.SIZE_FULL_WIDTH, Dialog.SIZE_FULL_HEIGHT, Dialog.SIZE_FULL_SCREEN or 'xs', 'sm', 'lg', 'xl', 'fullwidth', 'fullheight', 'fullheight-lg', 'fullheight-xl', 'fullscreen' |
|
|
1916
|
-
| previousButtonText | String / Node | — | The button text for switching to the previous media if there are multiple. |
|
|
1917
|
-
| previousButtonCallback | Function | () => {} | Callback function for when the previous button is clicked. |
|
|
1918
|
-
| nextButtonText | String / Node | — | The button text for switching to the next media if there are multiple. |
|
|
1919
|
-
| nextButtonCallback | Function | () => {} | Callback function for when the next button is clicked. |
|
|
1920
|
-
| media | Array of Objects | — | List of media objects. |
|
|
1921
|
-
| └type | String | — | Defines the media type that is going to be displayed. Possible values are: MediaDialog.MEDIA_TYPE_IMAGE, MediaDialog.MEDIA_TYPE_VIDEO or 'image', 'video' |
|
|
1922
|
-
| └src | String | — | The source location for the media data. |
|
|
1923
|
-
| └aspectRatio | String | — | Only relevant for videos where the aspect of the video is defined. Possible values are: ResponsiveVideo.ASPECT_RATIO_4_BY_3, ResponsiveVideo.ASPECT_RATIO_16_BY_9 or '4by3', '16by9' |
|
|
1924
|
-
| └className | String | — | Additional classes for the image element. |
|
|
1925
|
-
|
|
1926
1690
|
## FrameDialog
|
|
1927
1691
|
|
|
1928
1692
|
This component allows the user to create a dialog in a parent window triggered and controlled by a widget iframe.
|
|
@@ -1943,7 +1707,7 @@ For more details, please visit iframe guidlines
|
|
|
1943
1707
|
import React from 'react';
|
|
1944
1708
|
import IframeResizer from 'iframe-resizer-react';
|
|
1945
1709
|
|
|
1946
|
-
import FrameDialog from '
|
|
1710
|
+
import FrameDialog from '@rio-cloud/rio-uikit/FrameDialog';
|
|
1947
1711
|
import { PREFIX } from '../../../widgets/WidgetDemo';
|
|
1948
1712
|
|
|
1949
1713
|
const IFrameWidgetExample = React.memo(() => {
|
|
@@ -1970,9 +1734,9 @@ export default IFrameWidgetExample;
|
|
|
1970
1734
|
// ----------------------------------------------------------
|
|
1971
1735
|
import { useState } from 'react';
|
|
1972
1736
|
|
|
1973
|
-
import Button from '
|
|
1974
|
-
import { OPEN_DIALOG_EVENT, CLOSE_DIALOG_EVENT, type OPEN_DIALOG_EVENT_TYPE } from '
|
|
1975
|
-
import usePostMessage, { type RemoteAction } from '
|
|
1737
|
+
import Button from '@rio-cloud/rio-uikit/Button';
|
|
1738
|
+
import { OPEN_DIALOG_EVENT, CLOSE_DIALOG_EVENT, type OPEN_DIALOG_EVENT_TYPE } from '@rio-cloud/rio-uikit/FrameDialog';
|
|
1739
|
+
import usePostMessage, { type RemoteAction } from '@rio-cloud/rio-uikit/usePostMessage';
|
|
1976
1740
|
|
|
1977
1741
|
export const PREFIX = 'EVENT_UIKIT_WIDGET_DEMO';
|
|
1978
1742
|
|
|
@@ -2018,10 +1782,10 @@ const WidgetDemo = () => {
|
|
|
2018
1782
|
export default WidgetDemo;
|
|
2019
1783
|
|
|
2020
1784
|
// ----------------------------------------------------------
|
|
2021
|
-
import Button from '
|
|
2022
|
-
import Dialog from '
|
|
2023
|
-
import usePostMessage from '
|
|
2024
|
-
import { CLOSE_DIALOG_EVENT } from '
|
|
1785
|
+
import Button from '@rio-cloud/rio-uikit/Button';
|
|
1786
|
+
import Dialog from '@rio-cloud/rio-uikit/Dialog';
|
|
1787
|
+
import usePostMessage from '@rio-cloud/rio-uikit/usePostMessage';
|
|
1788
|
+
import { CLOSE_DIALOG_EVENT } from '@rio-cloud/rio-uikit/FrameDialog';
|
|
2025
1789
|
|
|
2026
1790
|
import { dummyText } from '../../utils/data';
|
|
2027
1791
|
import { PREFIX } from './WidgetDemo';
|
|
@@ -2230,15 +1994,4 @@ export default () => {
|
|
|
2230
1994
|
</nav>
|
|
2231
1995
|
</div>
|
|
2232
1996
|
</div>
|
|
2233
|
-
```
|
|
2234
|
-
|
|
2235
|
-
#### Props (json)
|
|
2236
|
-
|
|
2237
|
-
```json
|
|
2238
|
-
{
|
|
2239
|
-
"0.1.2": {
|
|
2240
|
-
date: String,
|
|
2241
|
-
content: arrayOf(nodes) or single node,
|
|
2242
|
-
}
|
|
2243
|
-
}
|
|
2244
1997
|
```
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/divider
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:42.411Z
|
|
7
7
|
|
|
8
8
|
## Divider
|
|
9
9
|
|
|
@@ -204,16 +204,4 @@ export default () => (
|
|
|
204
204
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. Ut consectetur enim nec tortor scelerisque tincidunt.</div>
|
|
205
205
|
</div>
|
|
206
206
|
</div>
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
#### Props
|
|
210
|
-
|
|
211
|
-
| Name | Type | Default | Description |
|
|
212
|
-
| --- | --- | --- | --- |
|
|
213
|
-
| spacing | number | 15 | The amount of space to either side |
|
|
214
|
-
| dividerWidth | 1 \| 2 \| 3 | 1 | Defines the width of the divider line |
|
|
215
|
-
| dividerColor | 'darkest' \| 'darker' \| 'dark' \| 'gray' \| 'light' \| 'lighter' \| 'lightest'3' | light | Defines the color of the divider line |
|
|
216
|
-
| asSpacer | boolean | false | Use the component as a spacer element without the divider line |
|
|
217
|
-
| vertical | boolean | false | Set the orientation for the divider line to vertical. This may be useful for button toolbars or elements on a single row. |
|
|
218
|
-
| titleAlignment | 'left' \| 'center' \| 'right' | center | Defines where the children are aligned on the divider line |
|
|
219
|
-
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
207
|
+
```
|