@rio-cloud/uikit-mcp 1.1.3 → 1.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/dist/doc-metadata.json +97 -97
- package/dist/docs/components/accentBar.md +5 -5
- package/dist/docs/components/activity.md +7 -7
- package/dist/docs/components/animatedNumber.md +10 -10
- package/dist/docs/components/animatedTextReveal.md +42 -43
- package/dist/docs/components/animations.md +42 -34
- package/dist/docs/components/appHeader.md +20 -35
- package/dist/docs/components/appLayout.md +198 -221
- package/dist/docs/components/appNavigationBar.md +21 -21
- package/dist/docs/components/areaCharts.md +38 -38
- package/dist/docs/components/aspectRatioPlaceholder.md +4 -5
- package/dist/docs/components/assetTree.md +887 -614
- package/dist/docs/components/autosuggests.md +4 -4
- package/dist/docs/components/avatar.md +7 -7
- package/dist/docs/components/banner.md +2 -2
- package/dist/docs/components/barCharts.md +173 -173
- package/dist/docs/components/barList.md +19 -41
- package/dist/docs/components/basicMap.md +1 -1
- package/dist/docs/components/bottomSheet.md +74 -74
- package/dist/docs/components/button.md +161 -71
- package/dist/docs/components/buttonToolbar.md +3 -3
- package/dist/docs/components/calendarStripe.md +71 -123
- package/dist/docs/components/card.md +4 -4
- package/dist/docs/components/carousel.md +1 -1
- package/dist/docs/components/chartColors.md +1 -1
- package/dist/docs/components/chartsGettingStarted.md +1 -1
- package/dist/docs/components/chat.md +2 -2
- package/dist/docs/components/checkbox.md +56 -131
- package/dist/docs/components/clearableInput.md +23 -127
- package/dist/docs/components/collapse.md +14 -16
- package/dist/docs/components/composedCharts.md +31 -31
- package/dist/docs/components/contentLoader.md +125 -122
- package/dist/docs/components/dataTabs.md +103 -93
- package/dist/docs/components/datepickers.md +734 -764
- package/dist/docs/components/dialogs.md +299 -186
- package/dist/docs/components/divider.md +4 -4
- package/dist/docs/components/dropdowns.md +4555 -4498
- package/dist/docs/components/editableContent.md +97 -97
- package/dist/docs/components/expander.md +56 -56
- package/dist/docs/components/fade.md +41 -41
- package/dist/docs/components/fadeExpander.md +4 -4
- package/dist/docs/components/fadeUp.md +8 -10
- package/dist/docs/components/feedback.md +22 -21
- package/dist/docs/components/filePickers.md +25 -25
- package/dist/docs/components/formLabel.md +5 -7
- package/dist/docs/components/groupedItemList.md +37 -37
- package/dist/docs/components/iconList.md +4 -4
- package/dist/docs/components/imagePreloader.md +6 -6
- package/dist/docs/components/labeledElement.md +4 -3
- package/dist/docs/components/licensePlate.md +2 -2
- package/dist/docs/components/lineCharts.md +58 -58
- package/dist/docs/components/listMenu.md +63 -41
- package/dist/docs/components/loadMore.md +17 -17
- package/dist/docs/components/mainNavigation.md +1 -1
- package/dist/docs/components/mapCircle.md +1 -1
- package/dist/docs/components/mapCluster.md +1 -1
- package/dist/docs/components/mapContext.md +1 -1
- package/dist/docs/components/mapDraggableMarker.md +1 -1
- package/dist/docs/components/mapGettingStarted.md +1 -1
- package/dist/docs/components/mapInfoBubble.md +1 -1
- package/dist/docs/components/mapLayerGroup.md +1 -1
- package/dist/docs/components/mapMarker.md +339 -345
- package/dist/docs/components/mapPolygon.md +16 -20
- package/dist/docs/components/mapRoute.md +14 -20
- package/dist/docs/components/mapRouteGenerator.md +1 -1
- package/dist/docs/components/mapSettings.md +263 -274
- package/dist/docs/components/mapUtils.md +3 -5
- package/dist/docs/components/multiselects.md +1 -1
- package/dist/docs/components/noData.md +11 -11
- package/dist/docs/components/notifications.md +1 -1
- package/dist/docs/components/numbercontrol.md +39 -37
- package/dist/docs/components/onboarding.md +18 -38
- package/dist/docs/components/page.md +16 -16
- package/dist/docs/components/pager.md +8 -8
- package/dist/docs/components/pieCharts.md +124 -124
- package/dist/docs/components/popover.md +37 -53
- package/dist/docs/components/position.md +4 -4
- package/dist/docs/components/radialBarCharts.md +506 -506
- package/dist/docs/components/radiobutton.md +209 -191
- package/dist/docs/components/releaseNotes.md +9 -3
- package/dist/docs/components/resizer.md +7 -8
- package/dist/docs/components/responsiveColumnStripe.md +11 -11
- package/dist/docs/components/responsiveVideo.md +5 -5
- package/dist/docs/components/rioglyph.md +11 -11
- package/dist/docs/components/rules.md +118 -92
- package/dist/docs/components/saveableInput.md +366 -356
- package/dist/docs/components/selects.md +9996 -15
- package/dist/docs/components/sidebar.md +22 -23
- package/dist/docs/components/sliders.md +26 -26
- package/dist/docs/components/smoothScrollbars.md +61 -25
- package/dist/docs/components/spinners.md +32 -30
- package/dist/docs/components/states.md +236 -245
- package/dist/docs/components/statsWidgets.md +37 -28
- package/dist/docs/components/statusBar.md +22 -22
- package/dist/docs/components/stepButton.md +2 -2
- package/dist/docs/components/steppedProgressBars.md +45 -45
- package/dist/docs/components/subNavigation.md +3 -3
- package/dist/docs/components/supportMarker.md +1 -1
- package/dist/docs/components/svgImage.md +2 -38
- package/dist/docs/components/switch.md +11 -11
- package/dist/docs/components/tables.md +1 -1
- package/dist/docs/components/tagManager.md +40 -40
- package/dist/docs/components/tags.md +21 -20
- package/dist/docs/components/teaser.md +22 -23
- package/dist/docs/components/timeline.md +1 -1
- package/dist/docs/components/timepicker.md +17 -13
- package/dist/docs/components/toggleButton.md +65 -29
- package/dist/docs/components/tooltip.md +27 -50
- package/dist/docs/components/virtualList.md +75 -75
- 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 +197 -197
- package/dist/docs/templates/loading-progress.md +1 -1
- 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 +58 -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 -8
- package/dist/version.json +2 -2
- package/package.json +6 -6
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Content
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/dialogs
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:51.877Z
|
|
7
7
|
|
|
8
8
|
This component allows the user to create a generic modal dialog.
|
|
9
9
|
|
|
@@ -376,26 +376,36 @@ export default () => {
|
|
|
376
376
|
</div>
|
|
377
377
|
```
|
|
378
378
|
|
|
379
|
-
#### Props
|
|
379
|
+
#### Props: Base dialog props
|
|
380
|
+
|
|
381
|
+
### Base dialog props
|
|
380
382
|
|
|
381
383
|
| Name | Type | Default | Description |
|
|
382
384
|
| --- | --- | --- | --- |
|
|
383
|
-
| show |
|
|
384
|
-
| title |
|
|
385
|
-
| subtitle |
|
|
386
|
-
|
|
|
387
|
-
|
|
|
388
|
-
|
|
|
389
|
-
|
|
|
390
|
-
|
|
|
391
|
-
|
|
|
392
|
-
|
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
|
385
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
386
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
387
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
388
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
389
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
390
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
391
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
392
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
393
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
394
|
+
| className | string | — | Additional classes for the modal element. |
|
|
395
|
+
|
|
396
|
+
#### Props: Dialog
|
|
397
|
+
|
|
398
|
+
### Dialog
|
|
399
|
+
|
|
400
|
+
| Name | Type | Default | Description |
|
|
401
|
+
| --- | --- | --- | --- |
|
|
402
|
+
| body | React.ReactNode | — | The dialog body content. |
|
|
403
|
+
| footer | React.ReactNode | — | The dialog body content. |
|
|
404
|
+
| bodyClassName | string | — | Additional classes for the modal-body element. |
|
|
405
|
+
| footerClassName | string | — | Additional classes for the modal-footer element. |
|
|
406
|
+
| headerButtons | React.ReactNode | — | Allows to add additional buttons to the dialog header. |
|
|
407
|
+
| onEsc | VoidFunction | — | A callback fired when esc key is pressed and the dialog is about to close. |
|
|
408
|
+
| onCloseValidation | () => boolean | () => true | A callback function to be executed before closing the dialog. If the function returns false, the dialog will not be closed |
|
|
399
409
|
|
|
400
410
|
## Dialog compound components
|
|
401
411
|
|
|
@@ -538,9 +548,10 @@ export default () => {
|
|
|
538
548
|
|
|
539
549
|
| Name | Type | Default | Description |
|
|
540
550
|
| --- | --- | --- | --- |
|
|
541
|
-
| title |
|
|
542
|
-
| subtitle |
|
|
543
|
-
| headerButtons | ReactNode | — | Allows to add additional buttons to the dialog header |
|
|
551
|
+
| title | string \| React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
552
|
+
| subtitle | string \| React.ReactNode | — | The dialog header subtitle content. |
|
|
553
|
+
| headerButtons | React.ReactNode | — | Allows to add additional buttons to the dialog header. |
|
|
554
|
+
| onCloseButtonClick | () => void | — | — |
|
|
544
555
|
|
|
545
556
|
#### Props: Dialog.Body
|
|
546
557
|
|
|
@@ -548,7 +559,7 @@ export default () => {
|
|
|
548
559
|
|
|
549
560
|
| Name | Type | Default | Description |
|
|
550
561
|
| --- | --- | --- | --- |
|
|
551
|
-
| className |
|
|
562
|
+
| className | string | — | Additional classes for the modal-body element. |
|
|
552
563
|
|
|
553
564
|
#### Props: Dialog.Footer
|
|
554
565
|
|
|
@@ -556,7 +567,7 @@ export default () => {
|
|
|
556
567
|
|
|
557
568
|
| Name | Type | Default | Description |
|
|
558
569
|
| --- | --- | --- | --- |
|
|
559
|
-
| className |
|
|
570
|
+
| className | string | — | Additional classes for the modal-footer element. |
|
|
560
571
|
|
|
561
572
|
## Dialogs with validation
|
|
562
573
|
|
|
@@ -669,26 +680,36 @@ export default () => {
|
|
|
669
680
|
<button type="button" class="btn btn-primary btn-component" tabindex="0">Open dialog</button>
|
|
670
681
|
```
|
|
671
682
|
|
|
672
|
-
#### Props
|
|
683
|
+
#### Props: Base dialog props
|
|
684
|
+
|
|
685
|
+
### Base dialog props
|
|
686
|
+
|
|
687
|
+
| Name | Type | Default | Description |
|
|
688
|
+
| --- | --- | --- | --- |
|
|
689
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
690
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
691
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
692
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
693
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
694
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
695
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
696
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
697
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
698
|
+
| className | string | — | Additional classes for the modal element. |
|
|
699
|
+
|
|
700
|
+
#### Props: Dialog
|
|
701
|
+
|
|
702
|
+
### Dialog
|
|
673
703
|
|
|
674
704
|
| Name | Type | Default | Description |
|
|
675
705
|
| --- | --- | --- | --- |
|
|
676
|
-
|
|
|
677
|
-
|
|
|
678
|
-
|
|
|
679
|
-
|
|
|
680
|
-
|
|
|
681
|
-
|
|
|
682
|
-
| onCloseValidation |
|
|
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 |
|
|
706
|
+
| body | React.ReactNode | — | The dialog body content. |
|
|
707
|
+
| footer | React.ReactNode | — | The dialog body content. |
|
|
708
|
+
| bodyClassName | string | — | Additional classes for the modal-body element. |
|
|
709
|
+
| footerClassName | string | — | Additional classes for the modal-footer element. |
|
|
710
|
+
| headerButtons | React.ReactNode | — | Allows to add additional buttons to the dialog header. |
|
|
711
|
+
| onEsc | VoidFunction | — | A callback fired when esc key is pressed and the dialog is about to close. |
|
|
712
|
+
| onCloseValidation | () => boolean | () => true | A callback function to be executed before closing the dialog. If the function returns false, the dialog will not be closed |
|
|
692
713
|
|
|
693
714
|
### Example: Example 4
|
|
694
715
|
|
|
@@ -840,26 +861,36 @@ export default () => {
|
|
|
840
861
|
<button type="button" class="btn btn-primary btn-component" tabindex="0">Open dialog</button>
|
|
841
862
|
```
|
|
842
863
|
|
|
843
|
-
#### Props
|
|
864
|
+
#### Props: Base dialog props
|
|
865
|
+
|
|
866
|
+
### Base dialog props
|
|
867
|
+
|
|
868
|
+
| Name | Type | Default | Description |
|
|
869
|
+
| --- | --- | --- | --- |
|
|
870
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
871
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
872
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
873
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
874
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
875
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
876
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
877
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
878
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
879
|
+
| className | string | — | Additional classes for the modal element. |
|
|
880
|
+
|
|
881
|
+
#### Props: Dialog
|
|
882
|
+
|
|
883
|
+
### Dialog
|
|
844
884
|
|
|
845
885
|
| Name | Type | Default | Description |
|
|
846
886
|
| --- | --- | --- | --- |
|
|
847
|
-
|
|
|
848
|
-
|
|
|
849
|
-
|
|
|
850
|
-
|
|
|
851
|
-
|
|
|
852
|
-
|
|
|
853
|
-
| onCloseValidation |
|
|
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 |
|
|
887
|
+
| body | React.ReactNode | — | The dialog body content. |
|
|
888
|
+
| footer | React.ReactNode | — | The dialog body content. |
|
|
889
|
+
| bodyClassName | string | — | Additional classes for the modal-body element. |
|
|
890
|
+
| footerClassName | string | — | Additional classes for the modal-footer element. |
|
|
891
|
+
| headerButtons | React.ReactNode | — | Allows to add additional buttons to the dialog header. |
|
|
892
|
+
| onEsc | VoidFunction | — | A callback fired when esc key is pressed and the dialog is about to close. |
|
|
893
|
+
| onCloseValidation | () => boolean | () => true | A callback function to be executed before closing the dialog. If the function returns false, the dialog will not be closed |
|
|
863
894
|
|
|
864
895
|
## SimpleDialog
|
|
865
896
|
|
|
@@ -928,25 +959,30 @@ export default () => {
|
|
|
928
959
|
</div>;
|
|
929
960
|
```
|
|
930
961
|
|
|
931
|
-
#### Props
|
|
962
|
+
#### Props: Base dialog props
|
|
963
|
+
|
|
964
|
+
### Base dialog props
|
|
932
965
|
|
|
933
966
|
| Name | Type | Default | Description |
|
|
934
967
|
| --- | --- | --- | --- |
|
|
935
|
-
| show |
|
|
936
|
-
| title |
|
|
937
|
-
| subtitle |
|
|
938
|
-
|
|
|
939
|
-
|
|
|
940
|
-
|
|
|
941
|
-
|
|
|
942
|
-
|
|
|
943
|
-
|
|
|
944
|
-
|
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
968
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
969
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
970
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
971
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
972
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
973
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
974
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
975
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
976
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
977
|
+
| className | string | — | Additional classes for the modal element. |
|
|
978
|
+
|
|
979
|
+
#### Props: SimpleDialog
|
|
980
|
+
|
|
981
|
+
### SimpleDialog
|
|
982
|
+
|
|
983
|
+
| Name | Type | Default | Description |
|
|
984
|
+
| --- | --- | --- | --- |
|
|
985
|
+
| content | string \| React.ReactNode | — | The content of the dialog body itself. |
|
|
950
986
|
|
|
951
987
|
## ConfirmationDialog
|
|
952
988
|
|
|
@@ -1026,21 +1062,35 @@ export default () => {
|
|
|
1026
1062
|
</div>;
|
|
1027
1063
|
```
|
|
1028
1064
|
|
|
1029
|
-
#### Props
|
|
1065
|
+
#### Props: Base dialog props
|
|
1066
|
+
|
|
1067
|
+
### Base dialog props
|
|
1030
1068
|
|
|
1031
1069
|
| Name | Type | Default | Description |
|
|
1032
1070
|
| --- | --- | --- | --- |
|
|
1033
|
-
| show |
|
|
1034
|
-
| title |
|
|
1035
|
-
| subtitle |
|
|
1036
|
-
|
|
|
1037
|
-
|
|
|
1038
|
-
|
|
|
1039
|
-
|
|
|
1040
|
-
|
|
|
1041
|
-
|
|
|
1042
|
-
|
|
|
1043
|
-
|
|
1071
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
1072
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
1073
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
1074
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
1075
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
1076
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
1077
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
1078
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
1079
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
1080
|
+
| className | string | — | Additional classes for the modal element. |
|
|
1081
|
+
|
|
1082
|
+
#### Props: ConfirmationDialog
|
|
1083
|
+
|
|
1084
|
+
### ConfirmationDialog
|
|
1085
|
+
|
|
1086
|
+
| Name | Type | Default | Description |
|
|
1087
|
+
| --- | --- | --- | --- |
|
|
1088
|
+
| content | string \| React.ReactNode | — | The content of the dialog body itself |
|
|
1089
|
+
| onClickConfirm | VoidFunction | () => {} | A callback fired when the confirmation button is clicked. |
|
|
1090
|
+
| onClickCancel | VoidFunction | () => {} | A callback fired when the cancel button is clicked or the dialog is closed. |
|
|
1091
|
+
| cancelButtonText | string \| React.ReactNode | — | The content of the cancel button. (Usually a text, can also be a FormattedMessage component). |
|
|
1092
|
+
| confirmButtonText | string \| React.ReactNode | — | 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. |
|
|
1093
|
+
| disableConfirm | boolean | — | When set to true the confirmation button will be disabled. |
|
|
1044
1094
|
|
|
1045
1095
|
## SaveDialog
|
|
1046
1096
|
|
|
@@ -1131,26 +1181,36 @@ export default () => {
|
|
|
1131
1181
|
</div>;
|
|
1132
1182
|
```
|
|
1133
1183
|
|
|
1134
|
-
#### Props
|
|
1184
|
+
#### Props: Base dialog props
|
|
1185
|
+
|
|
1186
|
+
### Base dialog props
|
|
1187
|
+
|
|
1188
|
+
| Name | Type | Default | Description |
|
|
1189
|
+
| --- | --- | --- | --- |
|
|
1190
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
1191
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
1192
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
1193
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
1194
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
1195
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
1196
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
1197
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
1198
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
1199
|
+
| className | string | — | Additional classes for the modal element. |
|
|
1200
|
+
|
|
1201
|
+
#### Props: SaveDialog
|
|
1202
|
+
|
|
1203
|
+
### SaveDialog
|
|
1135
1204
|
|
|
1136
1205
|
| Name | Type | Default | Description |
|
|
1137
1206
|
| --- | --- | --- | --- |
|
|
1138
|
-
|
|
|
1139
|
-
|
|
|
1140
|
-
|
|
|
1141
|
-
|
|
|
1142
|
-
|
|
|
1143
|
-
|
|
|
1144
|
-
|
|
|
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 |
|
|
1207
|
+
| content | string \| React.ReactNode | — | The content of the dialog body itself. |
|
|
1208
|
+
| onClickCancel | VoidFunction | — | A callback fired when the cancel button is clicked or the dialog is closed. |
|
|
1209
|
+
| onClickDiscard | VoidFunction | — | A callback fired when the discard button is clicked. |
|
|
1210
|
+
| onClickConfirm | VoidFunction | — | A callback fired when the confirmation button is clicked. |
|
|
1211
|
+
| discardButtonText | string \| React.ReactNode | — | The content of the discard button. (Usually a text, can also be a FormattedMessage component). |
|
|
1212
|
+
| cancelButtonText | string \| React.ReactNode | — | The content of the cancel button. (Usually a text, can also be a FormattedMessage component). |
|
|
1213
|
+
| confirmButtonText | string \| React.ReactNode | — | 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. |
|
|
1154
1214
|
|
|
1155
1215
|
## SplitDialog
|
|
1156
1216
|
|
|
@@ -1418,27 +1478,38 @@ const menuItems2 = [
|
|
|
1418
1478
|
</div>;
|
|
1419
1479
|
```
|
|
1420
1480
|
|
|
1421
|
-
#### Props
|
|
1481
|
+
#### Props: Base dialog props
|
|
1482
|
+
|
|
1483
|
+
### Base dialog props
|
|
1422
1484
|
|
|
1423
1485
|
| Name | Type | Default | Description |
|
|
1424
1486
|
| --- | --- | --- | --- |
|
|
1425
|
-
| show |
|
|
1426
|
-
| title |
|
|
1427
|
-
| subtitle |
|
|
1428
|
-
|
|
|
1429
|
-
|
|
|
1430
|
-
|
|
|
1431
|
-
|
|
|
1432
|
-
|
|
|
1433
|
-
|
|
|
1434
|
-
|
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
|
1441
|
-
|
|
|
1487
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
1488
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
1489
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
1490
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
1491
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
1492
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
1493
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
1494
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
1495
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
1496
|
+
| className | string | — | Additional classes for the modal element. |
|
|
1497
|
+
|
|
1498
|
+
#### Props: SplitDialog
|
|
1499
|
+
|
|
1500
|
+
### SplitDialog
|
|
1501
|
+
|
|
1502
|
+
| Name | Type | Default | Description |
|
|
1503
|
+
| --- | --- | --- | --- |
|
|
1504
|
+
| leftContent | string \| React.ReactNode | — | The content to be shown on the left side. |
|
|
1505
|
+
| leftContentClassName | string | — | Additional classes for the left content element. |
|
|
1506
|
+
| rightContent | string \| React.ReactNode | — | The content to be shown on the right side. |
|
|
1507
|
+
| rightContentClassName | string | — | Additional classes for the right content element. |
|
|
1508
|
+
| footer | React.ReactNode | — | The dialog body content. |
|
|
1509
|
+
| footerClassName | string | — | Additional classes for the modal-footer element. |
|
|
1510
|
+
| onCloseValidation | () => boolean | — | A callback function to be executed before closing the dialog. If the function returns false, the dialog will not be closed |
|
|
1511
|
+
| useOverflow | boolean | true | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
1512
|
+
| showDivider | boolean | true | Allows to disable the divider. |
|
|
1442
1513
|
|
|
1443
1514
|
## InfoDialog
|
|
1444
1515
|
|
|
@@ -1522,25 +1593,30 @@ export default InfoDialogExample;
|
|
|
1522
1593
|
</div>;
|
|
1523
1594
|
```
|
|
1524
1595
|
|
|
1525
|
-
#### Props
|
|
1596
|
+
#### Props: Base dialog props
|
|
1597
|
+
|
|
1598
|
+
### Base dialog props
|
|
1599
|
+
|
|
1600
|
+
| Name | Type | Default | Description |
|
|
1601
|
+
| --- | --- | --- | --- |
|
|
1602
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
1603
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
1604
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
1605
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
1606
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
1607
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
1608
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
1609
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
1610
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
1611
|
+
| className | string | — | Additional classes for the modal element. |
|
|
1612
|
+
|
|
1613
|
+
#### Props: InfoDialog
|
|
1614
|
+
|
|
1615
|
+
### InfoDialog
|
|
1526
1616
|
|
|
1527
1617
|
| Name | Type | Default | Description |
|
|
1528
1618
|
| --- | --- | --- | --- |
|
|
1529
|
-
|
|
|
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 |
|
|
1619
|
+
| content | string \| React.ReactNode | — | The content of the dialog body itself. |
|
|
1544
1620
|
|
|
1545
1621
|
### Example: Example 10
|
|
1546
1622
|
|
|
@@ -1662,25 +1738,30 @@ export default InfoDialogFeatureExample;
|
|
|
1662
1738
|
</div>;
|
|
1663
1739
|
```
|
|
1664
1740
|
|
|
1665
|
-
#### Props
|
|
1741
|
+
#### Props: Base dialog props
|
|
1742
|
+
|
|
1743
|
+
### Base dialog props
|
|
1666
1744
|
|
|
1667
1745
|
| Name | Type | Default | Description |
|
|
1668
1746
|
| --- | --- | --- | --- |
|
|
1669
|
-
| show |
|
|
1670
|
-
| title |
|
|
1671
|
-
| subtitle |
|
|
1672
|
-
|
|
|
1673
|
-
|
|
|
1674
|
-
|
|
|
1675
|
-
|
|
|
1676
|
-
|
|
|
1677
|
-
|
|
|
1678
|
-
|
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1747
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
1748
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
1749
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
1750
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
1751
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
1752
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
1753
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
1754
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
1755
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
1756
|
+
| className | string | — | Additional classes for the modal element. |
|
|
1757
|
+
|
|
1758
|
+
#### Props: InfoDialog
|
|
1759
|
+
|
|
1760
|
+
### InfoDialog
|
|
1761
|
+
|
|
1762
|
+
| Name | Type | Default | Description |
|
|
1763
|
+
| --- | --- | --- | --- |
|
|
1764
|
+
| content | string \| React.ReactNode | — | The content of the dialog body itself. |
|
|
1684
1765
|
|
|
1685
1766
|
## OnboardingDialog
|
|
1686
1767
|
|
|
@@ -1751,22 +1832,24 @@ export default () => {
|
|
|
1751
1832
|
</div>
|
|
1752
1833
|
```
|
|
1753
1834
|
|
|
1754
|
-
#### Props
|
|
1835
|
+
#### Props: OnboardingDialog
|
|
1836
|
+
|
|
1837
|
+
### OnboardingDialog
|
|
1755
1838
|
|
|
1756
1839
|
| Name | Type | Default | Description |
|
|
1757
1840
|
| --- | --- | --- | --- |
|
|
1758
|
-
| show | Boolean | false | Opens the dialog when set to true |
|
|
1759
1841
|
| imageSrc | string | — | The source URL of the image to be displayed in the dialog. |
|
|
1760
1842
|
| imageAlt | string | — | Alternative text for the image, used for accessibility. |
|
|
1761
1843
|
| title | string \| React.ReactNode | — | The title of the dialog. A welcome message. |
|
|
1762
|
-
| description | string \| React.ReactNode | — | A short description of the service and
|
|
1844
|
+
| description | string \| React.ReactNode | — | A short description of the service and it's onboarding. |
|
|
1763
1845
|
| onboardingRestartHint | string \| React.ReactNode | — | Hint text for restarting the onboarding process. |
|
|
1764
1846
|
| 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
|
|
1847
|
+
| skipButtonText | string \| React.ReactNode | — | Text for the skip button |
|
|
1848
|
+
| tourButtonText | string \| React.ReactNode | — | Text for the button to start the tour |
|
|
1767
1849
|
| onStartTour | () => void | — | Callback function to be called when the tour starts. |
|
|
1768
|
-
|
|
|
1769
|
-
|
|
|
1850
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
1851
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
1852
|
+
| className | string | — | Additional classes for the modal element. |
|
|
1770
1853
|
|
|
1771
1854
|
## MediaDialog
|
|
1772
1855
|
|
|
@@ -1902,26 +1985,40 @@ export default () => {
|
|
|
1902
1985
|
</div>;
|
|
1903
1986
|
```
|
|
1904
1987
|
|
|
1905
|
-
#### Props
|
|
1988
|
+
#### Props: Base dialog props
|
|
1989
|
+
|
|
1990
|
+
### Base dialog props
|
|
1906
1991
|
|
|
1907
1992
|
| Name | Type | Default | Description |
|
|
1908
1993
|
| --- | --- | --- | --- |
|
|
1909
|
-
| show |
|
|
1910
|
-
| title |
|
|
1911
|
-
| subtitle |
|
|
1912
|
-
|
|
|
1913
|
-
| onClose |
|
|
1914
|
-
|
|
|
1915
|
-
|
|
|
1916
|
-
|
|
|
1917
|
-
|
|
|
1918
|
-
|
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
|
|
|
1994
|
+
| show | boolean | false | Opens the dialog when set to true. |
|
|
1995
|
+
| title | React.ReactNode | — | The dialog title (can also be a FormattedMessage component). |
|
|
1996
|
+
| subtitle | React.ReactNode | — | The dialog header subtitle content. |
|
|
1997
|
+
| showCloseButton | boolean | true | Shows a close button when set to true. |
|
|
1998
|
+
| onClose | () => void | — | A callback function invoked when the dialog closes. |
|
|
1999
|
+
| bsSize | DialogSize | '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: 'xs' 'sm' 'lg' 'xl' 'fullwidth' 'fullheight' 'fullheight-lg' 'fullheight-xl' 'fullscreen' |
|
|
2000
|
+
| disableEsc | boolean | false | Enables or disabled closing the dialog via esc key. |
|
|
2001
|
+
| useOverflow | boolean | false | Enables the modal body to overflow and use inline scrolling if needed. |
|
|
2002
|
+
| showXsDialogBorders | boolean | false | Show Header and Footer Borders for the "xs" dialog |
|
|
2003
|
+
| className | string | — | Additional classes for the modal element. |
|
|
2004
|
+
|
|
2005
|
+
#### Props: MediaDialog
|
|
2006
|
+
|
|
2007
|
+
### MediaDialog
|
|
2008
|
+
|
|
2009
|
+
| Name | Type | Default | Description |
|
|
2010
|
+
| --- | --- | --- | --- |
|
|
2011
|
+
| media | MediaDialogMedia[] | — | List of media objects. |
|
|
2012
|
+
| └type | 'image' \| 'video' | — | Defines the media type that is going to be displayed. Possible values are: image and video. |
|
|
2013
|
+
| └src | string | — | The source location for the media data. |
|
|
2014
|
+
| └title | string \| React.ReactNode | — | The name or title of the media used for the dialogs title. |
|
|
2015
|
+
| └subtitle | string \| React.ReactNode | — | Additional media information used for the dialogs subtitle. |
|
|
2016
|
+
| └aspectRatio | '4by3' \| '16by9' | '16by9' | Only relevant for videos where the aspect of the video is defined. Possible values are: 4by3 and 16by9. |
|
|
2017
|
+
| └className | string | — | Additional classes for the image element. |
|
|
2018
|
+
| previousButtonText | string \| React.ReactNode | — | The button text for switching to the previous media if there are multiple. |
|
|
2019
|
+
| previousButtonCallback | (newIndex: number) => void | — | Callback function for when the previous button is clicked. |
|
|
2020
|
+
| nextButtonText | string \| React.ReactNode | — | The button text for switching to the next media if there are multiple. |
|
|
2021
|
+
| nextButtonCallback | (newIndex: number) => void | — | Callback function for when the next button is clicked. |
|
|
1925
2022
|
|
|
1926
2023
|
## FrameDialog
|
|
1927
2024
|
|
|
@@ -1943,7 +2040,7 @@ For more details, please visit iframe guidlines
|
|
|
1943
2040
|
import React from 'react';
|
|
1944
2041
|
import IframeResizer from 'iframe-resizer-react';
|
|
1945
2042
|
|
|
1946
|
-
import FrameDialog from '
|
|
2043
|
+
import FrameDialog from '@rio-cloud/rio-uikit/FrameDialog';
|
|
1947
2044
|
import { PREFIX } from '../../../widgets/WidgetDemo';
|
|
1948
2045
|
|
|
1949
2046
|
const IFrameWidgetExample = React.memo(() => {
|
|
@@ -1970,9 +2067,9 @@ export default IFrameWidgetExample;
|
|
|
1970
2067
|
// ----------------------------------------------------------
|
|
1971
2068
|
import { useState } from 'react';
|
|
1972
2069
|
|
|
1973
|
-
import Button from '
|
|
1974
|
-
import { OPEN_DIALOG_EVENT, CLOSE_DIALOG_EVENT, type OPEN_DIALOG_EVENT_TYPE } from '
|
|
1975
|
-
import usePostMessage, { type RemoteAction } from '
|
|
2070
|
+
import Button from '@rio-cloud/rio-uikit/Button';
|
|
2071
|
+
import { OPEN_DIALOG_EVENT, CLOSE_DIALOG_EVENT, type OPEN_DIALOG_EVENT_TYPE } from '@rio-cloud/rio-uikit/FrameDialog';
|
|
2072
|
+
import usePostMessage, { type RemoteAction } from '@rio-cloud/rio-uikit/usePostMessage';
|
|
1976
2073
|
|
|
1977
2074
|
export const PREFIX = 'EVENT_UIKIT_WIDGET_DEMO';
|
|
1978
2075
|
|
|
@@ -2018,10 +2115,10 @@ const WidgetDemo = () => {
|
|
|
2018
2115
|
export default WidgetDemo;
|
|
2019
2116
|
|
|
2020
2117
|
// ----------------------------------------------------------
|
|
2021
|
-
import Button from '
|
|
2022
|
-
import Dialog from '
|
|
2023
|
-
import usePostMessage from '
|
|
2024
|
-
import { CLOSE_DIALOG_EVENT } from '
|
|
2118
|
+
import Button from '@rio-cloud/rio-uikit/Button';
|
|
2119
|
+
import Dialog from '@rio-cloud/rio-uikit/Dialog';
|
|
2120
|
+
import usePostMessage from '@rio-cloud/rio-uikit/usePostMessage';
|
|
2121
|
+
import { CLOSE_DIALOG_EVENT } from '@rio-cloud/rio-uikit/FrameDialog';
|
|
2025
2122
|
|
|
2026
2123
|
import { dummyText } from '../../utils/data';
|
|
2027
2124
|
import { PREFIX } from './WidgetDemo';
|
|
@@ -2066,6 +2163,16 @@ export default WidgetDemo;
|
|
|
2066
2163
|
</div>
|
|
2067
2164
|
```
|
|
2068
2165
|
|
|
2166
|
+
#### Props: FrameDialog
|
|
2167
|
+
|
|
2168
|
+
### FrameDialog
|
|
2169
|
+
|
|
2170
|
+
| Name | Type | Default | Description |
|
|
2171
|
+
| --- | --- | --- | --- |
|
|
2172
|
+
| eventPrefix | string | 'EVENT_FRAME_DIALOG' | A prefix for all event types. |
|
|
2173
|
+
| getSourceFrame | () => HTMLIFrameElement \| null | — | A function to retrieve the iframe DOM element so a message can be sent to it. This is required when sending messages back to the origin widget iframe that triggered the dialog in the first place. |
|
|
2174
|
+
| className | string | — | Additional classes for the modal element. |
|
|
2175
|
+
|
|
2069
2176
|
## ReleaseNotesDialog
|
|
2070
2177
|
|
|
2071
2178
|
The ReleaseNotesDialog component is meant to be used for the release notes of a service.Note there exists also a separate ReleaseNotes component.
|
|
@@ -2237,8 +2344,14 @@ export default () => {
|
|
|
2237
2344
|
```json
|
|
2238
2345
|
{
|
|
2239
2346
|
"0.1.2": {
|
|
2240
|
-
date:
|
|
2241
|
-
content:
|
|
2347
|
+
date: '20.10.2023',
|
|
2348
|
+
content: (
|
|
2349
|
+
<div className='padding-left-15'>
|
|
2350
|
+
Summary
|
|
2351
|
+
• Feature 1
|
|
2352
|
+
• Feature 2
|
|
2353
|
+
</div>
|
|
2354
|
+
),
|
|
2242
2355
|
}
|
|
2243
2356
|
}
|
|
2244
2357
|
```
|