@rio-cloud/uikit-mcp 1.1.3 → 1.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/dist/doc-metadata.json +97 -97
- package/dist/docs/components/accentBar.md +5 -5
- package/dist/docs/components/activity.md +7 -7
- package/dist/docs/components/animatedNumber.md +10 -10
- package/dist/docs/components/animatedTextReveal.md +42 -43
- package/dist/docs/components/animations.md +42 -34
- package/dist/docs/components/appHeader.md +20 -35
- package/dist/docs/components/appLayout.md +198 -221
- package/dist/docs/components/appNavigationBar.md +21 -21
- package/dist/docs/components/areaCharts.md +38 -38
- package/dist/docs/components/aspectRatioPlaceholder.md +4 -5
- package/dist/docs/components/assetTree.md +887 -614
- package/dist/docs/components/autosuggests.md +4 -4
- package/dist/docs/components/avatar.md +7 -7
- package/dist/docs/components/banner.md +2 -2
- package/dist/docs/components/barCharts.md +173 -173
- package/dist/docs/components/barList.md +19 -41
- package/dist/docs/components/basicMap.md +1 -1
- package/dist/docs/components/bottomSheet.md +74 -74
- package/dist/docs/components/button.md +161 -71
- package/dist/docs/components/buttonToolbar.md +3 -3
- package/dist/docs/components/calendarStripe.md +71 -123
- package/dist/docs/components/card.md +4 -4
- package/dist/docs/components/carousel.md +1 -1
- package/dist/docs/components/chartColors.md +1 -1
- package/dist/docs/components/chartsGettingStarted.md +1 -1
- package/dist/docs/components/chat.md +2 -2
- package/dist/docs/components/checkbox.md +56 -131
- package/dist/docs/components/clearableInput.md +23 -127
- package/dist/docs/components/collapse.md +14 -16
- package/dist/docs/components/composedCharts.md +31 -31
- package/dist/docs/components/contentLoader.md +125 -122
- package/dist/docs/components/dataTabs.md +103 -93
- package/dist/docs/components/datepickers.md +734 -764
- package/dist/docs/components/dialogs.md +299 -186
- package/dist/docs/components/divider.md +4 -4
- package/dist/docs/components/dropdowns.md +4555 -4498
- package/dist/docs/components/editableContent.md +97 -97
- package/dist/docs/components/expander.md +56 -56
- package/dist/docs/components/fade.md +41 -41
- package/dist/docs/components/fadeExpander.md +4 -4
- package/dist/docs/components/fadeUp.md +8 -10
- package/dist/docs/components/feedback.md +22 -21
- package/dist/docs/components/filePickers.md +25 -25
- package/dist/docs/components/formLabel.md +5 -7
- package/dist/docs/components/groupedItemList.md +37 -37
- package/dist/docs/components/iconList.md +4 -4
- package/dist/docs/components/imagePreloader.md +6 -6
- package/dist/docs/components/labeledElement.md +4 -3
- package/dist/docs/components/licensePlate.md +2 -2
- package/dist/docs/components/lineCharts.md +58 -58
- package/dist/docs/components/listMenu.md +63 -41
- package/dist/docs/components/loadMore.md +17 -17
- package/dist/docs/components/mainNavigation.md +1 -1
- package/dist/docs/components/mapCircle.md +1 -1
- package/dist/docs/components/mapCluster.md +1 -1
- package/dist/docs/components/mapContext.md +1 -1
- package/dist/docs/components/mapDraggableMarker.md +1 -1
- package/dist/docs/components/mapGettingStarted.md +1 -1
- package/dist/docs/components/mapInfoBubble.md +1 -1
- package/dist/docs/components/mapLayerGroup.md +1 -1
- package/dist/docs/components/mapMarker.md +339 -345
- package/dist/docs/components/mapPolygon.md +16 -20
- package/dist/docs/components/mapRoute.md +14 -20
- package/dist/docs/components/mapRouteGenerator.md +1 -1
- package/dist/docs/components/mapSettings.md +263 -274
- package/dist/docs/components/mapUtils.md +3 -5
- package/dist/docs/components/multiselects.md +1 -1
- package/dist/docs/components/noData.md +11 -11
- package/dist/docs/components/notifications.md +1 -1
- package/dist/docs/components/numbercontrol.md +39 -37
- package/dist/docs/components/onboarding.md +18 -38
- package/dist/docs/components/page.md +16 -16
- package/dist/docs/components/pager.md +8 -8
- package/dist/docs/components/pieCharts.md +124 -124
- package/dist/docs/components/popover.md +37 -53
- package/dist/docs/components/position.md +4 -4
- package/dist/docs/components/radialBarCharts.md +506 -506
- package/dist/docs/components/radiobutton.md +209 -191
- package/dist/docs/components/releaseNotes.md +9 -3
- package/dist/docs/components/resizer.md +7 -8
- package/dist/docs/components/responsiveColumnStripe.md +11 -11
- package/dist/docs/components/responsiveVideo.md +5 -5
- package/dist/docs/components/rioglyph.md +11 -11
- package/dist/docs/components/rules.md +118 -92
- package/dist/docs/components/saveableInput.md +366 -356
- package/dist/docs/components/selects.md +9996 -15
- package/dist/docs/components/sidebar.md +22 -23
- package/dist/docs/components/sliders.md +26 -26
- package/dist/docs/components/smoothScrollbars.md +61 -25
- package/dist/docs/components/spinners.md +32 -30
- package/dist/docs/components/states.md +236 -245
- package/dist/docs/components/statsWidgets.md +37 -28
- package/dist/docs/components/statusBar.md +22 -22
- package/dist/docs/components/stepButton.md +2 -2
- package/dist/docs/components/steppedProgressBars.md +45 -45
- package/dist/docs/components/subNavigation.md +3 -3
- package/dist/docs/components/supportMarker.md +1 -1
- package/dist/docs/components/svgImage.md +2 -38
- package/dist/docs/components/switch.md +11 -11
- package/dist/docs/components/tables.md +1 -1
- package/dist/docs/components/tagManager.md +40 -40
- package/dist/docs/components/tags.md +21 -20
- package/dist/docs/components/teaser.md +22 -23
- package/dist/docs/components/timeline.md +1 -1
- package/dist/docs/components/timepicker.md +17 -13
- package/dist/docs/components/toggleButton.md +65 -29
- package/dist/docs/components/tooltip.md +27 -50
- package/dist/docs/components/virtualList.md +75 -75
- package/dist/docs/foundations.md +167 -167
- package/dist/docs/start/changelog.md +23 -1
- package/dist/docs/start/goodtoknow.md +1 -1
- package/dist/docs/start/guidelines/color-combinations.md +1 -1
- package/dist/docs/start/guidelines/custom-css.md +1 -1
- package/dist/docs/start/guidelines/custom-rioglyph.md +1 -1
- package/dist/docs/start/guidelines/formatting.md +1 -1
- package/dist/docs/start/guidelines/iframe.md +80 -27
- package/dist/docs/start/guidelines/obfuscate-data.md +1 -1
- package/dist/docs/start/guidelines/print-css.md +1 -1
- package/dist/docs/start/guidelines/spinner.md +81 -81
- package/dist/docs/start/guidelines/supported-browsers.md +1 -1
- package/dist/docs/start/guidelines/writing.md +1 -1
- package/dist/docs/start/howto.md +9 -9
- package/dist/docs/start/intro.md +1 -1
- package/dist/docs/start/responsiveness.md +1 -1
- package/dist/docs/templates/common-table.md +11 -11
- package/dist/docs/templates/detail-views.md +2 -2
- package/dist/docs/templates/expandable-details.md +1 -1
- package/dist/docs/templates/feature-cards.md +55 -55
- package/dist/docs/templates/form-summary.md +22 -22
- package/dist/docs/templates/form-toggle.md +1 -1
- package/dist/docs/templates/list-blocks.md +197 -197
- package/dist/docs/templates/loading-progress.md +1 -1
- package/dist/docs/templates/options-panel.md +1 -1
- package/dist/docs/templates/panel-variants.md +1 -1
- package/dist/docs/templates/progress-cards.md +1 -1
- package/dist/docs/templates/progress-success.md +1 -1
- package/dist/docs/templates/settings-form.md +23 -23
- package/dist/docs/templates/stats-blocks.md +41 -41
- package/dist/docs/templates/table-panel.md +1 -1
- package/dist/docs/templates/table-row-animation.md +1 -1
- package/dist/docs/templates/usage-cards.md +1 -1
- package/dist/docs/utilities/deviceUtils.md +6 -3
- package/dist/docs/utilities/featureToggles.md +1 -1
- package/dist/docs/utilities/fuelTypeUtils.md +1 -1
- package/dist/docs/utilities/routeUtils.md +59 -23
- package/dist/docs/utilities/useAfterMount.md +1 -1
- package/dist/docs/utilities/useAutoAnimate.md +1 -1
- package/dist/docs/utilities/useAverage.md +1 -1
- package/dist/docs/utilities/useClickOutside.md +1 -1
- package/dist/docs/utilities/useClipboard.md +2 -2
- package/dist/docs/utilities/useCount.md +1 -1
- package/dist/docs/utilities/useDarkMode.md +1 -1
- package/dist/docs/utilities/useDebugInfo.md +4 -4
- package/dist/docs/utilities/useEffectOnce.md +1 -1
- package/dist/docs/utilities/useElapsedTime.md +1 -1
- package/dist/docs/utilities/useElementSize.md +1 -1
- package/dist/docs/utilities/useEsc.md +1 -1
- package/dist/docs/utilities/useEvent.md +1 -1
- package/dist/docs/utilities/useFocusTrap.md +1 -1
- package/dist/docs/utilities/useFullscreen.md +1 -1
- package/dist/docs/utilities/useHover.md +1 -1
- package/dist/docs/utilities/useIncomingPostMessages.md +1 -1
- package/dist/docs/utilities/useInterval.md +1 -1
- package/dist/docs/utilities/useIsFocusWithin.md +1 -1
- package/dist/docs/utilities/useKey.md +7 -5
- package/dist/docs/utilities/useLocalStorage.md +1 -1
- package/dist/docs/utilities/useLocationSuggestions.md +1 -1
- package/dist/docs/utilities/useMax.md +1 -1
- package/dist/docs/utilities/useMin.md +1 -1
- package/dist/docs/utilities/useMutationObserver.md +1 -1
- package/dist/docs/utilities/useOnScreen.md +1 -1
- package/dist/docs/utilities/useOnlineStatus.md +1 -1
- package/dist/docs/utilities/usePostMessage.md +58 -2
- package/dist/docs/utilities/usePostMessageSender.md +1 -1
- package/dist/docs/utilities/usePrevious.md +1 -1
- package/dist/docs/utilities/useResizeObserver.md +1 -1
- package/dist/docs/utilities/useScrollPosition.md +1 -1
- package/dist/docs/utilities/useSearch.md +1 -1
- package/dist/docs/utilities/useSorting.md +1 -1
- package/dist/docs/utilities/useStateWithValidation.md +1 -1
- package/dist/docs/utilities/useSum.md +1 -1
- package/dist/docs/utilities/useTableExport.md +54 -54
- package/dist/docs/utilities/useTableSelection.md +93 -93
- package/dist/docs/utilities/useTimeout.md +1 -1
- package/dist/docs/utilities/useToggle.md +1 -1
- package/dist/docs/utilities/useWindowResize.md +1 -1
- package/dist/index.mjs +8 -8
- package/dist/version.json +2 -2
- package/package.json +6 -6
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Interaction
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/button
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:13.834Z
|
|
7
7
|
|
|
8
8
|
The button component is the React equivalent to the normal HTML button with some To check out the HTML version click here: Buttons
|
|
9
9
|
|
|
@@ -255,20 +255,38 @@ export default () => (
|
|
|
255
255
|
|
|
256
256
|
| Name | Type | Default | Description |
|
|
257
257
|
| --- | --- | --- | --- |
|
|
258
|
-
| disabled |
|
|
259
|
-
| active |
|
|
260
|
-
|
|
|
261
|
-
| iconOnly |
|
|
262
|
-
|
|
|
263
|
-
|
|
|
264
|
-
| multiline |
|
|
265
|
-
| block |
|
|
266
|
-
|
|
|
267
|
-
|
|
|
268
|
-
|
|
|
269
|
-
|
|
|
270
|
-
|
|
|
271
|
-
|
|
|
258
|
+
| disabled | boolean | false | Whether the button should be disabled. |
|
|
259
|
+
| active | boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
|
|
260
|
+
| type | 'button' \| 'submit' | 'button' | Defines the type of the button. This may be used for form submit buttons. |
|
|
261
|
+
| iconOnly | boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
|
|
262
|
+
| iconRight | boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
|
|
263
|
+
| iconName | string | — | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
|
|
264
|
+
| multiline | boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
|
|
265
|
+
| block | boolean | false | Defines whether the button takes up the full width of the parent element. |
|
|
266
|
+
| bsStyle | BUTTON_STYLE | "default" | Sets the button style. Possible values are: default, unstyled, primary, secondary, info, warning, danger, success, muted and muted-filled |
|
|
267
|
+
| bsSize | BUTTON_SIZE | — | Sets the button size. Possible values are: xs, sm, md and lg |
|
|
268
|
+
| variant | BUTTON_VARIANT | — | Sets the button variant. Possible values are: link, link-inline, outline and action |
|
|
269
|
+
| noRippleEffect | boolean | — | Whether the "ripple" effect should be suppressed on this button. |
|
|
270
|
+
| tabIndex | number | 0 | Number of the index used for keyboard support. |
|
|
271
|
+
| className | string | — | Additional classes to be set on the button element. |
|
|
272
|
+
|
|
273
|
+
#### Props: Regular button
|
|
274
|
+
|
|
275
|
+
### Regular button
|
|
276
|
+
|
|
277
|
+
| Name | Type | Default | Description |
|
|
278
|
+
| --- | --- | --- | --- |
|
|
279
|
+
| asToggle | false | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
280
|
+
| onClick | (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function triggered when clicking the button. |
|
|
281
|
+
|
|
282
|
+
#### Props: ToggleButton
|
|
283
|
+
|
|
284
|
+
### ToggleButton
|
|
285
|
+
|
|
286
|
+
| Name | Type | Default | Description |
|
|
287
|
+
| --- | --- | --- | --- |
|
|
288
|
+
| asToggle | true | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
289
|
+
| onClick | (value: boolean) => void | — | Callback function triggered when clicking the button. |
|
|
272
290
|
|
|
273
291
|
### Example: Link buttons
|
|
274
292
|
|
|
@@ -371,20 +389,38 @@ export default () => (
|
|
|
371
389
|
|
|
372
390
|
| Name | Type | Default | Description |
|
|
373
391
|
| --- | --- | --- | --- |
|
|
374
|
-
| disabled |
|
|
375
|
-
| active |
|
|
376
|
-
|
|
|
377
|
-
| iconOnly |
|
|
378
|
-
|
|
|
379
|
-
|
|
|
380
|
-
| multiline |
|
|
381
|
-
| block |
|
|
382
|
-
|
|
|
383
|
-
|
|
|
384
|
-
|
|
|
385
|
-
|
|
|
386
|
-
|
|
|
387
|
-
|
|
|
392
|
+
| disabled | boolean | false | Whether the button should be disabled. |
|
|
393
|
+
| active | boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
|
|
394
|
+
| type | 'button' \| 'submit' | 'button' | Defines the type of the button. This may be used for form submit buttons. |
|
|
395
|
+
| iconOnly | boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
|
|
396
|
+
| iconRight | boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
|
|
397
|
+
| iconName | string | — | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
|
|
398
|
+
| multiline | boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
|
|
399
|
+
| block | boolean | false | Defines whether the button takes up the full width of the parent element. |
|
|
400
|
+
| bsStyle | BUTTON_STYLE | "default" | Sets the button style. Possible values are: default, unstyled, primary, secondary, info, warning, danger, success, muted and muted-filled |
|
|
401
|
+
| bsSize | BUTTON_SIZE | — | Sets the button size. Possible values are: xs, sm, md and lg |
|
|
402
|
+
| variant | BUTTON_VARIANT | — | Sets the button variant. Possible values are: link, link-inline, outline and action |
|
|
403
|
+
| noRippleEffect | boolean | — | Whether the "ripple" effect should be suppressed on this button. |
|
|
404
|
+
| tabIndex | number | 0 | Number of the index used for keyboard support. |
|
|
405
|
+
| className | string | — | Additional classes to be set on the button element. |
|
|
406
|
+
|
|
407
|
+
#### Props: Regular button
|
|
408
|
+
|
|
409
|
+
### Regular button
|
|
410
|
+
|
|
411
|
+
| Name | Type | Default | Description |
|
|
412
|
+
| --- | --- | --- | --- |
|
|
413
|
+
| asToggle | false | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
414
|
+
| onClick | (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function triggered when clicking the button. |
|
|
415
|
+
|
|
416
|
+
#### Props: ToggleButton
|
|
417
|
+
|
|
418
|
+
### ToggleButton
|
|
419
|
+
|
|
420
|
+
| Name | Type | Default | Description |
|
|
421
|
+
| --- | --- | --- | --- |
|
|
422
|
+
| asToggle | true | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
423
|
+
| onClick | (value: boolean) => void | — | Callback function triggered when clicking the button. |
|
|
388
424
|
|
|
389
425
|
### Example: Button group
|
|
390
426
|
|
|
@@ -535,20 +571,38 @@ export default () => (
|
|
|
535
571
|
|
|
536
572
|
| Name | Type | Default | Description |
|
|
537
573
|
| --- | --- | --- | --- |
|
|
538
|
-
| disabled |
|
|
539
|
-
| active |
|
|
540
|
-
|
|
|
541
|
-
| iconOnly |
|
|
542
|
-
|
|
|
543
|
-
|
|
|
544
|
-
| multiline |
|
|
545
|
-
| block |
|
|
546
|
-
|
|
|
547
|
-
|
|
|
548
|
-
|
|
|
549
|
-
|
|
|
550
|
-
|
|
|
551
|
-
|
|
|
574
|
+
| disabled | boolean | false | Whether the button should be disabled. |
|
|
575
|
+
| active | boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
|
|
576
|
+
| type | 'button' \| 'submit' | 'button' | Defines the type of the button. This may be used for form submit buttons. |
|
|
577
|
+
| iconOnly | boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
|
|
578
|
+
| iconRight | boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
|
|
579
|
+
| iconName | string | — | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
|
|
580
|
+
| multiline | boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
|
|
581
|
+
| block | boolean | false | Defines whether the button takes up the full width of the parent element. |
|
|
582
|
+
| bsStyle | BUTTON_STYLE | "default" | Sets the button style. Possible values are: default, unstyled, primary, secondary, info, warning, danger, success, muted and muted-filled |
|
|
583
|
+
| bsSize | BUTTON_SIZE | — | Sets the button size. Possible values are: xs, sm, md and lg |
|
|
584
|
+
| variant | BUTTON_VARIANT | — | Sets the button variant. Possible values are: link, link-inline, outline and action |
|
|
585
|
+
| noRippleEffect | boolean | — | Whether the "ripple" effect should be suppressed on this button. |
|
|
586
|
+
| tabIndex | number | 0 | Number of the index used for keyboard support. |
|
|
587
|
+
| className | string | — | Additional classes to be set on the button element. |
|
|
588
|
+
|
|
589
|
+
#### Props: Regular button
|
|
590
|
+
|
|
591
|
+
### Regular button
|
|
592
|
+
|
|
593
|
+
| Name | Type | Default | Description |
|
|
594
|
+
| --- | --- | --- | --- |
|
|
595
|
+
| asToggle | false | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
596
|
+
| onClick | (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function triggered when clicking the button. |
|
|
597
|
+
|
|
598
|
+
#### Props: ToggleButton
|
|
599
|
+
|
|
600
|
+
### ToggleButton
|
|
601
|
+
|
|
602
|
+
| Name | Type | Default | Description |
|
|
603
|
+
| --- | --- | --- | --- |
|
|
604
|
+
| asToggle | true | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
605
|
+
| onClick | (value: boolean) => void | — | Callback function triggered when clicking the button. |
|
|
552
606
|
|
|
553
607
|
### Example: Outlined buttons (transparent)
|
|
554
608
|
|
|
@@ -638,20 +692,38 @@ export default () => (
|
|
|
638
692
|
|
|
639
693
|
| Name | Type | Default | Description |
|
|
640
694
|
| --- | --- | --- | --- |
|
|
641
|
-
| disabled |
|
|
642
|
-
| active |
|
|
643
|
-
|
|
|
644
|
-
| iconOnly |
|
|
645
|
-
|
|
|
646
|
-
|
|
|
647
|
-
| multiline |
|
|
648
|
-
| block |
|
|
649
|
-
|
|
|
650
|
-
|
|
|
651
|
-
|
|
|
652
|
-
|
|
|
653
|
-
|
|
|
654
|
-
|
|
|
695
|
+
| disabled | boolean | false | Whether the button should be disabled. |
|
|
696
|
+
| active | boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
|
|
697
|
+
| type | 'button' \| 'submit' | 'button' | Defines the type of the button. This may be used for form submit buttons. |
|
|
698
|
+
| iconOnly | boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
|
|
699
|
+
| iconRight | boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
|
|
700
|
+
| iconName | string | — | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
|
|
701
|
+
| multiline | boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
|
|
702
|
+
| block | boolean | false | Defines whether the button takes up the full width of the parent element. |
|
|
703
|
+
| bsStyle | BUTTON_STYLE | "default" | Sets the button style. Possible values are: default, unstyled, primary, secondary, info, warning, danger, success, muted and muted-filled |
|
|
704
|
+
| bsSize | BUTTON_SIZE | — | Sets the button size. Possible values are: xs, sm, md and lg |
|
|
705
|
+
| variant | BUTTON_VARIANT | — | Sets the button variant. Possible values are: link, link-inline, outline and action |
|
|
706
|
+
| noRippleEffect | boolean | — | Whether the "ripple" effect should be suppressed on this button. |
|
|
707
|
+
| tabIndex | number | 0 | Number of the index used for keyboard support. |
|
|
708
|
+
| className | string | — | Additional classes to be set on the button element. |
|
|
709
|
+
|
|
710
|
+
#### Props: Regular button
|
|
711
|
+
|
|
712
|
+
### Regular button
|
|
713
|
+
|
|
714
|
+
| Name | Type | Default | Description |
|
|
715
|
+
| --- | --- | --- | --- |
|
|
716
|
+
| asToggle | false | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
717
|
+
| onClick | (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function triggered when clicking the button. |
|
|
718
|
+
|
|
719
|
+
#### Props: ToggleButton
|
|
720
|
+
|
|
721
|
+
### ToggleButton
|
|
722
|
+
|
|
723
|
+
| Name | Type | Default | Description |
|
|
724
|
+
| --- | --- | --- | --- |
|
|
725
|
+
| asToggle | true | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
726
|
+
| onClick | (value: boolean) => void | — | Callback function triggered when clicking the button. |
|
|
655
727
|
|
|
656
728
|
### Example: Action buttons
|
|
657
729
|
|
|
@@ -759,17 +831,35 @@ export default () => (
|
|
|
759
831
|
|
|
760
832
|
| Name | Type | Default | Description |
|
|
761
833
|
| --- | --- | --- | --- |
|
|
762
|
-
| disabled |
|
|
763
|
-
| active |
|
|
764
|
-
|
|
|
765
|
-
| iconOnly |
|
|
766
|
-
|
|
|
767
|
-
|
|
|
768
|
-
| multiline |
|
|
769
|
-
| block |
|
|
770
|
-
|
|
|
771
|
-
|
|
|
772
|
-
|
|
|
773
|
-
|
|
|
774
|
-
|
|
|
775
|
-
|
|
|
834
|
+
| disabled | boolean | false | Whether the button should be disabled. |
|
|
835
|
+
| active | boolean | false | Set the button toggled. Should be used in combination with "asToggle" prop. |
|
|
836
|
+
| type | 'button' \| 'submit' | 'button' | Defines the type of the button. This may be used for form submit buttons. |
|
|
837
|
+
| iconOnly | boolean | false | Use when the content of the button is an icon only to adapt the button spacing accordingly. |
|
|
838
|
+
| iconRight | boolean | false | Adds right side spacing for an icon. This should be used when having navigation buttons that use an icon on the right side. |
|
|
839
|
+
| iconName | string | — | Optional rio-glyph icon name that comes in handy for icon only buttons for not adding a span tag for the icon which reduces boilerplate code. |
|
|
840
|
+
| multiline | boolean | false | Defines whether the button text break into multiple lines when the button space exceeds. Multiline buttons should be used as exception only. |
|
|
841
|
+
| block | boolean | false | Defines whether the button takes up the full width of the parent element. |
|
|
842
|
+
| bsStyle | BUTTON_STYLE | "default" | Sets the button style. Possible values are: default, unstyled, primary, secondary, info, warning, danger, success, muted and muted-filled |
|
|
843
|
+
| bsSize | BUTTON_SIZE | — | Sets the button size. Possible values are: xs, sm, md and lg |
|
|
844
|
+
| variant | BUTTON_VARIANT | — | Sets the button variant. Possible values are: link, link-inline, outline and action |
|
|
845
|
+
| noRippleEffect | boolean | — | Whether the "ripple" effect should be suppressed on this button. |
|
|
846
|
+
| tabIndex | number | 0 | Number of the index used for keyboard support. |
|
|
847
|
+
| className | string | — | Additional classes to be set on the button element. |
|
|
848
|
+
|
|
849
|
+
#### Props: Regular button
|
|
850
|
+
|
|
851
|
+
### Regular button
|
|
852
|
+
|
|
853
|
+
| Name | Type | Default | Description |
|
|
854
|
+
| --- | --- | --- | --- |
|
|
855
|
+
| asToggle | false | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
856
|
+
| onClick | (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Callback function triggered when clicking the button. |
|
|
857
|
+
|
|
858
|
+
#### Props: ToggleButton
|
|
859
|
+
|
|
860
|
+
### ToggleButton
|
|
861
|
+
|
|
862
|
+
| Name | Type | Default | Description |
|
|
863
|
+
| --- | --- | --- | --- |
|
|
864
|
+
| asToggle | true | false | Use the button as a toggle button. The toggle state can be controlled via the active prop. |
|
|
865
|
+
| onClick | (value: boolean) => void | — | Callback function triggered when clicking the button. |
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*Category:* Components
|
|
4
4
|
*Section:* Interaction
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/buttonToolbar
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:10.243Z
|
|
7
7
|
|
|
8
8
|
The ButtonToolbar is a utility component designed to simplify usage and alignment. Its purpose is to ensure consistent spacing.
|
|
9
9
|
|
|
@@ -130,5 +130,5 @@ export default () => (
|
|
|
130
130
|
|
|
131
131
|
| Name | Type | Default | Description |
|
|
132
132
|
| --- | --- | --- | --- |
|
|
133
|
-
| alignment | 'left' \| 'right' \| 'center' \| 'space-between' | — | Align buttons to
|
|
134
|
-
| className |
|
|
133
|
+
| alignment | 'left' \| 'right' \| 'center' \| 'space-between' | — | Align buttons to a defined side or set them apart. |
|
|
134
|
+
| className | string | — | Additional classes set to the outer element. |
|