@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:* Application
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/appLayout
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:06:55.859Z
|
|
7
7
|
|
|
8
8
|
The ApplicationLayout components consists of three sub-components: ApplicationHeader, ApplicationBody, ApplicationSidebar
|
|
9
9
|
|
|
@@ -136,77 +136,6 @@ export default () => (
|
|
|
136
136
|
</div>
|
|
137
137
|
```
|
|
138
138
|
|
|
139
|
-
#### Props: ApplicationLayout
|
|
140
|
-
|
|
141
|
-
### ApplicationLayout
|
|
142
|
-
|
|
143
|
-
| Name | Type | Default | Description |
|
|
144
|
-
| --- | --- | --- | --- |
|
|
145
|
-
| layoutRef | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
146
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
147
|
-
|
|
148
|
-
#### Props: ApplicationLayoutHeader
|
|
149
|
-
|
|
150
|
-
### ApplicationLayoutHeader
|
|
151
|
-
|
|
152
|
-
| Name | Type | Default | Description |
|
|
153
|
-
| --- | --- | --- | --- |
|
|
154
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
155
|
-
|
|
156
|
-
#### Props: ApplicationLayoutSidebar
|
|
157
|
-
|
|
158
|
-
### ApplicationLayoutSidebar
|
|
159
|
-
|
|
160
|
-
| Name | Type | Default | Description |
|
|
161
|
-
| --- | --- | --- | --- |
|
|
162
|
-
| ref | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
163
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
164
|
-
|
|
165
|
-
#### Props: ApplicationLayoutBody
|
|
166
|
-
|
|
167
|
-
### ApplicationLayoutBody
|
|
168
|
-
|
|
169
|
-
| Name | Type | Default | Description |
|
|
170
|
-
| --- | --- | --- | --- |
|
|
171
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
172
|
-
| innerClassName | String | — | Additional class names that are added to the inner module-content component. |
|
|
173
|
-
| children | any | — | Any component given to the layout components will be rendered |
|
|
174
|
-
| navigation | any | — | The ApplicationLayoutBodyNavigation component. |
|
|
175
|
-
| enableScrollToTop | Boolean | true | Show scroll to top button after scrolling the content. |
|
|
176
|
-
| forceScrollbar | Boolean | false | Always show vertical scrollbar to prevent the content from jumping. |
|
|
177
|
-
| bottomBar | Node \| String | — | Optional bottom bar component or a simple string. |
|
|
178
|
-
| bottomBarHeight | Number | 54 | Height of the bottomBar in pixel. |
|
|
179
|
-
| banner | any | — | The ApplicationLayoutBodyBanner component. |
|
|
180
|
-
|
|
181
|
-
#### Props: ApplicationLayoutBodyNavigation
|
|
182
|
-
|
|
183
|
-
### ApplicationLayoutBodyNavigation
|
|
184
|
-
|
|
185
|
-
| Name | Type | Default | Description |
|
|
186
|
-
| --- | --- | --- | --- |
|
|
187
|
-
| className | String | — | Additional class names that are added to the respective component. Example: "has-offset" |
|
|
188
|
-
|
|
189
|
-
#### Props: ApplicationLayoutBodyBottomBar
|
|
190
|
-
|
|
191
|
-
### ApplicationLayoutBodyBottomBar
|
|
192
|
-
|
|
193
|
-
| Name | Type | Default | Description |
|
|
194
|
-
| --- | --- | --- | --- |
|
|
195
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
196
|
-
| buttonAlignment | String | — | Tells the buttons if they are left or right aligned. Default behavior is: 1st button left and 2nd button right. ApplicationLayoutBodyBottomBar.LEFT, ApplicationLayoutBodyBottomBar.RIGHT or 'left''right' |
|
|
197
|
-
| useBodyPaddings | Boolean | false | Use same paddings (left and right) as the ApplicationLayoutBody. |
|
|
198
|
-
|
|
199
|
-
#### Props: ApplicationLayoutBodyBanner
|
|
200
|
-
|
|
201
|
-
### ApplicationLayoutBodyBanner
|
|
202
|
-
|
|
203
|
-
| Name | Type | Default | Description |
|
|
204
|
-
| --- | --- | --- | --- |
|
|
205
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
206
|
-
| backgroundColor | String | bg-primary | One of our bg-color utility classes. |
|
|
207
|
-
| textColor | string | text-color-white | One of our text-color utility classes. |
|
|
208
|
-
| isSticky | Boolean | false | Sticky while scrolling. |
|
|
209
|
-
|
|
210
139
|
## SubNavigation example
|
|
211
140
|
|
|
212
141
|
### Example: Example 2
|
|
@@ -414,77 +343,6 @@ const useResizer = () => {
|
|
|
414
343
|
</div>
|
|
415
344
|
```
|
|
416
345
|
|
|
417
|
-
#### Props: ApplicationLayout
|
|
418
|
-
|
|
419
|
-
### ApplicationLayout
|
|
420
|
-
|
|
421
|
-
| Name | Type | Default | Description |
|
|
422
|
-
| --- | --- | --- | --- |
|
|
423
|
-
| layoutRef | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
424
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
425
|
-
|
|
426
|
-
#### Props: ApplicationLayoutHeader
|
|
427
|
-
|
|
428
|
-
### ApplicationLayoutHeader
|
|
429
|
-
|
|
430
|
-
| Name | Type | Default | Description |
|
|
431
|
-
| --- | --- | --- | --- |
|
|
432
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
433
|
-
|
|
434
|
-
#### Props: ApplicationLayoutSidebar
|
|
435
|
-
|
|
436
|
-
### ApplicationLayoutSidebar
|
|
437
|
-
|
|
438
|
-
| Name | Type | Default | Description |
|
|
439
|
-
| --- | --- | --- | --- |
|
|
440
|
-
| ref | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
441
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
442
|
-
|
|
443
|
-
#### Props: ApplicationLayoutBody
|
|
444
|
-
|
|
445
|
-
### ApplicationLayoutBody
|
|
446
|
-
|
|
447
|
-
| Name | Type | Default | Description |
|
|
448
|
-
| --- | --- | --- | --- |
|
|
449
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
450
|
-
| innerClassName | String | — | Additional class names that are added to the inner module-content component. |
|
|
451
|
-
| children | any | — | Any component given to the layout components will be rendered |
|
|
452
|
-
| navigation | any | — | The ApplicationLayoutBodyNavigation component. |
|
|
453
|
-
| enableScrollToTop | Boolean | true | Show scroll to top button after scrolling the content. |
|
|
454
|
-
| forceScrollbar | Boolean | false | Always show vertical scrollbar to prevent the content from jumping. |
|
|
455
|
-
| bottomBar | Node \| String | — | Optional bottom bar component or a simple string. |
|
|
456
|
-
| bottomBarHeight | Number | 54 | Height of the bottomBar in pixel. |
|
|
457
|
-
| banner | any | — | The ApplicationLayoutBodyBanner component. |
|
|
458
|
-
|
|
459
|
-
#### Props: ApplicationLayoutBodyNavigation
|
|
460
|
-
|
|
461
|
-
### ApplicationLayoutBodyNavigation
|
|
462
|
-
|
|
463
|
-
| Name | Type | Default | Description |
|
|
464
|
-
| --- | --- | --- | --- |
|
|
465
|
-
| className | String | — | Additional class names that are added to the respective component. Example: "has-offset" |
|
|
466
|
-
|
|
467
|
-
#### Props: ApplicationLayoutBodyBottomBar
|
|
468
|
-
|
|
469
|
-
### ApplicationLayoutBodyBottomBar
|
|
470
|
-
|
|
471
|
-
| Name | Type | Default | Description |
|
|
472
|
-
| --- | --- | --- | --- |
|
|
473
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
474
|
-
| buttonAlignment | String | — | Tells the buttons if they are left or right aligned. Default behavior is: 1st button left and 2nd button right. ApplicationLayoutBodyBottomBar.LEFT, ApplicationLayoutBodyBottomBar.RIGHT or 'left''right' |
|
|
475
|
-
| useBodyPaddings | Boolean | false | Use same paddings (left and right) as the ApplicationLayoutBody. |
|
|
476
|
-
|
|
477
|
-
#### Props: ApplicationLayoutBodyBanner
|
|
478
|
-
|
|
479
|
-
### ApplicationLayoutBodyBanner
|
|
480
|
-
|
|
481
|
-
| Name | Type | Default | Description |
|
|
482
|
-
| --- | --- | --- | --- |
|
|
483
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
484
|
-
| backgroundColor | String | bg-primary | One of our bg-color utility classes. |
|
|
485
|
-
| textColor | string | text-color-white | One of our text-color utility classes. |
|
|
486
|
-
| isSticky | Boolean | false | Sticky while scrolling. |
|
|
487
|
-
|
|
488
346
|
## Body banner example
|
|
489
347
|
|
|
490
348
|
### Example: Example 3
|
|
@@ -619,77 +477,6 @@ export default () => (
|
|
|
619
477
|
</div>
|
|
620
478
|
```
|
|
621
479
|
|
|
622
|
-
#### Props: ApplicationLayout
|
|
623
|
-
|
|
624
|
-
### ApplicationLayout
|
|
625
|
-
|
|
626
|
-
| Name | Type | Default | Description |
|
|
627
|
-
| --- | --- | --- | --- |
|
|
628
|
-
| layoutRef | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
629
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
630
|
-
|
|
631
|
-
#### Props: ApplicationLayoutHeader
|
|
632
|
-
|
|
633
|
-
### ApplicationLayoutHeader
|
|
634
|
-
|
|
635
|
-
| Name | Type | Default | Description |
|
|
636
|
-
| --- | --- | --- | --- |
|
|
637
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
638
|
-
|
|
639
|
-
#### Props: ApplicationLayoutSidebar
|
|
640
|
-
|
|
641
|
-
### ApplicationLayoutSidebar
|
|
642
|
-
|
|
643
|
-
| Name | Type | Default | Description |
|
|
644
|
-
| --- | --- | --- | --- |
|
|
645
|
-
| ref | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
646
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
647
|
-
|
|
648
|
-
#### Props: ApplicationLayoutBody
|
|
649
|
-
|
|
650
|
-
### ApplicationLayoutBody
|
|
651
|
-
|
|
652
|
-
| Name | Type | Default | Description |
|
|
653
|
-
| --- | --- | --- | --- |
|
|
654
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
655
|
-
| innerClassName | String | — | Additional class names that are added to the inner module-content component. |
|
|
656
|
-
| children | any | — | Any component given to the layout components will be rendered |
|
|
657
|
-
| navigation | any | — | The ApplicationLayoutBodyNavigation component. |
|
|
658
|
-
| enableScrollToTop | Boolean | true | Show scroll to top button after scrolling the content. |
|
|
659
|
-
| forceScrollbar | Boolean | false | Always show vertical scrollbar to prevent the content from jumping. |
|
|
660
|
-
| bottomBar | Node \| String | — | Optional bottom bar component or a simple string. |
|
|
661
|
-
| bottomBarHeight | Number | 54 | Height of the bottomBar in pixel. |
|
|
662
|
-
| banner | any | — | The ApplicationLayoutBodyBanner component. |
|
|
663
|
-
|
|
664
|
-
#### Props: ApplicationLayoutBodyNavigation
|
|
665
|
-
|
|
666
|
-
### ApplicationLayoutBodyNavigation
|
|
667
|
-
|
|
668
|
-
| Name | Type | Default | Description |
|
|
669
|
-
| --- | --- | --- | --- |
|
|
670
|
-
| className | String | — | Additional class names that are added to the respective component. Example: "has-offset" |
|
|
671
|
-
|
|
672
|
-
#### Props: ApplicationLayoutBodyBottomBar
|
|
673
|
-
|
|
674
|
-
### ApplicationLayoutBodyBottomBar
|
|
675
|
-
|
|
676
|
-
| Name | Type | Default | Description |
|
|
677
|
-
| --- | --- | --- | --- |
|
|
678
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
679
|
-
| buttonAlignment | String | — | Tells the buttons if they are left or right aligned. Default behavior is: 1st button left and 2nd button right. ApplicationLayoutBodyBottomBar.LEFT, ApplicationLayoutBodyBottomBar.RIGHT or 'left''right' |
|
|
680
|
-
| useBodyPaddings | Boolean | false | Use same paddings (left and right) as the ApplicationLayoutBody. |
|
|
681
|
-
|
|
682
|
-
#### Props: ApplicationLayoutBodyBanner
|
|
683
|
-
|
|
684
|
-
### ApplicationLayoutBodyBanner
|
|
685
|
-
|
|
686
|
-
| Name | Type | Default | Description |
|
|
687
|
-
| --- | --- | --- | --- |
|
|
688
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
689
|
-
| backgroundColor | String | bg-primary | One of our bg-color utility classes. |
|
|
690
|
-
| textColor | string | text-color-white | One of our text-color utility classes. |
|
|
691
|
-
| isSticky | Boolean | false | Sticky while scrolling. |
|
|
692
|
-
|
|
693
480
|
## Bottom bar example
|
|
694
481
|
|
|
695
482
|
### Example: Example 4
|
|
@@ -828,77 +615,6 @@ export default () => (
|
|
|
828
615
|
</div>
|
|
829
616
|
```
|
|
830
617
|
|
|
831
|
-
#### Props: ApplicationLayout
|
|
832
|
-
|
|
833
|
-
### ApplicationLayout
|
|
834
|
-
|
|
835
|
-
| Name | Type | Default | Description |
|
|
836
|
-
| --- | --- | --- | --- |
|
|
837
|
-
| layoutRef | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
838
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
839
|
-
|
|
840
|
-
#### Props: ApplicationLayoutHeader
|
|
841
|
-
|
|
842
|
-
### ApplicationLayoutHeader
|
|
843
|
-
|
|
844
|
-
| Name | Type | Default | Description |
|
|
845
|
-
| --- | --- | --- | --- |
|
|
846
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
847
|
-
|
|
848
|
-
#### Props: ApplicationLayoutSidebar
|
|
849
|
-
|
|
850
|
-
### ApplicationLayoutSidebar
|
|
851
|
-
|
|
852
|
-
| Name | Type | Default | Description |
|
|
853
|
-
| --- | --- | --- | --- |
|
|
854
|
-
| ref | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
855
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
856
|
-
|
|
857
|
-
#### Props: ApplicationLayoutBody
|
|
858
|
-
|
|
859
|
-
### ApplicationLayoutBody
|
|
860
|
-
|
|
861
|
-
| Name | Type | Default | Description |
|
|
862
|
-
| --- | --- | --- | --- |
|
|
863
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
864
|
-
| innerClassName | String | — | Additional class names that are added to the inner module-content component. |
|
|
865
|
-
| children | any | — | Any component given to the layout components will be rendered |
|
|
866
|
-
| navigation | any | — | The ApplicationLayoutBodyNavigation component. |
|
|
867
|
-
| enableScrollToTop | Boolean | true | Show scroll to top button after scrolling the content. |
|
|
868
|
-
| forceScrollbar | Boolean | false | Always show vertical scrollbar to prevent the content from jumping. |
|
|
869
|
-
| bottomBar | Node \| String | — | Optional bottom bar component or a simple string. |
|
|
870
|
-
| bottomBarHeight | Number | 54 | Height of the bottomBar in pixel. |
|
|
871
|
-
| banner | any | — | The ApplicationLayoutBodyBanner component. |
|
|
872
|
-
|
|
873
|
-
#### Props: ApplicationLayoutBodyNavigation
|
|
874
|
-
|
|
875
|
-
### ApplicationLayoutBodyNavigation
|
|
876
|
-
|
|
877
|
-
| Name | Type | Default | Description |
|
|
878
|
-
| --- | --- | --- | --- |
|
|
879
|
-
| className | String | — | Additional class names that are added to the respective component. Example: "has-offset" |
|
|
880
|
-
|
|
881
|
-
#### Props: ApplicationLayoutBodyBottomBar
|
|
882
|
-
|
|
883
|
-
### ApplicationLayoutBodyBottomBar
|
|
884
|
-
|
|
885
|
-
| Name | Type | Default | Description |
|
|
886
|
-
| --- | --- | --- | --- |
|
|
887
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
888
|
-
| buttonAlignment | String | — | Tells the buttons if they are left or right aligned. Default behavior is: 1st button left and 2nd button right. ApplicationLayoutBodyBottomBar.LEFT, ApplicationLayoutBodyBottomBar.RIGHT or 'left''right' |
|
|
889
|
-
| useBodyPaddings | Boolean | false | Use same paddings (left and right) as the ApplicationLayoutBody. |
|
|
890
|
-
|
|
891
|
-
#### Props: ApplicationLayoutBodyBanner
|
|
892
|
-
|
|
893
|
-
### ApplicationLayoutBodyBanner
|
|
894
|
-
|
|
895
|
-
| Name | Type | Default | Description |
|
|
896
|
-
| --- | --- | --- | --- |
|
|
897
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
898
|
-
| backgroundColor | String | bg-primary | One of our bg-color utility classes. |
|
|
899
|
-
| textColor | string | text-color-white | One of our text-color utility classes. |
|
|
900
|
-
| isSticky | Boolean | false | Sticky while scrolling. |
|
|
901
|
-
|
|
902
618
|
## Sidebar Example
|
|
903
619
|
|
|
904
620
|
### Example: Example 5
|
|
@@ -1077,77 +793,6 @@ export default () => (
|
|
|
1077
793
|
</div>
|
|
1078
794
|
```
|
|
1079
795
|
|
|
1080
|
-
#### Props: ApplicationLayout
|
|
1081
|
-
|
|
1082
|
-
### ApplicationLayout
|
|
1083
|
-
|
|
1084
|
-
| Name | Type | Default | Description |
|
|
1085
|
-
| --- | --- | --- | --- |
|
|
1086
|
-
| layoutRef | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
1087
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
1088
|
-
|
|
1089
|
-
#### Props: ApplicationLayoutHeader
|
|
1090
|
-
|
|
1091
|
-
### ApplicationLayoutHeader
|
|
1092
|
-
|
|
1093
|
-
| Name | Type | Default | Description |
|
|
1094
|
-
| --- | --- | --- | --- |
|
|
1095
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
1096
|
-
|
|
1097
|
-
#### Props: ApplicationLayoutSidebar
|
|
1098
|
-
|
|
1099
|
-
### ApplicationLayoutSidebar
|
|
1100
|
-
|
|
1101
|
-
| Name | Type | Default | Description |
|
|
1102
|
-
| --- | --- | --- | --- |
|
|
1103
|
-
| ref | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
1104
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
1105
|
-
|
|
1106
|
-
#### Props: ApplicationLayoutBody
|
|
1107
|
-
|
|
1108
|
-
### ApplicationLayoutBody
|
|
1109
|
-
|
|
1110
|
-
| Name | Type | Default | Description |
|
|
1111
|
-
| --- | --- | --- | --- |
|
|
1112
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
1113
|
-
| innerClassName | String | — | Additional class names that are added to the inner module-content component. |
|
|
1114
|
-
| children | any | — | Any component given to the layout components will be rendered |
|
|
1115
|
-
| navigation | any | — | The ApplicationLayoutBodyNavigation component. |
|
|
1116
|
-
| enableScrollToTop | Boolean | true | Show scroll to top button after scrolling the content. |
|
|
1117
|
-
| forceScrollbar | Boolean | false | Always show vertical scrollbar to prevent the content from jumping. |
|
|
1118
|
-
| bottomBar | Node \| String | — | Optional bottom bar component or a simple string. |
|
|
1119
|
-
| bottomBarHeight | Number | 54 | Height of the bottomBar in pixel. |
|
|
1120
|
-
| banner | any | — | The ApplicationLayoutBodyBanner component. |
|
|
1121
|
-
|
|
1122
|
-
#### Props: ApplicationLayoutBodyNavigation
|
|
1123
|
-
|
|
1124
|
-
### ApplicationLayoutBodyNavigation
|
|
1125
|
-
|
|
1126
|
-
| Name | Type | Default | Description |
|
|
1127
|
-
| --- | --- | --- | --- |
|
|
1128
|
-
| className | String | — | Additional class names that are added to the respective component. Example: "has-offset" |
|
|
1129
|
-
|
|
1130
|
-
#### Props: ApplicationLayoutBodyBottomBar
|
|
1131
|
-
|
|
1132
|
-
### ApplicationLayoutBodyBottomBar
|
|
1133
|
-
|
|
1134
|
-
| Name | Type | Default | Description |
|
|
1135
|
-
| --- | --- | --- | --- |
|
|
1136
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
1137
|
-
| buttonAlignment | String | — | Tells the buttons if they are left or right aligned. Default behavior is: 1st button left and 2nd button right. ApplicationLayoutBodyBottomBar.LEFT, ApplicationLayoutBodyBottomBar.RIGHT or 'left''right' |
|
|
1138
|
-
| useBodyPaddings | Boolean | false | Use same paddings (left and right) as the ApplicationLayoutBody. |
|
|
1139
|
-
|
|
1140
|
-
#### Props: ApplicationLayoutBodyBanner
|
|
1141
|
-
|
|
1142
|
-
### ApplicationLayoutBodyBanner
|
|
1143
|
-
|
|
1144
|
-
| Name | Type | Default | Description |
|
|
1145
|
-
| --- | --- | --- | --- |
|
|
1146
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
1147
|
-
| backgroundColor | String | bg-primary | One of our bg-color utility classes. |
|
|
1148
|
-
| textColor | string | text-color-white | One of our text-color utility classes. |
|
|
1149
|
-
| isSticky | Boolean | false | Sticky while scrolling. |
|
|
1150
|
-
|
|
1151
796
|
## Complete example with all components
|
|
1152
797
|
|
|
1153
798
|
### Example: Example 6
|
|
@@ -1160,17 +805,15 @@ Navigation 3
|
|
|
1160
805
|
|
|
1161
806
|
4
|
|
1162
807
|
|
|
1163
|
-
3
|
|
1164
808
|
1
|
|
1165
|
-
2
|
|
1166
809
|
1
|
|
810
|
+
1
|
|
811
|
+
2
|
|
1167
812
|
|
|
1168
|
-
Asset
|
|
1169
|
-
Vehicle-
|
|
1170
|
-
Vehicle-
|
|
1171
|
-
Vehicle-
|
|
1172
|
-
Vehicle-6558Asset 1000
|
|
1173
|
-
Vehicle-9897Asset 1003
|
|
813
|
+
Asset Group3
|
|
814
|
+
Vehicle-3474Asset 1001
|
|
815
|
+
Vehicle-4057Asset 1004
|
|
816
|
+
Vehicle-7625Asset 1002
|
|
1174
817
|
|
|
1175
818
|
Ungrouped2
|
|
1176
819
|
|
|
@@ -1207,17 +850,15 @@ Navigation 3
|
|
|
1207
850
|
|
|
1208
851
|
4
|
|
1209
852
|
|
|
1210
|
-
3
|
|
1211
853
|
1
|
|
1212
|
-
2
|
|
1213
854
|
1
|
|
855
|
+
1
|
|
856
|
+
2
|
|
1214
857
|
|
|
1215
|
-
Asset
|
|
1216
|
-
Vehicle-
|
|
1217
|
-
Vehicle-
|
|
1218
|
-
Vehicle-
|
|
1219
|
-
Vehicle-6558Asset 1000
|
|
1220
|
-
Vehicle-9897Asset 1003
|
|
858
|
+
Asset Group3
|
|
859
|
+
Vehicle-3474Asset 1001
|
|
860
|
+
Vehicle-4057Asset 1004
|
|
861
|
+
Vehicle-7625Asset 1002
|
|
1221
862
|
|
|
1222
863
|
Ungrouped2
|
|
1223
864
|
|
|
@@ -1250,7 +891,7 @@ Bottom Button
|
|
|
1250
891
|
import { useState, useEffect } from 'react';
|
|
1251
892
|
import { Link, NavLink } from 'react-router-dom';
|
|
1252
893
|
import { random } from 'es-toolkit/compat';
|
|
1253
|
-
import faker from 'faker';
|
|
894
|
+
import { faker } from '@faker-js/faker';
|
|
1254
895
|
import IframeResizer from 'iframe-resizer-react';
|
|
1255
896
|
|
|
1256
897
|
import ApplicationLayout from '@rio-cloud/rio-uikit/ApplicationLayout';
|
|
@@ -1559,15 +1200,15 @@ const assets = Array.from({ length: random(5, 20) }, (_, index) => ({
|
|
|
1559
1200
|
id: `010191ac-d06d-4567-b13a-7b7fd85d97${index}`,
|
|
1560
1201
|
name: `Vehicle-${random(1000, 9999)}`,
|
|
1561
1202
|
info: `Asset 1${String(index).padStart(3, '0')}`,
|
|
1562
|
-
type: faker.
|
|
1563
|
-
groupIds: [faker.
|
|
1203
|
+
type: faker.helpers.arrayElement(['truck', 'trailer', 'van', 'bus']),
|
|
1204
|
+
groupIds: [faker.helpers.arrayElement(assetGroups).id],
|
|
1564
1205
|
}));
|
|
1565
1206
|
|
|
1566
1207
|
const randomDrivers = Array.from({ length: 200 }, (_, index) => ({
|
|
1567
1208
|
id: `74e8eb86-18a1-4abe-90cb-aeee7909f85${index}`,
|
|
1568
1209
|
name: {
|
|
1569
|
-
firstName: faker.internet.
|
|
1570
|
-
lastName: faker.
|
|
1210
|
+
firstName: faker.internet.username(),
|
|
1211
|
+
lastName: faker.person.firstName(),
|
|
1571
1212
|
},
|
|
1572
1213
|
type: 'driver',
|
|
1573
1214
|
}));
|
|
@@ -1707,23 +1348,23 @@ const randomDrivers = Array.from({ length: 200 }, (_, index) => ({
|
|
|
1707
1348
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1708
1349
|
<span class="rioglyph rioglyph-trailer text-size-16 margin-right-2">
|
|
1709
1350
|
</span>
|
|
1710
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">3</span>
|
|
1711
|
-
</div>
|
|
1712
|
-
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1713
|
-
<span class="rioglyph rioglyph-truck text-size-16 margin-right-2">
|
|
1714
|
-
</span>
|
|
1715
1351
|
<span class="TreeLabelCount label label-condensed label-muted label-filled">1</span>
|
|
1716
1352
|
</div>
|
|
1717
1353
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1718
1354
|
<span class="rioglyph rioglyph-van text-size-16 margin-right-2">
|
|
1719
1355
|
</span>
|
|
1720
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
1356
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">1</span>
|
|
1721
1357
|
</div>
|
|
1722
1358
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1723
1359
|
<span class="rioglyph rioglyph-bus text-size-16 margin-right-2">
|
|
1724
1360
|
</span>
|
|
1725
1361
|
<span class="TreeLabelCount label label-condensed label-muted label-filled">1</span>
|
|
1726
1362
|
</div>
|
|
1363
|
+
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1364
|
+
<span class="rioglyph rioglyph-truck text-size-16 margin-right-2">
|
|
1365
|
+
</span>
|
|
1366
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">2</span>
|
|
1367
|
+
</div>
|
|
1727
1368
|
</div>
|
|
1728
1369
|
</div>
|
|
1729
1370
|
</div>
|
|
@@ -1740,41 +1381,11 @@ const randomDrivers = Array.from({ length: 200 }, (_, index) => ({
|
|
|
1740
1381
|
<span class="TreeLabelNameText">
|
|
1741
1382
|
<span class="TreeLabelNameTextHeadline">Asset Group</span>
|
|
1742
1383
|
</span>
|
|
1743
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
1384
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">3</span>
|
|
1744
1385
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
1745
1386
|
</span>
|
|
1746
1387
|
</span>
|
|
1747
1388
|
</div>
|
|
1748
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d972">
|
|
1749
|
-
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1750
|
-
<input type="checkbox" class="TreeCheckbox">
|
|
1751
|
-
<span class="checkbox-text">
|
|
1752
|
-
</span>
|
|
1753
|
-
</label>
|
|
1754
|
-
<span class="TreeLabel TreeLabelName">
|
|
1755
|
-
<span class="rioglyph rioglyph-van">
|
|
1756
|
-
</span>
|
|
1757
|
-
<span class="TreeLabelNameText">
|
|
1758
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-2702</span>
|
|
1759
|
-
<span class="TreeLabelNameTextSubline">Asset 1002</span>
|
|
1760
|
-
</span>
|
|
1761
|
-
</span>
|
|
1762
|
-
</div>
|
|
1763
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d976">
|
|
1764
|
-
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1765
|
-
<input type="checkbox" class="TreeCheckbox">
|
|
1766
|
-
<span class="checkbox-text">
|
|
1767
|
-
</span>
|
|
1768
|
-
</label>
|
|
1769
|
-
<span class="TreeLabel TreeLabelName">
|
|
1770
|
-
<span class="rioglyph rioglyph-bus">
|
|
1771
|
-
</span>
|
|
1772
|
-
<span class="TreeLabelNameText">
|
|
1773
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-2861</span>
|
|
1774
|
-
<span class="TreeLabelNameTextSubline">Asset 1006</span>
|
|
1775
|
-
</span>
|
|
1776
|
-
</span>
|
|
1777
|
-
</div>
|
|
1778
1389
|
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d971">
|
|
1779
1390
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1780
1391
|
<input type="checkbox" class="TreeCheckbox">
|
|
@@ -1782,41 +1393,41 @@ const randomDrivers = Array.from({ length: 200 }, (_, index) => ({
|
|
|
1782
1393
|
</span>
|
|
1783
1394
|
</label>
|
|
1784
1395
|
<span class="TreeLabel TreeLabelName">
|
|
1785
|
-
<span class="rioglyph rioglyph-
|
|
1396
|
+
<span class="rioglyph rioglyph-van">
|
|
1786
1397
|
</span>
|
|
1787
1398
|
<span class="TreeLabelNameText">
|
|
1788
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1399
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-3474</span>
|
|
1789
1400
|
<span class="TreeLabelNameTextSubline">Asset 1001</span>
|
|
1790
1401
|
</span>
|
|
1791
1402
|
</span>
|
|
1792
1403
|
</div>
|
|
1793
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1404
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d974">
|
|
1794
1405
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1795
1406
|
<input type="checkbox" class="TreeCheckbox">
|
|
1796
1407
|
<span class="checkbox-text">
|
|
1797
1408
|
</span>
|
|
1798
1409
|
</label>
|
|
1799
1410
|
<span class="TreeLabel TreeLabelName">
|
|
1800
|
-
<span class="rioglyph rioglyph-
|
|
1411
|
+
<span class="rioglyph rioglyph-truck">
|
|
1801
1412
|
</span>
|
|
1802
1413
|
<span class="TreeLabelNameText">
|
|
1803
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1804
|
-
<span class="TreeLabelNameTextSubline">Asset
|
|
1414
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-4057</span>
|
|
1415
|
+
<span class="TreeLabelNameTextSubline">Asset 1004</span>
|
|
1805
1416
|
</span>
|
|
1806
1417
|
</span>
|
|
1807
1418
|
</div>
|
|
1808
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1419
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d972">
|
|
1809
1420
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1810
1421
|
<input type="checkbox" class="TreeCheckbox">
|
|
1811
1422
|
<span class="checkbox-text">
|
|
1812
1423
|
</span>
|
|
1813
1424
|
</label>
|
|
1814
1425
|
<span class="TreeLabel TreeLabelName">
|
|
1815
|
-
<span class="rioglyph rioglyph-
|
|
1426
|
+
<span class="rioglyph rioglyph-bus">
|
|
1816
1427
|
</span>
|
|
1817
1428
|
<span class="TreeLabelNameText">
|
|
1818
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1819
|
-
<span class="TreeLabelNameTextSubline">Asset
|
|
1429
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-7625</span>
|
|
1430
|
+
<span class="TreeLabelNameTextSubline">Asset 1002</span>
|
|
1820
1431
|
</span>
|
|
1821
1432
|
</span>
|
|
1822
1433
|
</div>
|
|
@@ -2000,75 +1611,4 @@ const randomDrivers = Array.from({ length: 200 }, (_, index) => ({
|
|
|
2000
1611
|
<button type="button" class="btn btn-primary">Bottom Button</button>
|
|
2001
1612
|
</div>
|
|
2002
1613
|
</div>
|
|
2003
|
-
```
|
|
2004
|
-
|
|
2005
|
-
#### Props: ApplicationLayout
|
|
2006
|
-
|
|
2007
|
-
### ApplicationLayout
|
|
2008
|
-
|
|
2009
|
-
| Name | Type | Default | Description |
|
|
2010
|
-
| --- | --- | --- | --- |
|
|
2011
|
-
| layoutRef | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
2012
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
2013
|
-
|
|
2014
|
-
#### Props: ApplicationLayoutHeader
|
|
2015
|
-
|
|
2016
|
-
### ApplicationLayoutHeader
|
|
2017
|
-
|
|
2018
|
-
| Name | Type | Default | Description |
|
|
2019
|
-
| --- | --- | --- | --- |
|
|
2020
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
2021
|
-
|
|
2022
|
-
#### Props: ApplicationLayoutSidebar
|
|
2023
|
-
|
|
2024
|
-
### ApplicationLayoutSidebar
|
|
2025
|
-
|
|
2026
|
-
| Name | Type | Default | Description |
|
|
2027
|
-
| --- | --- | --- | --- |
|
|
2028
|
-
| ref | React.ref | — | A React ref function assigned to the wrapper element. |
|
|
2029
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
2030
|
-
|
|
2031
|
-
#### Props: ApplicationLayoutBody
|
|
2032
|
-
|
|
2033
|
-
### ApplicationLayoutBody
|
|
2034
|
-
|
|
2035
|
-
| Name | Type | Default | Description |
|
|
2036
|
-
| --- | --- | --- | --- |
|
|
2037
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
2038
|
-
| innerClassName | String | — | Additional class names that are added to the inner module-content component. |
|
|
2039
|
-
| children | any | — | Any component given to the layout components will be rendered |
|
|
2040
|
-
| navigation | any | — | The ApplicationLayoutBodyNavigation component. |
|
|
2041
|
-
| enableScrollToTop | Boolean | true | Show scroll to top button after scrolling the content. |
|
|
2042
|
-
| forceScrollbar | Boolean | false | Always show vertical scrollbar to prevent the content from jumping. |
|
|
2043
|
-
| bottomBar | Node \| String | — | Optional bottom bar component or a simple string. |
|
|
2044
|
-
| bottomBarHeight | Number | 54 | Height of the bottomBar in pixel. |
|
|
2045
|
-
| banner | any | — | The ApplicationLayoutBodyBanner component. |
|
|
2046
|
-
|
|
2047
|
-
#### Props: ApplicationLayoutBodyNavigation
|
|
2048
|
-
|
|
2049
|
-
### ApplicationLayoutBodyNavigation
|
|
2050
|
-
|
|
2051
|
-
| Name | Type | Default | Description |
|
|
2052
|
-
| --- | --- | --- | --- |
|
|
2053
|
-
| className | String | — | Additional class names that are added to the respective component. Example: "has-offset" |
|
|
2054
|
-
|
|
2055
|
-
#### Props: ApplicationLayoutBodyBottomBar
|
|
2056
|
-
|
|
2057
|
-
### ApplicationLayoutBodyBottomBar
|
|
2058
|
-
|
|
2059
|
-
| Name | Type | Default | Description |
|
|
2060
|
-
| --- | --- | --- | --- |
|
|
2061
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
2062
|
-
| buttonAlignment | String | — | Tells the buttons if they are left or right aligned. Default behavior is: 1st button left and 2nd button right. ApplicationLayoutBodyBottomBar.LEFT, ApplicationLayoutBodyBottomBar.RIGHT or 'left''right' |
|
|
2063
|
-
| useBodyPaddings | Boolean | false | Use same paddings (left and right) as the ApplicationLayoutBody. |
|
|
2064
|
-
|
|
2065
|
-
#### Props: ApplicationLayoutBodyBanner
|
|
2066
|
-
|
|
2067
|
-
### ApplicationLayoutBodyBanner
|
|
2068
|
-
|
|
2069
|
-
| Name | Type | Default | Description |
|
|
2070
|
-
| --- | --- | --- | --- |
|
|
2071
|
-
| className | String | — | Additional class names that are added to the respective component. |
|
|
2072
|
-
| backgroundColor | String | bg-primary | One of our bg-color utility classes. |
|
|
2073
|
-
| textColor | string | text-color-white | One of our text-color utility classes. |
|
|
2074
|
-
| isSticky | Boolean | false | Sticky while scrolling. |
|
|
1614
|
+
```
|