@rio-cloud/uikit-mcp 1.1.3 → 1.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/dist/doc-metadata.json +97 -97
- package/dist/docs/components/accentBar.md +5 -5
- package/dist/docs/components/activity.md +7 -7
- package/dist/docs/components/animatedNumber.md +10 -10
- package/dist/docs/components/animatedTextReveal.md +42 -43
- package/dist/docs/components/animations.md +42 -34
- package/dist/docs/components/appHeader.md +20 -35
- package/dist/docs/components/appLayout.md +198 -221
- package/dist/docs/components/appNavigationBar.md +21 -21
- package/dist/docs/components/areaCharts.md +38 -38
- package/dist/docs/components/aspectRatioPlaceholder.md +4 -5
- package/dist/docs/components/assetTree.md +887 -614
- package/dist/docs/components/autosuggests.md +4 -4
- package/dist/docs/components/avatar.md +7 -7
- package/dist/docs/components/banner.md +2 -2
- package/dist/docs/components/barCharts.md +173 -173
- package/dist/docs/components/barList.md +19 -41
- package/dist/docs/components/basicMap.md +1 -1
- package/dist/docs/components/bottomSheet.md +74 -74
- package/dist/docs/components/button.md +161 -71
- package/dist/docs/components/buttonToolbar.md +3 -3
- package/dist/docs/components/calendarStripe.md +71 -123
- package/dist/docs/components/card.md +4 -4
- package/dist/docs/components/carousel.md +1 -1
- package/dist/docs/components/chartColors.md +1 -1
- package/dist/docs/components/chartsGettingStarted.md +1 -1
- package/dist/docs/components/chat.md +2 -2
- package/dist/docs/components/checkbox.md +56 -131
- package/dist/docs/components/clearableInput.md +23 -127
- package/dist/docs/components/collapse.md +14 -16
- package/dist/docs/components/composedCharts.md +31 -31
- package/dist/docs/components/contentLoader.md +125 -122
- package/dist/docs/components/dataTabs.md +103 -93
- package/dist/docs/components/datepickers.md +734 -764
- package/dist/docs/components/dialogs.md +299 -186
- package/dist/docs/components/divider.md +4 -4
- package/dist/docs/components/dropdowns.md +4555 -4498
- package/dist/docs/components/editableContent.md +97 -97
- package/dist/docs/components/expander.md +56 -56
- package/dist/docs/components/fade.md +41 -41
- package/dist/docs/components/fadeExpander.md +4 -4
- package/dist/docs/components/fadeUp.md +8 -10
- package/dist/docs/components/feedback.md +22 -21
- package/dist/docs/components/filePickers.md +25 -25
- package/dist/docs/components/formLabel.md +5 -7
- package/dist/docs/components/groupedItemList.md +37 -37
- package/dist/docs/components/iconList.md +4 -4
- package/dist/docs/components/imagePreloader.md +6 -6
- package/dist/docs/components/labeledElement.md +4 -3
- package/dist/docs/components/licensePlate.md +2 -2
- package/dist/docs/components/lineCharts.md +58 -58
- package/dist/docs/components/listMenu.md +63 -41
- package/dist/docs/components/loadMore.md +17 -17
- package/dist/docs/components/mainNavigation.md +1 -1
- package/dist/docs/components/mapCircle.md +1 -1
- package/dist/docs/components/mapCluster.md +1 -1
- package/dist/docs/components/mapContext.md +1 -1
- package/dist/docs/components/mapDraggableMarker.md +1 -1
- package/dist/docs/components/mapGettingStarted.md +1 -1
- package/dist/docs/components/mapInfoBubble.md +1 -1
- package/dist/docs/components/mapLayerGroup.md +1 -1
- package/dist/docs/components/mapMarker.md +339 -345
- package/dist/docs/components/mapPolygon.md +16 -20
- package/dist/docs/components/mapRoute.md +14 -20
- package/dist/docs/components/mapRouteGenerator.md +1 -1
- package/dist/docs/components/mapSettings.md +263 -274
- package/dist/docs/components/mapUtils.md +3 -5
- package/dist/docs/components/multiselects.md +1 -1
- package/dist/docs/components/noData.md +11 -11
- package/dist/docs/components/notifications.md +1 -1
- package/dist/docs/components/numbercontrol.md +39 -37
- package/dist/docs/components/onboarding.md +18 -38
- package/dist/docs/components/page.md +16 -16
- package/dist/docs/components/pager.md +8 -8
- package/dist/docs/components/pieCharts.md +124 -124
- package/dist/docs/components/popover.md +37 -53
- package/dist/docs/components/position.md +4 -4
- package/dist/docs/components/radialBarCharts.md +506 -506
- package/dist/docs/components/radiobutton.md +209 -191
- package/dist/docs/components/releaseNotes.md +9 -3
- package/dist/docs/components/resizer.md +7 -8
- package/dist/docs/components/responsiveColumnStripe.md +11 -11
- package/dist/docs/components/responsiveVideo.md +5 -5
- package/dist/docs/components/rioglyph.md +11 -11
- package/dist/docs/components/rules.md +118 -92
- package/dist/docs/components/saveableInput.md +366 -356
- package/dist/docs/components/selects.md +9996 -15
- package/dist/docs/components/sidebar.md +22 -23
- package/dist/docs/components/sliders.md +26 -26
- package/dist/docs/components/smoothScrollbars.md +61 -25
- package/dist/docs/components/spinners.md +32 -30
- package/dist/docs/components/states.md +236 -245
- package/dist/docs/components/statsWidgets.md +37 -28
- package/dist/docs/components/statusBar.md +22 -22
- package/dist/docs/components/stepButton.md +2 -2
- package/dist/docs/components/steppedProgressBars.md +45 -45
- package/dist/docs/components/subNavigation.md +3 -3
- package/dist/docs/components/supportMarker.md +1 -1
- package/dist/docs/components/svgImage.md +2 -38
- package/dist/docs/components/switch.md +11 -11
- package/dist/docs/components/tables.md +1 -1
- package/dist/docs/components/tagManager.md +40 -40
- package/dist/docs/components/tags.md +21 -20
- package/dist/docs/components/teaser.md +22 -23
- package/dist/docs/components/timeline.md +1 -1
- package/dist/docs/components/timepicker.md +17 -13
- package/dist/docs/components/toggleButton.md +65 -29
- package/dist/docs/components/tooltip.md +27 -50
- package/dist/docs/components/virtualList.md +75 -75
- package/dist/docs/foundations.md +167 -167
- package/dist/docs/start/changelog.md +23 -1
- package/dist/docs/start/goodtoknow.md +1 -1
- package/dist/docs/start/guidelines/color-combinations.md +1 -1
- package/dist/docs/start/guidelines/custom-css.md +1 -1
- package/dist/docs/start/guidelines/custom-rioglyph.md +1 -1
- package/dist/docs/start/guidelines/formatting.md +1 -1
- package/dist/docs/start/guidelines/iframe.md +80 -27
- package/dist/docs/start/guidelines/obfuscate-data.md +1 -1
- package/dist/docs/start/guidelines/print-css.md +1 -1
- package/dist/docs/start/guidelines/spinner.md +81 -81
- package/dist/docs/start/guidelines/supported-browsers.md +1 -1
- package/dist/docs/start/guidelines/writing.md +1 -1
- package/dist/docs/start/howto.md +9 -9
- package/dist/docs/start/intro.md +1 -1
- package/dist/docs/start/responsiveness.md +1 -1
- package/dist/docs/templates/common-table.md +11 -11
- package/dist/docs/templates/detail-views.md +2 -2
- package/dist/docs/templates/expandable-details.md +1 -1
- package/dist/docs/templates/feature-cards.md +55 -55
- package/dist/docs/templates/form-summary.md +22 -22
- package/dist/docs/templates/form-toggle.md +1 -1
- package/dist/docs/templates/list-blocks.md +197 -197
- package/dist/docs/templates/loading-progress.md +1 -1
- package/dist/docs/templates/options-panel.md +1 -1
- package/dist/docs/templates/panel-variants.md +1 -1
- package/dist/docs/templates/progress-cards.md +1 -1
- package/dist/docs/templates/progress-success.md +1 -1
- package/dist/docs/templates/settings-form.md +23 -23
- package/dist/docs/templates/stats-blocks.md +41 -41
- package/dist/docs/templates/table-panel.md +1 -1
- package/dist/docs/templates/table-row-animation.md +1 -1
- package/dist/docs/templates/usage-cards.md +1 -1
- package/dist/docs/utilities/deviceUtils.md +6 -3
- package/dist/docs/utilities/featureToggles.md +1 -1
- package/dist/docs/utilities/fuelTypeUtils.md +1 -1
- package/dist/docs/utilities/routeUtils.md +59 -23
- package/dist/docs/utilities/useAfterMount.md +1 -1
- package/dist/docs/utilities/useAutoAnimate.md +1 -1
- package/dist/docs/utilities/useAverage.md +1 -1
- package/dist/docs/utilities/useClickOutside.md +1 -1
- package/dist/docs/utilities/useClipboard.md +2 -2
- package/dist/docs/utilities/useCount.md +1 -1
- package/dist/docs/utilities/useDarkMode.md +1 -1
- package/dist/docs/utilities/useDebugInfo.md +4 -4
- package/dist/docs/utilities/useEffectOnce.md +1 -1
- package/dist/docs/utilities/useElapsedTime.md +1 -1
- package/dist/docs/utilities/useElementSize.md +1 -1
- package/dist/docs/utilities/useEsc.md +1 -1
- package/dist/docs/utilities/useEvent.md +1 -1
- package/dist/docs/utilities/useFocusTrap.md +1 -1
- package/dist/docs/utilities/useFullscreen.md +1 -1
- package/dist/docs/utilities/useHover.md +1 -1
- package/dist/docs/utilities/useIncomingPostMessages.md +1 -1
- package/dist/docs/utilities/useInterval.md +1 -1
- package/dist/docs/utilities/useIsFocusWithin.md +1 -1
- package/dist/docs/utilities/useKey.md +7 -5
- package/dist/docs/utilities/useLocalStorage.md +1 -1
- package/dist/docs/utilities/useLocationSuggestions.md +1 -1
- package/dist/docs/utilities/useMax.md +1 -1
- package/dist/docs/utilities/useMin.md +1 -1
- package/dist/docs/utilities/useMutationObserver.md +1 -1
- package/dist/docs/utilities/useOnScreen.md +1 -1
- package/dist/docs/utilities/useOnlineStatus.md +1 -1
- package/dist/docs/utilities/usePostMessage.md +58 -2
- package/dist/docs/utilities/usePostMessageSender.md +1 -1
- package/dist/docs/utilities/usePrevious.md +1 -1
- package/dist/docs/utilities/useResizeObserver.md +1 -1
- package/dist/docs/utilities/useScrollPosition.md +1 -1
- package/dist/docs/utilities/useSearch.md +1 -1
- package/dist/docs/utilities/useSorting.md +1 -1
- package/dist/docs/utilities/useStateWithValidation.md +1 -1
- package/dist/docs/utilities/useSum.md +1 -1
- package/dist/docs/utilities/useTableExport.md +54 -54
- package/dist/docs/utilities/useTableSelection.md +93 -93
- package/dist/docs/utilities/useTimeout.md +1 -1
- package/dist/docs/utilities/useToggle.md +1 -1
- package/dist/docs/utilities/useWindowResize.md +1 -1
- package/dist/index.mjs +8 -8
- package/dist/version.json +2 -2
- package/package.json +6 -6
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* 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
|
|
|
@@ -755,31 +755,32 @@ export default () => (
|
|
|
755
755
|
</div>
|
|
756
756
|
```
|
|
757
757
|
|
|
758
|
-
#### Props:
|
|
758
|
+
#### Props: Tag
|
|
759
759
|
|
|
760
|
-
###
|
|
760
|
+
### Tag
|
|
761
761
|
|
|
762
762
|
| Name | Type | Default | Description |
|
|
763
763
|
| --- | --- | --- | --- |
|
|
764
|
-
|
|
|
765
|
-
|
|
|
766
|
-
|
|
|
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. |
|
|
767
776
|
|
|
768
|
-
#### Props:
|
|
777
|
+
#### Props: TagList
|
|
769
778
|
|
|
770
|
-
###
|
|
779
|
+
### TagList
|
|
771
780
|
|
|
772
781
|
| Name | Type | Default | Description |
|
|
773
782
|
| --- | --- | --- | --- |
|
|
774
|
-
|
|
|
775
|
-
|
|
|
776
|
-
|
|
|
777
|
-
|
|
|
778
|
-
| selectable | Boolean | false | Defines if the tag is selectable. |
|
|
779
|
-
| deletable | Boolean | false | Defines if the tag is deletable. |
|
|
780
|
-
| revertable | Boolean | false | Defines if the tag is revertable. |
|
|
781
|
-
| disabled | Boolean | false | Defines if the tag is disabled. |
|
|
782
|
-
| round | Boolean | true | Defines if the tag is round. |
|
|
783
|
-
| muted | Boolean | false | Sets a more subtle style for border and background. |
|
|
784
|
-
| className | String | — | Additional classes to be set on the wrapper element. |
|
|
785
|
-
| children | any | — | Any element to be rendered inside the tag. |
|
|
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,10 +894,9 @@ export default () => (
|
|
|
894
894
|
|
|
895
895
|
| Name | Type | Default | Description |
|
|
896
896
|
| --- | --- | --- | --- |
|
|
897
|
-
|
|
|
898
|
-
|
|
|
899
|
-
|
|
|
900
|
-
| className | String | — | Optional string for additional classes added to the row. |
|
|
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. |
|
|
901
900
|
|
|
902
901
|
#### Props: Teaser
|
|
903
902
|
|
|
@@ -905,21 +904,21 @@ export default () => (
|
|
|
905
904
|
|
|
906
905
|
| Name | Type | Default | Description |
|
|
907
906
|
| --- | --- | --- | --- |
|
|
908
|
-
| headline |
|
|
909
|
-
| content |
|
|
910
|
-
| image |
|
|
911
|
-
| └src |
|
|
912
|
-
| └alt |
|
|
913
|
-
| └
|
|
914
|
-
| └
|
|
915
|
-
| └
|
|
916
|
-
| └className |
|
|
917
|
-
| button |
|
|
918
|
-
| └text |
|
|
919
|
-
| └bsStyle |
|
|
920
|
-
| └onClick |
|
|
921
|
-
| └className |
|
|
922
|
-
| verticalAlignment |
|
|
923
|
-
| segmentation |
|
|
924
|
-
| footer |
|
|
925
|
-
| className |
|
|
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. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Pickers
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/timepicker
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:35.393Z
|
|
7
7
|
|
|
8
8
|
## TimePicker
|
|
9
9
|
|
|
@@ -149,12 +149,14 @@ export default () => {
|
|
|
149
149
|
| Name | Type | Default | Description |
|
|
150
150
|
| --- | --- | --- | --- |
|
|
151
151
|
| value | string | — | Value of the time as string. Note, when value is given the component is treated as controlled. |
|
|
152
|
-
| onChange |
|
|
153
|
-
| alwaysShowMask |
|
|
154
|
-
| showIcon |
|
|
155
|
-
|
|
|
156
|
-
|
|
|
157
|
-
|
|
|
152
|
+
| onChange | (value: string) => void | — | Callback function when the value changes and is a valid time format. If not it handles the state internally until the time is valid and filled. |
|
|
153
|
+
| alwaysShowMask | boolean | true | Defines whether to always show the input mask placeholder. |
|
|
154
|
+
| showIcon | boolean | false | Defines whether to show the input icon. |
|
|
155
|
+
| errorMessage | string \| React.ReactNode | — | Input error message. |
|
|
156
|
+
| warningMessage | string \| React.ReactNode | — | Input warning message. |
|
|
157
|
+
| messageWhiteSpace | 'normal' \| 'nowrap' \| 'pre-line' | 'normal' | Feedback message width. |
|
|
158
|
+
| inputProps | Omit<React.InputHTMLAttributes<HTMLInputElement>, 'value' \| 'onChange'> | — | Additional properties to be set on the input element. |
|
|
159
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
158
160
|
|
|
159
161
|
### Example: Example 2
|
|
160
162
|
|
|
@@ -254,9 +256,11 @@ export default () => {
|
|
|
254
256
|
| Name | Type | Default | Description |
|
|
255
257
|
| --- | --- | --- | --- |
|
|
256
258
|
| value | string | — | Value of the time as string. Note, when value is given the component is treated as controlled. |
|
|
257
|
-
| onChange |
|
|
258
|
-
| alwaysShowMask |
|
|
259
|
-
| showIcon |
|
|
260
|
-
|
|
|
261
|
-
|
|
|
262
|
-
|
|
|
259
|
+
| onChange | (value: string) => void | — | Callback function when the value changes and is a valid time format. If not it handles the state internally until the time is valid and filled. |
|
|
260
|
+
| alwaysShowMask | boolean | true | Defines whether to always show the input mask placeholder. |
|
|
261
|
+
| showIcon | boolean | false | Defines whether to show the input icon. |
|
|
262
|
+
| errorMessage | string \| React.ReactNode | — | Input error message. |
|
|
263
|
+
| warningMessage | string \| React.ReactNode | — | Input warning message. |
|
|
264
|
+
| messageWhiteSpace | 'normal' \| 'nowrap' \| 'pre-line' | 'normal' | Feedback message width. |
|
|
265
|
+
| inputProps | Omit<React.InputHTMLAttributes<HTMLInputElement>, 'value' \| 'onChange'> | — | Additional properties to be set on the input element. |
|
|
266
|
+
| className | string | — | Additional classes to be set 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/toggleButton
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:22.766Z
|
|
7
7
|
|
|
8
8
|
This toggle button is based on the button component that can be used directly.
|
|
9
9
|
|
|
@@ -89,20 +89,38 @@ export default () => (
|
|
|
89
89
|
|
|
90
90
|
| Name | Type | Default | Description |
|
|
91
91
|
| --- | --- | --- | --- |
|
|
92
|
-
| disabled |
|
|
93
|
-
| active |
|
|
94
|
-
|
|
|
95
|
-
| iconOnly |
|
|
96
|
-
|
|
|
97
|
-
|
|
|
98
|
-
| multiline |
|
|
99
|
-
| block |
|
|
100
|
-
|
|
|
101
|
-
|
|
|
102
|
-
|
|
|
103
|
-
|
|
|
104
|
-
|
|
|
105
|
-
|
|
|
92
|
+
| disabled | boolean | false | Whether the button should be disabled. |
|
|
93
|
+
| active | boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
|
|
94
|
+
| type | 'button' \| 'submit' | 'button' | Defines the type of the button. This may be used for form submit buttons. |
|
|
95
|
+
| iconOnly | boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
|
|
96
|
+
| iconRight | boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
|
|
97
|
+
| iconName | string | — | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
|
|
98
|
+
| multiline | boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
|
|
99
|
+
| block | boolean | false | Defines whether the button takes up the full width of the parent element. |
|
|
100
|
+
| bsStyle | BUTTON_STYLE | "default" | Sets the button style. Possible values are: default, unstyled, primary, secondary, info, warning, danger, success, muted and muted-filled |
|
|
101
|
+
| bsSize | BUTTON_SIZE | — | Sets the button size. Possible values are: xs, sm, md and lg |
|
|
102
|
+
| variant | BUTTON_VARIANT | — | Sets the button variant. Possible values are: link, link-inline, outline and action |
|
|
103
|
+
| noRippleEffect | boolean | — | Whether the "ripple" effect should be suppressed on this button. |
|
|
104
|
+
| tabIndex | number | 0 | Number of the index used for keyboard support. |
|
|
105
|
+
| className | string | — | Additional classes to be set on the button element. |
|
|
106
|
+
|
|
107
|
+
#### Props: Regular button
|
|
108
|
+
|
|
109
|
+
### Regular button
|
|
110
|
+
|
|
111
|
+
| Name | Type | Default | Description |
|
|
112
|
+
| --- | --- | --- | --- |
|
|
113
|
+
| asToggle | false | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
114
|
+
| onClick | (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function triggered when clicking the button. |
|
|
115
|
+
|
|
116
|
+
#### Props: ToggleButton
|
|
117
|
+
|
|
118
|
+
### ToggleButton
|
|
119
|
+
|
|
120
|
+
| Name | Type | Default | Description |
|
|
121
|
+
| --- | --- | --- | --- |
|
|
122
|
+
| asToggle | true | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
123
|
+
| onClick | (value: boolean) => void | — | Callback function triggered when clicking the button. |
|
|
106
124
|
|
|
107
125
|
### Example: Controlled ToggleButton
|
|
108
126
|
|
|
@@ -162,17 +180,35 @@ export default () => {
|
|
|
162
180
|
|
|
163
181
|
| Name | Type | Default | Description |
|
|
164
182
|
| --- | --- | --- | --- |
|
|
165
|
-
| disabled |
|
|
166
|
-
| active |
|
|
167
|
-
|
|
|
168
|
-
| iconOnly |
|
|
169
|
-
|
|
|
170
|
-
|
|
|
171
|
-
| multiline |
|
|
172
|
-
| block |
|
|
173
|
-
|
|
|
174
|
-
|
|
|
175
|
-
|
|
|
176
|
-
|
|
|
177
|
-
|
|
|
178
|
-
|
|
|
183
|
+
| disabled | boolean | false | Whether the button should be disabled. |
|
|
184
|
+
| active | boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
|
|
185
|
+
| type | 'button' \| 'submit' | 'button' | Defines the type of the button. This may be used for form submit buttons. |
|
|
186
|
+
| iconOnly | boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
|
|
187
|
+
| iconRight | boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
|
|
188
|
+
| iconName | string | — | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
|
|
189
|
+
| multiline | boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
|
|
190
|
+
| block | boolean | false | Defines whether the button takes up the full width of the parent element. |
|
|
191
|
+
| bsStyle | BUTTON_STYLE | "default" | Sets the button style. Possible values are: default, unstyled, primary, secondary, info, warning, danger, success, muted and muted-filled |
|
|
192
|
+
| bsSize | BUTTON_SIZE | — | Sets the button size. Possible values are: xs, sm, md and lg |
|
|
193
|
+
| variant | BUTTON_VARIANT | — | Sets the button variant. Possible values are: link, link-inline, outline and action |
|
|
194
|
+
| noRippleEffect | boolean | — | Whether the "ripple" effect should be suppressed on this button. |
|
|
195
|
+
| tabIndex | number | 0 | Number of the index used for keyboard support. |
|
|
196
|
+
| className | string | — | Additional classes to be set on the button element. |
|
|
197
|
+
|
|
198
|
+
#### Props: Regular button
|
|
199
|
+
|
|
200
|
+
### Regular button
|
|
201
|
+
|
|
202
|
+
| Name | Type | Default | Description |
|
|
203
|
+
| --- | --- | --- | --- |
|
|
204
|
+
| asToggle | false | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
205
|
+
| onClick | (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function triggered when clicking the button. |
|
|
206
|
+
|
|
207
|
+
#### Props: ToggleButton
|
|
208
|
+
|
|
209
|
+
### ToggleButton
|
|
210
|
+
|
|
211
|
+
| Name | Type | Default | Description |
|
|
212
|
+
| --- | --- | --- | --- |
|
|
213
|
+
| asToggle | true | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
214
|
+
| onClick | (value: boolean) => void | — | Callback function triggered when clicking the button. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/tooltip
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:05:10.161Z
|
|
7
7
|
|
|
8
8
|
In order to use a Tooltip on an element, wrap it with the OverlayTrigger component or use the SimpleTooltip component.
|
|
9
9
|
|
|
@@ -300,36 +300,24 @@ export default () => (
|
|
|
300
300
|
</div>
|
|
301
301
|
```
|
|
302
302
|
|
|
303
|
-
#### Props
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
### OverlayTrigger
|
|
322
|
-
|
|
323
|
-
| Name | Type | Default | Description |
|
|
324
|
-
| --- | --- | --- | --- |
|
|
325
|
-
| trigger | 'click' \| 'hover' \| 'focus' | hover | Specify which action or actions trigger Overlay visibility. Possible values are: OverlayTrigger.TRIGGER_CLICK , OverlayTrigger.TRIGGER_HOVER, OverlayTrigger.TRIGGER_HOVER or 'click', 'hover', 'focus' |
|
|
326
|
-
| delay | Number / Object | — | A millisecond delay amount to show and hide the Overlay once triggered. |
|
|
327
|
-
| └show | Number | — | A millisecond delay amount before showing the Overlay once triggered. |
|
|
328
|
-
| └hide | Number | — | A millisecond delay amount before hiding the Overlay once triggered. |
|
|
329
|
-
| defaultShow | Boolean | — | The initial visibility state of the Overlay. For more nuanced visibility control, consider using the Overlay component directly. |
|
|
330
|
-
| overlay | Node | — | An element or text to overlay next to the target. |
|
|
331
|
-
| placement | String | — | Sets the direction the overlay is positioned towards. Possible values are: auto-start, auto, auto-end, top-start, top, top-end, bottom-start, bottom, bottom-end, right-start, right, right-end, left-start, left or left-end |
|
|
332
|
-
| popperConfig | Object | — | A Popper.js config object passed to the the underlying popper instance. |
|
|
303
|
+
#### Props (json)
|
|
304
|
+
|
|
305
|
+
```json
|
|
306
|
+
popperConfig={{
|
|
307
|
+
modifiers: [
|
|
308
|
+
{
|
|
309
|
+
name: 'offset',
|
|
310
|
+
options: {
|
|
311
|
+
offset: [0, 5],
|
|
312
|
+
},
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
name: 'arrow',
|
|
316
|
+
options: {},
|
|
317
|
+
},
|
|
318
|
+
],
|
|
319
|
+
}}
|
|
320
|
+
```
|
|
333
321
|
|
|
334
322
|
## SimpleTooltip
|
|
335
323
|
|
|
@@ -433,22 +421,11 @@ export default () => (
|
|
|
433
421
|
</div>
|
|
434
422
|
```
|
|
435
423
|
|
|
436
|
-
#### Props
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
| content | String / Node | — | The tooltip content. |
|
|
445
|
-
| targetRef | Ref | — | The react ref object assigned to the target of the tooltip. |
|
|
446
|
-
| delay | Number / Object | — | A millisecond delay amount to show the Overlay once triggered. |
|
|
447
|
-
| └show | Number | — | A millisecond delay amount before showing the Overlay once triggered. |
|
|
448
|
-
| └hide | Number | — | A millisecond delay amount before hiding the Overlay once triggered. |
|
|
449
|
-
| textAlignment | String | center | Defines the position of the text content. Possible values are: left, right, center |
|
|
450
|
-
| width | String | — | Defines the width of the tooltip. Possible values are: auto, 100, 150, 200, 250, 300, 350, 400, 450, 500 |
|
|
451
|
-
| className | String | — | Additional classes to be set on the wrapper element. |
|
|
452
|
-
| innerClassName | String | — | Additional classes to be set on the inner element. |
|
|
453
|
-
| popperConfig | Object | — | A Popper.js config object passed to the the underlying popper instance. |
|
|
454
|
-
| children | Node | — | The target node. |
|
|
424
|
+
#### Props (json)
|
|
425
|
+
|
|
426
|
+
```json
|
|
427
|
+
{
|
|
428
|
+
show: 1_000,
|
|
429
|
+
delay: 500,
|
|
430
|
+
}
|
|
431
|
+
```
|