@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:* Content
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/statsWidgets
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:52.361Z
|
|
7
7
|
|
|
8
8
|
## StatsWidgets
|
|
9
9
|
|
|
@@ -319,6 +319,46 @@ export default () => (
|
|
|
319
319
|
</div>
|
|
320
320
|
```
|
|
321
321
|
|
|
322
|
+
#### Props: StatsWidgets, StatsWidget, StatsWidgetSpacer and StatsWidgetNumber
|
|
323
|
+
|
|
324
|
+
### StatsWidgets, StatsWidget, StatsWidgetSpacer and StatsWidgetNumber
|
|
325
|
+
|
|
326
|
+
| Name | Type | Default | Description |
|
|
327
|
+
| --- | --- | --- | --- |
|
|
328
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
329
|
+
|
|
330
|
+
#### Props: StatsWidget
|
|
331
|
+
|
|
332
|
+
### StatsWidget
|
|
333
|
+
|
|
334
|
+
| Name | Type | Default | Description |
|
|
335
|
+
| --- | --- | --- | --- |
|
|
336
|
+
| onFilterReset | MouseEventHandler | — | Callback to reset the filter. |
|
|
337
|
+
| hasFilter | boolean | false | Defines whether a filter is active for this widget. |
|
|
338
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
339
|
+
|
|
340
|
+
#### Props: StatsWidgetBody
|
|
341
|
+
|
|
342
|
+
### StatsWidgetBody
|
|
343
|
+
|
|
344
|
+
| Name | Type | Default | Description |
|
|
345
|
+
| --- | --- | --- | --- |
|
|
346
|
+
| fullWidth | boolean | false | Whether to use flex space-between for StatsWidgetNumbers. |
|
|
347
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
348
|
+
|
|
349
|
+
#### Props: StatsWidgetNumber
|
|
350
|
+
|
|
351
|
+
### StatsWidgetNumber
|
|
352
|
+
|
|
353
|
+
| Name | Type | Default | Description |
|
|
354
|
+
| --- | --- | --- | --- |
|
|
355
|
+
| value | string \| number \| ReactNode | 0 | The value to be shown. |
|
|
356
|
+
| total | string \| number \| ReactNode | — | The total value to be shown i.e. in combination with an active filter. |
|
|
357
|
+
| label | string \| ReactNode | — | The label shown below the number. |
|
|
358
|
+
| clickable | boolean | false | Defines whether the number is clickable i.e. in combination with a filter. |
|
|
359
|
+
| onClick | MouseEventHandler | — | Callback for when the user clicks the number widget. |
|
|
360
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
361
|
+
|
|
322
362
|
### Example: Example 2
|
|
323
363
|
|
|
324
364
|
Current activity
|
|
@@ -409,6 +449,46 @@ export default () => (
|
|
|
409
449
|
</div>
|
|
410
450
|
```
|
|
411
451
|
|
|
452
|
+
#### Props: StatsWidgets, StatsWidget, StatsWidgetSpacer and StatsWidgetNumber
|
|
453
|
+
|
|
454
|
+
### StatsWidgets, StatsWidget, StatsWidgetSpacer and StatsWidgetNumber
|
|
455
|
+
|
|
456
|
+
| Name | Type | Default | Description |
|
|
457
|
+
| --- | --- | --- | --- |
|
|
458
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
459
|
+
|
|
460
|
+
#### Props: StatsWidget
|
|
461
|
+
|
|
462
|
+
### StatsWidget
|
|
463
|
+
|
|
464
|
+
| Name | Type | Default | Description |
|
|
465
|
+
| --- | --- | --- | --- |
|
|
466
|
+
| onFilterReset | MouseEventHandler | — | Callback to reset the filter. |
|
|
467
|
+
| hasFilter | boolean | false | Defines whether a filter is active for this widget. |
|
|
468
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
469
|
+
|
|
470
|
+
#### Props: StatsWidgetBody
|
|
471
|
+
|
|
472
|
+
### StatsWidgetBody
|
|
473
|
+
|
|
474
|
+
| Name | Type | Default | Description |
|
|
475
|
+
| --- | --- | --- | --- |
|
|
476
|
+
| fullWidth | boolean | false | Whether to use flex space-between for StatsWidgetNumbers. |
|
|
477
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
478
|
+
|
|
479
|
+
#### Props: StatsWidgetNumber
|
|
480
|
+
|
|
481
|
+
### StatsWidgetNumber
|
|
482
|
+
|
|
483
|
+
| Name | Type | Default | Description |
|
|
484
|
+
| --- | --- | --- | --- |
|
|
485
|
+
| value | string \| number \| ReactNode | 0 | The value to be shown. |
|
|
486
|
+
| total | string \| number \| ReactNode | — | The total value to be shown i.e. in combination with an active filter. |
|
|
487
|
+
| label | string \| ReactNode | — | The label shown below the number. |
|
|
488
|
+
| clickable | boolean | false | Defines whether the number is clickable i.e. in combination with a filter. |
|
|
489
|
+
| onClick | MouseEventHandler | — | Callback for when the user clicks the number widget. |
|
|
490
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
491
|
+
|
|
412
492
|
### Example: Example 3
|
|
413
493
|
|
|
414
494
|
Notifications
|
|
@@ -522,4 +602,44 @@ export default () => {
|
|
|
522
602
|
</div>
|
|
523
603
|
</div>
|
|
524
604
|
</div>
|
|
525
|
-
```
|
|
605
|
+
```
|
|
606
|
+
|
|
607
|
+
#### Props: StatsWidgets, StatsWidget, StatsWidgetSpacer and StatsWidgetNumber
|
|
608
|
+
|
|
609
|
+
### StatsWidgets, StatsWidget, StatsWidgetSpacer and StatsWidgetNumber
|
|
610
|
+
|
|
611
|
+
| Name | Type | Default | Description |
|
|
612
|
+
| --- | --- | --- | --- |
|
|
613
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
614
|
+
|
|
615
|
+
#### Props: StatsWidget
|
|
616
|
+
|
|
617
|
+
### StatsWidget
|
|
618
|
+
|
|
619
|
+
| Name | Type | Default | Description |
|
|
620
|
+
| --- | --- | --- | --- |
|
|
621
|
+
| onFilterReset | MouseEventHandler | — | Callback to reset the filter. |
|
|
622
|
+
| hasFilter | boolean | false | Defines whether a filter is active for this widget. |
|
|
623
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
624
|
+
|
|
625
|
+
#### Props: StatsWidgetBody
|
|
626
|
+
|
|
627
|
+
### StatsWidgetBody
|
|
628
|
+
|
|
629
|
+
| Name | Type | Default | Description |
|
|
630
|
+
| --- | --- | --- | --- |
|
|
631
|
+
| fullWidth | boolean | false | Whether to use flex space-between for StatsWidgetNumbers. |
|
|
632
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
633
|
+
|
|
634
|
+
#### Props: StatsWidgetNumber
|
|
635
|
+
|
|
636
|
+
### StatsWidgetNumber
|
|
637
|
+
|
|
638
|
+
| Name | Type | Default | Description |
|
|
639
|
+
| --- | --- | --- | --- |
|
|
640
|
+
| value | string \| number \| ReactNode | 0 | The value to be shown. |
|
|
641
|
+
| total | string \| number \| ReactNode | — | The total value to be shown i.e. in combination with an active filter. |
|
|
642
|
+
| label | string \| ReactNode | — | The label shown below the number. |
|
|
643
|
+
| clickable | boolean | false | Defines whether the number is clickable i.e. in combination with a filter. |
|
|
644
|
+
| onClick | MouseEventHandler | — | Callback for when the user clicks the number widget. |
|
|
645
|
+
| className | string | — | Additional class names to be added to the element. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Progress
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/statusBar
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:36.984Z
|
|
7
7
|
|
|
8
8
|
Flexible component to showcase various states based on progress bars.
|
|
9
9
|
|
|
@@ -615,4 +615,30 @@ export default () => (
|
|
|
615
615
|
</div>
|
|
616
616
|
</div>
|
|
617
617
|
</div>
|
|
618
|
-
```
|
|
618
|
+
```
|
|
619
|
+
|
|
620
|
+
#### Props
|
|
621
|
+
|
|
622
|
+
| Name | Type | Default | Description |
|
|
623
|
+
| --- | --- | --- | --- |
|
|
624
|
+
| icon | StatusBarIcon | — | The icon to be shown next to the progress bar. |
|
|
625
|
+
| └name | string | — | The class name of the icon i.e. "rioglyph-cruise-control". |
|
|
626
|
+
| └alignment | 'left' \| 'right' | 'left' | The position of the icon. |
|
|
627
|
+
| └color | string | 'text-color-gray' | The text color class name for the icon. |
|
|
628
|
+
| └className | string | — | Optional class names for the icon. |
|
|
629
|
+
| label | StatusBarLabel | — | The label to be shown for the progress bar. |
|
|
630
|
+
| └value | string \| React.ReactNode | — | The label content. |
|
|
631
|
+
| └alignment | 'left' \| 'top' \| 'right' | 'right' | The position of the icon. |
|
|
632
|
+
| └weight | 'light' \| 'bold' | 'bold' | The text weight of the label. |
|
|
633
|
+
| └color | string | 'text-color-gray' | The text color class name for the label. |
|
|
634
|
+
| └className | string | — | Optional class names for the label. |
|
|
635
|
+
| progress | StatusBarProgress[] | — | List of progress bars which will be stacked in given order if there are multiple. |
|
|
636
|
+
| └percentage | number | 0 | The percentage of the progress. |
|
|
637
|
+
| └color | string | 'progress-bar-info' | The color class name for the label. |
|
|
638
|
+
| └tooltip | string \| React.ReactNode | — | Optional tooltip content to be shown for the progress bar. |
|
|
639
|
+
| └tooltipPosition | 'top' \| 'right' \| 'bottom' \| 'left' | 'top' | The position of the tooltip for the progress bar. |
|
|
640
|
+
| └tooltipDelay | number | 50 | The delay in milliseconds for when the tooltip is shown when hovering the progress bar. |
|
|
641
|
+
| └className | string | — | Optional class names for the progress bar. |
|
|
642
|
+
| size | 'small' \| 'large' | 'small' | The size of the icon and progress bar. Possible values are: 'small' 'large' |
|
|
643
|
+
| useProgressDivider | boolean | true | Uses a divider for multiple progress bars when defined. |
|
|
644
|
+
| className | string | — | Optional class names for the wrapper element. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Interaction
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/stepButton
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:18.368Z
|
|
7
7
|
|
|
8
8
|
The StepButton is a convenient component designed to simplify usage and alignment of buttons with chevrons.
|
|
9
9
|
|
|
@@ -52,4 +52,10 @@ export default () => (
|
|
|
52
52
|
</span>Next</button>
|
|
53
53
|
</div>
|
|
54
54
|
</div>
|
|
55
|
-
```
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### Props
|
|
58
|
+
|
|
59
|
+
| Name | Type | Default | Description |
|
|
60
|
+
| --- | --- | --- | --- |
|
|
61
|
+
| direction | 'next' \| 'previous' | 'next' | Defines the chevron icon for the respective direction. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Progress
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/steppedProgressBars
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:39.685Z
|
|
7
7
|
|
|
8
8
|
## SteppedProgressBar - Circle
|
|
9
9
|
|
|
@@ -227,6 +227,22 @@ const ThirdPageContent = ({ pageNumber, onClickPrevious }: ThirdPageContentProps
|
|
|
227
227
|
</div>
|
|
228
228
|
```
|
|
229
229
|
|
|
230
|
+
#### Props
|
|
231
|
+
|
|
232
|
+
| Name | Type | Default | Description |
|
|
233
|
+
| --- | --- | --- | --- |
|
|
234
|
+
| labels | SteppedProgressBarLabel[] | — | Objects to defining the icon and the label of the navigation items. The icon can be a string or an icon. |
|
|
235
|
+
| └icon | string \| ReactNode | — | The element shown in the step element. This can be a single step number or an icon element. |
|
|
236
|
+
| └label | string \| ReactNode | — | The label shown below the step element. |
|
|
237
|
+
| └labelClassName | string | — | Additional classes to be set on the label element. |
|
|
238
|
+
| └labelWrapperClassName | string | — | Additional classes to be set on the label wrapping element. |
|
|
239
|
+
| selectedStepNumber | number | — | Index of the selected navigation item. |
|
|
240
|
+
| onSelectedChanged | (selectedKey: number) => void | — | Called with the new selected index after the user clicked a nav item. |
|
|
241
|
+
| variant | 'circle' \| 'rectangle' \| 'roadsign' | 'circle' | The SteppedProgressBar Variant. One of circle, rectangle or roadsign. |
|
|
242
|
+
| disableFollowingPages | number | — | All navigation items with a higher index than this will be disabled. |
|
|
243
|
+
| mobileBreakpoint | boolean | true | Deactivating the wrapping of bubbles on mobile. |
|
|
244
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
245
|
+
|
|
230
246
|
## SteppedProgressBar - Rectangle
|
|
231
247
|
|
|
232
248
|
### Example: Example 2
|
|
@@ -463,6 +479,22 @@ const ThirdPageContent = ({ pageNumber, onClickPrevious }: ThirdPageContentProps
|
|
|
463
479
|
</div>
|
|
464
480
|
```
|
|
465
481
|
|
|
482
|
+
#### Props
|
|
483
|
+
|
|
484
|
+
| Name | Type | Default | Description |
|
|
485
|
+
| --- | --- | --- | --- |
|
|
486
|
+
| labels | SteppedProgressBarLabel[] | — | Objects to defining the icon and the label of the navigation items. The icon can be a string or an icon. |
|
|
487
|
+
| └icon | string \| ReactNode | — | The element shown in the step element. This can be a single step number or an icon element. |
|
|
488
|
+
| └label | string \| ReactNode | — | The label shown below the step element. |
|
|
489
|
+
| └labelClassName | string | — | Additional classes to be set on the label element. |
|
|
490
|
+
| └labelWrapperClassName | string | — | Additional classes to be set on the label wrapping element. |
|
|
491
|
+
| selectedStepNumber | number | — | Index of the selected navigation item. |
|
|
492
|
+
| onSelectedChanged | (selectedKey: number) => void | — | Called with the new selected index after the user clicked a nav item. |
|
|
493
|
+
| variant | 'circle' \| 'rectangle' \| 'roadsign' | 'circle' | The SteppedProgressBar Variant. One of circle, rectangle or roadsign. |
|
|
494
|
+
| disableFollowingPages | number | — | All navigation items with a higher index than this will be disabled. |
|
|
495
|
+
| mobileBreakpoint | boolean | true | Deactivating the wrapping of bubbles on mobile. |
|
|
496
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
497
|
+
|
|
466
498
|
## SteppedProgressBar - Rectangle with custom content
|
|
467
499
|
|
|
468
500
|
### Example: Example 3
|
|
@@ -766,6 +798,22 @@ const ThirdPageContent = ({ pageNumber, onClickPrevious }: ThirdPageContentProps
|
|
|
766
798
|
</div>
|
|
767
799
|
```
|
|
768
800
|
|
|
801
|
+
#### Props
|
|
802
|
+
|
|
803
|
+
| Name | Type | Default | Description |
|
|
804
|
+
| --- | --- | --- | --- |
|
|
805
|
+
| labels | SteppedProgressBarLabel[] | — | Objects to defining the icon and the label of the navigation items. The icon can be a string or an icon. |
|
|
806
|
+
| └icon | string \| ReactNode | — | The element shown in the step element. This can be a single step number or an icon element. |
|
|
807
|
+
| └label | string \| ReactNode | — | The label shown below the step element. |
|
|
808
|
+
| └labelClassName | string | — | Additional classes to be set on the label element. |
|
|
809
|
+
| └labelWrapperClassName | string | — | Additional classes to be set on the label wrapping element. |
|
|
810
|
+
| selectedStepNumber | number | — | Index of the selected navigation item. |
|
|
811
|
+
| onSelectedChanged | (selectedKey: number) => void | — | Called with the new selected index after the user clicked a nav item. |
|
|
812
|
+
| variant | 'circle' \| 'rectangle' \| 'roadsign' | 'circle' | The SteppedProgressBar Variant. One of circle, rectangle or roadsign. |
|
|
813
|
+
| disableFollowingPages | number | — | All navigation items with a higher index than this will be disabled. |
|
|
814
|
+
| mobileBreakpoint | boolean | true | Deactivating the wrapping of bubbles on mobile. |
|
|
815
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
816
|
+
|
|
769
817
|
## SteppedProgressBar - Road Sign
|
|
770
818
|
|
|
771
819
|
### Example: Example 4
|
|
@@ -997,4 +1045,20 @@ const ThirdPageContent = ({ pageNumber, onClickPrevious }: ThirdPageContentProps
|
|
|
997
1045
|
</div>
|
|
998
1046
|
</div>
|
|
999
1047
|
</div>
|
|
1000
|
-
```
|
|
1048
|
+
```
|
|
1049
|
+
|
|
1050
|
+
#### Props
|
|
1051
|
+
|
|
1052
|
+
| Name | Type | Default | Description |
|
|
1053
|
+
| --- | --- | --- | --- |
|
|
1054
|
+
| labels | SteppedProgressBarLabel[] | — | Objects to defining the icon and the label of the navigation items. The icon can be a string or an icon. |
|
|
1055
|
+
| └icon | string \| ReactNode | — | The element shown in the step element. This can be a single step number or an icon element. |
|
|
1056
|
+
| └label | string \| ReactNode | — | The label shown below the step element. |
|
|
1057
|
+
| └labelClassName | string | — | Additional classes to be set on the label element. |
|
|
1058
|
+
| └labelWrapperClassName | string | — | Additional classes to be set on the label wrapping element. |
|
|
1059
|
+
| selectedStepNumber | number | — | Index of the selected navigation item. |
|
|
1060
|
+
| onSelectedChanged | (selectedKey: number) => void | — | Called with the new selected index after the user clicked a nav item. |
|
|
1061
|
+
| variant | 'circle' \| 'rectangle' \| 'roadsign' | 'circle' | The SteppedProgressBar Variant. One of circle, rectangle or roadsign. |
|
|
1062
|
+
| disableFollowingPages | number | — | All navigation items with a higher index than this will be disabled. |
|
|
1063
|
+
| mobileBreakpoint | boolean | true | Deactivating the wrapping of bubbles on mobile. |
|
|
1064
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Navigation
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/subNavigation
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:08.677Z
|
|
7
7
|
|
|
8
8
|
## SubNavigation
|
|
9
9
|
|
|
@@ -76,6 +76,13 @@ export default () => (
|
|
|
76
76
|
</div>
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
+
#### Props
|
|
80
|
+
|
|
81
|
+
| Name | Type | Default | Description |
|
|
82
|
+
| --- | --- | --- | --- |
|
|
83
|
+
| navItems | ModulePropType[] | — | List of navigation items with key and route prop. The route prop is a react-router NavLink component with an active style. |
|
|
84
|
+
| className | string | — | Additional classes for the wrapper element. |
|
|
85
|
+
|
|
79
86
|
## SubNavigation with offset
|
|
80
87
|
|
|
81
88
|
### Example: Example 2
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/supportMarker
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:05:06.241Z
|
|
7
7
|
|
|
8
8
|
You can add the support-marker class along with the data-support attribute to any HTML element - even divs wrapping around iframes, for example!
|
|
9
9
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/svgImage
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:05:07.374Z
|
|
7
7
|
|
|
8
8
|
This component helps to render SVG images hosted on RIO's CDN and lets you customize the colors for various brand themes. It uses the defined UIKIT CSS variables to automatically adapt to dark mode. When customizing colors, make sure to use existing CSS color variable names.
|
|
9
9
|
|
|
@@ -106,42 +106,6 @@ export default () => (
|
|
|
106
106
|
</path>
|
|
107
107
|
</g>
|
|
108
108
|
</svg>
|
|
109
|
-
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:serif="http://www.serif.com/" width="120" height="120" viewBox="0 0 250 250" version="1.1" xml:space="preserve" class="" style="fill-rule: evenodd; clip-rule: evenodd; stroke-miterlimit: 2;">
|
|
110
|
-
<g id="abstract-product" transform="matrix(3.96558,0,0,3.96558,-877.753,-267.258)">
|
|
111
|
-
<path d="M273.364,103.915C273.364,116.618 263.066,126.915 250.364,126.915C237.662,126.915 227.364,116.618 227.364,103.915C227.364,91.213 237.662,80.916 250.364,80.916C263.066,80.916 273.364,91.213 273.364,103.915Z" style="fill: var(--gray-lighter); fill-rule: nonzero;">
|
|
112
|
-
</path>
|
|
113
|
-
<path d="M229.364,79.916L229.364,85.916" style="fill: none; stroke: var(--gray); stroke-width: 2.1px;">
|
|
114
|
-
</path>
|
|
115
|
-
<path d="M232.364,82.916L226.364,82.916" style="fill: none; stroke: var(--gray); stroke-width: 2.1px;">
|
|
116
|
-
</path>
|
|
117
|
-
<path d="M240.364,69.916L240.364,75.916" style="fill: none; stroke: var(--gray); stroke-width: 2.1px;">
|
|
118
|
-
</path>
|
|
119
|
-
<path d="M243.364,72.916L237.364,72.916" style="fill: none; stroke: var(--gray); stroke-width: 2.1px;">
|
|
120
|
-
</path>
|
|
121
|
-
<path d="M269.133,103.237L263.251,106.027L262.929,106.149C262.512,105.406 261.802,104.915 260.814,104.915L254.814,104.915C253.439,104.915 251.348,102.915 249.692,102.915L243.814,102.915C241.397,102.915 239.238,104.894 238.021,106.027C236.141,107.907 232.364,111.703 232.364,111.703L241.556,120.905C243.059,119.403 244.829,117.915 246.364,117.915L258.364,117.915C260.237,117.915 262.101,117.34 263.425,116.016L273.376,106.065L276.205,98.995C274.481,97.271 270.547,99.113 269.133,103.237Z" style="fill: var(--color-white); fill-rule: nonzero;">
|
|
122
|
-
</path>
|
|
123
|
-
<path d="M250.364,110.915L260.814,110.915C262.471,110.915 263.364,109.61 263.364,107.954L263.364,107.935C263.364,106.277 262.471,104.915 260.814,104.915L254.814,104.915C253.439,104.915 251.348,102.915 249.692,102.915L243.814,102.915C241.397,102.915 239.238,104.894 238.021,106.027C236.141,107.907 232.364,111.703 232.364,111.703L241.556,120.905C243.059,119.403 244.829,117.915 246.364,117.915L258.364,117.915C260.237,117.915 262.101,117.34 263.425,116.016L273.376,106.065L276.205,98.995C274.481,97.271 270.547,99.113 269.133,103.237L263.251,106.027" style="fill: none; stroke: var(--brand-info); stroke-width: 2.1px; stroke-linecap: round;">
|
|
124
|
-
</path>
|
|
125
|
-
<path d="M231.364,108.915L225.364,114.915L238.364,127.915L244.363,121.915L231.364,108.915Z" style="fill: var(--color-highlight-lighter); fill-rule: nonzero;">
|
|
126
|
-
</path>
|
|
127
|
-
<path d="M231.364,108.915L225.364,114.915L238.364,127.915L244.363,121.915L231.364,108.915Z" style="fill: none; stroke: var(--brand-info); stroke-width: 2.1px; stroke-linejoin: round;">
|
|
128
|
-
</path>
|
|
129
|
-
<path d="M232.911,116.368L230.911,114.368" style="fill: none; stroke: var(--brand-info); stroke-width: 2.1px; stroke-linecap: round;">
|
|
130
|
-
</path>
|
|
131
|
-
<path d="M266.138,82.263L257.884,75.646C257.627,75.44 257.187,75.342 256.808,75.479L247.08,79.268C246.64,79.355 246.28,79.7 246.21,80.169L244.687,90.446C244.623,90.904 244.7,91.377 245.031,91.643L253.286,98.26C253.603,98.515 253.846,98.674 254.163,98.552L264.147,94.671C264.685,94.462 264.911,94.235 264.984,93.74L266.536,83.275C266.582,82.962 266.428,82.495 266.138,82.263Z" style="fill: var(--color-highlight-lighter); fill-rule: nonzero;">
|
|
132
|
-
</path>
|
|
133
|
-
<path d="M266.138,82.263L257.884,75.646C257.627,75.44 257.187,75.342 256.808,75.479L247.08,79.268C246.64,79.355 246.28,79.7 246.21,80.169L244.687,90.446C244.623,90.904 244.7,91.377 245.031,91.643L253.286,98.26C253.603,98.515 253.846,98.674 254.163,98.552L264.147,94.671C264.685,94.462 264.911,94.235 264.984,93.74L266.536,83.275C266.582,82.962 266.428,82.495 266.138,82.263Z" style="fill: none; stroke: var(--brand-info); stroke-width: 2.1px;">
|
|
134
|
-
</path>
|
|
135
|
-
<path d="M256.605,78.558L255.223,86.846L248.116,89.437" style="fill: none; stroke: var(--brand-info); stroke-width: 2.1px; stroke-linecap: round;">
|
|
136
|
-
</path>
|
|
137
|
-
<path d="M255.223,86.846L262.06,92.26" style="fill: none; stroke: var(--brand-info); stroke-width: 2.1px; stroke-linecap: round;">
|
|
138
|
-
</path>
|
|
139
|
-
<path d="M277.364,87.916L277.364,93.916" style="fill: none; stroke: var(--gray); stroke-width: 2.1px;">
|
|
140
|
-
</path>
|
|
141
|
-
<path d="M280.364,90.916L274.364,90.916" style="fill: none; stroke: var(--gray); stroke-width: 2.1px;">
|
|
142
|
-
</path>
|
|
143
|
-
</g>
|
|
144
|
-
</svg>
|
|
145
109
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:serif="http://www.serif.com/" width="120" height="120" viewBox="0 0 250 250" version="1.1" xml:space="preserve" class="" style="fill-rule: evenodd; clip-rule: evenodd; stroke-miterlimit: 2;">
|
|
146
110
|
<g transform="matrix(3.83333,0,0,3.83333,-417.263,-254.174)">
|
|
147
111
|
<g id="delivery">
|
|
@@ -235,4 +199,14 @@ export default () => (
|
|
|
235
199
|
</g>
|
|
236
200
|
</svg>
|
|
237
201
|
</div>
|
|
238
|
-
```
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
#### Props
|
|
205
|
+
|
|
206
|
+
| Name | Type | Default | Description |
|
|
207
|
+
| --- | --- | --- | --- |
|
|
208
|
+
| name | string | — | The name of the image file without extension. |
|
|
209
|
+
| size | number | 150 | The height and width of the SVG image in pixels. |
|
|
210
|
+
| baseUrl | string | 'https://cdn.rio.cloud/riosvg' | The CDN base URL where the images are located. |
|
|
211
|
+
| colorMap | ColorOverridesMap | — | Customize color using the color map and define the CSS variable name that shall be used. |
|
|
212
|
+
| className | string | — | Additional class names added to the SVG element. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Interaction
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/switch
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:20.481Z
|
|
7
7
|
|
|
8
8
|
## Switch
|
|
9
9
|
|
|
@@ -542,4 +542,13 @@ export default () => {
|
|
|
542
542
|
|
|
543
543
|
| Name | Type | Default | Description |
|
|
544
544
|
| --- | --- | --- | --- |
|
|
545
|
-
|
|
|
545
|
+
| keyName | string | — | Optional key that is used as key and as the id on the internal input. |
|
|
546
|
+
| onChange | (toggleState: boolean) => void | — | Callback function triggered when clicking the button. |
|
|
547
|
+
| checked | boolean | false | Set active / inactive state. |
|
|
548
|
+
| color | string | 'primary' | Defines the color of the switch. Possible values are: 'primary' 'secondary' 'info' 'success' 'warning' 'danger' |
|
|
549
|
+
| minWidth | number | 40 | The min-width of the switch. |
|
|
550
|
+
| disabled | boolean | false | Disables the component. |
|
|
551
|
+
| enabledText | string | — | The text used for the ON state. |
|
|
552
|
+
| disabledText | string | — | The text used for the OFF state. |
|
|
553
|
+
| labelPosition | 'left' \| 'right' | — | Defines the position of the switch label. Defaults to 'right' when children are present. Possible values are 'left' and 'right'. |
|
|
554
|
+
| className | string | — | Additional class names added to the SVG element. |
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Content
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/tables
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:50.602Z
|
|
7
7
|
|
|
8
8
|
The toolbar and its content has to be implemented by each team itself. Please use the following sample as a reference and adapt it accordingly.
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/tagManager
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:05:09.350Z
|
|
7
7
|
|
|
8
8
|
The TagManager allows to select and filter for existing tags as well as adding and removing them from a list of tags.
|
|
9
9
|
|
|
@@ -155,6 +155,24 @@ export default () => {
|
|
|
155
155
|
</div>
|
|
156
156
|
```
|
|
157
157
|
|
|
158
|
+
#### Props (json)
|
|
159
|
+
|
|
160
|
+
```json
|
|
161
|
+
[
|
|
162
|
+
{
|
|
163
|
+
label: 'Foo',
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
label: 'Bar',
|
|
167
|
+
toAdd: true,
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
label: 'Lorem ipsum',
|
|
171
|
+
toRemove: true,
|
|
172
|
+
}
|
|
173
|
+
]
|
|
174
|
+
```
|
|
175
|
+
|
|
158
176
|
### Example: Example 2
|
|
159
177
|
|
|
160
178
|
Lorem
|
|
@@ -257,6 +275,24 @@ export default () => {
|
|
|
257
275
|
</div>
|
|
258
276
|
```
|
|
259
277
|
|
|
278
|
+
#### Props (json)
|
|
279
|
+
|
|
280
|
+
```json
|
|
281
|
+
[
|
|
282
|
+
{
|
|
283
|
+
label: 'Foo',
|
|
284
|
+
},
|
|
285
|
+
{
|
|
286
|
+
label: 'Bar',
|
|
287
|
+
toAdd: true,
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
label: 'Lorem ipsum',
|
|
291
|
+
toRemove: true,
|
|
292
|
+
}
|
|
293
|
+
]
|
|
294
|
+
```
|
|
295
|
+
|
|
260
296
|
### Example: Fleet groups
|
|
261
297
|
|
|
262
298
|
Fleet groups
|
|
@@ -419,4 +455,22 @@ export default () => {
|
|
|
419
455
|
</div>
|
|
420
456
|
<button type="button" class="btn btn-default btn-component margin-top-15 disabled" tabindex="0">Save</button>
|
|
421
457
|
</div>
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
#### Props (json)
|
|
461
|
+
|
|
462
|
+
```json
|
|
463
|
+
[
|
|
464
|
+
{
|
|
465
|
+
label: 'Foo',
|
|
466
|
+
},
|
|
467
|
+
{
|
|
468
|
+
label: 'Bar',
|
|
469
|
+
toAdd: true,
|
|
470
|
+
},
|
|
471
|
+
{
|
|
472
|
+
label: 'Lorem ipsum',
|
|
473
|
+
toRemove: true,
|
|
474
|
+
}
|
|
475
|
+
]
|
|
422
476
|
```
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/tags
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:05:08.958Z
|
|
7
7
|
|
|
8
8
|
## Tag
|
|
9
9
|
|
|
@@ -753,4 +753,34 @@ export default () => (
|
|
|
753
753
|
</div>
|
|
754
754
|
</div>
|
|
755
755
|
</div>
|
|
756
|
-
```
|
|
756
|
+
```
|
|
757
|
+
|
|
758
|
+
#### Props: Tag
|
|
759
|
+
|
|
760
|
+
### Tag
|
|
761
|
+
|
|
762
|
+
| Name | Type | Default | Description |
|
|
763
|
+
| --- | --- | --- | --- |
|
|
764
|
+
| active | boolean | false | Defines if the tag is active. |
|
|
765
|
+
| clickable | boolean | false | Defines if the tag is clickable. |
|
|
766
|
+
| deletable | boolean | false | Defines if the tag is deletable. |
|
|
767
|
+
| revertable | boolean | false | Defines if the tag is revertable. |
|
|
768
|
+
| disabled | boolean | false | Defines if the tag is disabled. |
|
|
769
|
+
| icon | string | — | Define any rioglyph icon like "rioglyph-truck". |
|
|
770
|
+
| muted | boolean | false | Sets a more subtle style for border and background. |
|
|
771
|
+
| round | boolean | true | Defines if the tag is round. |
|
|
772
|
+
| selectable | boolean | false | Defines if the tag is selectable. |
|
|
773
|
+
| size | 'small' \| 'medium' | — | Defines if you want to render the tag in a different size. Possible values are: 'small' and 'medium' |
|
|
774
|
+
| multiline | boolean | false | Allows to render text on multiple lines. |
|
|
775
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
776
|
+
|
|
777
|
+
#### Props: TagList
|
|
778
|
+
|
|
779
|
+
### TagList
|
|
780
|
+
|
|
781
|
+
| Name | Type | Default | Description |
|
|
782
|
+
| --- | --- | --- | --- |
|
|
783
|
+
| inline | boolean | true | Defines if the tag list is rendered inline or vertically. |
|
|
784
|
+
| autoTagWidth | boolean | false | Defines if the tag has the same with as it`s parent container. |
|
|
785
|
+
| tagsPerRow | 1 \| 2 \| 3 \| 4 \| 6 | — | Possible values are 1-6 |
|
|
786
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Content
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/teaser
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:52.277Z
|
|
7
7
|
|
|
8
8
|
The teaser component was built to create all kinds of landing and/or single pages. for example, be used in dialogs or sidebars.
|
|
9
9
|
|
|
@@ -894,4 +894,31 @@ export default () => (
|
|
|
894
894
|
|
|
895
895
|
| Name | Type | Default | Description |
|
|
896
896
|
| --- | --- | --- | --- |
|
|
897
|
-
| teaserPerRow | number | — |
|
|
897
|
+
| teaserPerRow | number | — | Defines how many children are rendered into a row. If "teaserPerRow" is not defined, the container tries to put all children in a row with regard to the Bootstrap grid. This is done by dividing the amount of children by 12 in order to figure out the col grid classes. It is recommended to define "teasersPerRow" when having more than 4 teasers. Possible values are: 1 2 3 4 6 12 |
|
|
898
|
+
| columnClassName | string | — | Optional string for additional classes added to each column of a child. |
|
|
899
|
+
| className | string | — | Optional string for additional classes added to the row. |
|
|
900
|
+
|
|
901
|
+
#### Props: Teaser
|
|
902
|
+
|
|
903
|
+
### Teaser
|
|
904
|
+
|
|
905
|
+
| Name | Type | Default | Description |
|
|
906
|
+
| --- | --- | --- | --- |
|
|
907
|
+
| headline | string \| React.ReactNode | — | The headline for the teaser. |
|
|
908
|
+
| content | string \| React.ReactNode | — | The actual content to show e.g. some kind of text. |
|
|
909
|
+
| image | TeaserImage | — | Defines an image to render. |
|
|
910
|
+
| └src | string | — | The src URL for the image. |
|
|
911
|
+
| └alt | string | — | The alternate text for the image. |
|
|
912
|
+
| └align | 'left' \| 'right' | — | Defines whether the image is on the left or right side of the component. Possible values are: 'left' and 'right'. |
|
|
913
|
+
| └onClick | VoidFunction | — | Callback function for the image. |
|
|
914
|
+
| └aspectRatio | '1:1' \| '3:1' \| '3:2' \| '16:9' | — | Ratio of the transparent image placeholder. Possible values are '1:1', '3:1', '3:2' and '16:9'. |
|
|
915
|
+
| └className | string | — | Additional classes added to the image wrapper. |
|
|
916
|
+
| button | TeaserButton | — | Defines a button to render with. |
|
|
917
|
+
| └text | string \| React.ReactNode | — | The text content for the button. |
|
|
918
|
+
| └bsStyle | BUTTON_STYLE | 'primary' | The button style. See the button styles definition for possible values. |
|
|
919
|
+
| └onClick | (event: SyntheticEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function for the button. |
|
|
920
|
+
| └className | string | — | Additional classes added to the button. |
|
|
921
|
+
| verticalAlignment | 'top' \| 'center' | 'top' | Defines where the teaser content is aligned including headline and image. Possible values are: 'top' and 'center'. |
|
|
922
|
+
| segmentation | '50' \| '25:75' \| '75:25' \| '100' | — | Defines how the teaser content is segmented. Possible values are: '50', '25:75', '75:25' and '100'. |
|
|
923
|
+
| footer | string \| React.ReactNode | — | Optional content for footer in case the prop "button" is not sufficient. |
|
|
924
|
+
| className | string | — | Additional classes added to the wrapper. |
|