@rio-cloud/uikit-mcp 1.1.4 → 1.1.6
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 +188 -88
- package/dist/docs/components/accentBar.md +35 -3
- package/dist/docs/components/activity.md +14 -3
- package/dist/docs/components/animatedNumber.md +17 -4
- package/dist/docs/components/animatedTextReveal.md +54 -8
- package/dist/docs/components/animations.md +33 -33
- package/dist/docs/components/appHeader.md +65 -9
- package/dist/docs/components/appLayout.md +566 -61
- package/dist/docs/components/appNavigationBar.md +55 -3
- package/dist/docs/components/areaCharts.md +14 -14
- package/dist/docs/components/aspectRatioPlaceholder.md +11 -3
- package/dist/docs/components/assetTree.md +1174 -328
- package/dist/docs/components/autosuggests.md +2 -2
- package/dist/docs/components/avatar.md +25 -3
- package/dist/docs/components/banner.md +3 -3
- package/dist/docs/components/barCharts.md +38 -38
- package/dist/docs/components/barList.md +22 -10
- package/dist/docs/components/basicMap.md +2 -2
- package/dist/docs/components/bottomSheet.md +100 -3
- package/dist/docs/components/button.md +549 -36
- package/dist/docs/components/buttonToolbar.md +10 -3
- package/dist/docs/components/calendarStripe.md +127 -85
- package/dist/docs/components/card.md +11 -3
- package/dist/docs/components/carousel.md +2 -2
- package/dist/docs/components/chartColors.md +2 -2
- package/dist/docs/components/chartsGettingStarted.md +2 -2
- package/dist/docs/components/chat.md +3 -3
- package/dist/docs/components/checkbox.md +67 -45
- package/dist/docs/components/circularProgress.md +465 -0
- package/dist/docs/components/clearableInput.md +18 -18
- package/dist/docs/components/collapse.md +28 -4
- package/dist/docs/components/composedCharts.md +20 -20
- package/dist/docs/components/contentLoader.md +126 -105
- package/dist/docs/components/dataTabs.md +191 -11
- package/dist/docs/components/datepickers.md +735 -723
- package/dist/docs/components/dialogs.md +362 -2
- package/dist/docs/components/divider.md +15 -3
- package/dist/docs/components/dropdowns.md +4548 -4355
- package/dist/docs/components/editableContent.md +187 -3
- package/dist/docs/components/expander.md +52 -5
- package/dist/docs/components/fade.md +42 -7
- package/dist/docs/components/fadeExpander.md +13 -4
- package/dist/docs/components/fadeUp.md +22 -4
- package/dist/docs/components/feedback.md +44 -3
- package/dist/docs/components/filePickers.md +45 -3
- package/dist/docs/components/formLabel.md +20 -5
- package/dist/docs/components/groupedItemList.md +54 -3
- package/dist/docs/components/iconList.md +5 -5
- package/dist/docs/components/imagePreloader.md +7 -3
- package/dist/docs/components/labeledElement.md +13 -3
- package/dist/docs/components/licensePlate.md +11 -3
- package/dist/docs/components/lineCharts.md +10 -10
- package/dist/docs/components/listMenu.md +78 -8
- package/dist/docs/components/loadMore.md +29 -3
- package/dist/docs/components/mainNavigation.md +5 -5
- package/dist/docs/components/mapCircle.md +2 -2
- package/dist/docs/components/mapCluster.md +2 -2
- package/dist/docs/components/mapContext.md +2 -2
- package/dist/docs/components/mapDraggableMarker.md +2 -2
- package/dist/docs/components/mapGettingStarted.md +2 -2
- package/dist/docs/components/mapInfoBubble.md +2 -2
- package/dist/docs/components/mapLayerGroup.md +2 -2
- package/dist/docs/components/mapMarker.md +2 -2
- package/dist/docs/components/mapPolygon.md +2 -2
- package/dist/docs/components/mapRoute.md +2 -2
- package/dist/docs/components/mapRouteGenerator.md +2 -2
- package/dist/docs/components/mapSettings.md +9 -9
- package/dist/docs/components/mapUtils.md +2 -2
- package/dist/docs/components/multiselects.md +2 -2
- package/dist/docs/components/noData.md +23 -3
- package/dist/docs/components/notifications.md +2 -2
- package/dist/docs/components/numbercontrol.md +54 -5
- package/dist/docs/components/onboarding.md +26 -2
- package/dist/docs/components/page.md +33 -3
- package/dist/docs/components/pager.md +15 -3
- package/dist/docs/components/pieCharts.md +89 -78
- package/dist/docs/components/popover.md +40 -2
- package/dist/docs/components/position.md +11 -3
- package/dist/docs/components/radialBarCharts.md +2054 -2012
- package/dist/docs/components/radioCardGroup.md +487 -0
- package/dist/docs/components/radiobutton.md +138 -10
- package/dist/docs/components/releaseNotes.md +19 -2
- package/dist/docs/components/resizer.md +14 -3
- package/dist/docs/components/responsiveColumnStripe.md +20 -3
- package/dist/docs/components/responsiveVideo.md +12 -3
- package/dist/docs/components/rioglyph.md +13 -3
- package/dist/docs/components/rules.md +95 -5
- package/dist/docs/components/saveableInput.md +400 -276
- package/dist/docs/components/selects.md +2 -2
- package/dist/docs/components/sidebar.md +39 -3
- package/dist/docs/components/sliders.md +38 -3
- package/dist/docs/components/smoothScrollbars.md +93 -3
- package/dist/docs/components/spinners.md +51 -3
- package/dist/docs/components/states.md +217 -2
- package/dist/docs/components/statsWidgets.md +123 -3
- package/dist/docs/components/statusBar.md +29 -3
- package/dist/docs/components/stepButton.md +9 -3
- package/dist/docs/components/steppedProgressBars.md +67 -3
- package/dist/docs/components/subNavigation.md +24 -17
- package/dist/docs/components/supportMarker.md +2 -2
- package/dist/docs/components/svgImage.md +13 -3
- package/dist/docs/components/switch.md +218 -82
- package/dist/docs/components/tables.md +2 -2
- package/dist/docs/components/tagManager.md +56 -2
- package/dist/docs/components/tags.md +33 -3
- package/dist/docs/components/teaser.md +30 -3
- package/dist/docs/components/textTruncateMiddle.md +151 -0
- package/dist/docs/components/timeline.md +2 -2
- package/dist/docs/components/timepicker.md +687 -63
- package/dist/docs/components/toggleButton.md +96 -10
- package/dist/docs/components/tooltip.md +30 -21
- package/dist/docs/components/tracker.md +631 -0
- package/dist/docs/components/virtualList.md +107 -84
- package/dist/docs/foundations.md +647 -275
- package/dist/docs/start/changelog.md +2 -738
- package/dist/docs/start/goodtoknow.md +2 -2
- package/dist/docs/start/guidelines/color-combinations.md +2 -2
- package/dist/docs/start/guidelines/custom-css.md +2 -2
- package/dist/docs/start/guidelines/custom-rioglyph.md +2 -2
- package/dist/docs/start/guidelines/formatting.md +2 -2
- package/dist/docs/start/guidelines/iframe.md +2 -2
- package/dist/docs/start/guidelines/obfuscate-data.md +2 -2
- package/dist/docs/start/guidelines/print-css.md +2 -2
- package/dist/docs/start/guidelines/spinner.md +82 -82
- package/dist/docs/start/guidelines/state-in-url.md +263 -0
- package/dist/docs/start/guidelines/supported-browsers.md +2 -2
- package/dist/docs/start/guidelines/writing.md +2 -2
- package/dist/docs/start/howto.md +10 -10
- package/dist/docs/start/intro.md +2 -2
- package/dist/docs/start/responsiveness.md +2 -2
- package/dist/docs/templates/common-table.md +15 -14
- package/dist/docs/templates/detail-views.md +3 -3
- package/dist/docs/templates/expandable-details.md +2 -2
- package/dist/docs/templates/feature-cards.md +56 -56
- package/dist/docs/templates/form-summary.md +23 -23
- package/dist/docs/templates/form-toggle.md +2 -2
- package/dist/docs/templates/list-blocks.md +204 -204
- package/dist/docs/templates/loading-progress.md +2 -2
- package/dist/docs/templates/options-panel.md +2 -2
- package/dist/docs/templates/panel-variants.md +2 -2
- package/dist/docs/templates/progress-cards.md +2 -2
- package/dist/docs/templates/progress-success.md +2 -2
- package/dist/docs/templates/settings-form.md +24 -24
- package/dist/docs/templates/stats-blocks.md +18 -18
- package/dist/docs/templates/table-panel.md +2 -2
- package/dist/docs/templates/table-row-animation.md +2 -2
- package/dist/docs/templates/usage-cards.md +2 -2
- package/dist/docs/utilities/classNames.md +191 -0
- package/dist/docs/utilities/deviceUtils.md +2 -2
- package/dist/docs/utilities/featureToggles.md +2 -2
- package/dist/docs/utilities/fuelTypeUtils.md +2 -2
- package/dist/docs/utilities/routeUtils.md +326 -90
- package/dist/docs/utilities/useAfterMount.md +2 -2
- package/dist/docs/utilities/useAutoAnimate.md +2 -2
- package/dist/docs/utilities/useAverage.md +2 -2
- package/dist/docs/utilities/useClickOutside.md +2 -2
- package/dist/docs/utilities/useClipboard.md +3 -3
- package/dist/docs/utilities/useCookies.md +188 -0
- package/dist/docs/utilities/useCount.md +2 -2
- package/dist/docs/utilities/useDarkMode.md +2 -2
- package/dist/docs/utilities/useDebugInfo.md +5 -5
- package/dist/docs/utilities/useEffectOnce.md +2 -2
- package/dist/docs/utilities/useElapsedTime.md +2 -2
- package/dist/docs/utilities/useElementSize.md +2 -2
- package/dist/docs/utilities/useEsc.md +2 -2
- package/dist/docs/utilities/useEvent.md +2 -2
- package/dist/docs/utilities/useFocusTrap.md +2 -2
- package/dist/docs/utilities/useFullscreen.md +2 -2
- package/dist/docs/utilities/useHover.md +2 -2
- package/dist/docs/utilities/useIncomingPostMessages.md +2 -2
- package/dist/docs/utilities/useInterval.md +2 -2
- package/dist/docs/utilities/useIsFocusWithin.md +2 -2
- package/dist/docs/utilities/useKey.md +2 -2
- package/dist/docs/utilities/useLocalStorage.md +2 -2
- package/dist/docs/utilities/useLocationSuggestions.md +2 -2
- package/dist/docs/utilities/useMax.md +2 -2
- package/dist/docs/utilities/useMin.md +2 -2
- package/dist/docs/utilities/useMutationObserver.md +2 -2
- package/dist/docs/utilities/useOnScreen.md +2 -2
- package/dist/docs/utilities/useOnlineStatus.md +2 -2
- package/dist/docs/utilities/usePostMessage.md +3 -3
- package/dist/docs/utilities/usePostMessageSender.md +2 -2
- package/dist/docs/utilities/usePrevious.md +2 -2
- package/dist/docs/utilities/useResizeObserver.md +2 -2
- package/dist/docs/utilities/useRioCookieConsent.md +90 -0
- package/dist/docs/utilities/useScrollPosition.md +2 -2
- package/dist/docs/utilities/useSearch.md +2 -2
- package/dist/docs/utilities/useSearchHighlight.md +815 -0
- package/dist/docs/utilities/useSorting.md +2 -2
- package/dist/docs/utilities/useStateWithValidation.md +2 -2
- package/dist/docs/utilities/useSum.md +2 -2
- package/dist/docs/utilities/useTableExport.md +53 -53
- package/dist/docs/utilities/useTableSelection.md +90 -90
- package/dist/docs/utilities/useTimeout.md +2 -2
- package/dist/docs/utilities/useToggle.md +3 -3
- package/dist/docs/utilities/useUrlState.md +418 -0
- package/dist/docs/utilities/useWindowResize.md +2 -2
- package/dist/index.mjs +8 -8
- package/dist/version.json +2 -2
- package/package.json +9 -9
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Selection
|
|
5
|
-
*Source:* https://uikit.developers.rio.cloud
|
|
6
|
-
*Captured:* 2026-
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#/components/autosuggests
|
|
6
|
+
*Captured:* 2026-02-23T13:41:52.196Z
|
|
7
7
|
|
|
8
8
|
For a more flexible and smart search we highly recommend using fuse.js as searching algorithm.For more information on how to configure it, see: https://fusejs.io
|
|
9
9
|
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
|
-
*Source:* https://uikit.developers.rio.cloud
|
|
6
|
-
*Captured:* 2026-
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#/components/avatar
|
|
6
|
+
*Captured:* 2026-02-23T13:42:21.816Z
|
|
7
7
|
|
|
8
8
|
The Avatar is a small component designed to render a users image, the initials of the users name or an icon.
|
|
9
9
|
|
|
@@ -83,6 +83,21 @@ export default () => (
|
|
|
83
83
|
</div>
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
+
#### Props
|
|
87
|
+
|
|
88
|
+
| Name | Type | Default | Description |
|
|
89
|
+
| --- | --- | --- | --- |
|
|
90
|
+
| name | string | — | When a name is provided, the Avatar automatically generates and displays the initials of that name. The name also appears in a tooltip when hovered over. |
|
|
91
|
+
| abbr | string | — | The abbreviation can also be defined manually. It is recommended to limit abbreviations to a maximum of 2 to 3 characters. |
|
|
92
|
+
| image | string | — | The image to be shown. When an image is displayed, the abbreviation is not shown. |
|
|
93
|
+
| alt | string | — | The image alt text. If not given, the name will be used. |
|
|
94
|
+
| iconName | string | 'user' | The name of an icon that should be shown instead of initials. If nothing is provided, a default icon will be shown. |
|
|
95
|
+
| size | number | 40 | The height and width of the component. |
|
|
96
|
+
| backgroundColor | string | 'bg-lighter' | The background color for the component. By default, the text and icon color is derived from the background color. |
|
|
97
|
+
| tooltip | string \| JSX.Element | — | The content of the Avatars tooltip. if nothing is provided, the name is used. |
|
|
98
|
+
| iconClassName | string | — | Additional classes set to the icon element. |
|
|
99
|
+
| className | string | — | Additional classes set to the wrapper element. |
|
|
100
|
+
|
|
86
101
|
## AvatarGroup
|
|
87
102
|
|
|
88
103
|
### Example: Example 2
|
|
@@ -181,4 +196,11 @@ export default () => (
|
|
|
181
196
|
</div>
|
|
182
197
|
</div>
|
|
183
198
|
</div>
|
|
184
|
-
```
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
#### Props
|
|
202
|
+
|
|
203
|
+
| Name | Type | Default | Description |
|
|
204
|
+
| --- | --- | --- | --- |
|
|
205
|
+
| maxItemsVisible | number | — | Maximum number of items to be shown. Items that overflow are grouped into a single Avatar that displays the overflow count. Collapsed names are shown inside a tooltip. By default all items are shown. |
|
|
206
|
+
| className | string | — | Additional classes set to the outer element. |
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Content
|
|
5
|
-
*Source:* https://uikit.developers.rio.cloud
|
|
6
|
-
*Captured:* 2026-
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#/components/banner
|
|
6
|
+
*Captured:* 2026-02-23T13:42:08.529Z
|
|
7
7
|
|
|
8
8
|
Convey information or prompt action through in-line banners, ideal for educational content, updates, or announcements.
|
|
9
9
|
|
|
@@ -76,7 +76,7 @@ export default () => {
|
|
|
76
76
|
<div style="position: relative;">
|
|
77
77
|
<div class="bg-white rounded border shadow-default padding-20 Banner display-flex text-color-darker overflow-hidden position-relative">
|
|
78
78
|
<div class="flex-1-1 overflow-hidden">
|
|
79
|
-
<div style="opacity: 0; transform: translateX(
|
|
79
|
+
<div style="opacity: 0; transform: translateX(21.9553px);">
|
|
80
80
|
<div class="display-flex align-items-start align-items-center-ls width-100pct gap-15 ">
|
|
81
81
|
<div class="BannerIcon flex-0 margin-x-5 min-width-25 ">
|
|
82
82
|
<svg xmlns="http://www.w3.org/2000/svg" width="80" height="60" viewBox="0 0 773 612" xmlns:xlink="http://www.w3.org/1999/xlink" role="img" artist="Katerina Limpitsouni" source="https://undraw.co/">
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Charts
|
|
5
|
-
*Source:* https://uikit.developers.rio.cloud
|
|
6
|
-
*Captured:* 2026-
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#/components/barCharts
|
|
6
|
+
*Captured:* 2026-02-23T13:43:00.102Z
|
|
7
7
|
|
|
8
8
|
## BarChart
|
|
9
9
|
|
|
@@ -13,13 +13,13 @@
|
|
|
13
13
|
|
|
14
14
|
Simple horizontal BarChart
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
JanuaryFebruaryMarchAprilMayJune
|
|
17
17
|
|
|
18
18
|
#### Summary
|
|
19
19
|
|
|
20
20
|
Simple horizontal BarChart
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
JanuaryFebruaryMarchAprilMayJune
|
|
23
23
|
|
|
24
24
|
#### React (tsx)
|
|
25
25
|
|
|
@@ -120,37 +120,37 @@ const data = [
|
|
|
120
120
|
<g tabindex="-1">
|
|
121
121
|
</g>
|
|
122
122
|
<g tabindex="-1">
|
|
123
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
123
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r0:">
|
|
124
124
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
125
125
|
<g class="recharts-layer">
|
|
126
126
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
127
|
-
<path fill="#30b4c0 " name="undefined" x="7.8" y="
|
|
128
|
-
69.8,
|
|
127
|
+
<path fill="#30b4c0 " name="undefined" x="7.8" y="50.6704" width="62" height="172.3296" class="recharts-rectangle" d="M7.8,53.6704A 3,3,0,0,1,10.8,50.6704L 66.8,50.6704A 3,3,0,0,1,
|
|
128
|
+
69.8,53.6704L 69.8,223L 7.8,223Z">
|
|
129
129
|
</path>
|
|
130
130
|
</g>
|
|
131
131
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
132
|
-
<path fill="#30b4c0 " name="undefined" x="85.8" y="
|
|
133
|
-
147.8,
|
|
132
|
+
<path fill="#30b4c0 " name="undefined" x="85.8" y="141.9904" width="62" height="81.0096" class="recharts-rectangle" d="M85.8,144.9904A 3,3,0,0,1,88.8,141.9904L 144.8,141.9904A 3,3,0,0,1,
|
|
133
|
+
147.8,144.9904L 147.8,223L 85.8,223Z">
|
|
134
134
|
</path>
|
|
135
135
|
</g>
|
|
136
136
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
137
|
-
<path fill="#30b4c0 " name="undefined" x="163.8" y="
|
|
138
|
-
225.8,
|
|
137
|
+
<path fill="#30b4c0 " name="undefined" x="163.8" y="177.34" width="62" height="45.66" class="recharts-rectangle" d="M163.8,180.34A 3,3,0,0,1,166.8,177.34L 222.8,177.34A 3,3,0,0,1,
|
|
138
|
+
225.8,180.34L 225.8,223L 163.8,223Z">
|
|
139
139
|
</path>
|
|
140
140
|
</g>
|
|
141
141
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
142
|
-
<path fill="#30b4c0 " name="undefined" x="241.8" y="
|
|
143
|
-
303.8,
|
|
142
|
+
<path fill="#30b4c0 " name="undefined" x="241.8" y="208.7128" width="62" height="14.2872" class="recharts-rectangle" d="M241.8,211.7128A 3,3,0,0,1,244.8,208.7128L 300.8,208.7128A 3,3,0,0,1,
|
|
143
|
+
303.8,211.7128L 303.8,223L 241.8,223Z">
|
|
144
144
|
</path>
|
|
145
145
|
</g>
|
|
146
146
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
147
|
-
<path fill="#30b4c0 " name="undefined" x="319.8" y="211.
|
|
148
|
-
381.8,214.
|
|
147
|
+
<path fill="#30b4c0 " name="undefined" x="319.8" y="211.1063" width="62" height="11.8937" class="recharts-rectangle" d="M319.8,214.1063A 3,3,0,0,1,322.8,211.1063L 378.8,211.1063A 3,3,0,0,1,
|
|
148
|
+
381.8,214.1063L 381.8,223L 319.8,223Z">
|
|
149
149
|
</path>
|
|
150
150
|
</g>
|
|
151
151
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
152
|
-
<path fill="#30b4c0 " name="undefined" x="397.8" y="
|
|
153
|
-
459.8,
|
|
152
|
+
<path fill="#30b4c0 " name="undefined" x="397.8" y="205.8039" width="62" height="17.1961" class="recharts-rectangle" d="M397.8,208.8039A 3,3,0,0,1,400.8,205.8039L 456.8,205.8039A 3,3,0,0,1,
|
|
153
|
+
459.8,208.8039L 459.8,223L 397.8,223Z">
|
|
154
154
|
</path>
|
|
155
155
|
</g>
|
|
156
156
|
</g>
|
|
@@ -296,13 +296,13 @@ const data = [
|
|
|
296
296
|
|
|
297
297
|
Horizontal BarChart
|
|
298
298
|
|
|
299
|
-
|
|
299
|
+
JanuaryFebruaryMarchAprilMayJuneTimerange0 €15 €30 €45 €60 €Costs
|
|
300
300
|
|
|
301
301
|
#### Summary
|
|
302
302
|
|
|
303
303
|
Horizontal BarChart
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
JanuaryFebruaryMarchAprilMayJuneTimerange0 €15 €30 €45 €60 €Costs
|
|
306
306
|
|
|
307
307
|
#### React (tsx)
|
|
308
308
|
|
|
@@ -430,7 +430,7 @@ const data = [
|
|
|
430
430
|
<g tabindex="-1">
|
|
431
431
|
</g>
|
|
432
432
|
<g tabindex="-1">
|
|
433
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
433
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r1:">
|
|
434
434
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
435
435
|
<g class="recharts-layer">
|
|
436
436
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
@@ -670,7 +670,7 @@ Multiple Bars BarChart
|
|
|
670
670
|
pv
|
|
671
671
|
uv
|
|
672
672
|
|
|
673
|
-
Page
|
|
673
|
+
Page APage BPage CPage DPage EPage FPage G025005000750010000
|
|
674
674
|
|
|
675
675
|
#### Summary
|
|
676
676
|
|
|
@@ -679,7 +679,7 @@ Multiple Bars BarChart
|
|
|
679
679
|
pv
|
|
680
680
|
uv
|
|
681
681
|
|
|
682
|
-
Page
|
|
682
|
+
Page APage BPage CPage DPage EPage FPage G025005000750010000
|
|
683
683
|
|
|
684
684
|
#### React (tsx)
|
|
685
685
|
|
|
@@ -815,7 +815,7 @@ const data: CustomData[] = [
|
|
|
815
815
|
<g tabindex="-1">
|
|
816
816
|
</g>
|
|
817
817
|
<g tabindex="-1">
|
|
818
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
818
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r2:">
|
|
819
819
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
820
820
|
<g class="recharts-layer">
|
|
821
821
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
@@ -849,7 +849,7 @@ const data: CustomData[] = [
|
|
|
849
849
|
</g>
|
|
850
850
|
</g>
|
|
851
851
|
</g>
|
|
852
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
852
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r3:">
|
|
853
853
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
854
854
|
<g class="recharts-layer">
|
|
855
855
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
@@ -1090,7 +1090,7 @@ Stacked BarChart
|
|
|
1090
1090
|
pv
|
|
1091
1091
|
uv
|
|
1092
1092
|
|
|
1093
|
-
Page
|
|
1093
|
+
Page APage BPage CPage DPage EPage FPage G030006000900012000
|
|
1094
1094
|
|
|
1095
1095
|
#### Summary
|
|
1096
1096
|
|
|
@@ -1099,7 +1099,7 @@ Stacked BarChart
|
|
|
1099
1099
|
pv
|
|
1100
1100
|
uv
|
|
1101
1101
|
|
|
1102
|
-
Page
|
|
1102
|
+
Page APage BPage CPage DPage EPage FPage G030006000900012000
|
|
1103
1103
|
|
|
1104
1104
|
#### React (tsx)
|
|
1105
1105
|
|
|
@@ -1244,7 +1244,7 @@ const data = [
|
|
|
1244
1244
|
<g tabindex="-1">
|
|
1245
1245
|
</g>
|
|
1246
1246
|
<g tabindex="-1">
|
|
1247
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
1247
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r4:">
|
|
1248
1248
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
1249
1249
|
<g class="recharts-layer">
|
|
1250
1250
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
@@ -1278,7 +1278,7 @@ const data = [
|
|
|
1278
1278
|
</g>
|
|
1279
1279
|
</g>
|
|
1280
1280
|
</g>
|
|
1281
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
1281
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r5:">
|
|
1282
1282
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
1283
1283
|
<g class="recharts-layer">
|
|
1284
1284
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
@@ -1521,7 +1521,7 @@ Diesel
|
|
|
1521
1521
|
Maut
|
|
1522
1522
|
Zuschläge
|
|
1523
1523
|
|
|
1524
|
-
|
|
1524
|
+
015304560BasistarifDieselMautZuschläge
|
|
1525
1525
|
|
|
1526
1526
|
#### Summary
|
|
1527
1527
|
|
|
@@ -1532,7 +1532,7 @@ Diesel
|
|
|
1532
1532
|
Maut
|
|
1533
1533
|
Zuschläge
|
|
1534
1534
|
|
|
1535
|
-
|
|
1535
|
+
015304560BasistarifDieselMautZuschläge
|
|
1536
1536
|
|
|
1537
1537
|
#### React (tsx)
|
|
1538
1538
|
|
|
@@ -1690,7 +1690,7 @@ const data: CustomData[] = [
|
|
|
1690
1690
|
<g tabindex="-1">
|
|
1691
1691
|
</g>
|
|
1692
1692
|
<g tabindex="-1">
|
|
1693
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
1693
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r6:">
|
|
1694
1694
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
1695
1695
|
<g class="recharts-layer">
|
|
1696
1696
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
@@ -1895,7 +1895,7 @@ BarChart with custom Tooltips
|
|
|
1895
1895
|
pv
|
|
1896
1896
|
uv
|
|
1897
1897
|
|
|
1898
|
-
Truck
|
|
1898
|
+
Truck ATruck BTruck CTruck DTruck ETruck FTruck G030006000900012000
|
|
1899
1899
|
|
|
1900
1900
|
#### Summary
|
|
1901
1901
|
|
|
@@ -1903,7 +1903,7 @@ BarChart with custom Tooltips
|
|
|
1903
1903
|
pv
|
|
1904
1904
|
uv
|
|
1905
1905
|
|
|
1906
|
-
Truck
|
|
1906
|
+
Truck ATruck BTruck CTruck DTruck ETruck FTruck G030006000900012000
|
|
1907
1907
|
|
|
1908
1908
|
#### React (tsx)
|
|
1909
1909
|
|
|
@@ -2082,7 +2082,7 @@ const data = [
|
|
|
2082
2082
|
<g tabindex="-1">
|
|
2083
2083
|
</g>
|
|
2084
2084
|
<g tabindex="-1">
|
|
2085
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
2085
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r7:">
|
|
2086
2086
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
2087
2087
|
<g class="recharts-layer">
|
|
2088
2088
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
@@ -2116,7 +2116,7 @@ const data = [
|
|
|
2116
2116
|
</g>
|
|
2117
2117
|
</g>
|
|
2118
2118
|
</g>
|
|
2119
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
2119
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r8:">
|
|
2120
2120
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
2121
2121
|
<g class="recharts-layer">
|
|
2122
2122
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
@@ -2354,13 +2354,13 @@ const data = [
|
|
|
2354
2354
|
|
|
2355
2355
|
Multiple axis BarChart
|
|
2356
2356
|
|
|
2357
|
-
|
|
2357
|
+
JanuaryFebruaryMarchAprilMayJuneTimerange0 €15 €30 €45 €60 €CostsQ1Q1Q1Q2Q2Q2
|
|
2358
2358
|
|
|
2359
2359
|
#### Summary
|
|
2360
2360
|
|
|
2361
2361
|
Multiple axis BarChart
|
|
2362
2362
|
|
|
2363
|
-
|
|
2363
|
+
JanuaryFebruaryMarchAprilMayJuneTimerange0 €15 €30 €45 €60 €CostsQ1Q1Q1Q2Q2Q2
|
|
2364
2364
|
|
|
2365
2365
|
#### React (tsx)
|
|
2366
2366
|
|
|
@@ -2473,7 +2473,7 @@ const data = [
|
|
|
2473
2473
|
<g tabindex="-1">
|
|
2474
2474
|
</g>
|
|
2475
2475
|
<g tabindex="-1">
|
|
2476
|
-
<g class="recharts-layer recharts-bar" id="recharts-bar-:
|
|
2476
|
+
<g class="recharts-layer recharts-bar" id="recharts-bar-:r9:">
|
|
2477
2477
|
<g class="recharts-layer recharts-bar-rectangles">
|
|
2478
2478
|
<g class="recharts-layer">
|
|
2479
2479
|
<g class="recharts-layer recharts-bar-rectangle">
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Progress
|
|
5
|
-
*Source:* https://uikit.developers.rio.cloud
|
|
6
|
-
*Captured:* 2026-
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#/components/barList
|
|
6
|
+
*Captured:* 2026-02-23T13:42:01.308Z
|
|
7
7
|
|
|
8
8
|
## BarList
|
|
9
9
|
|
|
@@ -180,21 +180,21 @@ const transportData = [
|
|
|
180
180
|
<div class="display-flex justify-content-between gap-15">
|
|
181
181
|
<div class="width-100pct space-y-5">
|
|
182
182
|
<div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
|
|
183
|
-
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width:
|
|
183
|
+
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 47.3138%;">
|
|
184
184
|
</div>
|
|
185
185
|
<div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
|
|
186
186
|
<a href="https://example.com/metrics/on-time-delivery" class="text-color-darker" target="_blank" rel="noreferrer">On-time delivery</a>
|
|
187
187
|
</div>
|
|
188
188
|
</div>
|
|
189
189
|
<div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
|
|
190
|
-
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width:
|
|
190
|
+
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 29.2907%;">
|
|
191
191
|
</div>
|
|
192
192
|
<div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
|
|
193
193
|
<div class="text-color-darker">Warehouse efficiency</div>
|
|
194
194
|
</div>
|
|
195
195
|
</div>
|
|
196
196
|
<div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
|
|
197
|
-
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width:
|
|
197
|
+
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 12.9896%;">
|
|
198
198
|
</div>
|
|
199
199
|
<div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
|
|
200
200
|
<a href="https://example.com/metrics/truck-utilization" class="text-color-darker" target="_blank" rel="noreferrer">Truck utilization</a>
|
|
@@ -239,21 +239,21 @@ const transportData = [
|
|
|
239
239
|
<div class="display-flex justify-content-between gap-15 flex-row-reverse gap-10">
|
|
240
240
|
<div class="width-100pct space-y-5">
|
|
241
241
|
<div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
|
|
242
|
-
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width:
|
|
242
|
+
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 47.3138%;">
|
|
243
243
|
</div>
|
|
244
244
|
<div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
|
|
245
245
|
<a href="https://example.com/metrics/on-time-delivery" class="text-color-darker" target="_blank" rel="noreferrer">On-time delivery</a>
|
|
246
246
|
</div>
|
|
247
247
|
</div>
|
|
248
248
|
<div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
|
|
249
|
-
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width:
|
|
249
|
+
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 29.2907%;">
|
|
250
250
|
</div>
|
|
251
251
|
<div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
|
|
252
252
|
<div class="text-color-darker">Warehouse efficiency</div>
|
|
253
253
|
</div>
|
|
254
254
|
</div>
|
|
255
255
|
<div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-transparent cursor-pointer">
|
|
256
|
-
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width:
|
|
256
|
+
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-highlight-light" role="presentation" style="height: 25px; opacity: 0.5; width: 12.9896%;">
|
|
257
257
|
</div>
|
|
258
258
|
<div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
|
|
259
259
|
<a href="https://example.com/metrics/truck-utilization" class="text-color-darker" target="_blank" rel="noreferrer">Truck utilization</a>
|
|
@@ -307,6 +307,12 @@ const transportData = [
|
|
|
307
307
|
</div>
|
|
308
308
|
```
|
|
309
309
|
|
|
310
|
+
#### Props (json)
|
|
311
|
+
|
|
312
|
+
```json
|
|
313
|
+
valueFormatter={(value) => `${value}%`}
|
|
314
|
+
```
|
|
315
|
+
|
|
310
316
|
### Example: 95
|
|
311
317
|
|
|
312
318
|
Damaged packages
|
|
@@ -437,14 +443,14 @@ const transportData = [
|
|
|
437
443
|
</div>
|
|
438
444
|
</div>
|
|
439
445
|
<div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-lightest cursor-pointer">
|
|
440
|
-
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-coldplay-moos" role="presentation" style="height: 25px; opacity: 0.5; width:
|
|
446
|
+
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-coldplay-moos" role="presentation" style="height: 25px; opacity: 0.5; width: 48.3163%;">
|
|
441
447
|
</div>
|
|
442
448
|
<div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
|
|
443
449
|
<div class="text-color-darker">Stored in warehouse</div>
|
|
444
450
|
</div>
|
|
445
451
|
</div>
|
|
446
452
|
<div class="position-relative width-100pct rounded-small transition-all transition-ease-in-out transition-duration-01 bg-lightest cursor-pointer">
|
|
447
|
-
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-coldplay-moos" role="presentation" style="height: 25px; opacity: 0.5; width:
|
|
453
|
+
<div class="display-flex align-items-center rounded-small transition-all transition-ease-in-out transition-duration-01 bg-coldplay-moos" role="presentation" style="height: 25px; opacity: 0.5; width: 91.3224%;">
|
|
448
454
|
</div>
|
|
449
455
|
<div class="position-absolute left-0 top-50pct translate-y-50pct display-flex width-100pct padding-left-10">
|
|
450
456
|
<div class="text-color-darker">Shipped packages</div>
|
|
@@ -480,4 +486,10 @@ const transportData = [
|
|
|
480
486
|
</div>
|
|
481
487
|
</div>
|
|
482
488
|
</div>
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
#### Props (json)
|
|
492
|
+
|
|
493
|
+
```json
|
|
494
|
+
valueFormatter={(value) => `${value}%`}
|
|
483
495
|
```
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Map
|
|
5
|
-
*Source:* https://uikit.developers.rio.cloud
|
|
6
|
-
*Captured:* 2026-
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#/components/basicMap
|
|
6
|
+
*Captured:* 2026-02-23T13:42:45.274Z
|
|
7
7
|
|
|
8
8
|
The following map shows labels for locale de
|
|
9
9
|
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Application
|
|
5
|
-
*Source:* https://uikit.developers.rio.cloud
|
|
6
|
-
*Captured:* 2026-
|
|
5
|
+
*Source:* https://uikit.developers.rio.cloud/#/components/bottomSheet
|
|
6
|
+
*Captured:* 2026-02-23T13:41:33.424Z
|
|
7
7
|
|
|
8
8
|
The TimedBottomSheet is a wrapper component for the BottomSheet that allows to control it's visibility via timers and to use the localStorage to save user interaction for handling it's visibility.
|
|
9
9
|
|
|
@@ -76,6 +76,26 @@ const content = (
|
|
|
76
76
|
</div>
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
+
#### Props
|
|
80
|
+
|
|
81
|
+
| Name | Type | Default | Description |
|
|
82
|
+
| --- | --- | --- | --- |
|
|
83
|
+
| show | boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
|
|
84
|
+
| onClose | (isShown: boolean) => void | — | Callback for when the sheet closes. |
|
|
85
|
+
| width | number \| string | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a max-width-xxx via className to control it better. |
|
|
86
|
+
| height | number \| string | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
|
|
87
|
+
| title | string \| ReactNode | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
|
|
88
|
+
| showCloseButton | boolean | true | Defines whether or not the close button is shown. |
|
|
89
|
+
| showMaximizeButton | boolean | false | Defines whether or not the maximize button in the header is shown. |
|
|
90
|
+
| onHeightChange | VoidFunction | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
|
|
91
|
+
| detach | boolean | false | Set to true to detach the bottom sheet from the left side and the bottom and create a little offset. |
|
|
92
|
+
| detachOffset | number | 15 | Defines the amount of pixels for the sheet. |
|
|
93
|
+
| hasBackdrop | boolean | false | Set to true to render a modal like backdrop to emphasize the bottom sheet. |
|
|
94
|
+
| onBackdropClick | VoidFunction | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
|
|
95
|
+
| bodyRef | MutableRefObject<HTMLDivElement \| null> | — | A react ref added to the bottom sheet body. |
|
|
96
|
+
| bodyClassName | string | — | Additional classes to be set on the body element. |
|
|
97
|
+
| className | string | — | Additional classes to be set on the wrapping element. |
|
|
98
|
+
|
|
79
99
|
### Example: Example 2
|
|
80
100
|
|
|
81
101
|
This demonstrates a bottom sheet use case on mobile. This can be used for providing additional information on mobile instead of using a sidebar, onboarding, alternative for dialogs etc.
|
|
@@ -199,6 +219,26 @@ export default () => {
|
|
|
199
219
|
</div>
|
|
200
220
|
```
|
|
201
221
|
|
|
222
|
+
#### Props
|
|
223
|
+
|
|
224
|
+
| Name | Type | Default | Description |
|
|
225
|
+
| --- | --- | --- | --- |
|
|
226
|
+
| show | boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
|
|
227
|
+
| onClose | (isShown: boolean) => void | — | Callback for when the sheet closes. |
|
|
228
|
+
| width | number \| string | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a max-width-xxx via className to control it better. |
|
|
229
|
+
| height | number \| string | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
|
|
230
|
+
| title | string \| ReactNode | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
|
|
231
|
+
| showCloseButton | boolean | true | Defines whether or not the close button is shown. |
|
|
232
|
+
| showMaximizeButton | boolean | false | Defines whether or not the maximize button in the header is shown. |
|
|
233
|
+
| onHeightChange | VoidFunction | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
|
|
234
|
+
| detach | boolean | false | Set to true to detach the bottom sheet from the left side and the bottom and create a little offset. |
|
|
235
|
+
| detachOffset | number | 15 | Defines the amount of pixels for the sheet. |
|
|
236
|
+
| hasBackdrop | boolean | false | Set to true to render a modal like backdrop to emphasize the bottom sheet. |
|
|
237
|
+
| onBackdropClick | VoidFunction | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
|
|
238
|
+
| bodyRef | MutableRefObject<HTMLDivElement \| null> | — | A react ref added to the bottom sheet body. |
|
|
239
|
+
| bodyClassName | string | — | Additional classes to be set on the body element. |
|
|
240
|
+
| className | string | — | Additional classes to be set on the wrapping element. |
|
|
241
|
+
|
|
202
242
|
### Example: Example 3
|
|
203
243
|
|
|
204
244
|
This demonstrates a bottom sheet use case on mobile. It demonstrates a bottom sheet for smartphones to perform an action.
|
|
@@ -296,6 +336,26 @@ export default () => {
|
|
|
296
336
|
</div>
|
|
297
337
|
```
|
|
298
338
|
|
|
339
|
+
#### Props
|
|
340
|
+
|
|
341
|
+
| Name | Type | Default | Description |
|
|
342
|
+
| --- | --- | --- | --- |
|
|
343
|
+
| show | boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
|
|
344
|
+
| onClose | (isShown: boolean) => void | — | Callback for when the sheet closes. |
|
|
345
|
+
| width | number \| string | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a max-width-xxx via className to control it better. |
|
|
346
|
+
| height | number \| string | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
|
|
347
|
+
| title | string \| ReactNode | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
|
|
348
|
+
| showCloseButton | boolean | true | Defines whether or not the close button is shown. |
|
|
349
|
+
| showMaximizeButton | boolean | false | Defines whether or not the maximize button in the header is shown. |
|
|
350
|
+
| onHeightChange | VoidFunction | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
|
|
351
|
+
| detach | boolean | false | Set to true to detach the bottom sheet from the left side and the bottom and create a little offset. |
|
|
352
|
+
| detachOffset | number | 15 | Defines the amount of pixels for the sheet. |
|
|
353
|
+
| hasBackdrop | boolean | false | Set to true to render a modal like backdrop to emphasize the bottom sheet. |
|
|
354
|
+
| onBackdropClick | VoidFunction | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
|
|
355
|
+
| bodyRef | MutableRefObject<HTMLDivElement \| null> | — | A react ref added to the bottom sheet body. |
|
|
356
|
+
| bodyClassName | string | — | Additional classes to be set on the body element. |
|
|
357
|
+
| className | string | — | Additional classes to be set on the wrapping element. |
|
|
358
|
+
|
|
299
359
|
### Example: Example 4
|
|
300
360
|
|
|
301
361
|
This demonstrates a bottom sheet use case on mobile. It demonstrates a bottom sheet for an example of how you could do onboarding on smartphones.
|
|
@@ -380,6 +440,26 @@ export default () => {
|
|
|
380
440
|
</div>
|
|
381
441
|
```
|
|
382
442
|
|
|
443
|
+
#### Props
|
|
444
|
+
|
|
445
|
+
| Name | Type | Default | Description |
|
|
446
|
+
| --- | --- | --- | --- |
|
|
447
|
+
| show | boolean | false | Set the visibility of the bottom sheet. The component is already mounted and just moved offscreen. |
|
|
448
|
+
| onClose | (isShown: boolean) => void | — | Callback for when the sheet closes. |
|
|
449
|
+
| width | number \| string | — | The width of the bottom sheet. This is useful for desktop when not using the entire screen width. When no width is given it will take the width of the content and maximum 100% of the screen. So it this case you might want to apply a max-width-xxx via className to control it better. |
|
|
450
|
+
| height | number \| string | — | The height of the bottom sheet. If no height is given, the height is automatically calculated from the content. |
|
|
451
|
+
| title | string \| ReactNode | — | The title content shown in the header. If no title is given, the bottom sheet header is not shown. |
|
|
452
|
+
| showCloseButton | boolean | true | Defines whether or not the close button is shown. |
|
|
453
|
+
| showMaximizeButton | boolean | false | Defines whether or not the maximize button in the header is shown. |
|
|
454
|
+
| onHeightChange | VoidFunction | () => {} | The callback function triggered when the maximize button is clicked and the height changes. |
|
|
455
|
+
| detach | boolean | false | Set to true to detach the bottom sheet from the left side and the bottom and create a little offset. |
|
|
456
|
+
| detachOffset | number | 15 | Defines the amount of pixels for the sheet. |
|
|
457
|
+
| hasBackdrop | boolean | false | Set to true to render a modal like backdrop to emphasize the bottom sheet. |
|
|
458
|
+
| onBackdropClick | VoidFunction | () => {} | Callback function triggered when the backdrop is clicked. Usually used to close the bottom sheet. |
|
|
459
|
+
| bodyRef | MutableRefObject<HTMLDivElement \| null> | — | A react ref added to the bottom sheet body. |
|
|
460
|
+
| bodyClassName | string | — | Additional classes to be set on the body element. |
|
|
461
|
+
| className | string | — | Additional classes to be set on the wrapping element. |
|
|
462
|
+
|
|
383
463
|
## TimedBottomSheet
|
|
384
464
|
|
|
385
465
|
### Example: Example 5
|
|
@@ -621,4 +701,21 @@ export default () => {
|
|
|
621
701
|
```html
|
|
622
702
|
<p>Showcase of a timed bottom sheet used for requesting feedback from the user after a major feature was released or updated.</p>
|
|
623
703
|
<button type="button" class="btn btn-primary btn-component" tabindex="0">Trigger timed bottom sheet</button>
|
|
624
|
-
```
|
|
704
|
+
```
|
|
705
|
+
|
|
706
|
+
#### Props
|
|
707
|
+
|
|
708
|
+
| Name | Type | Default | Description |
|
|
709
|
+
| --- | --- | --- | --- |
|
|
710
|
+
| dismissed | boolean | false | The dismissed flag can be used to tell this component that the user has clicked on the content of the component like a button or a link. In this case, the bottom sheet will store a flag in the localStorage to hide the bottom sheet for the next time and it will close the sheet right away. |
|
|
711
|
+
| featureName | string | — | The featureName prop is used to name the localStorage flag that is used to control the visibility. It should be unique to avoid conflicts with other timed bottom sheets. |
|
|
712
|
+
| showAfter | number | 0 | Defines the time in milliseconds when the bottom sheet shall be shown. Default value is 0 to show it right away. |
|
|
713
|
+
| hideAfter | number | 3_600_000 | Defines the time in milliseconds when the bottom sheet hides itself automatically. Default value is 3_600_000 to hide it after 1 hour. In this case, the localStorage flag is not set and the bottom sheet will be shown on the next page load. |
|
|
714
|
+
| alwaysOn | boolean | false | With this enabled, the BottomSheet will not hide automatically. |
|
|
715
|
+
| showCloseButton | boolean | true | Enables or disabled the close button. |
|
|
716
|
+
| width | number | — | Optional width of the bottom sheet. Alternatively, you can set a max-width-xxx via className instead. |
|
|
717
|
+
| cleanupLocalStorage | boolean | false | Flag to allow to remove the localStorage flag again once the component is not needed anymore. |
|
|
718
|
+
| localStoragePrefix | string | — | A prefix that will be used for the local storage flag to store whether the bottom sheet should be hidden. Use this prefix for your service name for instance. |
|
|
719
|
+
| onClose | () => void | () => {} | Callback function that gets triggered when the user closed the bottom sheet with the close button. |
|
|
720
|
+
| bodyClassName | string | 'padding-25 margin-right-25' | Optional className to be set on the body. |
|
|
721
|
+
| className | string | — | Optional className to be set on the component. Use this to define a max-width value. |
|