@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:* Interaction
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/editableContent
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:18.154Z
|
|
7
7
|
|
|
8
8
|
The EditableContent component allows for inline editing text or other values. To make sure the user can recognize such an element, it's best to mark the text or content with a dotted line depending on the situation and where it is placed. Alternatively, you can place the "pencil" icon next to the content. Especially on mobile where no hover is available, the editable content must be marked permanently.
|
|
9
9
|
|
|
@@ -60,6 +60,29 @@ export default () => {
|
|
|
60
60
|
</span>
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
+
#### Props
|
|
64
|
+
|
|
65
|
+
| Name | Type | Default | Description |
|
|
66
|
+
| --- | --- | --- | --- |
|
|
67
|
+
| show | boolean | undefined | Visibility flag used to control edit mode from outside. |
|
|
68
|
+
| onSave | (value: string) => void | — | Callback function triggered when the save button is clicked. |
|
|
69
|
+
| onCancel | VoidFunction | — | Callback function triggered when the cancel button is clicked. |
|
|
70
|
+
| onFocus | VoidFunction | — | Callback function triggered when the input gets focused. |
|
|
71
|
+
| onBlur | VoidFunction | — | Callback function triggered when input looses it's focus. |
|
|
72
|
+
| onEditMode | VoidFunction | — | Callback function triggered when entering the edit mode. |
|
|
73
|
+
| onSaveValidation | (value: string) => boolean | — | Validation function to intercept saving and prevent save on error. |
|
|
74
|
+
| isValid | boolean | true | Controls the error message visibility from outside. This is useful when using a custom input where the validation happens outside of this component. |
|
|
75
|
+
| errorMessage | React.ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
76
|
+
| customEditor | React.ReactNode | — | Use this prop to define a custom editor input component like Select, NumberInput, TimePicker or DatePicker. Handling input state changes of a custom editor need to be handled outside of this component. By default the EditableContent uses a built-in textarea to allow resizing for larger text. |
|
|
77
|
+
| editorOffsetTop | number | 0 | Offset value to control the vertical position for the editor in case the text element has borders, spacings different text sizes. |
|
|
78
|
+
| editorOffsetLeft | number | 0 | Offset value to control the horizontal position for the editor in case the text element has borders, spacings different text sizes. |
|
|
79
|
+
| size | 'md' \| 'lg' | 'md' | Defines the input and button size. Use 'lg' for headlines. |
|
|
80
|
+
| allowResize | boolean | false | Defines if the internal textarea is allowed to resize vertically. This comes in handy for larger text and when using multiple input rows. |
|
|
81
|
+
| inputRows | number | 1 | Defines the number of rows to use by the internal textarea component. When a single line is used, the input is saved on "enter" key. |
|
|
82
|
+
| inputClassName | string | — | Additional classes to be set on the editor input itself. |
|
|
83
|
+
| editorClassName | string | — | Additional classes to be set on the editor wrapper element. |
|
|
84
|
+
| className | string | — | Additional classes to be set on the text wrapper element. |
|
|
85
|
+
|
|
63
86
|
### Example: Headline that can change
|
|
64
87
|
|
|
65
88
|
Editable headline - like dialog or panel header
|
|
@@ -135,6 +158,29 @@ export default () => {
|
|
|
135
158
|
</div>
|
|
136
159
|
```
|
|
137
160
|
|
|
161
|
+
#### Props
|
|
162
|
+
|
|
163
|
+
| Name | Type | Default | Description |
|
|
164
|
+
| --- | --- | --- | --- |
|
|
165
|
+
| show | boolean | undefined | Visibility flag used to control edit mode from outside. |
|
|
166
|
+
| onSave | (value: string) => void | — | Callback function triggered when the save button is clicked. |
|
|
167
|
+
| onCancel | VoidFunction | — | Callback function triggered when the cancel button is clicked. |
|
|
168
|
+
| onFocus | VoidFunction | — | Callback function triggered when the input gets focused. |
|
|
169
|
+
| onBlur | VoidFunction | — | Callback function triggered when input looses it's focus. |
|
|
170
|
+
| onEditMode | VoidFunction | — | Callback function triggered when entering the edit mode. |
|
|
171
|
+
| onSaveValidation | (value: string) => boolean | — | Validation function to intercept saving and prevent save on error. |
|
|
172
|
+
| isValid | boolean | true | Controls the error message visibility from outside. This is useful when using a custom input where the validation happens outside of this component. |
|
|
173
|
+
| errorMessage | React.ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
174
|
+
| customEditor | React.ReactNode | — | Use this prop to define a custom editor input component like Select, NumberInput, TimePicker or DatePicker. Handling input state changes of a custom editor need to be handled outside of this component. By default the EditableContent uses a built-in textarea to allow resizing for larger text. |
|
|
175
|
+
| editorOffsetTop | number | 0 | Offset value to control the vertical position for the editor in case the text element has borders, spacings different text sizes. |
|
|
176
|
+
| editorOffsetLeft | number | 0 | Offset value to control the horizontal position for the editor in case the text element has borders, spacings different text sizes. |
|
|
177
|
+
| size | 'md' \| 'lg' | 'md' | Defines the input and button size. Use 'lg' for headlines. |
|
|
178
|
+
| allowResize | boolean | false | Defines if the internal textarea is allowed to resize vertically. This comes in handy for larger text and when using multiple input rows. |
|
|
179
|
+
| inputRows | number | 1 | Defines the number of rows to use by the internal textarea component. When a single line is used, the input is saved on "enter" key. |
|
|
180
|
+
| inputClassName | string | — | Additional classes to be set on the editor input itself. |
|
|
181
|
+
| editorClassName | string | — | Additional classes to be set on the editor wrapper element. |
|
|
182
|
+
| className | string | — | Additional classes to be set on the text wrapper element. |
|
|
183
|
+
|
|
138
184
|
### Example: Example 3
|
|
139
185
|
|
|
140
186
|
Editable content using a resizable textarea
|
|
@@ -198,6 +244,29 @@ export default () => {
|
|
|
198
244
|
</div>
|
|
199
245
|
```
|
|
200
246
|
|
|
247
|
+
#### Props
|
|
248
|
+
|
|
249
|
+
| Name | Type | Default | Description |
|
|
250
|
+
| --- | --- | --- | --- |
|
|
251
|
+
| show | boolean | undefined | Visibility flag used to control edit mode from outside. |
|
|
252
|
+
| onSave | (value: string) => void | — | Callback function triggered when the save button is clicked. |
|
|
253
|
+
| onCancel | VoidFunction | — | Callback function triggered when the cancel button is clicked. |
|
|
254
|
+
| onFocus | VoidFunction | — | Callback function triggered when the input gets focused. |
|
|
255
|
+
| onBlur | VoidFunction | — | Callback function triggered when input looses it's focus. |
|
|
256
|
+
| onEditMode | VoidFunction | — | Callback function triggered when entering the edit mode. |
|
|
257
|
+
| onSaveValidation | (value: string) => boolean | — | Validation function to intercept saving and prevent save on error. |
|
|
258
|
+
| isValid | boolean | true | Controls the error message visibility from outside. This is useful when using a custom input where the validation happens outside of this component. |
|
|
259
|
+
| errorMessage | React.ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
260
|
+
| customEditor | React.ReactNode | — | Use this prop to define a custom editor input component like Select, NumberInput, TimePicker or DatePicker. Handling input state changes of a custom editor need to be handled outside of this component. By default the EditableContent uses a built-in textarea to allow resizing for larger text. |
|
|
261
|
+
| editorOffsetTop | number | 0 | Offset value to control the vertical position for the editor in case the text element has borders, spacings different text sizes. |
|
|
262
|
+
| editorOffsetLeft | number | 0 | Offset value to control the horizontal position for the editor in case the text element has borders, spacings different text sizes. |
|
|
263
|
+
| size | 'md' \| 'lg' | 'md' | Defines the input and button size. Use 'lg' for headlines. |
|
|
264
|
+
| allowResize | boolean | false | Defines if the internal textarea is allowed to resize vertically. This comes in handy for larger text and when using multiple input rows. |
|
|
265
|
+
| inputRows | number | 1 | Defines the number of rows to use by the internal textarea component. When a single line is used, the input is saved on "enter" key. |
|
|
266
|
+
| inputClassName | string | — | Additional classes to be set on the editor input itself. |
|
|
267
|
+
| editorClassName | string | — | Additional classes to be set on the editor wrapper element. |
|
|
268
|
+
| className | string | — | Additional classes to be set on the text wrapper element. |
|
|
269
|
+
|
|
201
270
|
### Example: Example 4
|
|
202
271
|
|
|
203
272
|
Focusable editable content with input validationThis content must not contain numbers.
|
|
@@ -275,6 +344,29 @@ export default () => {
|
|
|
275
344
|
</div>
|
|
276
345
|
```
|
|
277
346
|
|
|
347
|
+
#### Props
|
|
348
|
+
|
|
349
|
+
| Name | Type | Default | Description |
|
|
350
|
+
| --- | --- | --- | --- |
|
|
351
|
+
| show | boolean | undefined | Visibility flag used to control edit mode from outside. |
|
|
352
|
+
| onSave | (value: string) => void | — | Callback function triggered when the save button is clicked. |
|
|
353
|
+
| onCancel | VoidFunction | — | Callback function triggered when the cancel button is clicked. |
|
|
354
|
+
| onFocus | VoidFunction | — | Callback function triggered when the input gets focused. |
|
|
355
|
+
| onBlur | VoidFunction | — | Callback function triggered when input looses it's focus. |
|
|
356
|
+
| onEditMode | VoidFunction | — | Callback function triggered when entering the edit mode. |
|
|
357
|
+
| onSaveValidation | (value: string) => boolean | — | Validation function to intercept saving and prevent save on error. |
|
|
358
|
+
| isValid | boolean | true | Controls the error message visibility from outside. This is useful when using a custom input where the validation happens outside of this component. |
|
|
359
|
+
| errorMessage | React.ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
360
|
+
| customEditor | React.ReactNode | — | Use this prop to define a custom editor input component like Select, NumberInput, TimePicker or DatePicker. Handling input state changes of a custom editor need to be handled outside of this component. By default the EditableContent uses a built-in textarea to allow resizing for larger text. |
|
|
361
|
+
| editorOffsetTop | number | 0 | Offset value to control the vertical position for the editor in case the text element has borders, spacings different text sizes. |
|
|
362
|
+
| editorOffsetLeft | number | 0 | Offset value to control the horizontal position for the editor in case the text element has borders, spacings different text sizes. |
|
|
363
|
+
| size | 'md' \| 'lg' | 'md' | Defines the input and button size. Use 'lg' for headlines. |
|
|
364
|
+
| allowResize | boolean | false | Defines if the internal textarea is allowed to resize vertically. This comes in handy for larger text and when using multiple input rows. |
|
|
365
|
+
| inputRows | number | 1 | Defines the number of rows to use by the internal textarea component. When a single line is used, the input is saved on "enter" key. |
|
|
366
|
+
| inputClassName | string | — | Additional classes to be set on the editor input itself. |
|
|
367
|
+
| editorClassName | string | — | Additional classes to be set on the editor wrapper element. |
|
|
368
|
+
| className | string | — | Additional classes to be set on the text wrapper element. |
|
|
369
|
+
|
|
278
370
|
### Example: Example 5
|
|
279
371
|
|
|
280
372
|
Editable text inside of another textLorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis. Vivamus elementum ante et est sagittis semper. This text can be edited Ut consectetur enim nec tortor scelerisque tincidunt. Fusce ac ligula bibendum, rutrum libero quis, viverra sem. Interdum et malesuada fames ac ante ipsum primis in faucibus. Duis ut hendrerit massa, in molestie elit. Sed vitae orci ac purus volutpat posuere ac ut neque. Mauris ante orci, semper finibus lorem in, fringilla pretium velit.`;
|
|
@@ -326,6 +418,29 @@ export default () => {
|
|
|
326
418
|
</span> Ut consectetur enim nec tortor scelerisque tincidunt. Fusce ac ligula bibendum, rutrum libero quis, viverra sem. Interdum et malesuada fames ac ante ipsum primis in faucibus. Duis ut hendrerit massa, in molestie elit. Sed vitae orci ac purus volutpat posuere ac ut neque. Mauris ante orci, semper finibus lorem in, fringilla pretium velit.`;</p>
|
|
327
419
|
```
|
|
328
420
|
|
|
421
|
+
#### Props
|
|
422
|
+
|
|
423
|
+
| Name | Type | Default | Description |
|
|
424
|
+
| --- | --- | --- | --- |
|
|
425
|
+
| show | boolean | undefined | Visibility flag used to control edit mode from outside. |
|
|
426
|
+
| onSave | (value: string) => void | — | Callback function triggered when the save button is clicked. |
|
|
427
|
+
| onCancel | VoidFunction | — | Callback function triggered when the cancel button is clicked. |
|
|
428
|
+
| onFocus | VoidFunction | — | Callback function triggered when the input gets focused. |
|
|
429
|
+
| onBlur | VoidFunction | — | Callback function triggered when input looses it's focus. |
|
|
430
|
+
| onEditMode | VoidFunction | — | Callback function triggered when entering the edit mode. |
|
|
431
|
+
| onSaveValidation | (value: string) => boolean | — | Validation function to intercept saving and prevent save on error. |
|
|
432
|
+
| isValid | boolean | true | Controls the error message visibility from outside. This is useful when using a custom input where the validation happens outside of this component. |
|
|
433
|
+
| errorMessage | React.ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
434
|
+
| customEditor | React.ReactNode | — | Use this prop to define a custom editor input component like Select, NumberInput, TimePicker or DatePicker. Handling input state changes of a custom editor need to be handled outside of this component. By default the EditableContent uses a built-in textarea to allow resizing for larger text. |
|
|
435
|
+
| editorOffsetTop | number | 0 | Offset value to control the vertical position for the editor in case the text element has borders, spacings different text sizes. |
|
|
436
|
+
| editorOffsetLeft | number | 0 | Offset value to control the horizontal position for the editor in case the text element has borders, spacings different text sizes. |
|
|
437
|
+
| size | 'md' \| 'lg' | 'md' | Defines the input and button size. Use 'lg' for headlines. |
|
|
438
|
+
| allowResize | boolean | false | Defines if the internal textarea is allowed to resize vertically. This comes in handy for larger text and when using multiple input rows. |
|
|
439
|
+
| inputRows | number | 1 | Defines the number of rows to use by the internal textarea component. When a single line is used, the input is saved on "enter" key. |
|
|
440
|
+
| inputClassName | string | — | Additional classes to be set on the editor input itself. |
|
|
441
|
+
| editorClassName | string | — | Additional classes to be set on the editor wrapper element. |
|
|
442
|
+
| className | string | — | Additional classes to be set on the text wrapper element. |
|
|
443
|
+
|
|
329
444
|
### Example: Example 6
|
|
330
445
|
|
|
331
446
|
Render NumberControl as custom editor component
|
|
@@ -447,6 +562,29 @@ export default () => {
|
|
|
447
562
|
</div>
|
|
448
563
|
```
|
|
449
564
|
|
|
565
|
+
#### Props
|
|
566
|
+
|
|
567
|
+
| Name | Type | Default | Description |
|
|
568
|
+
| --- | --- | --- | --- |
|
|
569
|
+
| show | boolean | undefined | Visibility flag used to control edit mode from outside. |
|
|
570
|
+
| onSave | (value: string) => void | — | Callback function triggered when the save button is clicked. |
|
|
571
|
+
| onCancel | VoidFunction | — | Callback function triggered when the cancel button is clicked. |
|
|
572
|
+
| onFocus | VoidFunction | — | Callback function triggered when the input gets focused. |
|
|
573
|
+
| onBlur | VoidFunction | — | Callback function triggered when input looses it's focus. |
|
|
574
|
+
| onEditMode | VoidFunction | — | Callback function triggered when entering the edit mode. |
|
|
575
|
+
| onSaveValidation | (value: string) => boolean | — | Validation function to intercept saving and prevent save on error. |
|
|
576
|
+
| isValid | boolean | true | Controls the error message visibility from outside. This is useful when using a custom input where the validation happens outside of this component. |
|
|
577
|
+
| errorMessage | React.ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
578
|
+
| customEditor | React.ReactNode | — | Use this prop to define a custom editor input component like Select, NumberInput, TimePicker or DatePicker. Handling input state changes of a custom editor need to be handled outside of this component. By default the EditableContent uses a built-in textarea to allow resizing for larger text. |
|
|
579
|
+
| editorOffsetTop | number | 0 | Offset value to control the vertical position for the editor in case the text element has borders, spacings different text sizes. |
|
|
580
|
+
| editorOffsetLeft | number | 0 | Offset value to control the horizontal position for the editor in case the text element has borders, spacings different text sizes. |
|
|
581
|
+
| size | 'md' \| 'lg' | 'md' | Defines the input and button size. Use 'lg' for headlines. |
|
|
582
|
+
| allowResize | boolean | false | Defines if the internal textarea is allowed to resize vertically. This comes in handy for larger text and when using multiple input rows. |
|
|
583
|
+
| inputRows | number | 1 | Defines the number of rows to use by the internal textarea component. When a single line is used, the input is saved on "enter" key. |
|
|
584
|
+
| inputClassName | string | — | Additional classes to be set on the editor input itself. |
|
|
585
|
+
| editorClassName | string | — | Additional classes to be set on the editor wrapper element. |
|
|
586
|
+
| className | string | — | Additional classes to be set on the text wrapper element. |
|
|
587
|
+
|
|
450
588
|
### Example: Example 7
|
|
451
589
|
|
|
452
590
|
Render NumberInput as custom editor component with input validation
|
|
@@ -569,6 +707,29 @@ export default () => {
|
|
|
569
707
|
</div>
|
|
570
708
|
```
|
|
571
709
|
|
|
710
|
+
#### Props
|
|
711
|
+
|
|
712
|
+
| Name | Type | Default | Description |
|
|
713
|
+
| --- | --- | --- | --- |
|
|
714
|
+
| show | boolean | undefined | Visibility flag used to control edit mode from outside. |
|
|
715
|
+
| onSave | (value: string) => void | — | Callback function triggered when the save button is clicked. |
|
|
716
|
+
| onCancel | VoidFunction | — | Callback function triggered when the cancel button is clicked. |
|
|
717
|
+
| onFocus | VoidFunction | — | Callback function triggered when the input gets focused. |
|
|
718
|
+
| onBlur | VoidFunction | — | Callback function triggered when input looses it's focus. |
|
|
719
|
+
| onEditMode | VoidFunction | — | Callback function triggered when entering the edit mode. |
|
|
720
|
+
| onSaveValidation | (value: string) => boolean | — | Validation function to intercept saving and prevent save on error. |
|
|
721
|
+
| isValid | boolean | true | Controls the error message visibility from outside. This is useful when using a custom input where the validation happens outside of this component. |
|
|
722
|
+
| errorMessage | React.ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
723
|
+
| customEditor | React.ReactNode | — | Use this prop to define a custom editor input component like Select, NumberInput, TimePicker or DatePicker. Handling input state changes of a custom editor need to be handled outside of this component. By default the EditableContent uses a built-in textarea to allow resizing for larger text. |
|
|
724
|
+
| editorOffsetTop | number | 0 | Offset value to control the vertical position for the editor in case the text element has borders, spacings different text sizes. |
|
|
725
|
+
| editorOffsetLeft | number | 0 | Offset value to control the horizontal position for the editor in case the text element has borders, spacings different text sizes. |
|
|
726
|
+
| size | 'md' \| 'lg' | 'md' | Defines the input and button size. Use 'lg' for headlines. |
|
|
727
|
+
| allowResize | boolean | false | Defines if the internal textarea is allowed to resize vertically. This comes in handy for larger text and when using multiple input rows. |
|
|
728
|
+
| inputRows | number | 1 | Defines the number of rows to use by the internal textarea component. When a single line is used, the input is saved on "enter" key. |
|
|
729
|
+
| inputClassName | string | — | Additional classes to be set on the editor input itself. |
|
|
730
|
+
| editorClassName | string | — | Additional classes to be set on the editor wrapper element. |
|
|
731
|
+
| className | string | — | Additional classes to be set on the text wrapper element. |
|
|
732
|
+
|
|
572
733
|
## Usage guidelines
|
|
573
734
|
|
|
574
735
|
### Example: Example 8
|
|
@@ -940,4 +1101,27 @@ export default () => {
|
|
|
940
1101
|
<div class="width-100pct children-first-margin-top-0 children-last-margin-bottom-0 padding-top-1">In general, don't make every cell in a table editable. The indication style would be too repetitive and the user does not expect this behavior as it is not implemented in other services like so. Strive for a common look and feel with regards to other services.</div>
|
|
941
1102
|
</div>
|
|
942
1103
|
</b>
|
|
943
|
-
```
|
|
1104
|
+
```
|
|
1105
|
+
|
|
1106
|
+
#### Props
|
|
1107
|
+
|
|
1108
|
+
| Name | Type | Default | Description |
|
|
1109
|
+
| --- | --- | --- | --- |
|
|
1110
|
+
| show | boolean | undefined | Visibility flag used to control edit mode from outside. |
|
|
1111
|
+
| onSave | (value: string) => void | — | Callback function triggered when the save button is clicked. |
|
|
1112
|
+
| onCancel | VoidFunction | — | Callback function triggered when the cancel button is clicked. |
|
|
1113
|
+
| onFocus | VoidFunction | — | Callback function triggered when the input gets focused. |
|
|
1114
|
+
| onBlur | VoidFunction | — | Callback function triggered when input looses it's focus. |
|
|
1115
|
+
| onEditMode | VoidFunction | — | Callback function triggered when entering the edit mode. |
|
|
1116
|
+
| onSaveValidation | (value: string) => boolean | — | Validation function to intercept saving and prevent save on error. |
|
|
1117
|
+
| isValid | boolean | true | Controls the error message visibility from outside. This is useful when using a custom input where the validation happens outside of this component. |
|
|
1118
|
+
| errorMessage | React.ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
1119
|
+
| customEditor | React.ReactNode | — | Use this prop to define a custom editor input component like Select, NumberInput, TimePicker or DatePicker. Handling input state changes of a custom editor need to be handled outside of this component. By default the EditableContent uses a built-in textarea to allow resizing for larger text. |
|
|
1120
|
+
| editorOffsetTop | number | 0 | Offset value to control the vertical position for the editor in case the text element has borders, spacings different text sizes. |
|
|
1121
|
+
| editorOffsetLeft | number | 0 | Offset value to control the horizontal position for the editor in case the text element has borders, spacings different text sizes. |
|
|
1122
|
+
| size | 'md' \| 'lg' | 'md' | Defines the input and button size. Use 'lg' for headlines. |
|
|
1123
|
+
| allowResize | boolean | false | Defines if the internal textarea is allowed to resize vertically. This comes in handy for larger text and when using multiple input rows. |
|
|
1124
|
+
| inputRows | number | 1 | Defines the number of rows to use by the internal textarea component. When a single line is used, the input is saved on "enter" key. |
|
|
1125
|
+
| inputClassName | string | — | Additional classes to be set on the editor input itself. |
|
|
1126
|
+
| editorClassName | string | — | Additional classes to be set on the editor wrapper element. |
|
|
1127
|
+
| className | string | — | Additional classes to be set on the text wrapper element. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Show/Hide
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/expander
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:24.384Z
|
|
7
7
|
|
|
8
8
|
A simple panel component where the "panel-body" can be expanded.
|
|
9
9
|
|
|
@@ -117,7 +117,21 @@ export default () => {
|
|
|
117
117
|
|
|
118
118
|
| Name | Type | Default | Description |
|
|
119
119
|
| --- | --- | --- | --- |
|
|
120
|
-
|
|
|
120
|
+
| title | string \| React.ReactNode | — | The title to be shown in the expander header. |
|
|
121
|
+
| bsStyle | 'blank' \| 'default' \| 'separator' \| 'primary' \| 'secondary' \| 'info' \| 'warning' \| 'danger' \| 'success' | 'blank' | Component visual or contextual style variants. |
|
|
122
|
+
| iconLeft | boolean | false | Defines if the icon will be align left, otherwise it is aligned right. |
|
|
123
|
+
| open | boolean | false | Defines if the panel will be opened or closed by default. The open/closed state will be handled internally. |
|
|
124
|
+
| unmountOnExit | boolean | true | It unmounts the body component (remove it from the DOM) when it is collapsed. Set it to false to avoid the unmount. |
|
|
125
|
+
| onToggle | (isOpen: boolean) => void | — | Callback function for when the header is clicked and the expander toggles. |
|
|
126
|
+
| onEntered | VoidFunction | — | Callback fired after the component has expanded. |
|
|
127
|
+
| onExited | VoidFunction | — | Callback fired after the component has collapsed. |
|
|
128
|
+
| onAnimationStart | VoidFunction | — | Callback fired when the animation starts for either expand or collapse. |
|
|
129
|
+
| headerClassName | string | — | Additional classes to be set on the panel header. |
|
|
130
|
+
| titleClassName | string | — | Additional classes to be set on the header title. |
|
|
131
|
+
| bodyClassName | string | — | Additional classes to be set on the panel body. |
|
|
132
|
+
| iconClassName | string | — | Additional classes added to the chevron icon |
|
|
133
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
134
|
+
| children | React.ReactNode \| ((isOpen: boolean) => React.ReactNode \| JSX.Element) | — | Any element to be rendered inside the panel body. Providing a function enables the render prop approach. See https://reactjs.org/docs/render-props.html The function gets the isOpen state passed and is responsible for rendering the custom content. |
|
|
121
135
|
|
|
122
136
|
### Example: Default
|
|
123
137
|
|
|
@@ -641,7 +655,21 @@ const DynamicContent = () => {
|
|
|
641
655
|
|
|
642
656
|
| Name | Type | Default | Description |
|
|
643
657
|
| --- | --- | --- | --- |
|
|
644
|
-
|
|
|
658
|
+
| title | string \| React.ReactNode | — | The title to be shown in the expander header. |
|
|
659
|
+
| bsStyle | 'blank' \| 'default' \| 'separator' \| 'primary' \| 'secondary' \| 'info' \| 'warning' \| 'danger' \| 'success' | 'blank' | Component visual or contextual style variants. |
|
|
660
|
+
| iconLeft | boolean | false | Defines if the icon will be align left, otherwise it is aligned right. |
|
|
661
|
+
| open | boolean | false | Defines if the panel will be opened or closed by default. The open/closed state will be handled internally. |
|
|
662
|
+
| unmountOnExit | boolean | true | It unmounts the body component (remove it from the DOM) when it is collapsed. Set it to false to avoid the unmount. |
|
|
663
|
+
| onToggle | (isOpen: boolean) => void | — | Callback function for when the header is clicked and the expander toggles. |
|
|
664
|
+
| onEntered | VoidFunction | — | Callback fired after the component has expanded. |
|
|
665
|
+
| onExited | VoidFunction | — | Callback fired after the component has collapsed. |
|
|
666
|
+
| onAnimationStart | VoidFunction | — | Callback fired when the animation starts for either expand or collapse. |
|
|
667
|
+
| headerClassName | string | — | Additional classes to be set on the panel header. |
|
|
668
|
+
| titleClassName | string | — | Additional classes to be set on the header title. |
|
|
669
|
+
| bodyClassName | string | — | Additional classes to be set on the panel body. |
|
|
670
|
+
| iconClassName | string | — | Additional classes added to the chevron icon |
|
|
671
|
+
| className | string | — | Additional classes to be set on the wrapper element. |
|
|
672
|
+
| children | React.ReactNode \| ((isOpen: boolean) => React.ReactNode \| JSX.Element) | — | Any element to be rendered inside the panel body. Providing a function enables the render prop approach. See https://reactjs.org/docs/render-props.html The function gets the isOpen state passed and is responsible for rendering the custom content. |
|
|
645
673
|
|
|
646
674
|
## ExpanderList
|
|
647
675
|
|
|
@@ -920,4 +948,23 @@ export default () => {
|
|
|
920
948
|
</ul>
|
|
921
949
|
<button type="button" class="btn btn-default btn-component" tabindex="0">Toggle first</button>
|
|
922
950
|
</div>
|
|
923
|
-
```
|
|
951
|
+
```
|
|
952
|
+
|
|
953
|
+
#### Props
|
|
954
|
+
|
|
955
|
+
| Name | Type | Default | Description |
|
|
956
|
+
| --- | --- | --- | --- |
|
|
957
|
+
| items | ExpanderListItem[] | — | List of items to be rendered. The expanded state can be defined via the items open prop. |
|
|
958
|
+
| └id | string \| number | — | The "id" property is used to know which item is expanded. It will also be used to control the component from the outside. It can be a number or a string. If there is no "id" provided, a unique id is internally generated which will be used internally for the uncontrolled case.' |
|
|
959
|
+
| └header | string \| React.ReactNode | — | The header content. |
|
|
960
|
+
| └body | string \| React.ReactNode | — | The body content. If there is no "body" provided, the list item is not expandable. |
|
|
961
|
+
| └open | boolean | — | Defines if the item will be expanded or closed by default. |
|
|
962
|
+
| └onOpen | VoidFunction | — | Callback fired when item toggles to open after a click. |
|
|
963
|
+
| └onClose | VoidFunction | — | Callback fired when item toggles to close after a click. |
|
|
964
|
+
| └headerClassName | string | — | Additional classes to be set on "expander-list-header" node. |
|
|
965
|
+
| └bodyClassName | string | — | Additional classes to be set on "expander-list-body" node. |
|
|
966
|
+
| └className | string | — | Additional classes to be set on list item node. |
|
|
967
|
+
| rounded | boolean | true | Defines whether the "expander-list-body" is rounded or not. |
|
|
968
|
+
| bordered | boolean | true | Defines whether the "expander-list-body" has a border or not. |
|
|
969
|
+
| unmountOnExit | boolean | true | It unmounts the body component (remove it from the DOM) when it is collapsed. Set it to false to avoid the unmount. |
|
|
970
|
+
| className | string | — | Additional classes to be set on the unordered list itself. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Show/Hide
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/fade
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:26.307Z
|
|
7
7
|
|
|
8
8
|
The Fade component fades in and out content with a given animation style.
|
|
9
9
|
|
|
@@ -148,7 +148,14 @@ export default () => {
|
|
|
148
148
|
|
|
149
149
|
| Name | Type | Default | Description |
|
|
150
150
|
| --- | --- | --- | --- |
|
|
151
|
-
|
|
|
151
|
+
| show | boolean | true | Defines whether to show the content. |
|
|
152
|
+
| duration | number | 0.2 | Duration of the fade animation in seconds. |
|
|
153
|
+
| initial | boolean | false | Defines whether the animation is triggered initially when showing the content. |
|
|
154
|
+
| animationStyle | 'fade' \| 'tabs' \| 'page' \| 'pageBack' \| 'fromLeft' \| 'fromRight' \| 'fromTop' \| 'fromBottom' | 'fade' | Defines the desired animation style. Possible values are: - fade - tabs - page - pageBack - fromLeft - fromRight - fromTop - fromBottom |
|
|
155
|
+
| exitBeforeEnter | boolean | false | If set to true, only one component will be rendered at a time. The exiting component will finish its exit animation before the entering component is rendered. |
|
|
156
|
+
| onExitComplete | VoidFunction | () => {} | Fires when all exiting nodes have completed animating out. |
|
|
157
|
+
| animatePresenceProps | object | — | Additional custom props for the underlying Framer motion AnimatePresence component. Use this for additional customizations. |
|
|
158
|
+
| motionProps | object | — | Additional custom props for the underlying Framer motion <motion.div> component. Use this for additional customizations. |
|
|
152
159
|
|
|
153
160
|
### Example: Example 2
|
|
154
161
|
|
|
@@ -256,7 +263,14 @@ const ContentTab2 = () => (
|
|
|
256
263
|
|
|
257
264
|
| Name | Type | Default | Description |
|
|
258
265
|
| --- | --- | --- | --- |
|
|
259
|
-
|
|
|
266
|
+
| show | boolean | true | Defines whether to show the content. |
|
|
267
|
+
| duration | number | 0.2 | Duration of the fade animation in seconds. |
|
|
268
|
+
| initial | boolean | false | Defines whether the animation is triggered initially when showing the content. |
|
|
269
|
+
| animationStyle | 'fade' \| 'tabs' \| 'page' \| 'pageBack' \| 'fromLeft' \| 'fromRight' \| 'fromTop' \| 'fromBottom' | 'fade' | Defines the desired animation style. Possible values are: - fade - tabs - page - pageBack - fromLeft - fromRight - fromTop - fromBottom |
|
|
270
|
+
| exitBeforeEnter | boolean | false | If set to true, only one component will be rendered at a time. The exiting component will finish its exit animation before the entering component is rendered. |
|
|
271
|
+
| onExitComplete | VoidFunction | () => {} | Fires when all exiting nodes have completed animating out. |
|
|
272
|
+
| animatePresenceProps | object | — | Additional custom props for the underlying Framer motion AnimatePresence component. Use this for additional customizations. |
|
|
273
|
+
| motionProps | object | — | Additional custom props for the underlying Framer motion <motion.div> component. Use this for additional customizations. |
|
|
260
274
|
|
|
261
275
|
### Example: Example 3
|
|
262
276
|
|
|
@@ -378,7 +392,14 @@ const ContentTab2 = () => (
|
|
|
378
392
|
|
|
379
393
|
| Name | Type | Default | Description |
|
|
380
394
|
| --- | --- | --- | --- |
|
|
381
|
-
|
|
|
395
|
+
| show | boolean | true | Defines whether to show the content. |
|
|
396
|
+
| duration | number | 0.2 | Duration of the fade animation in seconds. |
|
|
397
|
+
| initial | boolean | false | Defines whether the animation is triggered initially when showing the content. |
|
|
398
|
+
| animationStyle | 'fade' \| 'tabs' \| 'page' \| 'pageBack' \| 'fromLeft' \| 'fromRight' \| 'fromTop' \| 'fromBottom' | 'fade' | Defines the desired animation style. Possible values are: - fade - tabs - page - pageBack - fromLeft - fromRight - fromTop - fromBottom |
|
|
399
|
+
| exitBeforeEnter | boolean | false | If set to true, only one component will be rendered at a time. The exiting component will finish its exit animation before the entering component is rendered. |
|
|
400
|
+
| onExitComplete | VoidFunction | () => {} | Fires when all exiting nodes have completed animating out. |
|
|
401
|
+
| animatePresenceProps | object | — | Additional custom props for the underlying Framer motion AnimatePresence component. Use this for additional customizations. |
|
|
402
|
+
| motionProps | object | — | Additional custom props for the underlying Framer motion <motion.div> component. Use this for additional customizations. |
|
|
382
403
|
|
|
383
404
|
### Example: Example 4
|
|
384
405
|
|
|
@@ -549,7 +570,14 @@ const Content3 = () => (
|
|
|
549
570
|
|
|
550
571
|
| Name | Type | Default | Description |
|
|
551
572
|
| --- | --- | --- | --- |
|
|
552
|
-
|
|
|
573
|
+
| show | boolean | true | Defines whether to show the content. |
|
|
574
|
+
| duration | number | 0.2 | Duration of the fade animation in seconds. |
|
|
575
|
+
| initial | boolean | false | Defines whether the animation is triggered initially when showing the content. |
|
|
576
|
+
| animationStyle | 'fade' \| 'tabs' \| 'page' \| 'pageBack' \| 'fromLeft' \| 'fromRight' \| 'fromTop' \| 'fromBottom' | 'fade' | Defines the desired animation style. Possible values are: - fade - tabs - page - pageBack - fromLeft - fromRight - fromTop - fromBottom |
|
|
577
|
+
| exitBeforeEnter | boolean | false | If set to true, only one component will be rendered at a time. The exiting component will finish its exit animation before the entering component is rendered. |
|
|
578
|
+
| onExitComplete | VoidFunction | () => {} | Fires when all exiting nodes have completed animating out. |
|
|
579
|
+
| animatePresenceProps | object | — | Additional custom props for the underlying Framer motion AnimatePresence component. Use this for additional customizations. |
|
|
580
|
+
| motionProps | object | — | Additional custom props for the underlying Framer motion <motion.div> component. Use this for additional customizations. |
|
|
553
581
|
|
|
554
582
|
### Example: Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod
|
|
555
583
|
|
|
@@ -798,4 +826,11 @@ const ItemDetails = ({ title = '', onBack }: { title: string | undefined; onBack
|
|
|
798
826
|
|
|
799
827
|
| Name | Type | Default | Description |
|
|
800
828
|
| --- | --- | --- | --- |
|
|
801
|
-
|
|
|
829
|
+
| show | boolean | true | Defines whether to show the content. |
|
|
830
|
+
| duration | number | 0.2 | Duration of the fade animation in seconds. |
|
|
831
|
+
| initial | boolean | false | Defines whether the animation is triggered initially when showing the content. |
|
|
832
|
+
| animationStyle | 'fade' \| 'tabs' \| 'page' \| 'pageBack' \| 'fromLeft' \| 'fromRight' \| 'fromTop' \| 'fromBottom' | 'fade' | Defines the desired animation style. Possible values are: - fade - tabs - page - pageBack - fromLeft - fromRight - fromTop - fromBottom |
|
|
833
|
+
| exitBeforeEnter | boolean | false | If set to true, only one component will be rendered at a time. The exiting component will finish its exit animation before the entering component is rendered. |
|
|
834
|
+
| onExitComplete | VoidFunction | () => {} | Fires when all exiting nodes have completed animating out. |
|
|
835
|
+
| animatePresenceProps | object | — | Additional custom props for the underlying Framer motion AnimatePresence component. Use this for additional customizations. |
|
|
836
|
+
| motionProps | object | — | Additional custom props for the underlying Framer motion <motion.div> component. Use this for additional customizations. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Show/Hide
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/fadeExpander
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:24.408Z
|
|
7
7
|
|
|
8
8
|
The FadeExpander component fades in and expands when the content.
|
|
9
9
|
|
|
@@ -168,4 +168,13 @@ export default () => {
|
|
|
168
168
|
</div>
|
|
169
169
|
</div>
|
|
170
170
|
</div>
|
|
171
|
-
```
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
#### Props
|
|
174
|
+
|
|
175
|
+
| Name | Type | Default | Description |
|
|
176
|
+
| --- | --- | --- | --- |
|
|
177
|
+
| show | boolean | false | Defines if the content is shown or not. |
|
|
178
|
+
| duration | number | 0.2 | Allows customization of animation duration. |
|
|
179
|
+
| delay | number | 0 | Delay in seconds before starting the animation. |
|
|
180
|
+
| className | string | — | Additional classes set to the wrapper element. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Show/Hide
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/fadeUp
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:25.440Z
|
|
7
7
|
|
|
8
8
|
The FadeUp component fades in when the content appears on the screen. After it faded in, the element will stay on screen. This can be used in a scrolling scenario where elements should fade up when they scroll into view. Using the delay helps to stagger the animation.
|
|
9
9
|
|
|
@@ -279,6 +279,15 @@ export default () => {
|
|
|
279
279
|
</div>
|
|
280
280
|
```
|
|
281
281
|
|
|
282
|
+
#### Props
|
|
283
|
+
|
|
284
|
+
| Name | Type | Default | Description |
|
|
285
|
+
| --- | --- | --- | --- |
|
|
286
|
+
| delay | number | 0 | Defines the time the animation should wait until it starts. |
|
|
287
|
+
| duration | number | 0.4 | Defines the duration in seconds of the fade up animation. |
|
|
288
|
+
| offset | number | 15 | Defines the y offset from the bottom where the element starts to fade in. |
|
|
289
|
+
| className | string | — | Additional classes names added to the motion div wrapper. |
|
|
290
|
+
|
|
282
291
|
### Example: Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis.
|
|
283
292
|
|
|
284
293
|
Lorem ipsum dolor sit amet
|
|
@@ -347,7 +356,7 @@ export default () => {
|
|
|
347
356
|
<div class="" style="opacity: 1; transform: none;">
|
|
348
357
|
<h1 class="">Lorem ipsum dolor sit amet</h1>
|
|
349
358
|
</div>
|
|
350
|
-
<div class="" style="opacity: 0; transform: translateY(
|
|
359
|
+
<div class="" style="opacity: 0; transform: translateY(15px);">
|
|
351
360
|
<p class="text-color-dark">
|
|
352
361
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In pharetra dui eget massa efficitur aliquam condimentum in felis. Integer eget metus vel nunc efficitur iaculis.</p>
|
|
353
362
|
</div>
|
|
@@ -373,4 +382,13 @@ data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAwMCIgaGVpZ2h0PSI2NjYiIHhtbG5zPSJodH
|
|
|
373
382
|
</div>
|
|
374
383
|
</div>
|
|
375
384
|
</div>
|
|
376
|
-
```
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
#### Props
|
|
388
|
+
|
|
389
|
+
| Name | Type | Default | Description |
|
|
390
|
+
| --- | --- | --- | --- |
|
|
391
|
+
| delay | number | 0 | Defines the time the animation should wait until it starts. |
|
|
392
|
+
| duration | number | 0.4 | Defines the duration in seconds of the fade up animation. |
|
|
393
|
+
| offset | number | 15 | Defines the y offset from the bottom where the element starts to fade in. |
|
|
394
|
+
| className | string | — | Additional classes names added to the motion div wrapper. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Misc
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/feedback
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:05:00.092Z
|
|
7
7
|
|
|
8
8
|
## FeedbackRating
|
|
9
9
|
|
|
@@ -287,6 +287,22 @@ export default () => {
|
|
|
287
287
|
</div>
|
|
288
288
|
```
|
|
289
289
|
|
|
290
|
+
#### Props
|
|
291
|
+
|
|
292
|
+
| Name | Type | Default | Description |
|
|
293
|
+
| --- | --- | --- | --- |
|
|
294
|
+
| headline | React.ReactNode | — | Optional headline |
|
|
295
|
+
| count | number | 1 | The amount of toggle buttons used to rate. |
|
|
296
|
+
| circleButtons | boolean | false | Defines whether the buttons are round. |
|
|
297
|
+
| buttonClassName | string | — | Optional class names applied to all the buttons. If you need more control on styling individual buttons, see buttonStyles. |
|
|
298
|
+
| buttonLabels | React.ReactNode[] | — | Array of button labels that will be used instead of the index. There needs to be a label for each button defined. |
|
|
299
|
+
| buttonStyles | { bsSize?: BUTTON_SIZE; bsStyle?: BUTTON_STYLE; variant?: BUTTON_VARIANT; className?: string; }[] | — | Array of button styles to individually define the button size, style and variant. There needs to be a item for each button defined. |
|
|
300
|
+
| leftLabel | React.ReactNode | — | Left aligned label to name the lowest rating option. |
|
|
301
|
+
| rightLabel | React.ReactNode | — | Right aligned label to name the highest rating option. |
|
|
302
|
+
| leadingIcon | React.ReactNode | — | Additional icon placed in front of the rating buttons. |
|
|
303
|
+
| trailingIcon | React.ReactNode | — | Additional icon placed after the rating buttons. |
|
|
304
|
+
| onRatingChanged | (rating: number \| undefined) => void | — | Callback triggered when the rating changes. |
|
|
305
|
+
|
|
290
306
|
## FeedbackInlineButtons
|
|
291
307
|
|
|
292
308
|
### Example: Was this helpful?
|
|
@@ -513,6 +529,13 @@ const CustomInlineButton = (props: CustomInlineButtonProps) => {
|
|
|
513
529
|
</div>
|
|
514
530
|
```
|
|
515
531
|
|
|
532
|
+
#### Props
|
|
533
|
+
|
|
534
|
+
| Name | Type | Default | Description |
|
|
535
|
+
| --- | --- | --- | --- |
|
|
536
|
+
| headline | React.ReactNode | — | Optional headline inlined with the buttons. |
|
|
537
|
+
| buttons | React.ReactNode[] | — | List of buttons to be shown. |
|
|
538
|
+
|
|
516
539
|
## FeedbackReactions
|
|
517
540
|
|
|
518
541
|
### Example: Example 3
|
|
@@ -715,4 +738,22 @@ export default () => {
|
|
|
715
738
|
</div>
|
|
716
739
|
</div>
|
|
717
740
|
</div>
|
|
718
|
-
```
|
|
741
|
+
```
|
|
742
|
+
|
|
743
|
+
#### Props
|
|
744
|
+
|
|
745
|
+
| Name | Type | Default | Description |
|
|
746
|
+
| --- | --- | --- | --- |
|
|
747
|
+
| headline | React.ReactNode | — | Optional headline inlined with the buttons. |
|
|
748
|
+
| size | 'sm' \| 'md' | 'md' | Size of the reaction buttons. |
|
|
749
|
+
| labelPosition | 'right' \| 'bottom' | 'bottom' | Position of the reaction button labels. |
|
|
750
|
+
| labelUp | React.ReactNode | — | Label for the up button. |
|
|
751
|
+
| labelDown | React.ReactNode | — | Label for the down button. |
|
|
752
|
+
| colorFillUp | string | 'bg-lightest' | Custom fill color for the up button. |
|
|
753
|
+
| colorFillDown | string | 'bg-lightest' | Custom fill color for the down button. |
|
|
754
|
+
| colorHoverUp | string | 'primary' | Custom hover color for the up button. |
|
|
755
|
+
| colorHoverDown | string | 'primary' | Custom hover color for the down button. |
|
|
756
|
+
| onVoteUp | VoidFunction | — | Callback function triggered on up vote. |
|
|
757
|
+
| onVoteDown | VoidFunction | — | Callback function triggered on down vote. |
|
|
758
|
+
| itemClassName | string | — | Additional classes applied to the individual reaction item (button and label). |
|
|
759
|
+
| animated | boolean | false | Defines whether the reaction icon is animated. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Pickers
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/filePickers
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:36.027Z
|
|
7
7
|
|
|
8
8
|
## FilePicker
|
|
9
9
|
|
|
@@ -94,6 +94,20 @@ export default FilePickerExample;
|
|
|
94
94
|
</div>
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
+
#### Props
|
|
98
|
+
|
|
99
|
+
| Name | Type | Default | Description |
|
|
100
|
+
| --- | --- | --- | --- |
|
|
101
|
+
| displayMode | 'button' \| 'dropzone' \| 'full' | 'button' | Defines the file picker display mode. Possible values are 'button' for a single button, 'dropzone' for a custom dropzone passed as child function, or 'full' for showing both. |
|
|
102
|
+
| multiple | boolean | true | Indicating if multiple files may be selected. |
|
|
103
|
+
| label | string \| ReactNode | 'Select files' | Text to display on Button if displayMode is set to "button". |
|
|
104
|
+
| maxSize | number | — | Maximum file size in byte. 5 MB = 5,242,880 byte |
|
|
105
|
+
| onPick | (files: File[], rejectedFiles: FileRejection[]) => void | — | Function called after one or multiple files have been picked. |
|
|
106
|
+
| className | string | — | Additional classes for the select button. |
|
|
107
|
+
| fullHeight | boolean | false | Flag to set the dropzone wrapper element to 100% height. This comes in handy, when the dropzone should have 100 % height so it can grow. |
|
|
108
|
+
| accept | { [mimeType: string]: string[]; } | — | Object list of accepted Mime Types as keys and file extensions array as value. |
|
|
109
|
+
| children | ({ isDragActive }: FilePickerRenderProps) => React.ReactElement | — | Pass a custom dropzone element as function receiving some render props. |
|
|
110
|
+
|
|
97
111
|
### Example: Example 2
|
|
98
112
|
|
|
99
113
|
FilePicker for multiple images and with dropzoneSelect multiple ImagesDrag & drop files here, or click to select files
|
|
@@ -207,6 +221,20 @@ export default FilePickerWithDropzoneExample;
|
|
|
207
221
|
</div>
|
|
208
222
|
```
|
|
209
223
|
|
|
224
|
+
#### Props
|
|
225
|
+
|
|
226
|
+
| Name | Type | Default | Description |
|
|
227
|
+
| --- | --- | --- | --- |
|
|
228
|
+
| displayMode | 'button' \| 'dropzone' \| 'full' | 'button' | Defines the file picker display mode. Possible values are 'button' for a single button, 'dropzone' for a custom dropzone passed as child function, or 'full' for showing both. |
|
|
229
|
+
| multiple | boolean | true | Indicating if multiple files may be selected. |
|
|
230
|
+
| label | string \| ReactNode | 'Select files' | Text to display on Button if displayMode is set to "button". |
|
|
231
|
+
| maxSize | number | — | Maximum file size in byte. 5 MB = 5,242,880 byte |
|
|
232
|
+
| onPick | (files: File[], rejectedFiles: FileRejection[]) => void | — | Function called after one or multiple files have been picked. |
|
|
233
|
+
| className | string | — | Additional classes for the select button. |
|
|
234
|
+
| fullHeight | boolean | false | Flag to set the dropzone wrapper element to 100% height. This comes in handy, when the dropzone should have 100 % height so it can grow. |
|
|
235
|
+
| accept | { [mimeType: string]: string[]; } | — | Object list of accepted Mime Types as keys and file extensions array as value. |
|
|
236
|
+
| children | ({ isDragActive }: FilePickerRenderProps) => React.ReactElement | — | Pass a custom dropzone element as function receiving some render props. |
|
|
237
|
+
|
|
210
238
|
### Example: You have no file selected yet
|
|
211
239
|
|
|
212
240
|
FilePicker for all files and with dropzone onlyDrag & drop PDF files here or click to select
|
|
@@ -325,4 +353,18 @@ export default FilePickerDocumentExample;
|
|
|
325
353
|
</div>
|
|
326
354
|
</div>
|
|
327
355
|
</div>
|
|
328
|
-
```
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
#### Props
|
|
359
|
+
|
|
360
|
+
| Name | Type | Default | Description |
|
|
361
|
+
| --- | --- | --- | --- |
|
|
362
|
+
| displayMode | 'button' \| 'dropzone' \| 'full' | 'button' | Defines the file picker display mode. Possible values are 'button' for a single button, 'dropzone' for a custom dropzone passed as child function, or 'full' for showing both. |
|
|
363
|
+
| multiple | boolean | true | Indicating if multiple files may be selected. |
|
|
364
|
+
| label | string \| ReactNode | 'Select files' | Text to display on Button if displayMode is set to "button". |
|
|
365
|
+
| maxSize | number | — | Maximum file size in byte. 5 MB = 5,242,880 byte |
|
|
366
|
+
| onPick | (files: File[], rejectedFiles: FileRejection[]) => void | — | Function called after one or multiple files have been picked. |
|
|
367
|
+
| className | string | — | Additional classes for the select button. |
|
|
368
|
+
| fullHeight | boolean | false | Flag to set the dropzone wrapper element to 100% height. This comes in handy, when the dropzone should have 100 % height so it can grow. |
|
|
369
|
+
| accept | { [mimeType: string]: string[]; } | — | Object list of accepted Mime Types as keys and file extensions array as value. |
|
|
370
|
+
| children | ({ isDragActive }: FilePickerRenderProps) => React.ReactElement | — | Pass a custom dropzone element as function receiving some render props. |
|