@rio-cloud/uikit-mcp 1.1.4 → 1.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/dist/doc-metadata.json +80 -80
- package/dist/docs/components/accentBar.md +34 -2
- package/dist/docs/components/activity.md +13 -2
- package/dist/docs/components/animatedNumber.md +16 -3
- package/dist/docs/components/animatedTextReveal.md +53 -7
- package/dist/docs/components/animations.md +30 -30
- package/dist/docs/components/appHeader.md +58 -2
- package/dist/docs/components/appLayout.md +543 -38
- package/dist/docs/components/appNavigationBar.md +54 -2
- package/dist/docs/components/areaCharts.md +4 -4
- package/dist/docs/components/aspectRatioPlaceholder.md +10 -2
- package/dist/docs/components/assetTree.md +1065 -218
- package/dist/docs/components/autosuggests.md +1 -1
- package/dist/docs/components/avatar.md +24 -2
- package/dist/docs/components/banner.md +2 -2
- package/dist/docs/components/barCharts.md +27 -27
- package/dist/docs/components/barList.md +21 -9
- package/dist/docs/components/basicMap.md +1 -1
- package/dist/docs/components/bottomSheet.md +99 -2
- package/dist/docs/components/button.md +161 -16
- package/dist/docs/components/buttonToolbar.md +9 -2
- package/dist/docs/components/calendarStripe.md +84 -110
- package/dist/docs/components/card.md +10 -2
- package/dist/docs/components/carousel.md +1 -1
- package/dist/docs/components/chartColors.md +1 -1
- package/dist/docs/components/chartsGettingStarted.md +1 -1
- package/dist/docs/components/chat.md +2 -2
- package/dist/docs/components/checkbox.md +51 -26
- package/dist/docs/components/clearableInput.md +17 -17
- package/dist/docs/components/collapse.md +27 -3
- package/dist/docs/components/composedCharts.md +15 -15
- package/dist/docs/components/contentLoader.md +125 -104
- package/dist/docs/components/dataTabs.md +189 -9
- package/dist/docs/components/datepickers.md +733 -721
- package/dist/docs/components/dialogs.md +361 -1
- package/dist/docs/components/divider.md +14 -2
- package/dist/docs/components/dropdowns.md +4533 -4352
- package/dist/docs/components/editableContent.md +186 -2
- package/dist/docs/components/expander.md +51 -4
- package/dist/docs/components/fade.md +41 -6
- package/dist/docs/components/fadeExpander.md +11 -2
- package/dist/docs/components/fadeUp.md +21 -3
- package/dist/docs/components/feedback.md +43 -2
- package/dist/docs/components/filePickers.md +44 -2
- package/dist/docs/components/formLabel.md +16 -2
- package/dist/docs/components/groupedItemList.md +53 -2
- package/dist/docs/components/iconList.md +4 -4
- package/dist/docs/components/imagePreloader.md +6 -2
- package/dist/docs/components/labeledElement.md +12 -2
- package/dist/docs/components/licensePlate.md +10 -2
- package/dist/docs/components/lineCharts.md +3 -3
- package/dist/docs/components/listMenu.md +72 -2
- package/dist/docs/components/loadMore.md +28 -2
- package/dist/docs/components/mainNavigation.md +1 -1
- package/dist/docs/components/mapCircle.md +1 -1
- package/dist/docs/components/mapCluster.md +1 -1
- package/dist/docs/components/mapContext.md +1 -1
- package/dist/docs/components/mapDraggableMarker.md +1 -1
- package/dist/docs/components/mapGettingStarted.md +1 -1
- package/dist/docs/components/mapInfoBubble.md +1 -1
- package/dist/docs/components/mapLayerGroup.md +1 -1
- package/dist/docs/components/mapMarker.md +1 -1
- package/dist/docs/components/mapPolygon.md +1 -1
- package/dist/docs/components/mapRoute.md +1 -1
- package/dist/docs/components/mapRouteGenerator.md +1 -1
- package/dist/docs/components/mapSettings.md +1 -1
- package/dist/docs/components/mapUtils.md +1 -1
- package/dist/docs/components/multiselects.md +1 -1
- package/dist/docs/components/noData.md +22 -2
- package/dist/docs/components/notifications.md +1 -1
- package/dist/docs/components/numbercontrol.md +50 -2
- package/dist/docs/components/onboarding.md +25 -1
- package/dist/docs/components/page.md +32 -2
- package/dist/docs/components/pager.md +14 -2
- package/dist/docs/components/pieCharts.md +36 -36
- package/dist/docs/components/popover.md +39 -1
- package/dist/docs/components/position.md +10 -2
- package/dist/docs/components/radialBarCharts.md +25 -25
- package/dist/docs/components/radiobutton.md +137 -9
- package/dist/docs/components/releaseNotes.md +18 -1
- package/dist/docs/components/resizer.md +13 -2
- package/dist/docs/components/responsiveColumnStripe.md +19 -2
- package/dist/docs/components/responsiveVideo.md +11 -2
- package/dist/docs/components/rioglyph.md +12 -2
- package/dist/docs/components/rules.md +94 -4
- package/dist/docs/components/saveableInput.md +399 -275
- package/dist/docs/components/selects.md +1 -1
- package/dist/docs/components/sidebar.md +38 -2
- package/dist/docs/components/sliders.md +37 -2
- package/dist/docs/components/smoothScrollbars.md +92 -2
- package/dist/docs/components/spinners.md +50 -2
- package/dist/docs/components/states.md +216 -1
- package/dist/docs/components/statsWidgets.md +122 -2
- package/dist/docs/components/statusBar.md +28 -2
- package/dist/docs/components/stepButton.md +8 -2
- package/dist/docs/components/steppedProgressBars.md +66 -2
- package/dist/docs/components/subNavigation.md +8 -1
- package/dist/docs/components/supportMarker.md +1 -1
- package/dist/docs/components/svgImage.md +12 -38
- package/dist/docs/components/switch.md +11 -2
- package/dist/docs/components/tables.md +1 -1
- package/dist/docs/components/tagManager.md +55 -1
- package/dist/docs/components/tags.md +32 -2
- package/dist/docs/components/teaser.md +29 -2
- package/dist/docs/components/timeline.md +1 -1
- package/dist/docs/components/timepicker.md +30 -2
- package/dist/docs/components/toggleButton.md +65 -7
- package/dist/docs/components/tooltip.md +26 -18
- package/dist/docs/components/virtualList.md +103 -77
- package/dist/docs/foundations.md +177 -177
- package/dist/docs/start/changelog.md +1 -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 +2 -2
- 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 +1 -1
- 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 +1 -1
- package/dist/docs/templates/options-panel.md +1 -1
- package/dist/docs/templates/panel-variants.md +1 -1
- package/dist/docs/templates/progress-cards.md +1 -1
- package/dist/docs/templates/progress-success.md +1 -1
- package/dist/docs/templates/settings-form.md +23 -23
- package/dist/docs/templates/stats-blocks.md +16 -16
- 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 +1 -1
- package/dist/docs/utilities/featureToggles.md +1 -1
- package/dist/docs/utilities/fuelTypeUtils.md +1 -1
- package/dist/docs/utilities/routeUtils.md +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +51 -51
- package/dist/docs/utilities/useTableSelection.md +87 -87
- package/dist/docs/utilities/useTimeout.md +1 -1
- package/dist/docs/utilities/useToggle.md +1 -1
- package/dist/docs/utilities/useWindowResize.md +1 -1
- package/dist/index.mjs +8 -8
- package/dist/version.json +1 -1
- package/package.json +6 -6
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Selection
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/selects
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:33.842Z
|
|
7
7
|
|
|
8
8
|
The Select and Multiselect components are form controls and are intended to be used within forms. They are designed to be used instead of native HTML Select which cannot be styled and are rendered by each browser differently.
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Application
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/sidebar
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:05.660Z
|
|
7
7
|
|
|
8
8
|
There are 2 kinds of Sidebars. The default fluid and the fly variant.
|
|
9
9
|
|
|
@@ -292,4 +292,40 @@ export default SidebarDemos;
|
|
|
292
292
|
</div>
|
|
293
293
|
</div>
|
|
294
294
|
</div>
|
|
295
|
-
```
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
#### Props
|
|
298
|
+
|
|
299
|
+
| Name | Type | Default | Description |
|
|
300
|
+
| --- | --- | --- | --- |
|
|
301
|
+
| fly | boolean | false | Defines if the component will overlap the body content. |
|
|
302
|
+
| closed | boolean | false | Defines whether the component is hidden or not. |
|
|
303
|
+
| disableClose | boolean | false | Hides the close button. This may be used when the sidebar is always visible and may not be closed. |
|
|
304
|
+
| onClose | VoidFunction | — | Callback function triggered when clicking the close icon. |
|
|
305
|
+
| footer | string \| React.ReactNode | — | The Footer content. For example a save button. |
|
|
306
|
+
| footerClassName | string | — | Additional classes added to the Sidebar footer. |
|
|
307
|
+
| headerButtons | React.ReactNode | — | Additional buttons to be rendered in the header. |
|
|
308
|
+
| headerClassName | string | — | Additional classes added to the Sidebar header. |
|
|
309
|
+
| showHeaderBorder | boolean | — | Shows a sidebar header border |
|
|
310
|
+
| width | number | 350 | Defines the width of the component. The value is set as pixel value as inline style. Note: In the past, the type allowed to pass in a sting value like "400px" but that is not possible anymore due to internal width calculations. To be backwards compatible for non Typescript projects, the width is converted to a number. |
|
|
311
|
+
| minWidth | number | 100 | Defines the minimum width in px of the component that will take effect when resizing. |
|
|
312
|
+
| maxWidth | number | 800 | Defines the maximum width in px of the component that will take effect when resizing. |
|
|
313
|
+
| openInFullscreen | boolean | false | Opens Sidebar in fullscreen, means 100vw. |
|
|
314
|
+
| onFullScreenChange | (newFullscreenState: boolean) => void | — | Callback for when the fullscreen is toggled. |
|
|
315
|
+
| enableFullscreenToggle | boolean | false | Enables the fullscreen functionality and shows the fullscreen toggle. |
|
|
316
|
+
| fullscreenToggleTooltip | string | — | Translated tooltip text for the fullscreen toggle button. |
|
|
317
|
+
| position | ObjectValues<typeof SidebarPosition> | 'left' | Tells the sidebar where it is positioned. This will affect the resizing behavior respectively. Note: the position need to be set properly whe using the resize functionality to know on which side of the sidebar to attach the resizer handle. It is also relevant when the sidebar mode is set to fly to properly animate the sidebar into the view. Possible values are: 'left' 'right' Sidebar.LEFT Sidebar.RIGHT |
|
|
318
|
+
| resizable | boolean | false | Defines whether or not the sidebar is resizable. |
|
|
319
|
+
| onResizeEnd | VoidFunction | — | Callback for when the resize is done. |
|
|
320
|
+
| switchModeBreakpoint | number | — | Defines the breakpoint in pixel when the sidebar mode shall be changed. If the window width is lower than the given breakpoint the mode is set to fly. If the window width is higher the mode is set to fluid. This functionality is disabled by default and will be enabled when defining a breakpoint higher than 0. |
|
|
321
|
+
| disableEsc | boolean | false | By default the fullscreen mode can be left with "esc". If this is unwanted it can be disabled. |
|
|
322
|
+
| hasBackdrop | boolean | false | Defined whether or not a backdrop will be rendered behind the Sidebar to avoid clicks outside. |
|
|
323
|
+
| hasSmoothScrollbar | boolean | false | Defined whether or not the UIKIT SmoothScrollbar is active. |
|
|
324
|
+
| makeBackdropVisible | boolean | false | Defined whether or not the backdrop is visible similar to the backdrop for modal dialogs. |
|
|
325
|
+
| onBackdropClick | VoidFunction | — | Callback for when the backdrop is clicked. This comes in handy when handling transient data from the sidebar which need to be saved first and handle clicks outside. |
|
|
326
|
+
| bodyRef | React.MutableRefObject<HTMLDivElement \| null> | — | Additional ref added to the Sidebar body. |
|
|
327
|
+
| title | string \| React.ReactNode | — | Content that will be displayed in the components header. |
|
|
328
|
+
| titleClassName | string | — | Additional classes added to the Sidebar title. |
|
|
329
|
+
| backdropClassName | string | — | Additional classes added to the Sidebar backdrop. |
|
|
330
|
+
| bodyClassName | string | — | Additional classes added to the Sidebar body. |
|
|
331
|
+
| className | string | — | Additional classes added on the wrapper element. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Interaction
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/sliders
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:21.151Z
|
|
7
7
|
|
|
8
8
|
## Slider
|
|
9
9
|
|
|
@@ -225,6 +225,24 @@ export default SliderExample;
|
|
|
225
225
|
</div>
|
|
226
226
|
```
|
|
227
227
|
|
|
228
|
+
#### Props
|
|
229
|
+
|
|
230
|
+
| Name | Type | Default | Description |
|
|
231
|
+
| --- | --- | --- | --- |
|
|
232
|
+
| value | number | 0 | The current value. |
|
|
233
|
+
| minValue | number | 0 | The lower limit. |
|
|
234
|
+
| maxValue | number | Number.MAX_VALUE | The upper limit. |
|
|
235
|
+
| valueLabels | boolean | false | Whether to show the value labels. |
|
|
236
|
+
| valueLabelUnit | string \| React.ReactNode | — | Additional unit used for the slider value label. |
|
|
237
|
+
| hideValueBar | boolean | false | Whether to hide the dark-colored value bar. |
|
|
238
|
+
| largeValueLabels | boolean | false | Whether to show larger value labels instead of the normal ones. |
|
|
239
|
+
| step | number | 1 | Selector step value. |
|
|
240
|
+
| color | CurrentColor | 'primary' | Defines the color of the slider. Possible values are: 'primary' 'secondary' 'info' 'warning' 'danger' 'success' |
|
|
241
|
+
| disabled | boolean | false | Disables all pointer events. |
|
|
242
|
+
| onChange | (newValue: number) => void | — | Callback to get the new value every time it changes. |
|
|
243
|
+
| onDragEnd | (newValue: number) => void | — | Callback to get the value after the slider ended dragging. |
|
|
244
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
245
|
+
|
|
228
246
|
## RangeSlider
|
|
229
247
|
|
|
230
248
|
### Example: Example 2
|
|
@@ -338,4 +356,21 @@ export default () => (
|
|
|
338
356
|
<input class="" min="-50" max="1000" step="1" type="range" value="800" style="z-index: 5;">
|
|
339
357
|
</div>
|
|
340
358
|
</div>
|
|
341
|
-
```
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
#### Props
|
|
362
|
+
|
|
363
|
+
| Name | Type | Default | Description |
|
|
364
|
+
| --- | --- | --- | --- |
|
|
365
|
+
| leftValue | number | — | The current left value of the selected range. |
|
|
366
|
+
| rightValue | number | — | The current right value of the selected range. |
|
|
367
|
+
| minValue | number | 0 | The lower limit. |
|
|
368
|
+
| maxValue | number | Number.MAX_VALUE | The upper limit. |
|
|
369
|
+
| valueLabels | boolean | false | Whether to show the value labels. |
|
|
370
|
+
| valueLabelUnit | string \| React.ReactNode | — | Additional unit used for the slider value labels. |
|
|
371
|
+
| step | number | 1 | Selector step value. |
|
|
372
|
+
| color | CurrentColor | 'primary' | Defines the color of the slider. Possible values are: 'primary' 'secondary' 'info' 'warning' 'danger' 'success' |
|
|
373
|
+
| disabled | boolean | false | Disables all pointer events. |
|
|
374
|
+
| onChange | (newLeftValue: number, newRightValue: number) => void | — | Callback to get the new value every time it changes. |
|
|
375
|
+
| onDragEnd | (newLeftValue: number, newRightValue: number) => void | — | Callback to get the value after the slider ended dragging. |
|
|
376
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/smoothScrollbars
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:05:09.047Z
|
|
7
7
|
|
|
8
8
|
## SmoothScrollbars
|
|
9
9
|
|
|
@@ -104,6 +104,21 @@ export default () => (
|
|
|
104
104
|
</div>
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
+
#### Props
|
|
108
|
+
|
|
109
|
+
| Name | Type | Default | Description |
|
|
110
|
+
| --- | --- | --- | --- |
|
|
111
|
+
| slideIn | boolean | false | Defines whether the scrollbars should slide in on hover. |
|
|
112
|
+
| largeTrack | boolean | false | Defines whether the scrollbars should be slightly larger. |
|
|
113
|
+
| trackOffset | boolean | false | Defines whether the scrollbars should have an offset. |
|
|
114
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
115
|
+
| tagName | string | 'div' | Tag name used for the scroll container. |
|
|
116
|
+
| autoHeight | boolean | false | Enable auto-height behavior. |
|
|
117
|
+
| autoHeightMin | number | 0 | Minimum height when auto-height is enabled. |
|
|
118
|
+
| autoHeightMax | number | 200 | Maximum height when auto-height is enabled. |
|
|
119
|
+
| onScroll | (event: React.UIEvent<any> \| undefined) => void | — | Scroll callback, forwarded to the underlying scrollbars instance. |
|
|
120
|
+
| style | React.CSSProperties | — | Inline styles for the scroll container. |
|
|
121
|
+
|
|
107
122
|
### Example: Slide in on hover
|
|
108
123
|
|
|
109
124
|
Slide in on hover
|
|
@@ -199,6 +214,21 @@ export default () => (
|
|
|
199
214
|
</div>
|
|
200
215
|
```
|
|
201
216
|
|
|
217
|
+
#### Props
|
|
218
|
+
|
|
219
|
+
| Name | Type | Default | Description |
|
|
220
|
+
| --- | --- | --- | --- |
|
|
221
|
+
| slideIn | boolean | false | Defines whether the scrollbars should slide in on hover. |
|
|
222
|
+
| largeTrack | boolean | false | Defines whether the scrollbars should be slightly larger. |
|
|
223
|
+
| trackOffset | boolean | false | Defines whether the scrollbars should have an offset. |
|
|
224
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
225
|
+
| tagName | string | 'div' | Tag name used for the scroll container. |
|
|
226
|
+
| autoHeight | boolean | false | Enable auto-height behavior. |
|
|
227
|
+
| autoHeightMin | number | 0 | Minimum height when auto-height is enabled. |
|
|
228
|
+
| autoHeightMax | number | 200 | Maximum height when auto-height is enabled. |
|
|
229
|
+
| onScroll | (event: React.UIEvent<any> \| undefined) => void | — | Scroll callback, forwarded to the underlying scrollbars instance. |
|
|
230
|
+
| style | React.CSSProperties | — | Inline styles for the scroll container. |
|
|
231
|
+
|
|
202
232
|
### Example: Larger track
|
|
203
233
|
|
|
204
234
|
Larger track
|
|
@@ -294,6 +324,21 @@ export default () => (
|
|
|
294
324
|
</div>
|
|
295
325
|
```
|
|
296
326
|
|
|
327
|
+
#### Props
|
|
328
|
+
|
|
329
|
+
| Name | Type | Default | Description |
|
|
330
|
+
| --- | --- | --- | --- |
|
|
331
|
+
| slideIn | boolean | false | Defines whether the scrollbars should slide in on hover. |
|
|
332
|
+
| largeTrack | boolean | false | Defines whether the scrollbars should be slightly larger. |
|
|
333
|
+
| trackOffset | boolean | false | Defines whether the scrollbars should have an offset. |
|
|
334
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
335
|
+
| tagName | string | 'div' | Tag name used for the scroll container. |
|
|
336
|
+
| autoHeight | boolean | false | Enable auto-height behavior. |
|
|
337
|
+
| autoHeightMin | number | 0 | Minimum height when auto-height is enabled. |
|
|
338
|
+
| autoHeightMax | number | 200 | Maximum height when auto-height is enabled. |
|
|
339
|
+
| onScroll | (event: React.UIEvent<any> \| undefined) => void | — | Scroll callback, forwarded to the underlying scrollbars instance. |
|
|
340
|
+
| style | React.CSSProperties | — | Inline styles for the scroll container. |
|
|
341
|
+
|
|
297
342
|
### Example: Track with offset
|
|
298
343
|
|
|
299
344
|
Track with offset
|
|
@@ -389,6 +434,21 @@ export default () => (
|
|
|
389
434
|
</div>
|
|
390
435
|
```
|
|
391
436
|
|
|
437
|
+
#### Props
|
|
438
|
+
|
|
439
|
+
| Name | Type | Default | Description |
|
|
440
|
+
| --- | --- | --- | --- |
|
|
441
|
+
| slideIn | boolean | false | Defines whether the scrollbars should slide in on hover. |
|
|
442
|
+
| largeTrack | boolean | false | Defines whether the scrollbars should be slightly larger. |
|
|
443
|
+
| trackOffset | boolean | false | Defines whether the scrollbars should have an offset. |
|
|
444
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
445
|
+
| tagName | string | 'div' | Tag name used for the scroll container. |
|
|
446
|
+
| autoHeight | boolean | false | Enable auto-height behavior. |
|
|
447
|
+
| autoHeightMin | number | 0 | Minimum height when auto-height is enabled. |
|
|
448
|
+
| autoHeightMax | number | 200 | Maximum height when auto-height is enabled. |
|
|
449
|
+
| onScroll | (event: React.UIEvent<any> \| undefined) => void | — | Scroll callback, forwarded to the underlying scrollbars instance. |
|
|
450
|
+
| style | React.CSSProperties | — | Inline styles for the scroll container. |
|
|
451
|
+
|
|
392
452
|
### Example: Horizontal Example
|
|
393
453
|
|
|
394
454
|
Horizontal Example
|
|
@@ -652,6 +712,21 @@ export default () => (
|
|
|
652
712
|
</div>
|
|
653
713
|
```
|
|
654
714
|
|
|
715
|
+
#### Props
|
|
716
|
+
|
|
717
|
+
| Name | Type | Default | Description |
|
|
718
|
+
| --- | --- | --- | --- |
|
|
719
|
+
| slideIn | boolean | false | Defines whether the scrollbars should slide in on hover. |
|
|
720
|
+
| largeTrack | boolean | false | Defines whether the scrollbars should be slightly larger. |
|
|
721
|
+
| trackOffset | boolean | false | Defines whether the scrollbars should have an offset. |
|
|
722
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
723
|
+
| tagName | string | 'div' | Tag name used for the scroll container. |
|
|
724
|
+
| autoHeight | boolean | false | Enable auto-height behavior. |
|
|
725
|
+
| autoHeightMin | number | 0 | Minimum height when auto-height is enabled. |
|
|
726
|
+
| autoHeightMax | number | 200 | Maximum height when auto-height is enabled. |
|
|
727
|
+
| onScroll | (event: React.UIEvent<any> \| undefined) => void | — | Scroll callback, forwarded to the underlying scrollbars instance. |
|
|
728
|
+
| style | React.CSSProperties | — | Inline styles for the scroll container. |
|
|
729
|
+
|
|
655
730
|
### Example: Full Example
|
|
656
731
|
|
|
657
732
|
Full Example
|
|
@@ -1123,4 +1198,19 @@ export default () => (
|
|
|
1123
1198
|
</div>
|
|
1124
1199
|
</div>
|
|
1125
1200
|
</div>
|
|
1126
|
-
```
|
|
1201
|
+
```
|
|
1202
|
+
|
|
1203
|
+
#### Props
|
|
1204
|
+
|
|
1205
|
+
| Name | Type | Default | Description |
|
|
1206
|
+
| --- | --- | --- | --- |
|
|
1207
|
+
| slideIn | boolean | false | Defines whether the scrollbars should slide in on hover. |
|
|
1208
|
+
| largeTrack | boolean | false | Defines whether the scrollbars should be slightly larger. |
|
|
1209
|
+
| trackOffset | boolean | false | Defines whether the scrollbars should have an offset. |
|
|
1210
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
1211
|
+
| tagName | string | 'div' | Tag name used for the scroll container. |
|
|
1212
|
+
| autoHeight | boolean | false | Enable auto-height behavior. |
|
|
1213
|
+
| autoHeightMin | number | 0 | Minimum height when auto-height is enabled. |
|
|
1214
|
+
| autoHeightMax | number | 200 | Maximum height when auto-height is enabled. |
|
|
1215
|
+
| onScroll | (event: React.UIEvent<any> \| undefined) => void | — | Scroll callback, forwarded to the underlying scrollbars instance. |
|
|
1216
|
+
| style | React.CSSProperties | — | Inline styles for the scroll container. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/spinners
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:05:07.959Z
|
|
7
7
|
|
|
8
8
|
## Spinner
|
|
9
9
|
|
|
@@ -133,6 +133,18 @@ export default () => (
|
|
|
133
133
|
</div>
|
|
134
134
|
```
|
|
135
135
|
|
|
136
|
+
#### Props
|
|
137
|
+
|
|
138
|
+
| Name | Type | Default | Description |
|
|
139
|
+
| --- | --- | --- | --- |
|
|
140
|
+
| isInverse | boolean | false | Defines whether the spinner is shown on bright or dark background. |
|
|
141
|
+
| isDoubleSized | boolean | false | If set to "true" the spinner will be rendered twice as big. |
|
|
142
|
+
| isFullSized | boolean | false | Renders the spinner as overlay in full-size mode. This will be relative to the parent container. Set the parent element to "position-relative" in this case. |
|
|
143
|
+
| isFullScreen | boolean | false | Renders the spinner in fullscreen mode, relative to the body. |
|
|
144
|
+
| isInline | boolean | false | Renders the spinner without centered wrapper. |
|
|
145
|
+
| show | boolean | false | Flag to control the visibility of the spinner. Only relevant in combination with isFullSized or isFullScreen. |
|
|
146
|
+
| text | string \| React.ReactNode | — | The text shown next to the spinner icon. |
|
|
147
|
+
|
|
136
148
|
## Spinner in Buttons
|
|
137
149
|
|
|
138
150
|
### Example: Example 2
|
|
@@ -358,6 +370,18 @@ export default () => (
|
|
|
358
370
|
</div>
|
|
359
371
|
```
|
|
360
372
|
|
|
373
|
+
#### Props
|
|
374
|
+
|
|
375
|
+
| Name | Type | Default | Description |
|
|
376
|
+
| --- | --- | --- | --- |
|
|
377
|
+
| isInverse | boolean | false | Defines whether the spinner is shown on bright or dark background. |
|
|
378
|
+
| isDoubleSized | boolean | false | If set to "true" the spinner will be rendered twice as big. |
|
|
379
|
+
| isFullSized | boolean | false | Renders the spinner as overlay in full-size mode. This will be relative to the parent container. Set the parent element to "position-relative" in this case. |
|
|
380
|
+
| isFullScreen | boolean | false | Renders the spinner in fullscreen mode, relative to the body. |
|
|
381
|
+
| isInline | boolean | false | Renders the spinner without centered wrapper. |
|
|
382
|
+
| show | boolean | false | Flag to control the visibility of the spinner. Only relevant in combination with isFullSized or isFullScreen. |
|
|
383
|
+
| text | string \| React.ReactNode | — | The text shown next to the spinner icon. |
|
|
384
|
+
|
|
361
385
|
## Spinner fullsized
|
|
362
386
|
|
|
363
387
|
### Example: Example 4
|
|
@@ -415,6 +439,18 @@ export default () => {
|
|
|
415
439
|
</div>
|
|
416
440
|
```
|
|
417
441
|
|
|
442
|
+
#### Props
|
|
443
|
+
|
|
444
|
+
| Name | Type | Default | Description |
|
|
445
|
+
| --- | --- | --- | --- |
|
|
446
|
+
| isInverse | boolean | false | Defines whether the spinner is shown on bright or dark background. |
|
|
447
|
+
| isDoubleSized | boolean | false | If set to "true" the spinner will be rendered twice as big. |
|
|
448
|
+
| isFullSized | boolean | false | Renders the spinner as overlay in full-size mode. This will be relative to the parent container. Set the parent element to "position-relative" in this case. |
|
|
449
|
+
| isFullScreen | boolean | false | Renders the spinner in fullscreen mode, relative to the body. |
|
|
450
|
+
| isInline | boolean | false | Renders the spinner without centered wrapper. |
|
|
451
|
+
| show | boolean | false | Flag to control the visibility of the spinner. Only relevant in combination with isFullSized or isFullScreen. |
|
|
452
|
+
| text | string \| React.ReactNode | — | The text shown next to the spinner icon. |
|
|
453
|
+
|
|
418
454
|
## Spinner fullscreen
|
|
419
455
|
|
|
420
456
|
### Example: Example 5
|
|
@@ -457,4 +493,16 @@ export default () => {
|
|
|
457
493
|
<button class="btn btn-default margin-top-25" type="button">Toggle fullscreen loading spinner</button>
|
|
458
494
|
<p>exit fullscreen with esc key</p>
|
|
459
495
|
</div>
|
|
460
|
-
```
|
|
496
|
+
```
|
|
497
|
+
|
|
498
|
+
#### Props
|
|
499
|
+
|
|
500
|
+
| Name | Type | Default | Description |
|
|
501
|
+
| --- | --- | --- | --- |
|
|
502
|
+
| isInverse | boolean | false | Defines whether the spinner is shown on bright or dark background. |
|
|
503
|
+
| isDoubleSized | boolean | false | If set to "true" the spinner will be rendered twice as big. |
|
|
504
|
+
| isFullSized | boolean | false | Renders the spinner as overlay in full-size mode. This will be relative to the parent container. Set the parent element to "position-relative" in this case. |
|
|
505
|
+
| isFullScreen | boolean | false | Renders the spinner in fullscreen mode, relative to the body. |
|
|
506
|
+
| isInline | boolean | false | Renders the spinner without centered wrapper. |
|
|
507
|
+
| show | boolean | false | Flag to control the visibility of the spinner. Only relevant in combination with isFullSized or isFullScreen. |
|
|
508
|
+
| text | string \| React.ReactNode | — | The text shown next to the spinner icon. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Content
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/states
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:56.502Z
|
|
7
7
|
|
|
8
8
|
## ErrorState
|
|
9
9
|
|
|
@@ -129,6 +129,25 @@ export default () => (
|
|
|
129
129
|
|
|
130
130
|
| Name | Type | Default | Description |
|
|
131
131
|
| --- | --- | --- | --- |
|
|
132
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
133
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
134
|
+
| └name | string | — | The name of the icon |
|
|
135
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
136
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
137
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
138
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
139
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
140
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
141
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
142
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
143
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
144
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
145
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
146
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
147
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
148
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
149
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
150
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
132
151
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
133
152
|
|
|
134
153
|
## NotFoundState
|
|
@@ -203,6 +222,25 @@ export default () => (
|
|
|
203
222
|
|
|
204
223
|
| Name | Type | Default | Description |
|
|
205
224
|
| --- | --- | --- | --- |
|
|
225
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
226
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
227
|
+
| └name | string | — | The name of the icon |
|
|
228
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
229
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
230
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
231
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
232
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
233
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
234
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
235
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
236
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
237
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
238
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
239
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
240
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
241
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
242
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
243
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
206
244
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
207
245
|
|
|
208
246
|
## EmptyState
|
|
@@ -279,6 +317,25 @@ export default () => (
|
|
|
279
317
|
|
|
280
318
|
| Name | Type | Default | Description |
|
|
281
319
|
| --- | --- | --- | --- |
|
|
320
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
321
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
322
|
+
| └name | string | — | The name of the icon |
|
|
323
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
324
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
325
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
326
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
327
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
328
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
329
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
330
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
331
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
332
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
333
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
334
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
335
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
336
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
337
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
338
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
282
339
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
283
340
|
|
|
284
341
|
## ForbiddenState
|
|
@@ -342,6 +399,25 @@ export default () => (
|
|
|
342
399
|
|
|
343
400
|
| Name | Type | Default | Description |
|
|
344
401
|
| --- | --- | --- | --- |
|
|
402
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
403
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
404
|
+
| └name | string | — | The name of the icon |
|
|
405
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
406
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
407
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
408
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
409
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
410
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
411
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
412
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
413
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
414
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
415
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
416
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
417
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
418
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
419
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
420
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
345
421
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
346
422
|
|
|
347
423
|
## MaintenanceState
|
|
@@ -390,6 +466,25 @@ export default () => (
|
|
|
390
466
|
|
|
391
467
|
| Name | Type | Default | Description |
|
|
392
468
|
| --- | --- | --- | --- |
|
|
469
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
470
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
471
|
+
| └name | string | — | The name of the icon |
|
|
472
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
473
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
474
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
475
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
476
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
477
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
478
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
479
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
480
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
481
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
482
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
483
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
484
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
485
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
486
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
487
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
393
488
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
394
489
|
|
|
395
490
|
## CustomState
|
|
@@ -475,6 +570,25 @@ export default () => (
|
|
|
475
570
|
|
|
476
571
|
| Name | Type | Default | Description |
|
|
477
572
|
| --- | --- | --- | --- |
|
|
573
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
574
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
575
|
+
| └name | string | — | The name of the icon |
|
|
576
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
577
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
578
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
579
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
580
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
581
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
582
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
583
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
584
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
585
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
586
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
587
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
588
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
589
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
590
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
591
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
478
592
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
479
593
|
|
|
480
594
|
### Example: You don't have access to this issue
|
|
@@ -560,6 +674,25 @@ export default () => (
|
|
|
560
674
|
|
|
561
675
|
| Name | Type | Default | Description |
|
|
562
676
|
| --- | --- | --- | --- |
|
|
677
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
678
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
679
|
+
| └name | string | — | The name of the icon |
|
|
680
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
681
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
682
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
683
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
684
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
685
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
686
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
687
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
688
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
689
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
690
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
691
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
692
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
693
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
694
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
695
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
563
696
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
564
697
|
|
|
565
698
|
## NotBookedState
|
|
@@ -636,6 +769,31 @@ export default () => (
|
|
|
636
769
|
|
|
637
770
|
| Name | Type | Default | Description |
|
|
638
771
|
| --- | --- | --- | --- |
|
|
772
|
+
| features | string \| React.ReactNode[] | — | List of features. |
|
|
773
|
+
|
|
774
|
+
#### Props
|
|
775
|
+
|
|
776
|
+
| Name | Type | Default | Description |
|
|
777
|
+
| --- | --- | --- | --- |
|
|
778
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
779
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
780
|
+
| └name | string | — | The name of the icon |
|
|
781
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
782
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
783
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
784
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
785
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
786
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
787
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
788
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
789
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
790
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
791
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
792
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
793
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
794
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
795
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
796
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
639
797
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
640
798
|
|
|
641
799
|
## Fully customized state
|
|
@@ -688,6 +846,25 @@ export default () => <CustomState headline='Stay tuned' message={dummyTextShort}
|
|
|
688
846
|
|
|
689
847
|
| Name | Type | Default | Description |
|
|
690
848
|
| --- | --- | --- | --- |
|
|
849
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
850
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
851
|
+
| └name | string | — | The name of the icon |
|
|
852
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
853
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
854
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
855
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
856
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
857
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
858
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
859
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
860
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
861
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
862
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
863
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
864
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
865
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
866
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
867
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
691
868
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
692
869
|
|
|
693
870
|
### Example: End User License AgreementCurrently, there is no vehicle in your fleet that requires acceptance of the EULA. However, you may still choose to accept it voluntarily.
|
|
@@ -772,6 +949,25 @@ export default () => (
|
|
|
772
949
|
|
|
773
950
|
| Name | Type | Default | Description |
|
|
774
951
|
| --- | --- | --- | --- |
|
|
952
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
953
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
954
|
+
| └name | string | — | The name of the icon |
|
|
955
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
956
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
957
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
958
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
959
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
960
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
961
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
962
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
963
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
964
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
965
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
966
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
967
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
968
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
969
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
970
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
775
971
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|
|
776
972
|
|
|
777
973
|
## Table with a state
|
|
@@ -949,4 +1145,23 @@ export default () => (
|
|
|
949
1145
|
|
|
950
1146
|
| Name | Type | Default | Description |
|
|
951
1147
|
| --- | --- | --- | --- |
|
|
1148
|
+
| icon | string | — | The icon to be shown. Default icons are defined for all states. |
|
|
1149
|
+
| icons | StateIconProps[] | [] | List of icons to show instead a single icon. |
|
|
1150
|
+
| └name | string | — | The name of the icon |
|
|
1151
|
+
| └className | string | 'text-size-300pct' | Optional class names for this icon. |
|
|
1152
|
+
| └color | string | 'text-color-light' | Optional color class name for the icon. |
|
|
1153
|
+
| image | React.ReactNode | — | Custom Image if needed. |
|
|
1154
|
+
| headline | string \| React.ReactNode | — | The headline to be shown. |
|
|
1155
|
+
| message | string \| React.ReactNode | — | The text to display. |
|
|
1156
|
+
| buttons | StateButtonProps[] | [] | Definitions for the buttons to show. |
|
|
1157
|
+
| └text | string \| React.ReactNode | — | The button text. This can also be a node with an icon to be shown on the button. |
|
|
1158
|
+
| └onClick | VoidFunction | () => {} | Callback fired after the component starts to collapse. |
|
|
1159
|
+
| └href | string | — | Instead of a callback for the button you can specify a "href". This way it will render a link button instead. |
|
|
1160
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The style of the button. |
|
|
1161
|
+
| └className | string | — | Additional classes assigned to the button. |
|
|
1162
|
+
| fullWidth | boolean | false | Defines whether to use 100% width or default width. Note: Only to be used for special cases on the CustomState component. |
|
|
1163
|
+
| condensed | boolean | false | Smaller icon and headline size. |
|
|
1164
|
+
| alignment | TextAlignment | 'center' | Defines where the panel is aligned. Possible values are: 'left' 'center' 'right' |
|
|
1165
|
+
| outerClassName | string | — | Optional class names for the wrapper. |
|
|
1166
|
+
| innerClassName | string | — | Optional class names for the content. |
|
|
952
1167
|
| children | any | — | Additional elements that are rendered below the headline and text. |
|