@rio-cloud/uikit-mcp 1.1.2 → 1.1.4
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/dist/doc-metadata.json +117 -127
- package/dist/docs/components/accentBar.md +2 -34
- package/dist/docs/components/activity.md +2 -13
- package/dist/docs/components/animatedNumber.md +4 -17
- package/dist/docs/components/animatedTextReveal.md +7 -54
- package/dist/docs/components/animations.md +42 -34
- package/dist/docs/components/appHeader.md +2 -73
- package/dist/docs/components/appLayout.md +36 -496
- package/dist/docs/components/appNavigationBar.md +2 -54
- package/dist/docs/components/areaCharts.md +37 -37
- package/dist/docs/components/aspectRatioPlaceholder.md +2 -11
- package/dist/docs/components/assetTree.md +435 -901
- package/dist/docs/components/autosuggests.md +4 -4
- package/dist/docs/components/avatar.md +2 -24
- package/dist/docs/components/banner.md +2 -2
- package/dist/docs/components/barCharts.md +186 -186
- package/dist/docs/components/barList.md +12 -46
- package/dist/docs/components/basicMap.md +7 -7
- package/dist/docs/components/bottomSheet.md +3 -100
- package/dist/docs/components/button.md +16 -71
- package/dist/docs/components/buttonToolbar.md +2 -9
- package/dist/docs/components/calendarStripe.md +95 -121
- package/dist/docs/components/card.md +2 -10
- 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 +4 -1
- package/dist/docs/components/checkbox.md +11 -111
- package/dist/docs/components/clearableInput.md +7 -111
- package/dist/docs/components/collapse.md +3 -29
- package/dist/docs/components/composedCharts.md +31 -31
- package/dist/docs/components/contentLoader.md +104 -122
- package/dist/docs/components/dataTabs.md +24 -194
- package/dist/docs/components/datepickers.md +727 -769
- package/dist/docs/components/dialogs.md +15 -262
- package/dist/docs/components/divider.md +2 -14
- package/dist/docs/components/dropdowns.md +4387 -4550
- package/dist/docs/components/editableContent.md +2 -186
- package/dist/docs/components/expander.md +23 -70
- package/dist/docs/components/fade.md +6 -41
- package/dist/docs/components/fadeExpander.md +2 -11
- package/dist/docs/components/fadeUp.md +3 -23
- package/dist/docs/components/feedback.md +2 -42
- package/dist/docs/components/filePickers.md +2 -44
- package/dist/docs/components/formLabel.md +2 -18
- package/dist/docs/components/groupedItemList.md +2 -53
- package/dist/docs/components/iconList.md +3 -3
- package/dist/docs/components/imagePreloader.md +2 -6
- package/dist/docs/components/labeledElement.md +2 -11
- package/dist/docs/components/licensePlate.md +2 -10
- package/dist/docs/components/lineCharts.md +60 -60
- package/dist/docs/components/listMenu.md +2 -50
- package/dist/docs/components/loadMore.md +2 -28
- package/dist/docs/components/mainNavigation.md +1 -1
- package/dist/docs/components/mapCircle.md +3 -3
- package/dist/docs/components/mapCluster.md +5 -5
- package/dist/docs/components/mapContext.md +3 -3
- package/dist/docs/components/mapDraggableMarker.md +3 -3
- package/dist/docs/components/mapGettingStarted.md +1 -1
- package/dist/docs/components/mapInfoBubble.md +3 -3
- package/dist/docs/components/mapLayerGroup.md +3 -3
- package/dist/docs/components/mapMarker.md +341 -347
- package/dist/docs/components/mapPolygon.md +20 -24
- package/dist/docs/components/mapRoute.md +26 -32
- package/dist/docs/components/mapRouteGenerator.md +1 -1
- package/dist/docs/components/mapSettings.md +273 -284
- package/dist/docs/components/mapUtils.md +3 -5
- package/dist/docs/components/multiselects.md +1 -1
- package/dist/docs/components/noData.md +2 -22
- package/dist/docs/components/notifications.md +1 -1
- package/dist/docs/components/numbercontrol.md +2 -48
- package/dist/docs/components/onboarding.md +2 -46
- package/dist/docs/components/page.md +2 -32
- package/dist/docs/components/pager.md +2 -14
- package/dist/docs/components/pieCharts.md +125 -157
- package/dist/docs/components/popover.md +2 -56
- package/dist/docs/components/position.md +2 -10
- package/dist/docs/components/radialBarCharts.md +506 -506
- package/dist/docs/components/radiobutton.md +81 -191
- package/dist/docs/components/releaseNotes.md +1 -12
- package/dist/docs/components/resizer.md +2 -14
- package/dist/docs/components/responsiveColumnStripe.md +2 -19
- package/dist/docs/components/responsiveVideo.md +2 -11
- package/dist/docs/components/rioglyph.md +2 -12
- package/dist/docs/components/rules.md +69 -133
- package/dist/docs/components/saveableInput.md +279 -393
- package/dist/docs/components/selects.md +9996 -15
- package/dist/docs/components/sidebar.md +2 -39
- package/dist/docs/components/sliders.md +2 -37
- package/dist/docs/components/smoothScrollbars.md +2 -56
- package/dist/docs/components/spinners.md +5 -51
- package/dist/docs/components/states.md +21 -245
- package/dist/docs/components/statsWidgets.md +2 -113
- package/dist/docs/components/statusBar.md +2 -28
- package/dist/docs/components/stepButton.md +2 -8
- package/dist/docs/components/steppedProgressBars.md +2 -66
- package/dist/docs/components/subNavigation.md +1 -8
- package/dist/docs/components/supportMarker.md +1 -1
- package/dist/docs/components/svgImage.md +2 -12
- package/dist/docs/components/switch.md +2 -11
- package/dist/docs/components/tables.md +1 -1
- package/dist/docs/components/tagManager.md +4 -58
- package/dist/docs/components/tags.md +2 -31
- package/dist/docs/components/teaser.md +2 -30
- package/dist/docs/components/timeline.md +1 -1
- package/dist/docs/components/timepicker.md +2 -26
- package/dist/docs/components/toggleButton.md +7 -29
- package/dist/docs/components/tooltip.md +9 -40
- package/dist/docs/components/virtualList.md +73 -99
- 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 +200 -200
- package/dist/docs/templates/loading-progress.md +3 -3
- 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 +2 -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 -2
- package/dist/version.json +2 -2
- package/package.json +8 -8
- package/dist/docs/components/fullscreenMap.md +0 -10
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Interaction
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/editableContent
|
|
6
|
-
*Captured:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:04.611Z
|
|
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,29 +60,6 @@ export default () => {
|
|
|
60
60
|
</span>
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
#### Props
|
|
64
|
-
|
|
65
|
-
| Name | Type | Default | Description |
|
|
66
|
-
| --- | --- | --- | --- |
|
|
67
|
-
| show | Boolean | — | 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 the 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 | ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
76
|
-
| customEditor | 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. the text element has borders, spacings different text sizes. |
|
|
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 | String | 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. |
|
|
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
|
-
|
|
86
63
|
### Example: Headline that can change
|
|
87
64
|
|
|
88
65
|
Editable headline - like dialog or panel header
|
|
@@ -158,29 +135,6 @@ export default () => {
|
|
|
158
135
|
</div>
|
|
159
136
|
```
|
|
160
137
|
|
|
161
|
-
#### Props
|
|
162
|
-
|
|
163
|
-
| Name | Type | Default | Description |
|
|
164
|
-
| --- | --- | --- | --- |
|
|
165
|
-
| show | Boolean | — | 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 the 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 | ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
174
|
-
| customEditor | 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. the text element has borders, spacings different text sizes. |
|
|
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 | String | 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. |
|
|
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
|
-
|
|
184
138
|
### Example: Example 3
|
|
185
139
|
|
|
186
140
|
Editable content using a resizable textarea
|
|
@@ -244,29 +198,6 @@ export default () => {
|
|
|
244
198
|
</div>
|
|
245
199
|
```
|
|
246
200
|
|
|
247
|
-
#### Props
|
|
248
|
-
|
|
249
|
-
| Name | Type | Default | Description |
|
|
250
|
-
| --- | --- | --- | --- |
|
|
251
|
-
| show | Boolean | — | 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 the 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 | ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
260
|
-
| customEditor | 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. the text element has borders, spacings different text sizes. |
|
|
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 | String | 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. |
|
|
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
|
-
|
|
270
201
|
### Example: Example 4
|
|
271
202
|
|
|
272
203
|
Focusable editable content with input validationThis content must not contain numbers.
|
|
@@ -344,29 +275,6 @@ export default () => {
|
|
|
344
275
|
</div>
|
|
345
276
|
```
|
|
346
277
|
|
|
347
|
-
#### Props
|
|
348
|
-
|
|
349
|
-
| Name | Type | Default | Description |
|
|
350
|
-
| --- | --- | --- | --- |
|
|
351
|
-
| show | Boolean | — | 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 the 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 | ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
360
|
-
| customEditor | 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. the text element has borders, spacings different text sizes. |
|
|
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 | String | 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. |
|
|
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
|
-
|
|
370
278
|
### Example: Example 5
|
|
371
279
|
|
|
372
280
|
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.`;
|
|
@@ -418,29 +326,6 @@ export default () => {
|
|
|
418
326
|
</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>
|
|
419
327
|
```
|
|
420
328
|
|
|
421
|
-
#### Props
|
|
422
|
-
|
|
423
|
-
| Name | Type | Default | Description |
|
|
424
|
-
| --- | --- | --- | --- |
|
|
425
|
-
| show | Boolean | — | 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 the 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 | ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
434
|
-
| customEditor | 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. the text element has borders, spacings different text sizes. |
|
|
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 | String | 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. |
|
|
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
|
-
|
|
444
329
|
### Example: Example 6
|
|
445
330
|
|
|
446
331
|
Render NumberControl as custom editor component
|
|
@@ -562,29 +447,6 @@ export default () => {
|
|
|
562
447
|
</div>
|
|
563
448
|
```
|
|
564
449
|
|
|
565
|
-
#### Props
|
|
566
|
-
|
|
567
|
-
| Name | Type | Default | Description |
|
|
568
|
-
| --- | --- | --- | --- |
|
|
569
|
-
| show | Boolean | — | 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 the 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 | ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
578
|
-
| customEditor | 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. the text element has borders, spacings different text sizes. |
|
|
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 | String | 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. |
|
|
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
|
-
|
|
588
450
|
### Example: Example 7
|
|
589
451
|
|
|
590
452
|
Render NumberInput as custom editor component with input validation
|
|
@@ -707,29 +569,6 @@ export default () => {
|
|
|
707
569
|
</div>
|
|
708
570
|
```
|
|
709
571
|
|
|
710
|
-
#### Props
|
|
711
|
-
|
|
712
|
-
| Name | Type | Default | Description |
|
|
713
|
-
| --- | --- | --- | --- |
|
|
714
|
-
| show | Boolean | — | 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 the 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 | ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
723
|
-
| customEditor | 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. the text element has borders, spacings different text sizes. |
|
|
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 | String | 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. |
|
|
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
|
-
|
|
733
572
|
## Usage guidelines
|
|
734
573
|
|
|
735
574
|
### Example: Example 8
|
|
@@ -1101,27 +940,4 @@ export default () => {
|
|
|
1101
940
|
<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>
|
|
1102
941
|
</div>
|
|
1103
942
|
</b>
|
|
1104
|
-
```
|
|
1105
|
-
|
|
1106
|
-
#### Props
|
|
1107
|
-
|
|
1108
|
-
| Name | Type | Default | Description |
|
|
1109
|
-
| --- | --- | --- | --- |
|
|
1110
|
-
| show | Boolean | — | 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 the 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 | ReactNode | — | The error message that shall be shown to the user in case the validation fails. |
|
|
1119
|
-
| customEditor | 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. the text element has borders, spacings different text sizes. |
|
|
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 | String | 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. |
|
|
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. |
|
|
943
|
+
```
|
|
@@ -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:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:10.877Z
|
|
7
7
|
|
|
8
8
|
A simple panel component where the "panel-body" can be expanded.
|
|
9
9
|
|
|
@@ -117,22 +117,7 @@ export default () => {
|
|
|
117
117
|
|
|
118
118
|
| Name | Type | Default | Description |
|
|
119
119
|
| --- | --- | --- | --- |
|
|
120
|
-
|
|
|
121
|
-
| bsStyle | String | 'blank' | Component visual or contextual style variants. Possible values are: 'default' 'separator' 'blank' 'primary' 'secondary' 'info' 'warning' 'danger' 'success' |
|
|
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
|
-
| className | String | — | Additional classes to be set on the wrapper element. |
|
|
126
|
-
| iconClassName | String | — | Additional classes added to the chevron icon |
|
|
127
|
-
| headerClassName | String | — | Additional classes to be set on the panel header. |
|
|
128
|
-
| titleClassName | String | — | Additional classes to be set on the header title. |
|
|
129
|
-
| bodyClassName | String | — | Additional classes to be set on the panel body. |
|
|
130
|
-
| onToggle | (isOpen: boolean) => void | — | Callback function for when the header is clicked and the expander toggles. |
|
|
131
|
-
| onEntered | VoidFunction | — | Callback fired after the component has expanded. |
|
|
132
|
-
| onExited | VoidFunction | — | Callback fired after the component has collapsed. |
|
|
133
|
-
| onAnimationStart | VoidFunction | — | Callback fired when the animation starts for either expand or collapse. |
|
|
134
|
-
| children | Node | — | Any element to be rendered inside the panel body. |
|
|
135
|
-
| children | Function | — | Providing a function enables the "render props" approach. The function gets the isOpen state passed and is responsible for rendering the custom content. |
|
|
120
|
+
| children | | — | — |
|
|
136
121
|
|
|
137
122
|
### Example: Default
|
|
138
123
|
|
|
@@ -277,8 +262,8 @@ export default () => (
|
|
|
277
262
|
bsStyle='separator'
|
|
278
263
|
bodyClassName='padding-top-5 padding-x-0'
|
|
279
264
|
>
|
|
280
|
-
{
|
|
281
|
-
console.log(`isOpen: ${
|
|
265
|
+
{isOpen => {
|
|
266
|
+
console.log(`isOpen: ${isOpen}`);
|
|
282
267
|
return content2;
|
|
283
268
|
}}
|
|
284
269
|
</ExpanderPanel>
|
|
@@ -291,8 +276,8 @@ export default () => (
|
|
|
291
276
|
bsStyle='separator'
|
|
292
277
|
bodyClassName='padding-top-5 padding-right-20'
|
|
293
278
|
>
|
|
294
|
-
{
|
|
295
|
-
console.log(`isOpen: ${
|
|
279
|
+
{isOpen => {
|
|
280
|
+
console.log(`isOpen: ${isOpen}`);
|
|
296
281
|
return content2;
|
|
297
282
|
}}
|
|
298
283
|
</ExpanderPanel>
|
|
@@ -300,8 +285,8 @@ export default () => (
|
|
|
300
285
|
<div className='grid-colspan-1 grid-colspan-2-lg'>
|
|
301
286
|
<label className='text-color-dark'>Primary</label>
|
|
302
287
|
<ExpanderPanel title='Lorem ipsum' titleClassName='text-normal' bsStyle='primary'>
|
|
303
|
-
{
|
|
304
|
-
console.log(`isOpen: ${
|
|
288
|
+
{isOpen => {
|
|
289
|
+
console.log(`isOpen: ${isOpen}`);
|
|
305
290
|
return content2;
|
|
306
291
|
}}
|
|
307
292
|
</ExpanderPanel>
|
|
@@ -309,37 +294,37 @@ export default () => (
|
|
|
309
294
|
<div className='grid-colspan-1 grid-colspan-2-lg'>
|
|
310
295
|
<label className='text-color-dark'>Primary</label>
|
|
311
296
|
<ExpanderPanel title='Header with icon left' titleClassName='text-normal' iconLeft bsStyle='primary'>
|
|
312
|
-
{
|
|
313
|
-
console.log(`isOpen: ${
|
|
297
|
+
{isOpen => {
|
|
298
|
+
console.log(`isOpen: ${isOpen}`);
|
|
314
299
|
return content2;
|
|
315
300
|
}}
|
|
316
301
|
</ExpanderPanel>
|
|
317
302
|
</div>
|
|
318
|
-
<div
|
|
303
|
+
<div>
|
|
319
304
|
<label className='text-color-dark'>Secondary</label>
|
|
320
305
|
<ExpanderPanel title='Lorem ipsum' bsStyle='secondary'>
|
|
321
306
|
{dummyTextExtraShort}
|
|
322
307
|
</ExpanderPanel>
|
|
323
308
|
</div>
|
|
324
|
-
<div
|
|
309
|
+
<div>
|
|
325
310
|
<label className='text-color-dark'>Info</label>
|
|
326
311
|
<ExpanderPanel title='Lorem ipsum' bsStyle='info'>
|
|
327
312
|
{dummyTextExtraShort}
|
|
328
313
|
</ExpanderPanel>
|
|
329
314
|
</div>
|
|
330
|
-
<div
|
|
315
|
+
<div>
|
|
331
316
|
<label className='text-color-dark'>Warning</label>
|
|
332
317
|
<ExpanderPanel title='Lorem ipsum' bsStyle='warning'>
|
|
333
318
|
{dummyTextExtraShort}
|
|
334
319
|
</ExpanderPanel>
|
|
335
320
|
</div>
|
|
336
|
-
<div
|
|
321
|
+
<div>
|
|
337
322
|
<label className='text-color-dark'>Danger</label>
|
|
338
323
|
<ExpanderPanel title='Lorem ipsum' bsStyle='danger'>
|
|
339
324
|
{dummyTextExtraShort}
|
|
340
325
|
</ExpanderPanel>
|
|
341
326
|
</div>
|
|
342
|
-
<div
|
|
327
|
+
<div>
|
|
343
328
|
<label className='text-color-dark'>success</label>
|
|
344
329
|
<ExpanderPanel title='Lorem ipsum' bsStyle='success'>
|
|
345
330
|
{dummyTextExtraShort}
|
|
@@ -386,7 +371,7 @@ const DynamicContent = () => {
|
|
|
386
371
|
const idString = event.currentTarget.getAttribute('data-id');
|
|
387
372
|
if (idString) {
|
|
388
373
|
const id = Number.parseInt(idString, 10);
|
|
389
|
-
if (!isNaN(id)) {
|
|
374
|
+
if (!Number.isNaN(id)) {
|
|
390
375
|
setListItems(listItems.filter(item => item.id !== id));
|
|
391
376
|
}
|
|
392
377
|
}
|
|
@@ -542,7 +527,7 @@ const DynamicContent = () => {
|
|
|
542
527
|
</div>
|
|
543
528
|
</div>
|
|
544
529
|
</div>
|
|
545
|
-
<div
|
|
530
|
+
<div>
|
|
546
531
|
<label class="text-color-dark">Secondary</label>
|
|
547
532
|
<div class="expander-panel panel panel-secondary" aria-label="expander panel">
|
|
548
533
|
<div class="panel-heading" aria-label="panel heading">
|
|
@@ -552,7 +537,7 @@ const DynamicContent = () => {
|
|
|
552
537
|
</div>
|
|
553
538
|
</div>
|
|
554
539
|
</div>
|
|
555
|
-
<div
|
|
540
|
+
<div>
|
|
556
541
|
<label class="text-color-dark">Info</label>
|
|
557
542
|
<div class="expander-panel panel panel-info" aria-label="expander panel">
|
|
558
543
|
<div class="panel-heading" aria-label="panel heading">
|
|
@@ -562,7 +547,7 @@ const DynamicContent = () => {
|
|
|
562
547
|
</div>
|
|
563
548
|
</div>
|
|
564
549
|
</div>
|
|
565
|
-
<div
|
|
550
|
+
<div>
|
|
566
551
|
<label class="text-color-dark">Warning</label>
|
|
567
552
|
<div class="expander-panel panel panel-warning" aria-label="expander panel">
|
|
568
553
|
<div class="panel-heading" aria-label="panel heading">
|
|
@@ -572,7 +557,7 @@ const DynamicContent = () => {
|
|
|
572
557
|
</div>
|
|
573
558
|
</div>
|
|
574
559
|
</div>
|
|
575
|
-
<div
|
|
560
|
+
<div>
|
|
576
561
|
<label class="text-color-dark">Danger</label>
|
|
577
562
|
<div class="expander-panel panel panel-danger" aria-label="expander panel">
|
|
578
563
|
<div class="panel-heading" aria-label="panel heading">
|
|
@@ -582,7 +567,7 @@ const DynamicContent = () => {
|
|
|
582
567
|
</div>
|
|
583
568
|
</div>
|
|
584
569
|
</div>
|
|
585
|
-
<div
|
|
570
|
+
<div>
|
|
586
571
|
<label class="text-color-dark">success</label>
|
|
587
572
|
<div class="expander-panel panel panel-success" aria-label="expander panel">
|
|
588
573
|
<div class="panel-heading" aria-label="panel heading">
|
|
@@ -656,22 +641,7 @@ const DynamicContent = () => {
|
|
|
656
641
|
|
|
657
642
|
| Name | Type | Default | Description |
|
|
658
643
|
| --- | --- | --- | --- |
|
|
659
|
-
|
|
|
660
|
-
| bsStyle | String | 'blank' | Component visual or contextual style variants. Possible values are: 'default' 'separator' 'blank' 'primary' 'secondary' 'info' 'warning' 'danger' 'success' |
|
|
661
|
-
| iconLeft | Boolean | false | Defines if the icon will be align left, otherwise it is aligned right. |
|
|
662
|
-
| open | Boolean | false | Defines if the panel will be opened or closed by default. The open/closed state will be handled internally |
|
|
663
|
-
| 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. |
|
|
664
|
-
| className | String | — | Additional classes to be set on the wrapper element. |
|
|
665
|
-
| iconClassName | String | — | Additional classes added to the chevron icon |
|
|
666
|
-
| headerClassName | String | — | Additional classes to be set on the panel header. |
|
|
667
|
-
| titleClassName | String | — | Additional classes to be set on the header title. |
|
|
668
|
-
| bodyClassName | String | — | Additional classes to be set on the panel body. |
|
|
669
|
-
| onToggle | (isOpen: boolean) => void | — | Callback function for when the header is clicked and the expander toggles. |
|
|
670
|
-
| onEntered | VoidFunction | — | Callback fired after the component has expanded. |
|
|
671
|
-
| onExited | VoidFunction | — | Callback fired after the component has collapsed. |
|
|
672
|
-
| onAnimationStart | VoidFunction | — | Callback fired when the animation starts for either expand or collapse. |
|
|
673
|
-
| children | Node | — | Any element to be rendered inside the panel body. |
|
|
674
|
-
| children | Function | — | Providing a function enables the "render props" approach. The function gets the isOpen state passed and is responsible for rendering the custom content. |
|
|
644
|
+
| children | | — | — |
|
|
675
645
|
|
|
676
646
|
## ExpanderList
|
|
677
647
|
|
|
@@ -950,21 +920,4 @@ export default () => {
|
|
|
950
920
|
</ul>
|
|
951
921
|
<button type="button" class="btn btn-default btn-component" tabindex="0">Toggle first</button>
|
|
952
922
|
</div>
|
|
953
|
-
```
|
|
954
|
-
|
|
955
|
-
#### Props
|
|
956
|
-
|
|
957
|
-
| Name | Type | Default | Description |
|
|
958
|
-
| --- | --- | --- | --- |
|
|
959
|
-
| items | Array of Objects | [] | List of items to be rendered |
|
|
960
|
-
| └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. |
|
|
961
|
-
| └header | String / Node | — | The header content. |
|
|
962
|
-
| └body | String / Node | — | The body content. If there is no "body" provided, the list item is not expandable. |
|
|
963
|
-
| └open | Boolean | — | Defines if the item will be expanded or closed by default. |
|
|
964
|
-
| └className | String | — | Additional classes to be set on list item node. |
|
|
965
|
-
| └headerClassName | String | — | Additional classes to be set on "expander-list-header" node. |
|
|
966
|
-
| └bodyClassName | String | — | Additional classes to be set on "expander-list-body" node. |
|
|
967
|
-
| rounded | Boolean | true | Defines whether the "expander-list-body" is rounded or not. |
|
|
968
|
-
| border | 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. |
|
|
923
|
+
```
|
|
@@ -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:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:12.339Z
|
|
7
7
|
|
|
8
8
|
The Fade component fades in and out content with a given animation style.
|
|
9
9
|
|
|
@@ -148,14 +148,7 @@ export default () => {
|
|
|
148
148
|
|
|
149
149
|
| Name | Type | Default | Description |
|
|
150
150
|
| --- | --- | --- | --- |
|
|
151
|
-
|
|
|
152
|
-
| duration | Number | 0.2 | Duration of the fade animation in seconds. |
|
|
153
|
-
| initial | Boolean | false | Defines whether or not the animation is triggered initially when showing the content. |
|
|
154
|
-
| animationStyle | String | fade | Defines the desired animation style. Possible values are: fade tabs page pageBackfromLeft 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 | Function | () => {} | 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. |
|
|
151
|
+
| animationStyle | | — | — |
|
|
159
152
|
|
|
160
153
|
### Example: Example 2
|
|
161
154
|
|
|
@@ -263,14 +256,7 @@ const ContentTab2 = () => (
|
|
|
263
256
|
|
|
264
257
|
| Name | Type | Default | Description |
|
|
265
258
|
| --- | --- | --- | --- |
|
|
266
|
-
|
|
|
267
|
-
| duration | Number | 0.2 | Duration of the fade animation in seconds. |
|
|
268
|
-
| initial | Boolean | false | Defines whether or not the animation is triggered initially when showing the content. |
|
|
269
|
-
| animationStyle | String | fade | Defines the desired animation style. Possible values are: fade tabs page pageBackfromLeft 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 | Function | () => {} | 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. |
|
|
259
|
+
| animationStyle | | — | — |
|
|
274
260
|
|
|
275
261
|
### Example: Example 3
|
|
276
262
|
|
|
@@ -392,14 +378,7 @@ const ContentTab2 = () => (
|
|
|
392
378
|
|
|
393
379
|
| Name | Type | Default | Description |
|
|
394
380
|
| --- | --- | --- | --- |
|
|
395
|
-
|
|
|
396
|
-
| duration | Number | 0.2 | Duration of the fade animation in seconds. |
|
|
397
|
-
| initial | Boolean | false | Defines whether or not the animation is triggered initially when showing the content. |
|
|
398
|
-
| animationStyle | String | fade | Defines the desired animation style. Possible values are: fade tabs page pageBackfromLeft 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 | Function | () => {} | 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. |
|
|
381
|
+
| animationStyle | | — | — |
|
|
403
382
|
|
|
404
383
|
### Example: Example 4
|
|
405
384
|
|
|
@@ -570,14 +549,7 @@ const Content3 = () => (
|
|
|
570
549
|
|
|
571
550
|
| Name | Type | Default | Description |
|
|
572
551
|
| --- | --- | --- | --- |
|
|
573
|
-
|
|
|
574
|
-
| duration | Number | 0.2 | Duration of the fade animation in seconds. |
|
|
575
|
-
| initial | Boolean | false | Defines whether or not the animation is triggered initially when showing the content. |
|
|
576
|
-
| animationStyle | String | fade | Defines the desired animation style. Possible values are: fade tabs page pageBackfromLeft 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 | Function | () => {} | 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. |
|
|
552
|
+
| animationStyle | | — | — |
|
|
581
553
|
|
|
582
554
|
### Example: Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod
|
|
583
555
|
|
|
@@ -826,11 +798,4 @@ const ItemDetails = ({ title = '', onBack }: { title: string | undefined; onBack
|
|
|
826
798
|
|
|
827
799
|
| Name | Type | Default | Description |
|
|
828
800
|
| --- | --- | --- | --- |
|
|
829
|
-
|
|
|
830
|
-
| duration | Number | 0.2 | Duration of the fade animation in seconds. |
|
|
831
|
-
| initial | Boolean | false | Defines whether or not the animation is triggered initially when showing the content. |
|
|
832
|
-
| animationStyle | String | fade | Defines the desired animation style. Possible values are: fade tabs page pageBackfromLeft 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 | Function | () => {} | 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. |
|
|
801
|
+
| animationStyle | | — | — |
|
|
@@ -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:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:10.038Z
|
|
7
7
|
|
|
8
8
|
The FadeExpander component fades in and expands when the content.
|
|
9
9
|
|
|
@@ -168,13 +168,4 @@ export default () => {
|
|
|
168
168
|
</div>
|
|
169
169
|
</div>
|
|
170
170
|
</div>
|
|
171
|
-
```
|
|
172
|
-
|
|
173
|
-
#### Props
|
|
174
|
-
|
|
175
|
-
| Name | Type | Default | Description |
|
|
176
|
-
| --- | --- | --- | --- |
|
|
177
|
-
| show | boolean | false | Defines if the content is shown or not. |
|
|
178
|
-
| delay | Number | 0 | Defines the time the animation should wait until it starts. |
|
|
179
|
-
| duration | Number | 0.2 | Defines the duration in seconds of the expand animation. |
|
|
180
|
-
| className | String | — | Additional classes names added to the motion div wrapper. |
|
|
171
|
+
```
|
|
@@ -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:*
|
|
6
|
+
*Captured:* 2026-01-14T09:07:10.833Z
|
|
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
|
|
|
@@ -143,7 +143,6 @@ export default () => {
|
|
|
143
143
|
return (
|
|
144
144
|
<div className='max-width-500 max-height-500 overflow-auto padding-x-25'>
|
|
145
145
|
{Array.from({ length: 30 }, (_, index) => (
|
|
146
|
-
// biome-ignore lint/suspicious/noArrayIndexKey: <explanation>
|
|
147
146
|
<FadeUp key={index} duration={0.5} delay={0.3}>
|
|
148
147
|
<div className='bg-white rounded border padding-25 margin-bottom-15'>{dummyText}</div>
|
|
149
148
|
</FadeUp>
|
|
@@ -280,15 +279,6 @@ export default () => {
|
|
|
280
279
|
</div>
|
|
281
280
|
```
|
|
282
281
|
|
|
283
|
-
#### Props
|
|
284
|
-
|
|
285
|
-
| Name | Type | Default | Description |
|
|
286
|
-
| --- | --- | --- | --- |
|
|
287
|
-
| delay | Number | 0 | Defines the time the animation should wait until it starts. |
|
|
288
|
-
| duration | Number | 0.4 | Defines the duration in seconds of the fade up animation. |
|
|
289
|
-
| offset | number | 15 | Defines the y offset from the bottom where the element starts to fade in. |
|
|
290
|
-
| className | String | — | Additional classes names added to the motion div wrapper. |
|
|
291
|
-
|
|
292
282
|
### 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.
|
|
293
283
|
|
|
294
284
|
Lorem ipsum dolor sit amet
|
|
@@ -338,7 +328,6 @@ export default () => {
|
|
|
338
328
|
|
|
339
329
|
<FadeUp delay={1.3} className='display-grid grid-cols-1 grid-cols-3-md gap-15'>
|
|
340
330
|
{Array.from({ length: 3 }, (_, index) => (
|
|
341
|
-
// biome-ignore lint/suspicious/noArrayIndexKey: <explanation>
|
|
342
331
|
<FadeUp key={index} delay={1.5 + index * 0.2}>
|
|
343
332
|
<div className='bg-white rounded border padding-25 margin-bottom-15'>{dummyTextShort}</div>
|
|
344
333
|
</FadeUp>
|
|
@@ -358,7 +347,7 @@ export default () => {
|
|
|
358
347
|
<div class="" style="opacity: 1; transform: none;">
|
|
359
348
|
<h1 class="">Lorem ipsum dolor sit amet</h1>
|
|
360
349
|
</div>
|
|
361
|
-
<div class="" style="opacity: 0; transform: translateY(
|
|
350
|
+
<div class="" style="opacity: 0; transform: translateY(0.0309728px);">
|
|
362
351
|
<p class="text-color-dark">
|
|
363
352
|
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>
|
|
364
353
|
</div>
|
|
@@ -384,13 +373,4 @@ data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAwMCIgaGVpZ2h0PSI2NjYiIHhtbG5zPSJodH
|
|
|
384
373
|
</div>
|
|
385
374
|
</div>
|
|
386
375
|
</div>
|
|
387
|
-
```
|
|
388
|
-
|
|
389
|
-
#### Props
|
|
390
|
-
|
|
391
|
-
| Name | Type | Default | Description |
|
|
392
|
-
| --- | --- | --- | --- |
|
|
393
|
-
| delay | Number | 0 | Defines the time the animation should wait until it starts. |
|
|
394
|
-
| duration | Number | 0.4 | Defines the duration in seconds of the fade up animation. |
|
|
395
|
-
| offset | number | 15 | Defines the y offset from the bottom where the element starts to fade in. |
|
|
396
|
-
| className | String | — | Additional classes names added to the motion div wrapper. |
|
|
376
|
+
```
|