@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:* Selection
|
|
5
5
|
*Source:* https://uikit.developers.rio.cloud/#components/assetTree
|
|
6
|
-
*Captured:* 2026-
|
|
6
|
+
*Captured:* 2026-02-03T14:04:32.850Z
|
|
7
7
|
|
|
8
8
|
## AssetTree
|
|
9
9
|
|
|
@@ -11,36 +11,36 @@
|
|
|
11
11
|
|
|
12
12
|
Filter
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
5868
|
|
15
15
|
4
|
|
16
16
|
|
|
17
|
-
Group -
|
|
17
|
+
Group - Adrienne Weimann - 60548
|
|
18
18
|
|
|
19
|
-
Group -
|
|
19
|
+
Group - Agnes Homenick - 817311
|
|
20
20
|
|
|
21
|
-
Group -
|
|
21
|
+
Group - Alejandro Little - 593623
|
|
22
22
|
|
|
23
|
-
Group -
|
|
23
|
+
Group - Alexander Kautzer - 58489
|
|
24
24
|
|
|
25
|
-
Group -
|
|
25
|
+
Group - Alexandra McGlynn - 40409
|
|
26
26
|
|
|
27
|
-
Group -
|
|
27
|
+
Group - Allen Feeney - 758310
|
|
28
28
|
|
|
29
|
-
Group -
|
|
29
|
+
Group - Alma Bradtke - 812611
|
|
30
30
|
|
|
31
|
-
Group -
|
|
31
|
+
Group - Alton Becker MD - 390414
|
|
32
32
|
|
|
33
|
-
Group -
|
|
33
|
+
Group - Amber Swift IV - 81856
|
|
34
34
|
|
|
35
|
-
Group -
|
|
35
|
+
Group - Amos Gorczany - 298611
|
|
36
36
|
|
|
37
|
-
Group -
|
|
37
|
+
Group - Amos Hickle - 741010
|
|
38
38
|
|
|
39
|
-
Group -
|
|
39
|
+
Group - Amos Nader - 357510
|
|
40
40
|
|
|
41
|
-
Group -
|
|
41
|
+
Group - Ana Sanford - 221715
|
|
42
42
|
|
|
43
|
-
Group -
|
|
43
|
+
Group - Ana Sporer - 48377
|
|
44
44
|
|
|
45
45
|
200
|
|
46
46
|
|
|
@@ -68,36 +68,36 @@ Asset type filter:
|
|
|
68
68
|
|
|
69
69
|
Filter
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
5868
|
|
72
72
|
4
|
|
73
73
|
|
|
74
|
-
Group -
|
|
74
|
+
Group - Adrienne Weimann - 60548
|
|
75
75
|
|
|
76
|
-
Group -
|
|
76
|
+
Group - Agnes Homenick - 817311
|
|
77
77
|
|
|
78
|
-
Group -
|
|
78
|
+
Group - Alejandro Little - 593623
|
|
79
79
|
|
|
80
|
-
Group -
|
|
80
|
+
Group - Alexander Kautzer - 58489
|
|
81
81
|
|
|
82
|
-
Group -
|
|
82
|
+
Group - Alexandra McGlynn - 40409
|
|
83
83
|
|
|
84
|
-
Group -
|
|
84
|
+
Group - Allen Feeney - 758310
|
|
85
85
|
|
|
86
|
-
Group -
|
|
86
|
+
Group - Alma Bradtke - 812611
|
|
87
87
|
|
|
88
|
-
Group -
|
|
88
|
+
Group - Alton Becker MD - 390414
|
|
89
89
|
|
|
90
|
-
Group -
|
|
90
|
+
Group - Amber Swift IV - 81856
|
|
91
91
|
|
|
92
|
-
Group -
|
|
92
|
+
Group - Amos Gorczany - 298611
|
|
93
93
|
|
|
94
|
-
Group -
|
|
94
|
+
Group - Amos Hickle - 741010
|
|
95
95
|
|
|
96
|
-
Group -
|
|
96
|
+
Group - Amos Nader - 357510
|
|
97
97
|
|
|
98
|
-
Group -
|
|
98
|
+
Group - Ana Sanford - 221715
|
|
99
99
|
|
|
100
|
-
Group -
|
|
100
|
+
Group - Ana Sporer - 48377
|
|
101
101
|
|
|
102
102
|
200
|
|
103
103
|
|
|
@@ -466,35 +466,177 @@ const AssetTreeExample = () => {
|
|
|
466
466
|
export default AssetTreeExample;
|
|
467
467
|
```
|
|
468
468
|
|
|
469
|
+
#### Props: AssetTree
|
|
470
|
+
|
|
471
|
+
### AssetTree
|
|
472
|
+
|
|
473
|
+
| Name | Type | Default | Description |
|
|
474
|
+
| --- | --- | --- | --- |
|
|
475
|
+
| fly | boolean | false | Defines if the component will overlap the body content. |
|
|
476
|
+
| resizable | boolean | true | Defines whether or not the sidebar is resizable. |
|
|
477
|
+
| bordered | boolean | false | Defines whether the component has a border or not. |
|
|
478
|
+
| width | number | 350 | Defines the width of the component. The value is set as inline style. Note: when component is resizable it will take the provided width in px only and convert it to number in case. |
|
|
479
|
+
| minWidth | number | 100 | Defines the minimum width of the component in px that will take effect when resizing. |
|
|
480
|
+
| maxWidth | number | 0 | Defines the maximum width of the component in px that will take effect when resizing. |
|
|
481
|
+
| height | number | — | Defines the height of the component in px. |
|
|
482
|
+
| isOpen | boolean | true | Defines whether the component is open or not. |
|
|
483
|
+
| onToggleTree | (isOpen: boolean) => void | () => {} | Callback for when the tree visibility is toggled. |
|
|
484
|
+
| currentCategoryId | string | — | The id of the category which is currently active and shall be shown. |
|
|
485
|
+
| onCategoryChange | (selectedCategoryId: string) => void | () => {} | Callback for handling change of category. |
|
|
486
|
+
| onResizeEnd | VoidFunction | () => {} | Callback for when the resize is done. |
|
|
487
|
+
| useOffscreen | boolean | false | Defines whether the tree components are rendered offscreen and kept mounted in the DOM. |
|
|
488
|
+
| className | string | — | Additional classes added on the wrapper element. |
|
|
489
|
+
|
|
490
|
+
#### Props: TreeCategory
|
|
491
|
+
|
|
492
|
+
### TreeCategory
|
|
493
|
+
|
|
494
|
+
| Name | Type | Default | Description |
|
|
495
|
+
| --- | --- | --- | --- |
|
|
496
|
+
| id | string | — | A unique identifier for that category. |
|
|
497
|
+
| icon | string | — | The rioglyph icon name for that category. |
|
|
498
|
+
| label | string \| React.ReactNode | — | The optional label for the category which will be shown in a tooltip. |
|
|
499
|
+
| hasSelection | boolean | — | Defines whether or not a selection indicator should be shown. |
|
|
500
|
+
|
|
501
|
+
#### Props: Tree
|
|
502
|
+
|
|
503
|
+
### Tree
|
|
504
|
+
|
|
505
|
+
| Name | Type | Default | Description |
|
|
506
|
+
| --- | --- | --- | --- |
|
|
507
|
+
| groups | TreeGroup[] | [] | The list of groups of the items. If no groups are provided all items are rendered as flat list. |
|
|
508
|
+
| └id | string | — | A unique identifier of a group. |
|
|
509
|
+
| └name | string \| React.ReactNode | — | The name of a group. |
|
|
510
|
+
| └position | 'last' | — | Can be set to "last" to enforce the last position in the tree. |
|
|
511
|
+
| └disabled | boolean | — | Disallows the selection of the group itself. |
|
|
512
|
+
| └icon | string | — | The rioglyph icon name for a group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
513
|
+
| └expandedIcon | string | — | The rioglyph icon name for a expanded group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
514
|
+
| └className | string | — | Additional classes added to the group element. |
|
|
515
|
+
| items | TreeItem[] | [] | The list of items. |
|
|
516
|
+
| └id | string | — | A unique identifier of an item. |
|
|
517
|
+
| └name | string \| TreeItemName | — | The name of an item. Either it is a plain string or an object composed of: firstName and lastName where lastName is mandatory. |
|
|
518
|
+
| └info | string \| React.ReactNode | — | The subline of an item. This can e used to show additional information for that item. |
|
|
519
|
+
| └type | string | — | The primary type of the item. This is also used as the fallback icon name and refers to the name of the respective rioglyph icon (excluding the rioglyph- prefix). |
|
|
520
|
+
| └icon | string \| null | — | Optional icon override for the item. If set to a string (e.g. 'truck'), this icon will be used explicitly. If set to undefined, the type property will be used as the fallback icon. If set to null, no icon will be rendered, even if type is defined. This allows full control over the icon behavior while maintaining backward compatibility with type-based icons. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
521
|
+
| └subType | string | — | Optional sub-type of the item. This refers to the name of an additional rioglyph icon (excluding the rioglyph- prefix), typically used to render a secondary icon next to the primary one (Note: for fuel types better use the pairIcon prop). |
|
|
522
|
+
| └pairIcon | string \| null \| undefined | — | Optional pair icon override for the subType. If set to a string (e.g. 'fuel-gas'), this icon will be used explicitly. If set to undefined, the subType property will be used as the fallback icon. If set to null, no icon will be rendered, even if subType is defined. This allows full control over the icon behavior while maintaining backward compatibility with subType-based icons. |
|
|
523
|
+
| └groupIds | string[] | [] | List of group ids the items is associated with. |
|
|
524
|
+
| └className | string | — | Additional classes added to the item element. |
|
|
525
|
+
| selectedGroups | string[] | [] | List of selected group ids. |
|
|
526
|
+
| selectedItems | string[] | [] | List of selected item ids. |
|
|
527
|
+
| onSelectionChange | ({ items, groups }: SelectionChangeResponse) => void | — | Merged Callback for item and group selection changes. It responds with a selection object that contains the selected itemIds and groupIds: { items: [], groups: [] } |
|
|
528
|
+
| hasMultiselect | boolean | true | Defines the selection behavior of the tree. |
|
|
529
|
+
| showRadioButtons | boolean | false | Defines if the single selection should also show radios. |
|
|
530
|
+
| hideSearch | boolean | false | Defines whether or not the built-in Search is shown. |
|
|
531
|
+
| searchPlaceholder | string | — | The text used as placeholder for the search input. |
|
|
532
|
+
| onSearchChange | (value: string) => void | — | Callback for when the search value changes. |
|
|
533
|
+
| search | React.ReactNode | — | Used to define custom search component which replaces the built-in search. |
|
|
534
|
+
| summary | React.ReactNode | — | Used to define custom asset type counter component which replaces the built-in summary. |
|
|
535
|
+
| hideSummary | boolean | false | Defines whether a summary is shown. |
|
|
536
|
+
| onTypeFilterChange | (currentTypes: string[]) => void | — | Callback triggered when the built-in asset type filter changes. This is only available when the default summary is used. |
|
|
537
|
+
| hideTreeHead | boolean | false | Defines whether the entire area below the search field is shown or not. Note: Disabling the tree head will hide the select all checkbox and the tree options as well as the tree summary. |
|
|
538
|
+
| treeHeaderContent | React.ReactElement | — | Additional custom content that is rendered at the top of the tree component. This can be used for nav pills. |
|
|
539
|
+
| scrollHeight | number | — | Defines the max-height of the scrollable list. |
|
|
540
|
+
| expandedGroups | string[] | — | List of group ids which are expanded. |
|
|
541
|
+
| onExpandGroupsChange | (newExpandedGroups: string[]) => void | — | Callback function triggered when a group expands or collapses. |
|
|
542
|
+
| showEmptyGroups | boolean | true | Defines whether empty groups are shown or not. |
|
|
543
|
+
| treeOptions | React.ReactNode[] | — | Component to offer customization options for the tree. |
|
|
544
|
+
| treeOptionsTooltip | React.ReactNode | — | Tooltip content for the tree options dropdown. |
|
|
545
|
+
| disableAnimation | boolean | false | Disables animation when filtering or using search |
|
|
546
|
+
| virtualizeThreshold | number | 50 | The number of items (including groups and children) used for virtualizing the tree. |
|
|
547
|
+
| overscan | number | 5 | The number of items rendered beyond the visible area of a virtualized tree. |
|
|
548
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
549
|
+
|
|
550
|
+
#### Props: TreeSearch
|
|
551
|
+
|
|
552
|
+
### TreeSearch
|
|
553
|
+
|
|
554
|
+
| Name | Type | Default | Description |
|
|
555
|
+
| --- | --- | --- | --- |
|
|
556
|
+
| value | string | — | The search value to be shown and used for the search. |
|
|
557
|
+
| onChange | (newValue: string, event: React.ChangeEvent \| React.MouseEvent) => void | () => {} | Callback for when the search value changes. |
|
|
558
|
+
| placeholder | string | — | The placeholder text used for the input field. |
|
|
559
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
560
|
+
|
|
561
|
+
#### Props: TreeSummary
|
|
562
|
+
|
|
563
|
+
### TreeSummary
|
|
564
|
+
|
|
565
|
+
| Name | Type | Default | Description |
|
|
566
|
+
| --- | --- | --- | --- |
|
|
567
|
+
| assetCounts | TreeSummaryCounts | — | The object containing various asset type counter. |
|
|
568
|
+
| └truck | number | — | The amount of trucks |
|
|
569
|
+
| └trailer | number | — | The amount of trailers |
|
|
570
|
+
| └bus | number | — | The amount of buses |
|
|
571
|
+
| └van | number | — | The amount of vans |
|
|
572
|
+
| └car | number | — | The amount of cars |
|
|
573
|
+
| └driver | number | — | The amount of drivers |
|
|
574
|
+
| gridCols | number | 4 | The number of grid columns used for the built-in TreeSummaryRow. |
|
|
575
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
576
|
+
|
|
577
|
+
#### Props: TreeSummaryRow
|
|
578
|
+
|
|
579
|
+
### TreeSummaryRow
|
|
580
|
+
|
|
581
|
+
| Name | Type | Default | Description |
|
|
582
|
+
| --- | --- | --- | --- |
|
|
583
|
+
| gridCols | number | 4 | Defined the number of grid columns for a single row. Note, when the amount of children exceed the columns it will wrap around to a new line. |
|
|
584
|
+
|
|
585
|
+
#### Props: TypeCounter
|
|
586
|
+
|
|
587
|
+
### TypeCounter
|
|
588
|
+
|
|
589
|
+
| Name | Type | Default | Description |
|
|
590
|
+
| --- | --- | --- | --- |
|
|
591
|
+
| type | string | — | The item type for that counter. This will be used as a return value for the onClick callback. |
|
|
592
|
+
| icon | string | — | The icon name. Note, when using the built-in generic type counter, the icon name will the same as the item type. So make sure there is a corresponding icon for the defined type. |
|
|
593
|
+
| isActive | boolean | — | Sets the active styling if active |
|
|
594
|
+
| hasFilter | boolean | false | Should be set when there is a type filter set in the tree to style the counter accordingly. |
|
|
595
|
+
| enableActivity | boolean | false | Allows for interactivity. Use this prop when you allow clicking on the counter. |
|
|
596
|
+
| hideOnZero | boolean | false | Defines if the counter is rendered at all when the value is not defined ot 0. |
|
|
597
|
+
| onClick | (type: string) => void | — | Callback function when the counter is clicked. It returns the type value. Make sure the "type" prop is defined to receive the value in the callback. |
|
|
598
|
+
| value | string \| React.ReactNode \| number | — | A custom value to be shown in the counter. |
|
|
599
|
+
|
|
600
|
+
#### Props: TreeOption
|
|
601
|
+
|
|
602
|
+
### TreeOption
|
|
603
|
+
|
|
604
|
+
| Name | Type | Default | Description |
|
|
605
|
+
| --- | --- | --- | --- |
|
|
606
|
+
| isChecked | boolean | false | Defines whether the option is set. |
|
|
607
|
+
| onChange | (event: React.MouseEvent<HTMLDivElement>) => void | — | Callback triggered when option is selected. |
|
|
608
|
+
| label | string \| React.ReactNode | — | The label for the option. |
|
|
609
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
610
|
+
|
|
469
611
|
## AssetTree with single select
|
|
470
612
|
|
|
471
613
|
### Example: Example 2
|
|
472
614
|
|
|
473
|
-
6
|
|
474
615
|
11
|
|
475
616
|
7
|
|
476
|
-
|
|
617
|
+
4
|
|
618
|
+
8
|
|
477
619
|
|
|
478
|
-
My Empty
|
|
620
|
+
My Empty Group4
|
|
479
621
|
|
|
480
|
-
Truck Group
|
|
622
|
+
Truck Group East4
|
|
481
623
|
|
|
482
624
|
Truck Group North9
|
|
483
|
-
N18-
|
|
484
|
-
N18-
|
|
485
|
-
N18-
|
|
486
|
-
N18-
|
|
487
|
-
N18-
|
|
488
|
-
N18-
|
|
489
|
-
N18-
|
|
490
|
-
N18-
|
|
491
|
-
N18-
|
|
625
|
+
N18-G203 / M-AN 1002
|
|
626
|
+
N18-G260 / M-AN 1028
|
|
627
|
+
N18-G314 / M-AN 1006
|
|
628
|
+
N18-G370 / M-AN 1022
|
|
629
|
+
N18-G455 / M-AN 1024
|
|
630
|
+
N18-G502 / M-AN 1014
|
|
631
|
+
N18-G600 / M-AN 1001
|
|
632
|
+
N18-G752 / M-AN 1021
|
|
633
|
+
N18-G990 / M-AN 1015
|
|
492
634
|
|
|
493
|
-
Truck Group
|
|
635
|
+
Truck Group South5
|
|
494
636
|
|
|
495
|
-
Truck Group
|
|
637
|
+
Truck Group West3
|
|
496
638
|
|
|
497
|
-
All my unassigned
|
|
639
|
+
All my unassigned Trucks5
|
|
498
640
|
|
|
499
641
|
Current category:
|
|
500
642
|
assets
|
|
@@ -507,31 +649,31 @@ Truck Group North
|
|
|
507
649
|
|
|
508
650
|
#### Summary
|
|
509
651
|
|
|
510
|
-
6
|
|
511
652
|
11
|
|
512
653
|
7
|
|
513
|
-
|
|
654
|
+
4
|
|
655
|
+
8
|
|
514
656
|
|
|
515
|
-
My Empty
|
|
657
|
+
My Empty Group4
|
|
516
658
|
|
|
517
|
-
Truck Group
|
|
659
|
+
Truck Group East4
|
|
518
660
|
|
|
519
661
|
Truck Group North9
|
|
520
|
-
N18-
|
|
521
|
-
N18-
|
|
522
|
-
N18-
|
|
523
|
-
N18-
|
|
524
|
-
N18-
|
|
525
|
-
N18-
|
|
526
|
-
N18-
|
|
527
|
-
N18-
|
|
528
|
-
N18-
|
|
662
|
+
N18-G203 / M-AN 1002
|
|
663
|
+
N18-G260 / M-AN 1028
|
|
664
|
+
N18-G314 / M-AN 1006
|
|
665
|
+
N18-G370 / M-AN 1022
|
|
666
|
+
N18-G455 / M-AN 1024
|
|
667
|
+
N18-G502 / M-AN 1014
|
|
668
|
+
N18-G600 / M-AN 1001
|
|
669
|
+
N18-G752 / M-AN 1021
|
|
670
|
+
N18-G990 / M-AN 1015
|
|
529
671
|
|
|
530
|
-
Truck Group
|
|
672
|
+
Truck Group South5
|
|
531
673
|
|
|
532
|
-
Truck Group
|
|
674
|
+
Truck Group West3
|
|
533
675
|
|
|
534
|
-
All my unassigned
|
|
676
|
+
All my unassigned Trucks5
|
|
535
677
|
|
|
536
678
|
Current category:
|
|
537
679
|
assets
|
|
@@ -730,22 +872,22 @@ export default AssetTreeSingleSelectExample;
|
|
|
730
872
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
731
873
|
<span class="rioglyph rioglyph-trailer text-size-16 margin-right-2">
|
|
732
874
|
</span>
|
|
733
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
875
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">11</span>
|
|
734
876
|
</div>
|
|
735
877
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
736
|
-
<span class="rioglyph rioglyph-
|
|
878
|
+
<span class="rioglyph rioglyph-bus text-size-16 margin-right-2">
|
|
737
879
|
</span>
|
|
738
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
880
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">7</span>
|
|
739
881
|
</div>
|
|
740
882
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
741
|
-
<span class="rioglyph rioglyph-
|
|
883
|
+
<span class="rioglyph rioglyph-van text-size-16 margin-right-2">
|
|
742
884
|
</span>
|
|
743
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
885
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">4</span>
|
|
744
886
|
</div>
|
|
745
887
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
746
|
-
<span class="rioglyph rioglyph-
|
|
888
|
+
<span class="rioglyph rioglyph-truck text-size-16 margin-right-2">
|
|
747
889
|
</span>
|
|
748
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
890
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">8</span>
|
|
749
891
|
</div>
|
|
750
892
|
</div>
|
|
751
893
|
</div>
|
|
@@ -758,7 +900,7 @@ export default AssetTreeSingleSelectExample;
|
|
|
758
900
|
<span class="TreeLabelNameText">
|
|
759
901
|
<span class="TreeLabelNameTextHeadline">My Empty Group</span>
|
|
760
902
|
</span>
|
|
761
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
903
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">4</span>
|
|
762
904
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
763
905
|
</span>
|
|
764
906
|
</span>
|
|
@@ -770,7 +912,7 @@ export default AssetTreeSingleSelectExample;
|
|
|
770
912
|
<span class="TreeLabelNameText">
|
|
771
913
|
<span class="TreeLabelNameTextHeadline">Truck Group East</span>
|
|
772
914
|
</span>
|
|
773
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
915
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">4</span>
|
|
774
916
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
775
917
|
</span>
|
|
776
918
|
</span>
|
|
@@ -787,84 +929,84 @@ export default AssetTreeSingleSelectExample;
|
|
|
787
929
|
</span>
|
|
788
930
|
</span>
|
|
789
931
|
</div>
|
|
790
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
932
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d972">
|
|
791
933
|
<span class="TreeLabel TreeLabelName">
|
|
792
934
|
<span class="rioglyph rioglyph-trailer">
|
|
793
935
|
</span>
|
|
794
936
|
<span class="TreeLabelNameText">
|
|
795
|
-
<span class="TreeLabelNameTextHeadline">N18-
|
|
937
|
+
<span class="TreeLabelNameTextHeadline">N18-G203 / M-AN 1002</span>
|
|
796
938
|
</span>
|
|
797
939
|
</span>
|
|
798
940
|
</div>
|
|
799
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
941
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d9728">
|
|
800
942
|
<span class="TreeLabel TreeLabelName">
|
|
801
|
-
<span class="rioglyph rioglyph-
|
|
943
|
+
<span class="rioglyph rioglyph-bus">
|
|
802
944
|
</span>
|
|
803
945
|
<span class="TreeLabelNameText">
|
|
804
|
-
<span class="TreeLabelNameTextHeadline">N18-
|
|
946
|
+
<span class="TreeLabelNameTextHeadline">N18-G260 / M-AN 1028</span>
|
|
805
947
|
</span>
|
|
806
948
|
</span>
|
|
807
949
|
</div>
|
|
808
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
950
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d976">
|
|
809
951
|
<span class="TreeLabel TreeLabelName">
|
|
810
952
|
<span class="rioglyph rioglyph-truck">
|
|
811
953
|
</span>
|
|
812
954
|
<span class="TreeLabelNameText">
|
|
813
|
-
<span class="TreeLabelNameTextHeadline">N18-
|
|
955
|
+
<span class="TreeLabelNameTextHeadline">N18-G314 / M-AN 1006</span>
|
|
814
956
|
</span>
|
|
815
957
|
</span>
|
|
816
958
|
</div>
|
|
817
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
959
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d9722">
|
|
818
960
|
<span class="TreeLabel TreeLabelName">
|
|
819
|
-
<span class="rioglyph rioglyph-
|
|
961
|
+
<span class="rioglyph rioglyph-bus">
|
|
820
962
|
</span>
|
|
821
963
|
<span class="TreeLabelNameText">
|
|
822
|
-
<span class="TreeLabelNameTextHeadline">N18-
|
|
964
|
+
<span class="TreeLabelNameTextHeadline">N18-G370 / M-AN 1022</span>
|
|
823
965
|
</span>
|
|
824
966
|
</span>
|
|
825
967
|
</div>
|
|
826
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
968
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d9724">
|
|
827
969
|
<span class="TreeLabel TreeLabelName">
|
|
828
|
-
<span class="rioglyph rioglyph-
|
|
970
|
+
<span class="rioglyph rioglyph-van">
|
|
829
971
|
</span>
|
|
830
972
|
<span class="TreeLabelNameText">
|
|
831
|
-
<span class="TreeLabelNameTextHeadline">N18-
|
|
973
|
+
<span class="TreeLabelNameTextHeadline">N18-G455 / M-AN 1024</span>
|
|
832
974
|
</span>
|
|
833
975
|
</span>
|
|
834
976
|
</div>
|
|
835
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
977
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d9714">
|
|
836
978
|
<span class="TreeLabel TreeLabelName">
|
|
837
|
-
<span class="rioglyph rioglyph-
|
|
979
|
+
<span class="rioglyph rioglyph-truck">
|
|
838
980
|
</span>
|
|
839
981
|
<span class="TreeLabelNameText">
|
|
840
|
-
<span class="TreeLabelNameTextHeadline">N18-
|
|
982
|
+
<span class="TreeLabelNameTextHeadline">N18-G502 / M-AN 1014</span>
|
|
841
983
|
</span>
|
|
842
984
|
</span>
|
|
843
985
|
</div>
|
|
844
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
986
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d971">
|
|
845
987
|
<span class="TreeLabel TreeLabelName">
|
|
846
|
-
<span class="rioglyph rioglyph-
|
|
988
|
+
<span class="rioglyph rioglyph-bus">
|
|
847
989
|
</span>
|
|
848
990
|
<span class="TreeLabelNameText">
|
|
849
|
-
<span class="TreeLabelNameTextHeadline">N18-
|
|
991
|
+
<span class="TreeLabelNameTextHeadline">N18-G600 / M-AN 1001</span>
|
|
850
992
|
</span>
|
|
851
993
|
</span>
|
|
852
994
|
</div>
|
|
853
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
995
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d9721">
|
|
854
996
|
<span class="TreeLabel TreeLabelName">
|
|
855
|
-
<span class="rioglyph rioglyph-
|
|
997
|
+
<span class="rioglyph rioglyph-trailer">
|
|
856
998
|
</span>
|
|
857
999
|
<span class="TreeLabelNameText">
|
|
858
|
-
<span class="TreeLabelNameTextHeadline">N18-
|
|
1000
|
+
<span class="TreeLabelNameTextHeadline">N18-G752 / M-AN 1021</span>
|
|
859
1001
|
</span>
|
|
860
1002
|
</span>
|
|
861
1003
|
</div>
|
|
862
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1004
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d9715">
|
|
863
1005
|
<span class="TreeLabel TreeLabelName">
|
|
864
1006
|
<span class="rioglyph rioglyph-bus">
|
|
865
1007
|
</span>
|
|
866
1008
|
<span class="TreeLabelNameText">
|
|
867
|
-
<span class="TreeLabelNameTextHeadline">N18-
|
|
1009
|
+
<span class="TreeLabelNameTextHeadline">N18-G990 / M-AN 1015</span>
|
|
868
1010
|
</span>
|
|
869
1011
|
</span>
|
|
870
1012
|
</div>
|
|
@@ -875,7 +1017,7 @@ export default AssetTreeSingleSelectExample;
|
|
|
875
1017
|
<span class="TreeLabelNameText">
|
|
876
1018
|
<span class="TreeLabelNameTextHeadline">Truck Group South</span>
|
|
877
1019
|
</span>
|
|
878
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
1020
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">5</span>
|
|
879
1021
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
880
1022
|
</span>
|
|
881
1023
|
</span>
|
|
@@ -887,7 +1029,7 @@ export default AssetTreeSingleSelectExample;
|
|
|
887
1029
|
<span class="TreeLabelNameText">
|
|
888
1030
|
<span class="TreeLabelNameTextHeadline">Truck Group West</span>
|
|
889
1031
|
</span>
|
|
890
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
1032
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">3</span>
|
|
891
1033
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
892
1034
|
</span>
|
|
893
1035
|
</span>
|
|
@@ -899,7 +1041,7 @@ export default AssetTreeSingleSelectExample;
|
|
|
899
1041
|
<span class="TreeLabelNameText">
|
|
900
1042
|
<span class="TreeLabelNameTextHeadline">All my unassigned Trucks</span>
|
|
901
1043
|
</span>
|
|
902
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
1044
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">5</span>
|
|
903
1045
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
904
1046
|
</span>
|
|
905
1047
|
</span>
|
|
@@ -940,33 +1082,174 @@ export default AssetTreeSingleSelectExample;
|
|
|
940
1082
|
</div>
|
|
941
1083
|
```
|
|
942
1084
|
|
|
1085
|
+
#### Props: AssetTree
|
|
1086
|
+
|
|
1087
|
+
### AssetTree
|
|
1088
|
+
|
|
1089
|
+
| Name | Type | Default | Description |
|
|
1090
|
+
| --- | --- | --- | --- |
|
|
1091
|
+
| fly | boolean | false | Defines if the component will overlap the body content. |
|
|
1092
|
+
| resizable | boolean | true | Defines whether or not the sidebar is resizable. |
|
|
1093
|
+
| bordered | boolean | false | Defines whether the component has a border or not. |
|
|
1094
|
+
| width | number | 350 | Defines the width of the component. The value is set as inline style. Note: when component is resizable it will take the provided width in px only and convert it to number in case. |
|
|
1095
|
+
| minWidth | number | 100 | Defines the minimum width of the component in px that will take effect when resizing. |
|
|
1096
|
+
| maxWidth | number | 0 | Defines the maximum width of the component in px that will take effect when resizing. |
|
|
1097
|
+
| height | number | — | Defines the height of the component in px. |
|
|
1098
|
+
| isOpen | boolean | true | Defines whether the component is open or not. |
|
|
1099
|
+
| onToggleTree | (isOpen: boolean) => void | () => {} | Callback for when the tree visibility is toggled. |
|
|
1100
|
+
| currentCategoryId | string | — | The id of the category which is currently active and shall be shown. |
|
|
1101
|
+
| onCategoryChange | (selectedCategoryId: string) => void | () => {} | Callback for handling change of category. |
|
|
1102
|
+
| onResizeEnd | VoidFunction | () => {} | Callback for when the resize is done. |
|
|
1103
|
+
| useOffscreen | boolean | false | Defines whether the tree components are rendered offscreen and kept mounted in the DOM. |
|
|
1104
|
+
| className | string | — | Additional classes added on the wrapper element. |
|
|
1105
|
+
|
|
1106
|
+
#### Props: TreeCategory
|
|
1107
|
+
|
|
1108
|
+
### TreeCategory
|
|
1109
|
+
|
|
1110
|
+
| Name | Type | Default | Description |
|
|
1111
|
+
| --- | --- | --- | --- |
|
|
1112
|
+
| id | string | — | A unique identifier for that category. |
|
|
1113
|
+
| icon | string | — | The rioglyph icon name for that category. |
|
|
1114
|
+
| label | string \| React.ReactNode | — | The optional label for the category which will be shown in a tooltip. |
|
|
1115
|
+
| hasSelection | boolean | — | Defines whether or not a selection indicator should be shown. |
|
|
1116
|
+
|
|
1117
|
+
#### Props: Tree
|
|
1118
|
+
|
|
1119
|
+
### Tree
|
|
1120
|
+
|
|
1121
|
+
| Name | Type | Default | Description |
|
|
1122
|
+
| --- | --- | --- | --- |
|
|
1123
|
+
| groups | TreeGroup[] | [] | The list of groups of the items. If no groups are provided all items are rendered as flat list. |
|
|
1124
|
+
| └id | string | — | A unique identifier of a group. |
|
|
1125
|
+
| └name | string \| React.ReactNode | — | The name of a group. |
|
|
1126
|
+
| └position | 'last' | — | Can be set to "last" to enforce the last position in the tree. |
|
|
1127
|
+
| └disabled | boolean | — | Disallows the selection of the group itself. |
|
|
1128
|
+
| └icon | string | — | The rioglyph icon name for a group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
1129
|
+
| └expandedIcon | string | — | The rioglyph icon name for a expanded group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
1130
|
+
| └className | string | — | Additional classes added to the group element. |
|
|
1131
|
+
| items | TreeItem[] | [] | The list of items. |
|
|
1132
|
+
| └id | string | — | A unique identifier of an item. |
|
|
1133
|
+
| └name | string \| TreeItemName | — | The name of an item. Either it is a plain string or an object composed of: firstName and lastName where lastName is mandatory. |
|
|
1134
|
+
| └info | string \| React.ReactNode | — | The subline of an item. This can e used to show additional information for that item. |
|
|
1135
|
+
| └type | string | — | The primary type of the item. This is also used as the fallback icon name and refers to the name of the respective rioglyph icon (excluding the rioglyph- prefix). |
|
|
1136
|
+
| └icon | string \| null | — | Optional icon override for the item. If set to a string (e.g. 'truck'), this icon will be used explicitly. If set to undefined, the type property will be used as the fallback icon. If set to null, no icon will be rendered, even if type is defined. This allows full control over the icon behavior while maintaining backward compatibility with type-based icons. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
1137
|
+
| └subType | string | — | Optional sub-type of the item. This refers to the name of an additional rioglyph icon (excluding the rioglyph- prefix), typically used to render a secondary icon next to the primary one (Note: for fuel types better use the pairIcon prop). |
|
|
1138
|
+
| └pairIcon | string \| null \| undefined | — | Optional pair icon override for the subType. If set to a string (e.g. 'fuel-gas'), this icon will be used explicitly. If set to undefined, the subType property will be used as the fallback icon. If set to null, no icon will be rendered, even if subType is defined. This allows full control over the icon behavior while maintaining backward compatibility with subType-based icons. |
|
|
1139
|
+
| └groupIds | string[] | [] | List of group ids the items is associated with. |
|
|
1140
|
+
| └className | string | — | Additional classes added to the item element. |
|
|
1141
|
+
| selectedGroups | string[] | [] | List of selected group ids. |
|
|
1142
|
+
| selectedItems | string[] | [] | List of selected item ids. |
|
|
1143
|
+
| onSelectionChange | ({ items, groups }: SelectionChangeResponse) => void | — | Merged Callback for item and group selection changes. It responds with a selection object that contains the selected itemIds and groupIds: { items: [], groups: [] } |
|
|
1144
|
+
| hasMultiselect | boolean | true | Defines the selection behavior of the tree. |
|
|
1145
|
+
| showRadioButtons | boolean | false | Defines if the single selection should also show radios. |
|
|
1146
|
+
| hideSearch | boolean | false | Defines whether or not the built-in Search is shown. |
|
|
1147
|
+
| searchPlaceholder | string | — | The text used as placeholder for the search input. |
|
|
1148
|
+
| onSearchChange | (value: string) => void | — | Callback for when the search value changes. |
|
|
1149
|
+
| search | React.ReactNode | — | Used to define custom search component which replaces the built-in search. |
|
|
1150
|
+
| summary | React.ReactNode | — | Used to define custom asset type counter component which replaces the built-in summary. |
|
|
1151
|
+
| hideSummary | boolean | false | Defines whether a summary is shown. |
|
|
1152
|
+
| onTypeFilterChange | (currentTypes: string[]) => void | — | Callback triggered when the built-in asset type filter changes. This is only available when the default summary is used. |
|
|
1153
|
+
| hideTreeHead | boolean | false | Defines whether the entire area below the search field is shown or not. Note: Disabling the tree head will hide the select all checkbox and the tree options as well as the tree summary. |
|
|
1154
|
+
| treeHeaderContent | React.ReactElement | — | Additional custom content that is rendered at the top of the tree component. This can be used for nav pills. |
|
|
1155
|
+
| scrollHeight | number | — | Defines the max-height of the scrollable list. |
|
|
1156
|
+
| expandedGroups | string[] | — | List of group ids which are expanded. |
|
|
1157
|
+
| onExpandGroupsChange | (newExpandedGroups: string[]) => void | — | Callback function triggered when a group expands or collapses. |
|
|
1158
|
+
| showEmptyGroups | boolean | true | Defines whether empty groups are shown or not. |
|
|
1159
|
+
| treeOptions | React.ReactNode[] | — | Component to offer customization options for the tree. |
|
|
1160
|
+
| treeOptionsTooltip | React.ReactNode | — | Tooltip content for the tree options dropdown. |
|
|
1161
|
+
| disableAnimation | boolean | false | Disables animation when filtering or using search |
|
|
1162
|
+
| virtualizeThreshold | number | 50 | The number of items (including groups and children) used for virtualizing the tree. |
|
|
1163
|
+
| overscan | number | 5 | The number of items rendered beyond the visible area of a virtualized tree. |
|
|
1164
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
1165
|
+
|
|
1166
|
+
#### Props: TreeSearch
|
|
1167
|
+
|
|
1168
|
+
### TreeSearch
|
|
1169
|
+
|
|
1170
|
+
| Name | Type | Default | Description |
|
|
1171
|
+
| --- | --- | --- | --- |
|
|
1172
|
+
| value | string | — | The search value to be shown and used for the search. |
|
|
1173
|
+
| onChange | (newValue: string, event: React.ChangeEvent \| React.MouseEvent) => void | () => {} | Callback for when the search value changes. |
|
|
1174
|
+
| placeholder | string | — | The placeholder text used for the input field. |
|
|
1175
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
1176
|
+
|
|
1177
|
+
#### Props: TreeSummary
|
|
1178
|
+
|
|
1179
|
+
### TreeSummary
|
|
1180
|
+
|
|
1181
|
+
| Name | Type | Default | Description |
|
|
1182
|
+
| --- | --- | --- | --- |
|
|
1183
|
+
| assetCounts | TreeSummaryCounts | — | The object containing various asset type counter. |
|
|
1184
|
+
| └truck | number | — | The amount of trucks |
|
|
1185
|
+
| └trailer | number | — | The amount of trailers |
|
|
1186
|
+
| └bus | number | — | The amount of buses |
|
|
1187
|
+
| └van | number | — | The amount of vans |
|
|
1188
|
+
| └car | number | — | The amount of cars |
|
|
1189
|
+
| └driver | number | — | The amount of drivers |
|
|
1190
|
+
| gridCols | number | 4 | The number of grid columns used for the built-in TreeSummaryRow. |
|
|
1191
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
1192
|
+
|
|
1193
|
+
#### Props: TreeSummaryRow
|
|
1194
|
+
|
|
1195
|
+
### TreeSummaryRow
|
|
1196
|
+
|
|
1197
|
+
| Name | Type | Default | Description |
|
|
1198
|
+
| --- | --- | --- | --- |
|
|
1199
|
+
| gridCols | number | 4 | Defined the number of grid columns for a single row. Note, when the amount of children exceed the columns it will wrap around to a new line. |
|
|
1200
|
+
|
|
1201
|
+
#### Props: TypeCounter
|
|
1202
|
+
|
|
1203
|
+
### TypeCounter
|
|
1204
|
+
|
|
1205
|
+
| Name | Type | Default | Description |
|
|
1206
|
+
| --- | --- | --- | --- |
|
|
1207
|
+
| type | string | — | The item type for that counter. This will be used as a return value for the onClick callback. |
|
|
1208
|
+
| icon | string | — | The icon name. Note, when using the built-in generic type counter, the icon name will the same as the item type. So make sure there is a corresponding icon for the defined type. |
|
|
1209
|
+
| isActive | boolean | — | Sets the active styling if active |
|
|
1210
|
+
| hasFilter | boolean | false | Should be set when there is a type filter set in the tree to style the counter accordingly. |
|
|
1211
|
+
| enableActivity | boolean | false | Allows for interactivity. Use this prop when you allow clicking on the counter. |
|
|
1212
|
+
| hideOnZero | boolean | false | Defines if the counter is rendered at all when the value is not defined ot 0. |
|
|
1213
|
+
| onClick | (type: string) => void | — | Callback function when the counter is clicked. It returns the type value. Make sure the "type" prop is defined to receive the value in the callback. |
|
|
1214
|
+
| value | string \| React.ReactNode \| number | — | A custom value to be shown in the counter. |
|
|
1215
|
+
|
|
1216
|
+
#### Props: TreeOption
|
|
1217
|
+
|
|
1218
|
+
### TreeOption
|
|
1219
|
+
|
|
1220
|
+
| Name | Type | Default | Description |
|
|
1221
|
+
| --- | --- | --- | --- |
|
|
1222
|
+
| isChecked | boolean | false | Defines whether the option is set. |
|
|
1223
|
+
| onChange | (event: React.MouseEvent<HTMLDivElement>) => void | — | Callback triggered when option is selected. |
|
|
1224
|
+
| label | string \| React.ReactNode | — | The label for the option. |
|
|
1225
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
1226
|
+
|
|
943
1227
|
## AssetTree with multiple asset filter in summary
|
|
944
1228
|
|
|
945
1229
|
### Example: Example 3
|
|
946
1230
|
|
|
947
|
-
|
|
948
|
-
4
|
|
949
|
-
4
|
|
1231
|
+
9
|
|
950
1232
|
7
|
|
1233
|
+
3
|
|
1234
|
+
1
|
|
951
1235
|
|
|
952
1236
|
8
|
|
953
|
-
|
|
1237
|
+
7
|
|
1238
|
+
1
|
|
954
1239
|
2
|
|
955
1240
|
2
|
|
956
|
-
3
|
|
957
1241
|
|
|
958
|
-
Mixed
|
|
959
|
-
Vehicle-
|
|
960
|
-
Vehicle-
|
|
961
|
-
Vehicle-
|
|
962
|
-
Vehicle-
|
|
963
|
-
Vehicle-
|
|
964
|
-
Vehicle-
|
|
965
|
-
Vehicle-
|
|
966
|
-
Vehicle-
|
|
967
|
-
Vehicle-8794Debug: dual_fuel_diesel_cng
|
|
1242
|
+
Mixed Vehicles8
|
|
1243
|
+
Vehicle-1670Debug: hydrogen
|
|
1244
|
+
Vehicle-2011Debug: diesel
|
|
1245
|
+
Vehicle-3346Debug: dual_fuel_diesel_cng
|
|
1246
|
+
Vehicle-3670Debug: lpg
|
|
1247
|
+
Vehicle-5464Debug: cng
|
|
1248
|
+
Vehicle-6229Debug: lpg
|
|
1249
|
+
Vehicle-6521Debug: cng
|
|
1250
|
+
Vehicle-7377Debug: gas
|
|
968
1251
|
|
|
969
|
-
|
|
1252
|
+
Ungrouped12
|
|
970
1253
|
|
|
971
1254
|
Selected groups:
|
|
972
1255
|
|
|
@@ -977,29 +1260,28 @@ Mixed Vehicles
|
|
|
977
1260
|
|
|
978
1261
|
#### Summary
|
|
979
1262
|
|
|
980
|
-
|
|
981
|
-
4
|
|
982
|
-
4
|
|
1263
|
+
9
|
|
983
1264
|
7
|
|
1265
|
+
3
|
|
1266
|
+
1
|
|
984
1267
|
|
|
985
1268
|
8
|
|
986
|
-
|
|
1269
|
+
7
|
|
1270
|
+
1
|
|
987
1271
|
2
|
|
988
1272
|
2
|
|
989
|
-
3
|
|
990
1273
|
|
|
991
|
-
Mixed
|
|
992
|
-
Vehicle-
|
|
993
|
-
Vehicle-
|
|
994
|
-
Vehicle-
|
|
995
|
-
Vehicle-
|
|
996
|
-
Vehicle-
|
|
997
|
-
Vehicle-
|
|
998
|
-
Vehicle-
|
|
999
|
-
Vehicle-
|
|
1000
|
-
Vehicle-8794Debug: dual_fuel_diesel_cng
|
|
1274
|
+
Mixed Vehicles8
|
|
1275
|
+
Vehicle-1670Debug: hydrogen
|
|
1276
|
+
Vehicle-2011Debug: diesel
|
|
1277
|
+
Vehicle-3346Debug: dual_fuel_diesel_cng
|
|
1278
|
+
Vehicle-3670Debug: lpg
|
|
1279
|
+
Vehicle-5464Debug: cng
|
|
1280
|
+
Vehicle-6229Debug: lpg
|
|
1281
|
+
Vehicle-6521Debug: cng
|
|
1282
|
+
Vehicle-7377Debug: gas
|
|
1001
1283
|
|
|
1002
|
-
|
|
1284
|
+
Ungrouped12
|
|
1003
1285
|
|
|
1004
1286
|
Selected groups:
|
|
1005
1287
|
|
|
@@ -1334,22 +1616,22 @@ export default AssetTreeExample;
|
|
|
1334
1616
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1335
1617
|
<span class="rioglyph rioglyph-truck-baseline text-size-16 margin-right-2">
|
|
1336
1618
|
</span>
|
|
1337
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
1619
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">9</span>
|
|
1338
1620
|
</div>
|
|
1339
1621
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1340
1622
|
<span class="rioglyph rioglyph-bus-baseline text-size-16 margin-right-2">
|
|
1341
1623
|
</span>
|
|
1342
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
1624
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">7</span>
|
|
1343
1625
|
</div>
|
|
1344
1626
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1345
1627
|
<span class="rioglyph rioglyph-van-baseline text-size-16 margin-right-2">
|
|
1346
1628
|
</span>
|
|
1347
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
1629
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">3</span>
|
|
1348
1630
|
</div>
|
|
1349
1631
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1350
1632
|
<span class="rioglyph rioglyph-car-baseline text-size-16 margin-right-2">
|
|
1351
1633
|
</span>
|
|
1352
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
1634
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">1</span>
|
|
1353
1635
|
</div>
|
|
1354
1636
|
</div>
|
|
1355
1637
|
<div class="TreeSummaryRow display-grid grid-cols-4 gap-10">
|
|
@@ -1361,12 +1643,12 @@ export default AssetTreeExample;
|
|
|
1361
1643
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1362
1644
|
<span class="rioglyph rioglyph-fuel-gas text-size-16 margin-right-2">
|
|
1363
1645
|
</span>
|
|
1364
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
1646
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">7</span>
|
|
1365
1647
|
</div>
|
|
1366
1648
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1367
1649
|
<span class="rioglyph rioglyph-fuel-electric text-size-16 margin-right-2">
|
|
1368
1650
|
</span>
|
|
1369
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
1651
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">1</span>
|
|
1370
1652
|
</div>
|
|
1371
1653
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1372
1654
|
<span class="rioglyph rioglyph-fuel-hydrogen text-size-16 margin-right-2">
|
|
@@ -1376,14 +1658,14 @@ export default AssetTreeExample;
|
|
|
1376
1658
|
<div class="TypeCounter display-flex align-items-center user-select-none margin-right-2 cursor-pointer">
|
|
1377
1659
|
<span class="rioglyph rioglyph-fuel-mix text-size-16 margin-right-2">
|
|
1378
1660
|
</span>
|
|
1379
|
-
<span class="TreeLabelCount label label-condensed label-muted label-filled">
|
|
1661
|
+
<span class="TreeLabelCount label label-condensed label-muted label-filled">2</span>
|
|
1380
1662
|
</div>
|
|
1381
1663
|
</div>
|
|
1382
1664
|
</div>
|
|
1383
1665
|
</div>
|
|
1384
1666
|
<div>
|
|
1385
1667
|
<div class="dropdown btn-group TreeHeaderOptions height-20">
|
|
1386
|
-
<button type="button" id="
|
|
1668
|
+
<button type="button" id="ujryythjcze" class="btn btn-default btn-sm btn-icon-only btn-component dropdown-toggle hover-bg-white border-none text-color-gray hover-text-color-dark" tabindex="0">
|
|
1387
1669
|
<span class="rioglyph rioglyph-option-vertical" aria-hidden="true">
|
|
1388
1670
|
</span>
|
|
1389
1671
|
</button>
|
|
@@ -1403,33 +1685,12 @@ export default AssetTreeExample;
|
|
|
1403
1685
|
<span class="TreeLabelNameText">
|
|
1404
1686
|
<span class="TreeLabelNameTextHeadline">Mixed Vehicles</span>
|
|
1405
1687
|
</span>
|
|
1406
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
1688
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">8</span>
|
|
1407
1689
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
1408
1690
|
</span>
|
|
1409
1691
|
</span>
|
|
1410
1692
|
</div>
|
|
1411
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1412
|
-
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1413
|
-
<input type="checkbox" class="TreeCheckbox">
|
|
1414
|
-
<span class="checkbox-text">
|
|
1415
|
-
</span>
|
|
1416
|
-
</label>
|
|
1417
|
-
<span class="TreeLabel TreeLabelName">
|
|
1418
|
-
<span class="rioglyph-icon-pair">
|
|
1419
|
-
<span class="rioglyph rioglyph-van">
|
|
1420
|
-
</span>
|
|
1421
|
-
<span class="rioglyph rioglyph-fuel-gas">
|
|
1422
|
-
</span>
|
|
1423
|
-
</span>
|
|
1424
|
-
<span class="TreeLabelNameText">
|
|
1425
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-2340</span>
|
|
1426
|
-
<span class="TreeLabelNameTextSubline">
|
|
1427
|
-
<span>Debug: cng</span>
|
|
1428
|
-
</span>
|
|
1429
|
-
</span>
|
|
1430
|
-
</span>
|
|
1431
|
-
</div>
|
|
1432
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d972">
|
|
1693
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d978">
|
|
1433
1694
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1434
1695
|
<input type="checkbox" class="TreeCheckbox">
|
|
1435
1696
|
<span class="checkbox-text">
|
|
@@ -1439,18 +1700,18 @@ export default AssetTreeExample;
|
|
|
1439
1700
|
<span class="rioglyph-icon-pair">
|
|
1440
1701
|
<span class="rioglyph rioglyph-van">
|
|
1441
1702
|
</span>
|
|
1442
|
-
<span class="rioglyph rioglyph-fuel-
|
|
1703
|
+
<span class="rioglyph rioglyph-fuel-hydrogen">
|
|
1443
1704
|
</span>
|
|
1444
1705
|
</span>
|
|
1445
1706
|
<span class="TreeLabelNameText">
|
|
1446
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1707
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-1670</span>
|
|
1447
1708
|
<span class="TreeLabelNameTextSubline">
|
|
1448
|
-
<span>Debug:
|
|
1709
|
+
<span>Debug: hydrogen</span>
|
|
1449
1710
|
</span>
|
|
1450
1711
|
</span>
|
|
1451
1712
|
</span>
|
|
1452
1713
|
</div>
|
|
1453
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1714
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d970">
|
|
1454
1715
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1455
1716
|
<input type="checkbox" class="TreeCheckbox">
|
|
1456
1717
|
<span class="checkbox-text">
|
|
@@ -1458,20 +1719,20 @@ export default AssetTreeExample;
|
|
|
1458
1719
|
</label>
|
|
1459
1720
|
<span class="TreeLabel TreeLabelName">
|
|
1460
1721
|
<span class="rioglyph-icon-pair">
|
|
1461
|
-
<span class="rioglyph rioglyph-
|
|
1722
|
+
<span class="rioglyph rioglyph-truck">
|
|
1462
1723
|
</span>
|
|
1463
1724
|
<span class="rioglyph rioglyph-fuel-liquid">
|
|
1464
1725
|
</span>
|
|
1465
1726
|
</span>
|
|
1466
1727
|
<span class="TreeLabelNameText">
|
|
1467
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1728
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-2011</span>
|
|
1468
1729
|
<span class="TreeLabelNameTextSubline">
|
|
1469
|
-
<span>Debug:
|
|
1730
|
+
<span>Debug: diesel</span>
|
|
1470
1731
|
</span>
|
|
1471
1732
|
</span>
|
|
1472
1733
|
</span>
|
|
1473
1734
|
</div>
|
|
1474
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1735
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d9715">
|
|
1475
1736
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1476
1737
|
<input type="checkbox" class="TreeCheckbox">
|
|
1477
1738
|
<span class="checkbox-text">
|
|
@@ -1481,18 +1742,18 @@ export default AssetTreeExample;
|
|
|
1481
1742
|
<span class="rioglyph-icon-pair">
|
|
1482
1743
|
<span class="rioglyph rioglyph-truck">
|
|
1483
1744
|
</span>
|
|
1484
|
-
<span class="rioglyph rioglyph-fuel-
|
|
1745
|
+
<span class="rioglyph rioglyph-fuel-mix">
|
|
1485
1746
|
</span>
|
|
1486
1747
|
</span>
|
|
1487
1748
|
<span class="TreeLabelNameText">
|
|
1488
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1749
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-3346</span>
|
|
1489
1750
|
<span class="TreeLabelNameTextSubline">
|
|
1490
|
-
<span>Debug:
|
|
1751
|
+
<span>Debug: dual_fuel_diesel_cng</span>
|
|
1491
1752
|
</span>
|
|
1492
1753
|
</span>
|
|
1493
1754
|
</span>
|
|
1494
1755
|
</div>
|
|
1495
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1756
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d979">
|
|
1496
1757
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1497
1758
|
<input type="checkbox" class="TreeCheckbox">
|
|
1498
1759
|
<span class="checkbox-text">
|
|
@@ -1502,18 +1763,18 @@ export default AssetTreeExample;
|
|
|
1502
1763
|
<span class="rioglyph-icon-pair">
|
|
1503
1764
|
<span class="rioglyph rioglyph-bus">
|
|
1504
1765
|
</span>
|
|
1505
|
-
<span class="rioglyph rioglyph-fuel-
|
|
1766
|
+
<span class="rioglyph rioglyph-fuel-gas">
|
|
1506
1767
|
</span>
|
|
1507
1768
|
</span>
|
|
1508
1769
|
<span class="TreeLabelNameText">
|
|
1509
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1770
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-3670</span>
|
|
1510
1771
|
<span class="TreeLabelNameTextSubline">
|
|
1511
|
-
<span>Debug:
|
|
1772
|
+
<span>Debug: lpg</span>
|
|
1512
1773
|
</span>
|
|
1513
1774
|
</span>
|
|
1514
1775
|
</span>
|
|
1515
1776
|
</div>
|
|
1516
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1777
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d9717">
|
|
1517
1778
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1518
1779
|
<input type="checkbox" class="TreeCheckbox">
|
|
1519
1780
|
<span class="checkbox-text">
|
|
@@ -1523,18 +1784,18 @@ export default AssetTreeExample;
|
|
|
1523
1784
|
<span class="rioglyph-icon-pair">
|
|
1524
1785
|
<span class="rioglyph rioglyph-truck">
|
|
1525
1786
|
</span>
|
|
1526
|
-
<span class="rioglyph rioglyph-fuel-
|
|
1787
|
+
<span class="rioglyph rioglyph-fuel-gas">
|
|
1527
1788
|
</span>
|
|
1528
1789
|
</span>
|
|
1529
1790
|
<span class="TreeLabelNameText">
|
|
1530
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1791
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-5464</span>
|
|
1531
1792
|
<span class="TreeLabelNameTextSubline">
|
|
1532
|
-
<span>Debug:
|
|
1793
|
+
<span>Debug: cng</span>
|
|
1533
1794
|
</span>
|
|
1534
1795
|
</span>
|
|
1535
1796
|
</span>
|
|
1536
1797
|
</div>
|
|
1537
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1798
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d971">
|
|
1538
1799
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1539
1800
|
<input type="checkbox" class="TreeCheckbox">
|
|
1540
1801
|
<span class="checkbox-text">
|
|
@@ -1542,20 +1803,20 @@ export default AssetTreeExample;
|
|
|
1542
1803
|
</label>
|
|
1543
1804
|
<span class="TreeLabel TreeLabelName">
|
|
1544
1805
|
<span class="rioglyph-icon-pair">
|
|
1545
|
-
<span class="rioglyph rioglyph-
|
|
1806
|
+
<span class="rioglyph rioglyph-truck">
|
|
1546
1807
|
</span>
|
|
1547
1808
|
<span class="rioglyph rioglyph-fuel-gas">
|
|
1548
1809
|
</span>
|
|
1549
1810
|
</span>
|
|
1550
1811
|
<span class="TreeLabelNameText">
|
|
1551
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1812
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-6229</span>
|
|
1552
1813
|
<span class="TreeLabelNameTextSubline">
|
|
1553
|
-
<span>Debug:
|
|
1814
|
+
<span>Debug: lpg</span>
|
|
1554
1815
|
</span>
|
|
1555
1816
|
</span>
|
|
1556
1817
|
</span>
|
|
1557
1818
|
</div>
|
|
1558
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1819
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d976">
|
|
1559
1820
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1560
1821
|
<input type="checkbox" class="TreeCheckbox">
|
|
1561
1822
|
<span class="checkbox-text">
|
|
@@ -1563,20 +1824,20 @@ export default AssetTreeExample;
|
|
|
1563
1824
|
</label>
|
|
1564
1825
|
<span class="TreeLabel TreeLabelName">
|
|
1565
1826
|
<span class="rioglyph-icon-pair">
|
|
1566
|
-
<span class="rioglyph rioglyph-
|
|
1827
|
+
<span class="rioglyph rioglyph-bus">
|
|
1567
1828
|
</span>
|
|
1568
|
-
<span class="rioglyph rioglyph-fuel-
|
|
1829
|
+
<span class="rioglyph rioglyph-fuel-gas">
|
|
1569
1830
|
</span>
|
|
1570
1831
|
</span>
|
|
1571
1832
|
<span class="TreeLabelNameText">
|
|
1572
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1833
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-6521</span>
|
|
1573
1834
|
<span class="TreeLabelNameTextSubline">
|
|
1574
|
-
<span>Debug:
|
|
1835
|
+
<span>Debug: cng</span>
|
|
1575
1836
|
</span>
|
|
1576
1837
|
</span>
|
|
1577
1838
|
</span>
|
|
1578
1839
|
</div>
|
|
1579
|
-
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-
|
|
1840
|
+
<div class="TreeLeaf form-group margin-bottom-0" data-key="010191ac-d06d-4567-b13a-7b7fd85d9719">
|
|
1580
1841
|
<label class="checkbox TreeCheckbox" tabindex="0">
|
|
1581
1842
|
<input type="checkbox" class="TreeCheckbox">
|
|
1582
1843
|
<span class="checkbox-text">
|
|
@@ -1584,15 +1845,15 @@ export default AssetTreeExample;
|
|
|
1584
1845
|
</label>
|
|
1585
1846
|
<span class="TreeLabel TreeLabelName">
|
|
1586
1847
|
<span class="rioglyph-icon-pair">
|
|
1587
|
-
<span class="rioglyph rioglyph-
|
|
1848
|
+
<span class="rioglyph rioglyph-truck">
|
|
1588
1849
|
</span>
|
|
1589
|
-
<span class="rioglyph rioglyph-fuel-
|
|
1850
|
+
<span class="rioglyph rioglyph-fuel-liquid">
|
|
1590
1851
|
</span>
|
|
1591
1852
|
</span>
|
|
1592
1853
|
<span class="TreeLabelNameText">
|
|
1593
|
-
<span class="TreeLabelNameTextHeadline">Vehicle-
|
|
1854
|
+
<span class="TreeLabelNameTextHeadline">Vehicle-7377</span>
|
|
1594
1855
|
<span class="TreeLabelNameTextSubline">
|
|
1595
|
-
<span>Debug:
|
|
1856
|
+
<span>Debug: gas</span>
|
|
1596
1857
|
</span>
|
|
1597
1858
|
</span>
|
|
1598
1859
|
</span>
|
|
@@ -1609,7 +1870,7 @@ export default AssetTreeExample;
|
|
|
1609
1870
|
<span class="TreeLabelNameText">
|
|
1610
1871
|
<span class="TreeLabelNameTextHeadline">Ungrouped</span>
|
|
1611
1872
|
</span>
|
|
1612
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
1873
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">12</span>
|
|
1613
1874
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
1614
1875
|
</span>
|
|
1615
1876
|
</span>
|
|
@@ -1648,6 +1909,148 @@ export default AssetTreeExample;
|
|
|
1648
1909
|
</div>
|
|
1649
1910
|
```
|
|
1650
1911
|
|
|
1912
|
+
#### Props: AssetTree
|
|
1913
|
+
|
|
1914
|
+
### AssetTree
|
|
1915
|
+
|
|
1916
|
+
| Name | Type | Default | Description |
|
|
1917
|
+
| --- | --- | --- | --- |
|
|
1918
|
+
| fly | boolean | false | Defines if the component will overlap the body content. |
|
|
1919
|
+
| resizable | boolean | true | Defines whether or not the sidebar is resizable. |
|
|
1920
|
+
| bordered | boolean | false | Defines whether the component has a border or not. |
|
|
1921
|
+
| width | number | 350 | Defines the width of the component. The value is set as inline style. Note: when component is resizable it will take the provided width in px only and convert it to number in case. |
|
|
1922
|
+
| minWidth | number | 100 | Defines the minimum width of the component in px that will take effect when resizing. |
|
|
1923
|
+
| maxWidth | number | 0 | Defines the maximum width of the component in px that will take effect when resizing. |
|
|
1924
|
+
| height | number | — | Defines the height of the component in px. |
|
|
1925
|
+
| isOpen | boolean | true | Defines whether the component is open or not. |
|
|
1926
|
+
| onToggleTree | (isOpen: boolean) => void | () => {} | Callback for when the tree visibility is toggled. |
|
|
1927
|
+
| currentCategoryId | string | — | The id of the category which is currently active and shall be shown. |
|
|
1928
|
+
| onCategoryChange | (selectedCategoryId: string) => void | () => {} | Callback for handling change of category. |
|
|
1929
|
+
| onResizeEnd | VoidFunction | () => {} | Callback for when the resize is done. |
|
|
1930
|
+
| useOffscreen | boolean | false | Defines whether the tree components are rendered offscreen and kept mounted in the DOM. |
|
|
1931
|
+
| className | string | — | Additional classes added on the wrapper element. |
|
|
1932
|
+
|
|
1933
|
+
#### Props: TreeCategory
|
|
1934
|
+
|
|
1935
|
+
### TreeCategory
|
|
1936
|
+
|
|
1937
|
+
| Name | Type | Default | Description |
|
|
1938
|
+
| --- | --- | --- | --- |
|
|
1939
|
+
| id | string | — | A unique identifier for that category. |
|
|
1940
|
+
| icon | string | — | The rioglyph icon name for that category. |
|
|
1941
|
+
| label | string \| React.ReactNode | — | The optional label for the category which will be shown in a tooltip. |
|
|
1942
|
+
| hasSelection | boolean | — | Defines whether or not a selection indicator should be shown. |
|
|
1943
|
+
|
|
1944
|
+
#### Props: Tree
|
|
1945
|
+
|
|
1946
|
+
### Tree
|
|
1947
|
+
|
|
1948
|
+
| Name | Type | Default | Description |
|
|
1949
|
+
| --- | --- | --- | --- |
|
|
1950
|
+
| groups | TreeGroup[] | [] | The list of groups of the items. If no groups are provided all items are rendered as flat list. |
|
|
1951
|
+
| └id | string | — | A unique identifier of a group. |
|
|
1952
|
+
| └name | string \| React.ReactNode | — | The name of a group. |
|
|
1953
|
+
| └position | 'last' | — | Can be set to "last" to enforce the last position in the tree. |
|
|
1954
|
+
| └disabled | boolean | — | Disallows the selection of the group itself. |
|
|
1955
|
+
| └icon | string | — | The rioglyph icon name for a group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
1956
|
+
| └expandedIcon | string | — | The rioglyph icon name for a expanded group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
1957
|
+
| └className | string | — | Additional classes added to the group element. |
|
|
1958
|
+
| items | TreeItem[] | [] | The list of items. |
|
|
1959
|
+
| └id | string | — | A unique identifier of an item. |
|
|
1960
|
+
| └name | string \| TreeItemName | — | The name of an item. Either it is a plain string or an object composed of: firstName and lastName where lastName is mandatory. |
|
|
1961
|
+
| └info | string \| React.ReactNode | — | The subline of an item. This can e used to show additional information for that item. |
|
|
1962
|
+
| └type | string | — | The primary type of the item. This is also used as the fallback icon name and refers to the name of the respective rioglyph icon (excluding the rioglyph- prefix). |
|
|
1963
|
+
| └icon | string \| null | — | Optional icon override for the item. If set to a string (e.g. 'truck'), this icon will be used explicitly. If set to undefined, the type property will be used as the fallback icon. If set to null, no icon will be rendered, even if type is defined. This allows full control over the icon behavior while maintaining backward compatibility with type-based icons. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
1964
|
+
| └subType | string | — | Optional sub-type of the item. This refers to the name of an additional rioglyph icon (excluding the rioglyph- prefix), typically used to render a secondary icon next to the primary one (Note: for fuel types better use the pairIcon prop). |
|
|
1965
|
+
| └pairIcon | string \| null \| undefined | — | Optional pair icon override for the subType. If set to a string (e.g. 'fuel-gas'), this icon will be used explicitly. If set to undefined, the subType property will be used as the fallback icon. If set to null, no icon will be rendered, even if subType is defined. This allows full control over the icon behavior while maintaining backward compatibility with subType-based icons. |
|
|
1966
|
+
| └groupIds | string[] | [] | List of group ids the items is associated with. |
|
|
1967
|
+
| └className | string | — | Additional classes added to the item element. |
|
|
1968
|
+
| selectedGroups | string[] | [] | List of selected group ids. |
|
|
1969
|
+
| selectedItems | string[] | [] | List of selected item ids. |
|
|
1970
|
+
| onSelectionChange | ({ items, groups }: SelectionChangeResponse) => void | — | Merged Callback for item and group selection changes. It responds with a selection object that contains the selected itemIds and groupIds: { items: [], groups: [] } |
|
|
1971
|
+
| hasMultiselect | boolean | true | Defines the selection behavior of the tree. |
|
|
1972
|
+
| showRadioButtons | boolean | false | Defines if the single selection should also show radios. |
|
|
1973
|
+
| hideSearch | boolean | false | Defines whether or not the built-in Search is shown. |
|
|
1974
|
+
| searchPlaceholder | string | — | The text used as placeholder for the search input. |
|
|
1975
|
+
| onSearchChange | (value: string) => void | — | Callback for when the search value changes. |
|
|
1976
|
+
| search | React.ReactNode | — | Used to define custom search component which replaces the built-in search. |
|
|
1977
|
+
| summary | React.ReactNode | — | Used to define custom asset type counter component which replaces the built-in summary. |
|
|
1978
|
+
| hideSummary | boolean | false | Defines whether a summary is shown. |
|
|
1979
|
+
| onTypeFilterChange | (currentTypes: string[]) => void | — | Callback triggered when the built-in asset type filter changes. This is only available when the default summary is used. |
|
|
1980
|
+
| hideTreeHead | boolean | false | Defines whether the entire area below the search field is shown or not. Note: Disabling the tree head will hide the select all checkbox and the tree options as well as the tree summary. |
|
|
1981
|
+
| treeHeaderContent | React.ReactElement | — | Additional custom content that is rendered at the top of the tree component. This can be used for nav pills. |
|
|
1982
|
+
| scrollHeight | number | — | Defines the max-height of the scrollable list. |
|
|
1983
|
+
| expandedGroups | string[] | — | List of group ids which are expanded. |
|
|
1984
|
+
| onExpandGroupsChange | (newExpandedGroups: string[]) => void | — | Callback function triggered when a group expands or collapses. |
|
|
1985
|
+
| showEmptyGroups | boolean | true | Defines whether empty groups are shown or not. |
|
|
1986
|
+
| treeOptions | React.ReactNode[] | — | Component to offer customization options for the tree. |
|
|
1987
|
+
| treeOptionsTooltip | React.ReactNode | — | Tooltip content for the tree options dropdown. |
|
|
1988
|
+
| disableAnimation | boolean | false | Disables animation when filtering or using search |
|
|
1989
|
+
| virtualizeThreshold | number | 50 | The number of items (including groups and children) used for virtualizing the tree. |
|
|
1990
|
+
| overscan | number | 5 | The number of items rendered beyond the visible area of a virtualized tree. |
|
|
1991
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
1992
|
+
|
|
1993
|
+
#### Props: TreeSearch
|
|
1994
|
+
|
|
1995
|
+
### TreeSearch
|
|
1996
|
+
|
|
1997
|
+
| Name | Type | Default | Description |
|
|
1998
|
+
| --- | --- | --- | --- |
|
|
1999
|
+
| value | string | — | The search value to be shown and used for the search. |
|
|
2000
|
+
| onChange | (newValue: string, event: React.ChangeEvent \| React.MouseEvent) => void | () => {} | Callback for when the search value changes. |
|
|
2001
|
+
| placeholder | string | — | The placeholder text used for the input field. |
|
|
2002
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2003
|
+
|
|
2004
|
+
#### Props: TreeSummary
|
|
2005
|
+
|
|
2006
|
+
### TreeSummary
|
|
2007
|
+
|
|
2008
|
+
| Name | Type | Default | Description |
|
|
2009
|
+
| --- | --- | --- | --- |
|
|
2010
|
+
| assetCounts | TreeSummaryCounts | — | The object containing various asset type counter. |
|
|
2011
|
+
| └truck | number | — | The amount of trucks |
|
|
2012
|
+
| └trailer | number | — | The amount of trailers |
|
|
2013
|
+
| └bus | number | — | The amount of buses |
|
|
2014
|
+
| └van | number | — | The amount of vans |
|
|
2015
|
+
| └car | number | — | The amount of cars |
|
|
2016
|
+
| └driver | number | — | The amount of drivers |
|
|
2017
|
+
| gridCols | number | 4 | The number of grid columns used for the built-in TreeSummaryRow. |
|
|
2018
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2019
|
+
|
|
2020
|
+
#### Props: TreeSummaryRow
|
|
2021
|
+
|
|
2022
|
+
### TreeSummaryRow
|
|
2023
|
+
|
|
2024
|
+
| Name | Type | Default | Description |
|
|
2025
|
+
| --- | --- | --- | --- |
|
|
2026
|
+
| gridCols | number | 4 | Defined the number of grid columns for a single row. Note, when the amount of children exceed the columns it will wrap around to a new line. |
|
|
2027
|
+
|
|
2028
|
+
#### Props: TypeCounter
|
|
2029
|
+
|
|
2030
|
+
### TypeCounter
|
|
2031
|
+
|
|
2032
|
+
| Name | Type | Default | Description |
|
|
2033
|
+
| --- | --- | --- | --- |
|
|
2034
|
+
| type | string | — | The item type for that counter. This will be used as a return value for the onClick callback. |
|
|
2035
|
+
| icon | string | — | The icon name. Note, when using the built-in generic type counter, the icon name will the same as the item type. So make sure there is a corresponding icon for the defined type. |
|
|
2036
|
+
| isActive | boolean | — | Sets the active styling if active |
|
|
2037
|
+
| hasFilter | boolean | false | Should be set when there is a type filter set in the tree to style the counter accordingly. |
|
|
2038
|
+
| enableActivity | boolean | false | Allows for interactivity. Use this prop when you allow clicking on the counter. |
|
|
2039
|
+
| hideOnZero | boolean | false | Defines if the counter is rendered at all when the value is not defined ot 0. |
|
|
2040
|
+
| onClick | (type: string) => void | — | Callback function when the counter is clicked. It returns the type value. Make sure the "type" prop is defined to receive the value in the callback. |
|
|
2041
|
+
| value | string \| React.ReactNode \| number | — | A custom value to be shown in the counter. |
|
|
2042
|
+
|
|
2043
|
+
#### Props: TreeOption
|
|
2044
|
+
|
|
2045
|
+
### TreeOption
|
|
2046
|
+
|
|
2047
|
+
| Name | Type | Default | Description |
|
|
2048
|
+
| --- | --- | --- | --- |
|
|
2049
|
+
| isChecked | boolean | false | Defines whether the option is set. |
|
|
2050
|
+
| onChange | (event: React.MouseEvent<HTMLDivElement>) => void | — | Callback triggered when option is selected. |
|
|
2051
|
+
| label | string \| React.ReactNode | — | The label for the option. |
|
|
2052
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2053
|
+
|
|
1651
2054
|
## AssetTree with custom summary
|
|
1652
2055
|
|
|
1653
2056
|
### Example: Some small dummy text at the bottom to showcase that you can put something here
|
|
@@ -1913,6 +2316,148 @@ export default AssetTreeWithCustomSummaryExample;
|
|
|
1913
2316
|
</div>
|
|
1914
2317
|
```
|
|
1915
2318
|
|
|
2319
|
+
#### Props: AssetTree
|
|
2320
|
+
|
|
2321
|
+
### AssetTree
|
|
2322
|
+
|
|
2323
|
+
| Name | Type | Default | Description |
|
|
2324
|
+
| --- | --- | --- | --- |
|
|
2325
|
+
| fly | boolean | false | Defines if the component will overlap the body content. |
|
|
2326
|
+
| resizable | boolean | true | Defines whether or not the sidebar is resizable. |
|
|
2327
|
+
| bordered | boolean | false | Defines whether the component has a border or not. |
|
|
2328
|
+
| width | number | 350 | Defines the width of the component. The value is set as inline style. Note: when component is resizable it will take the provided width in px only and convert it to number in case. |
|
|
2329
|
+
| minWidth | number | 100 | Defines the minimum width of the component in px that will take effect when resizing. |
|
|
2330
|
+
| maxWidth | number | 0 | Defines the maximum width of the component in px that will take effect when resizing. |
|
|
2331
|
+
| height | number | — | Defines the height of the component in px. |
|
|
2332
|
+
| isOpen | boolean | true | Defines whether the component is open or not. |
|
|
2333
|
+
| onToggleTree | (isOpen: boolean) => void | () => {} | Callback for when the tree visibility is toggled. |
|
|
2334
|
+
| currentCategoryId | string | — | The id of the category which is currently active and shall be shown. |
|
|
2335
|
+
| onCategoryChange | (selectedCategoryId: string) => void | () => {} | Callback for handling change of category. |
|
|
2336
|
+
| onResizeEnd | VoidFunction | () => {} | Callback for when the resize is done. |
|
|
2337
|
+
| useOffscreen | boolean | false | Defines whether the tree components are rendered offscreen and kept mounted in the DOM. |
|
|
2338
|
+
| className | string | — | Additional classes added on the wrapper element. |
|
|
2339
|
+
|
|
2340
|
+
#### Props: TreeCategory
|
|
2341
|
+
|
|
2342
|
+
### TreeCategory
|
|
2343
|
+
|
|
2344
|
+
| Name | Type | Default | Description |
|
|
2345
|
+
| --- | --- | --- | --- |
|
|
2346
|
+
| id | string | — | A unique identifier for that category. |
|
|
2347
|
+
| icon | string | — | The rioglyph icon name for that category. |
|
|
2348
|
+
| label | string \| React.ReactNode | — | The optional label for the category which will be shown in a tooltip. |
|
|
2349
|
+
| hasSelection | boolean | — | Defines whether or not a selection indicator should be shown. |
|
|
2350
|
+
|
|
2351
|
+
#### Props: Tree
|
|
2352
|
+
|
|
2353
|
+
### Tree
|
|
2354
|
+
|
|
2355
|
+
| Name | Type | Default | Description |
|
|
2356
|
+
| --- | --- | --- | --- |
|
|
2357
|
+
| groups | TreeGroup[] | [] | The list of groups of the items. If no groups are provided all items are rendered as flat list. |
|
|
2358
|
+
| └id | string | — | A unique identifier of a group. |
|
|
2359
|
+
| └name | string \| React.ReactNode | — | The name of a group. |
|
|
2360
|
+
| └position | 'last' | — | Can be set to "last" to enforce the last position in the tree. |
|
|
2361
|
+
| └disabled | boolean | — | Disallows the selection of the group itself. |
|
|
2362
|
+
| └icon | string | — | The rioglyph icon name for a group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
2363
|
+
| └expandedIcon | string | — | The rioglyph icon name for a expanded group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
2364
|
+
| └className | string | — | Additional classes added to the group element. |
|
|
2365
|
+
| items | TreeItem[] | [] | The list of items. |
|
|
2366
|
+
| └id | string | — | A unique identifier of an item. |
|
|
2367
|
+
| └name | string \| TreeItemName | — | The name of an item. Either it is a plain string or an object composed of: firstName and lastName where lastName is mandatory. |
|
|
2368
|
+
| └info | string \| React.ReactNode | — | The subline of an item. This can e used to show additional information for that item. |
|
|
2369
|
+
| └type | string | — | The primary type of the item. This is also used as the fallback icon name and refers to the name of the respective rioglyph icon (excluding the rioglyph- prefix). |
|
|
2370
|
+
| └icon | string \| null | — | Optional icon override for the item. If set to a string (e.g. 'truck'), this icon will be used explicitly. If set to undefined, the type property will be used as the fallback icon. If set to null, no icon will be rendered, even if type is defined. This allows full control over the icon behavior while maintaining backward compatibility with type-based icons. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
2371
|
+
| └subType | string | — | Optional sub-type of the item. This refers to the name of an additional rioglyph icon (excluding the rioglyph- prefix), typically used to render a secondary icon next to the primary one (Note: for fuel types better use the pairIcon prop). |
|
|
2372
|
+
| └pairIcon | string \| null \| undefined | — | Optional pair icon override for the subType. If set to a string (e.g. 'fuel-gas'), this icon will be used explicitly. If set to undefined, the subType property will be used as the fallback icon. If set to null, no icon will be rendered, even if subType is defined. This allows full control over the icon behavior while maintaining backward compatibility with subType-based icons. |
|
|
2373
|
+
| └groupIds | string[] | [] | List of group ids the items is associated with. |
|
|
2374
|
+
| └className | string | — | Additional classes added to the item element. |
|
|
2375
|
+
| selectedGroups | string[] | [] | List of selected group ids. |
|
|
2376
|
+
| selectedItems | string[] | [] | List of selected item ids. |
|
|
2377
|
+
| onSelectionChange | ({ items, groups }: SelectionChangeResponse) => void | — | Merged Callback for item and group selection changes. It responds with a selection object that contains the selected itemIds and groupIds: { items: [], groups: [] } |
|
|
2378
|
+
| hasMultiselect | boolean | true | Defines the selection behavior of the tree. |
|
|
2379
|
+
| showRadioButtons | boolean | false | Defines if the single selection should also show radios. |
|
|
2380
|
+
| hideSearch | boolean | false | Defines whether or not the built-in Search is shown. |
|
|
2381
|
+
| searchPlaceholder | string | — | The text used as placeholder for the search input. |
|
|
2382
|
+
| onSearchChange | (value: string) => void | — | Callback for when the search value changes. |
|
|
2383
|
+
| search | React.ReactNode | — | Used to define custom search component which replaces the built-in search. |
|
|
2384
|
+
| summary | React.ReactNode | — | Used to define custom asset type counter component which replaces the built-in summary. |
|
|
2385
|
+
| hideSummary | boolean | false | Defines whether a summary is shown. |
|
|
2386
|
+
| onTypeFilterChange | (currentTypes: string[]) => void | — | Callback triggered when the built-in asset type filter changes. This is only available when the default summary is used. |
|
|
2387
|
+
| hideTreeHead | boolean | false | Defines whether the entire area below the search field is shown or not. Note: Disabling the tree head will hide the select all checkbox and the tree options as well as the tree summary. |
|
|
2388
|
+
| treeHeaderContent | React.ReactElement | — | Additional custom content that is rendered at the top of the tree component. This can be used for nav pills. |
|
|
2389
|
+
| scrollHeight | number | — | Defines the max-height of the scrollable list. |
|
|
2390
|
+
| expandedGroups | string[] | — | List of group ids which are expanded. |
|
|
2391
|
+
| onExpandGroupsChange | (newExpandedGroups: string[]) => void | — | Callback function triggered when a group expands or collapses. |
|
|
2392
|
+
| showEmptyGroups | boolean | true | Defines whether empty groups are shown or not. |
|
|
2393
|
+
| treeOptions | React.ReactNode[] | — | Component to offer customization options for the tree. |
|
|
2394
|
+
| treeOptionsTooltip | React.ReactNode | — | Tooltip content for the tree options dropdown. |
|
|
2395
|
+
| disableAnimation | boolean | false | Disables animation when filtering or using search |
|
|
2396
|
+
| virtualizeThreshold | number | 50 | The number of items (including groups and children) used for virtualizing the tree. |
|
|
2397
|
+
| overscan | number | 5 | The number of items rendered beyond the visible area of a virtualized tree. |
|
|
2398
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2399
|
+
|
|
2400
|
+
#### Props: TreeSearch
|
|
2401
|
+
|
|
2402
|
+
### TreeSearch
|
|
2403
|
+
|
|
2404
|
+
| Name | Type | Default | Description |
|
|
2405
|
+
| --- | --- | --- | --- |
|
|
2406
|
+
| value | string | — | The search value to be shown and used for the search. |
|
|
2407
|
+
| onChange | (newValue: string, event: React.ChangeEvent \| React.MouseEvent) => void | () => {} | Callback for when the search value changes. |
|
|
2408
|
+
| placeholder | string | — | The placeholder text used for the input field. |
|
|
2409
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2410
|
+
|
|
2411
|
+
#### Props: TreeSummary
|
|
2412
|
+
|
|
2413
|
+
### TreeSummary
|
|
2414
|
+
|
|
2415
|
+
| Name | Type | Default | Description |
|
|
2416
|
+
| --- | --- | --- | --- |
|
|
2417
|
+
| assetCounts | TreeSummaryCounts | — | The object containing various asset type counter. |
|
|
2418
|
+
| └truck | number | — | The amount of trucks |
|
|
2419
|
+
| └trailer | number | — | The amount of trailers |
|
|
2420
|
+
| └bus | number | — | The amount of buses |
|
|
2421
|
+
| └van | number | — | The amount of vans |
|
|
2422
|
+
| └car | number | — | The amount of cars |
|
|
2423
|
+
| └driver | number | — | The amount of drivers |
|
|
2424
|
+
| gridCols | number | 4 | The number of grid columns used for the built-in TreeSummaryRow. |
|
|
2425
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2426
|
+
|
|
2427
|
+
#### Props: TreeSummaryRow
|
|
2428
|
+
|
|
2429
|
+
### TreeSummaryRow
|
|
2430
|
+
|
|
2431
|
+
| Name | Type | Default | Description |
|
|
2432
|
+
| --- | --- | --- | --- |
|
|
2433
|
+
| gridCols | number | 4 | Defined the number of grid columns for a single row. Note, when the amount of children exceed the columns it will wrap around to a new line. |
|
|
2434
|
+
|
|
2435
|
+
#### Props: TypeCounter
|
|
2436
|
+
|
|
2437
|
+
### TypeCounter
|
|
2438
|
+
|
|
2439
|
+
| Name | Type | Default | Description |
|
|
2440
|
+
| --- | --- | --- | --- |
|
|
2441
|
+
| type | string | — | The item type for that counter. This will be used as a return value for the onClick callback. |
|
|
2442
|
+
| icon | string | — | The icon name. Note, when using the built-in generic type counter, the icon name will the same as the item type. So make sure there is a corresponding icon for the defined type. |
|
|
2443
|
+
| isActive | boolean | — | Sets the active styling if active |
|
|
2444
|
+
| hasFilter | boolean | false | Should be set when there is a type filter set in the tree to style the counter accordingly. |
|
|
2445
|
+
| enableActivity | boolean | false | Allows for interactivity. Use this prop when you allow clicking on the counter. |
|
|
2446
|
+
| hideOnZero | boolean | false | Defines if the counter is rendered at all when the value is not defined ot 0. |
|
|
2447
|
+
| onClick | (type: string) => void | — | Callback function when the counter is clicked. It returns the type value. Make sure the "type" prop is defined to receive the value in the callback. |
|
|
2448
|
+
| value | string \| React.ReactNode \| number | — | A custom value to be shown in the counter. |
|
|
2449
|
+
|
|
2450
|
+
#### Props: TreeOption
|
|
2451
|
+
|
|
2452
|
+
### TreeOption
|
|
2453
|
+
|
|
2454
|
+
| Name | Type | Default | Description |
|
|
2455
|
+
| --- | --- | --- | --- |
|
|
2456
|
+
| isChecked | boolean | false | Defines whether the option is set. |
|
|
2457
|
+
| onChange | (event: React.MouseEvent<HTMLDivElement>) => void | — | Callback triggered when option is selected. |
|
|
2458
|
+
| label | string \| React.ReactNode | — | The label for the option. |
|
|
2459
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2460
|
+
|
|
1916
2461
|
## Tree with custom icons
|
|
1917
2462
|
|
|
1918
2463
|
### Example: Tree with header and search
|
|
@@ -1921,11 +2466,11 @@ Tree with header and search
|
|
|
1921
2466
|
|
|
1922
2467
|
20
|
|
1923
2468
|
|
|
1924
|
-
Group
|
|
2469
|
+
Group 014
|
|
1925
2470
|
|
|
1926
|
-
Group
|
|
2471
|
+
Group 026
|
|
1927
2472
|
|
|
1928
|
-
Group
|
|
2473
|
+
Group 0310
|
|
1929
2474
|
|
|
1930
2475
|
#### Summary
|
|
1931
2476
|
|
|
@@ -1933,11 +2478,11 @@ Tree with header and search
|
|
|
1933
2478
|
|
|
1934
2479
|
20
|
|
1935
2480
|
|
|
1936
|
-
Group
|
|
2481
|
+
Group 014
|
|
1937
2482
|
|
|
1938
|
-
Group
|
|
2483
|
+
Group 026
|
|
1939
2484
|
|
|
1940
|
-
Group
|
|
2485
|
+
Group 0310
|
|
1941
2486
|
|
|
1942
2487
|
#### React (tsx)
|
|
1943
2488
|
|
|
@@ -2055,7 +2600,7 @@ export default () => {
|
|
|
2055
2600
|
<span class="TreeLabelNameText">
|
|
2056
2601
|
<span class="TreeLabelNameTextHeadline">Group 01</span>
|
|
2057
2602
|
</span>
|
|
2058
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
2603
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">4</span>
|
|
2059
2604
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
2060
2605
|
</span>
|
|
2061
2606
|
</span>
|
|
@@ -2070,7 +2615,7 @@ export default () => {
|
|
|
2070
2615
|
<span class="TreeLabelNameText">
|
|
2071
2616
|
<span class="TreeLabelNameTextHeadline">Group 02</span>
|
|
2072
2617
|
</span>
|
|
2073
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
2618
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">6</span>
|
|
2074
2619
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
2075
2620
|
</span>
|
|
2076
2621
|
</span>
|
|
@@ -2085,7 +2630,7 @@ export default () => {
|
|
|
2085
2630
|
<span class="TreeLabelNameText">
|
|
2086
2631
|
<span class="TreeLabelNameTextHeadline">Group 03</span>
|
|
2087
2632
|
</span>
|
|
2088
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
2633
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">10</span>
|
|
2089
2634
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
2090
2635
|
</span>
|
|
2091
2636
|
</span>
|
|
@@ -2098,6 +2643,148 @@ export default () => {
|
|
|
2098
2643
|
</div>
|
|
2099
2644
|
```
|
|
2100
2645
|
|
|
2646
|
+
#### Props: AssetTree
|
|
2647
|
+
|
|
2648
|
+
### AssetTree
|
|
2649
|
+
|
|
2650
|
+
| Name | Type | Default | Description |
|
|
2651
|
+
| --- | --- | --- | --- |
|
|
2652
|
+
| fly | boolean | false | Defines if the component will overlap the body content. |
|
|
2653
|
+
| resizable | boolean | true | Defines whether or not the sidebar is resizable. |
|
|
2654
|
+
| bordered | boolean | false | Defines whether the component has a border or not. |
|
|
2655
|
+
| width | number | 350 | Defines the width of the component. The value is set as inline style. Note: when component is resizable it will take the provided width in px only and convert it to number in case. |
|
|
2656
|
+
| minWidth | number | 100 | Defines the minimum width of the component in px that will take effect when resizing. |
|
|
2657
|
+
| maxWidth | number | 0 | Defines the maximum width of the component in px that will take effect when resizing. |
|
|
2658
|
+
| height | number | — | Defines the height of the component in px. |
|
|
2659
|
+
| isOpen | boolean | true | Defines whether the component is open or not. |
|
|
2660
|
+
| onToggleTree | (isOpen: boolean) => void | () => {} | Callback for when the tree visibility is toggled. |
|
|
2661
|
+
| currentCategoryId | string | — | The id of the category which is currently active and shall be shown. |
|
|
2662
|
+
| onCategoryChange | (selectedCategoryId: string) => void | () => {} | Callback for handling change of category. |
|
|
2663
|
+
| onResizeEnd | VoidFunction | () => {} | Callback for when the resize is done. |
|
|
2664
|
+
| useOffscreen | boolean | false | Defines whether the tree components are rendered offscreen and kept mounted in the DOM. |
|
|
2665
|
+
| className | string | — | Additional classes added on the wrapper element. |
|
|
2666
|
+
|
|
2667
|
+
#### Props: TreeCategory
|
|
2668
|
+
|
|
2669
|
+
### TreeCategory
|
|
2670
|
+
|
|
2671
|
+
| Name | Type | Default | Description |
|
|
2672
|
+
| --- | --- | --- | --- |
|
|
2673
|
+
| id | string | — | A unique identifier for that category. |
|
|
2674
|
+
| icon | string | — | The rioglyph icon name for that category. |
|
|
2675
|
+
| label | string \| React.ReactNode | — | The optional label for the category which will be shown in a tooltip. |
|
|
2676
|
+
| hasSelection | boolean | — | Defines whether or not a selection indicator should be shown. |
|
|
2677
|
+
|
|
2678
|
+
#### Props: Tree
|
|
2679
|
+
|
|
2680
|
+
### Tree
|
|
2681
|
+
|
|
2682
|
+
| Name | Type | Default | Description |
|
|
2683
|
+
| --- | --- | --- | --- |
|
|
2684
|
+
| groups | TreeGroup[] | [] | The list of groups of the items. If no groups are provided all items are rendered as flat list. |
|
|
2685
|
+
| └id | string | — | A unique identifier of a group. |
|
|
2686
|
+
| └name | string \| React.ReactNode | — | The name of a group. |
|
|
2687
|
+
| └position | 'last' | — | Can be set to "last" to enforce the last position in the tree. |
|
|
2688
|
+
| └disabled | boolean | — | Disallows the selection of the group itself. |
|
|
2689
|
+
| └icon | string | — | The rioglyph icon name for a group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
2690
|
+
| └expandedIcon | string | — | The rioglyph icon name for a expanded group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
2691
|
+
| └className | string | — | Additional classes added to the group element. |
|
|
2692
|
+
| items | TreeItem[] | [] | The list of items. |
|
|
2693
|
+
| └id | string | — | A unique identifier of an item. |
|
|
2694
|
+
| └name | string \| TreeItemName | — | The name of an item. Either it is a plain string or an object composed of: firstName and lastName where lastName is mandatory. |
|
|
2695
|
+
| └info | string \| React.ReactNode | — | The subline of an item. This can e used to show additional information for that item. |
|
|
2696
|
+
| └type | string | — | The primary type of the item. This is also used as the fallback icon name and refers to the name of the respective rioglyph icon (excluding the rioglyph- prefix). |
|
|
2697
|
+
| └icon | string \| null | — | Optional icon override for the item. If set to a string (e.g. 'truck'), this icon will be used explicitly. If set to undefined, the type property will be used as the fallback icon. If set to null, no icon will be rendered, even if type is defined. This allows full control over the icon behavior while maintaining backward compatibility with type-based icons. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
2698
|
+
| └subType | string | — | Optional sub-type of the item. This refers to the name of an additional rioglyph icon (excluding the rioglyph- prefix), typically used to render a secondary icon next to the primary one (Note: for fuel types better use the pairIcon prop). |
|
|
2699
|
+
| └pairIcon | string \| null \| undefined | — | Optional pair icon override for the subType. If set to a string (e.g. 'fuel-gas'), this icon will be used explicitly. If set to undefined, the subType property will be used as the fallback icon. If set to null, no icon will be rendered, even if subType is defined. This allows full control over the icon behavior while maintaining backward compatibility with subType-based icons. |
|
|
2700
|
+
| └groupIds | string[] | [] | List of group ids the items is associated with. |
|
|
2701
|
+
| └className | string | — | Additional classes added to the item element. |
|
|
2702
|
+
| selectedGroups | string[] | [] | List of selected group ids. |
|
|
2703
|
+
| selectedItems | string[] | [] | List of selected item ids. |
|
|
2704
|
+
| onSelectionChange | ({ items, groups }: SelectionChangeResponse) => void | — | Merged Callback for item and group selection changes. It responds with a selection object that contains the selected itemIds and groupIds: { items: [], groups: [] } |
|
|
2705
|
+
| hasMultiselect | boolean | true | Defines the selection behavior of the tree. |
|
|
2706
|
+
| showRadioButtons | boolean | false | Defines if the single selection should also show radios. |
|
|
2707
|
+
| hideSearch | boolean | false | Defines whether or not the built-in Search is shown. |
|
|
2708
|
+
| searchPlaceholder | string | — | The text used as placeholder for the search input. |
|
|
2709
|
+
| onSearchChange | (value: string) => void | — | Callback for when the search value changes. |
|
|
2710
|
+
| search | React.ReactNode | — | Used to define custom search component which replaces the built-in search. |
|
|
2711
|
+
| summary | React.ReactNode | — | Used to define custom asset type counter component which replaces the built-in summary. |
|
|
2712
|
+
| hideSummary | boolean | false | Defines whether a summary is shown. |
|
|
2713
|
+
| onTypeFilterChange | (currentTypes: string[]) => void | — | Callback triggered when the built-in asset type filter changes. This is only available when the default summary is used. |
|
|
2714
|
+
| hideTreeHead | boolean | false | Defines whether the entire area below the search field is shown or not. Note: Disabling the tree head will hide the select all checkbox and the tree options as well as the tree summary. |
|
|
2715
|
+
| treeHeaderContent | React.ReactElement | — | Additional custom content that is rendered at the top of the tree component. This can be used for nav pills. |
|
|
2716
|
+
| scrollHeight | number | — | Defines the max-height of the scrollable list. |
|
|
2717
|
+
| expandedGroups | string[] | — | List of group ids which are expanded. |
|
|
2718
|
+
| onExpandGroupsChange | (newExpandedGroups: string[]) => void | — | Callback function triggered when a group expands or collapses. |
|
|
2719
|
+
| showEmptyGroups | boolean | true | Defines whether empty groups are shown or not. |
|
|
2720
|
+
| treeOptions | React.ReactNode[] | — | Component to offer customization options for the tree. |
|
|
2721
|
+
| treeOptionsTooltip | React.ReactNode | — | Tooltip content for the tree options dropdown. |
|
|
2722
|
+
| disableAnimation | boolean | false | Disables animation when filtering or using search |
|
|
2723
|
+
| virtualizeThreshold | number | 50 | The number of items (including groups and children) used for virtualizing the tree. |
|
|
2724
|
+
| overscan | number | 5 | The number of items rendered beyond the visible area of a virtualized tree. |
|
|
2725
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2726
|
+
|
|
2727
|
+
#### Props: TreeSearch
|
|
2728
|
+
|
|
2729
|
+
### TreeSearch
|
|
2730
|
+
|
|
2731
|
+
| Name | Type | Default | Description |
|
|
2732
|
+
| --- | --- | --- | --- |
|
|
2733
|
+
| value | string | — | The search value to be shown and used for the search. |
|
|
2734
|
+
| onChange | (newValue: string, event: React.ChangeEvent \| React.MouseEvent) => void | () => {} | Callback for when the search value changes. |
|
|
2735
|
+
| placeholder | string | — | The placeholder text used for the input field. |
|
|
2736
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2737
|
+
|
|
2738
|
+
#### Props: TreeSummary
|
|
2739
|
+
|
|
2740
|
+
### TreeSummary
|
|
2741
|
+
|
|
2742
|
+
| Name | Type | Default | Description |
|
|
2743
|
+
| --- | --- | --- | --- |
|
|
2744
|
+
| assetCounts | TreeSummaryCounts | — | The object containing various asset type counter. |
|
|
2745
|
+
| └truck | number | — | The amount of trucks |
|
|
2746
|
+
| └trailer | number | — | The amount of trailers |
|
|
2747
|
+
| └bus | number | — | The amount of buses |
|
|
2748
|
+
| └van | number | — | The amount of vans |
|
|
2749
|
+
| └car | number | — | The amount of cars |
|
|
2750
|
+
| └driver | number | — | The amount of drivers |
|
|
2751
|
+
| gridCols | number | 4 | The number of grid columns used for the built-in TreeSummaryRow. |
|
|
2752
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2753
|
+
|
|
2754
|
+
#### Props: TreeSummaryRow
|
|
2755
|
+
|
|
2756
|
+
### TreeSummaryRow
|
|
2757
|
+
|
|
2758
|
+
| Name | Type | Default | Description |
|
|
2759
|
+
| --- | --- | --- | --- |
|
|
2760
|
+
| gridCols | number | 4 | Defined the number of grid columns for a single row. Note, when the amount of children exceed the columns it will wrap around to a new line. |
|
|
2761
|
+
|
|
2762
|
+
#### Props: TypeCounter
|
|
2763
|
+
|
|
2764
|
+
### TypeCounter
|
|
2765
|
+
|
|
2766
|
+
| Name | Type | Default | Description |
|
|
2767
|
+
| --- | --- | --- | --- |
|
|
2768
|
+
| type | string | — | The item type for that counter. This will be used as a return value for the onClick callback. |
|
|
2769
|
+
| icon | string | — | The icon name. Note, when using the built-in generic type counter, the icon name will the same as the item type. So make sure there is a corresponding icon for the defined type. |
|
|
2770
|
+
| isActive | boolean | — | Sets the active styling if active |
|
|
2771
|
+
| hasFilter | boolean | false | Should be set when there is a type filter set in the tree to style the counter accordingly. |
|
|
2772
|
+
| enableActivity | boolean | false | Allows for interactivity. Use this prop when you allow clicking on the counter. |
|
|
2773
|
+
| hideOnZero | boolean | false | Defines if the counter is rendered at all when the value is not defined ot 0. |
|
|
2774
|
+
| onClick | (type: string) => void | — | Callback function when the counter is clicked. It returns the type value. Make sure the "type" prop is defined to receive the value in the callback. |
|
|
2775
|
+
| value | string \| React.ReactNode \| number | — | A custom value to be shown in the counter. |
|
|
2776
|
+
|
|
2777
|
+
#### Props: TreeOption
|
|
2778
|
+
|
|
2779
|
+
### TreeOption
|
|
2780
|
+
|
|
2781
|
+
| Name | Type | Default | Description |
|
|
2782
|
+
| --- | --- | --- | --- |
|
|
2783
|
+
| isChecked | boolean | false | Defines whether the option is set. |
|
|
2784
|
+
| onChange | (event: React.MouseEvent<HTMLDivElement>) => void | — | Callback triggered when option is selected. |
|
|
2785
|
+
| label | string \| React.ReactNode | — | The label for the option. |
|
|
2786
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
2787
|
+
|
|
2101
2788
|
## Tree
|
|
2102
2789
|
|
|
2103
2790
|
### Example: Tree with header and search
|
|
@@ -2106,9 +2793,9 @@ Tree with header and search
|
|
|
2106
2793
|
|
|
2107
2794
|
20
|
|
2108
2795
|
|
|
2109
|
-
Folder
|
|
2796
|
+
Folder 017
|
|
2110
2797
|
|
|
2111
|
-
Folder
|
|
2798
|
+
Folder 024
|
|
2112
2799
|
|
|
2113
2800
|
Folder 035
|
|
2114
2801
|
|
|
@@ -2124,9 +2811,9 @@ Tree with header and search
|
|
|
2124
2811
|
|
|
2125
2812
|
20
|
|
2126
2813
|
|
|
2127
|
-
Folder
|
|
2814
|
+
Folder 017
|
|
2128
2815
|
|
|
2129
|
-
Folder
|
|
2816
|
+
Folder 024
|
|
2130
2817
|
|
|
2131
2818
|
Folder 035
|
|
2132
2819
|
|
|
@@ -2275,7 +2962,7 @@ export default TreeOnlyExample;
|
|
|
2275
2962
|
<span class="TreeLabelNameText">
|
|
2276
2963
|
<span class="TreeLabelNameTextHeadline">Folder 01</span>
|
|
2277
2964
|
</span>
|
|
2278
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
2965
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">7</span>
|
|
2279
2966
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
2280
2967
|
</span>
|
|
2281
2968
|
</span>
|
|
@@ -2289,7 +2976,7 @@ export default TreeOnlyExample;
|
|
|
2289
2976
|
<span class="TreeLabelNameText">
|
|
2290
2977
|
<span class="TreeLabelNameTextHeadline">Folder 02</span>
|
|
2291
2978
|
</span>
|
|
2292
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
2979
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">4</span>
|
|
2293
2980
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
2294
2981
|
</span>
|
|
2295
2982
|
</span>
|
|
@@ -2338,6 +3025,55 @@ export default TreeOnlyExample;
|
|
|
2338
3025
|
</div>
|
|
2339
3026
|
```
|
|
2340
3027
|
|
|
3028
|
+
#### Props: Tree
|
|
3029
|
+
|
|
3030
|
+
### Tree
|
|
3031
|
+
|
|
3032
|
+
| Name | Type | Default | Description |
|
|
3033
|
+
| --- | --- | --- | --- |
|
|
3034
|
+
| groups | TreeGroup[] | [] | The list of groups of the items. If no groups are provided all items are rendered as flat list. |
|
|
3035
|
+
| └id | string | — | A unique identifier of a group. |
|
|
3036
|
+
| └name | string \| React.ReactNode | — | The name of a group. |
|
|
3037
|
+
| └position | 'last' | — | Can be set to "last" to enforce the last position in the tree. |
|
|
3038
|
+
| └disabled | boolean | — | Disallows the selection of the group itself. |
|
|
3039
|
+
| └icon | string | — | The rioglyph icon name for a group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
3040
|
+
| └expandedIcon | string | — | The rioglyph icon name for a expanded group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
3041
|
+
| └className | string | — | Additional classes added to the group element. |
|
|
3042
|
+
| items | TreeItem[] | [] | The list of items. |
|
|
3043
|
+
| └id | string | — | A unique identifier of an item. |
|
|
3044
|
+
| └name | string \| TreeItemName | — | The name of an item. Either it is a plain string or an object composed of: firstName and lastName where lastName is mandatory. |
|
|
3045
|
+
| └info | string \| React.ReactNode | — | The subline of an item. This can e used to show additional information for that item. |
|
|
3046
|
+
| └type | string | — | The primary type of the item. This is also used as the fallback icon name and refers to the name of the respective rioglyph icon (excluding the rioglyph- prefix). |
|
|
3047
|
+
| └icon | string \| null | — | Optional icon override for the item. If set to a string (e.g. 'truck'), this icon will be used explicitly. If set to undefined, the type property will be used as the fallback icon. If set to null, no icon will be rendered, even if type is defined. This allows full control over the icon behavior while maintaining backward compatibility with type-based icons. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
3048
|
+
| └subType | string | — | Optional sub-type of the item. This refers to the name of an additional rioglyph icon (excluding the rioglyph- prefix), typically used to render a secondary icon next to the primary one (Note: for fuel types better use the pairIcon prop). |
|
|
3049
|
+
| └pairIcon | string \| null \| undefined | — | Optional pair icon override for the subType. If set to a string (e.g. 'fuel-gas'), this icon will be used explicitly. If set to undefined, the subType property will be used as the fallback icon. If set to null, no icon will be rendered, even if subType is defined. This allows full control over the icon behavior while maintaining backward compatibility with subType-based icons. |
|
|
3050
|
+
| └groupIds | string[] | [] | List of group ids the items is associated with. |
|
|
3051
|
+
| └className | string | — | Additional classes added to the item element. |
|
|
3052
|
+
| selectedGroups | string[] | [] | List of selected group ids. |
|
|
3053
|
+
| selectedItems | string[] | [] | List of selected item ids. |
|
|
3054
|
+
| onSelectionChange | ({ items, groups }: SelectionChangeResponse) => void | — | Merged Callback for item and group selection changes. It responds with a selection object that contains the selected itemIds and groupIds: { items: [], groups: [] } |
|
|
3055
|
+
| hasMultiselect | boolean | true | Defines the selection behavior of the tree. |
|
|
3056
|
+
| showRadioButtons | boolean | false | Defines if the single selection should also show radios. |
|
|
3057
|
+
| hideSearch | boolean | false | Defines whether or not the built-in Search is shown. |
|
|
3058
|
+
| searchPlaceholder | string | — | The text used as placeholder for the search input. |
|
|
3059
|
+
| onSearchChange | (value: string) => void | — | Callback for when the search value changes. |
|
|
3060
|
+
| search | React.ReactNode | — | Used to define custom search component which replaces the built-in search. |
|
|
3061
|
+
| summary | React.ReactNode | — | Used to define custom asset type counter component which replaces the built-in summary. |
|
|
3062
|
+
| hideSummary | boolean | false | Defines whether a summary is shown. |
|
|
3063
|
+
| onTypeFilterChange | (currentTypes: string[]) => void | — | Callback triggered when the built-in asset type filter changes. This is only available when the default summary is used. |
|
|
3064
|
+
| hideTreeHead | boolean | false | Defines whether the entire area below the search field is shown or not. Note: Disabling the tree head will hide the select all checkbox and the tree options as well as the tree summary. |
|
|
3065
|
+
| treeHeaderContent | React.ReactElement | — | Additional custom content that is rendered at the top of the tree component. This can be used for nav pills. |
|
|
3066
|
+
| scrollHeight | number | — | Defines the max-height of the scrollable list. |
|
|
3067
|
+
| expandedGroups | string[] | — | List of group ids which are expanded. |
|
|
3068
|
+
| onExpandGroupsChange | (newExpandedGroups: string[]) => void | — | Callback function triggered when a group expands or collapses. |
|
|
3069
|
+
| showEmptyGroups | boolean | true | Defines whether empty groups are shown or not. |
|
|
3070
|
+
| treeOptions | React.ReactNode[] | — | Component to offer customization options for the tree. |
|
|
3071
|
+
| treeOptionsTooltip | React.ReactNode | — | Tooltip content for the tree options dropdown. |
|
|
3072
|
+
| disableAnimation | boolean | false | Disables animation when filtering or using search |
|
|
3073
|
+
| virtualizeThreshold | number | 50 | The number of items (including groups and children) used for virtualizing the tree. |
|
|
3074
|
+
| overscan | number | 5 | The number of items rendered beyond the visible area of a virtualized tree. |
|
|
3075
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
3076
|
+
|
|
2341
3077
|
### Example: Tree without header and search
|
|
2342
3078
|
|
|
2343
3079
|
Tree without header and search
|
|
@@ -2346,9 +3082,9 @@ Folder 012
|
|
|
2346
3082
|
|
|
2347
3083
|
Folder 028
|
|
2348
3084
|
|
|
2349
|
-
Folder
|
|
3085
|
+
Folder 034
|
|
2350
3086
|
|
|
2351
|
-
Folder
|
|
3087
|
+
Folder 046
|
|
2352
3088
|
|
|
2353
3089
|
Selected items:
|
|
2354
3090
|
|
|
@@ -2362,9 +3098,9 @@ Folder 012
|
|
|
2362
3098
|
|
|
2363
3099
|
Folder 028
|
|
2364
3100
|
|
|
2365
|
-
Folder
|
|
3101
|
+
Folder 034
|
|
2366
3102
|
|
|
2367
|
-
Folder
|
|
3103
|
+
Folder 046
|
|
2368
3104
|
|
|
2369
3105
|
Selected items:
|
|
2370
3106
|
|
|
@@ -2513,7 +3249,7 @@ export default TreeOnlyExample;
|
|
|
2513
3249
|
<span class="TreeLabelNameText">
|
|
2514
3250
|
<span class="TreeLabelNameTextHeadline">Folder 03</span>
|
|
2515
3251
|
</span>
|
|
2516
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
3252
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">4</span>
|
|
2517
3253
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
2518
3254
|
</span>
|
|
2519
3255
|
</span>
|
|
@@ -2527,7 +3263,7 @@ export default TreeOnlyExample;
|
|
|
2527
3263
|
<span class="TreeLabelNameText">
|
|
2528
3264
|
<span class="TreeLabelNameTextHeadline">Folder 04</span>
|
|
2529
3265
|
</span>
|
|
2530
|
-
<span class="TreeLabelCount label label-muted label-filled label-condensed">
|
|
3266
|
+
<span class="TreeLabelCount label label-muted label-filled label-condensed">6</span>
|
|
2531
3267
|
<span class="TreeLabelExpander rioglyph rioglyph-chevron-down ">
|
|
2532
3268
|
</span>
|
|
2533
3269
|
</span>
|
|
@@ -2548,6 +3284,55 @@ export default TreeOnlyExample;
|
|
|
2548
3284
|
</div>
|
|
2549
3285
|
```
|
|
2550
3286
|
|
|
3287
|
+
#### Props: Tree
|
|
3288
|
+
|
|
3289
|
+
### Tree
|
|
3290
|
+
|
|
3291
|
+
| Name | Type | Default | Description |
|
|
3292
|
+
| --- | --- | --- | --- |
|
|
3293
|
+
| groups | TreeGroup[] | [] | The list of groups of the items. If no groups are provided all items are rendered as flat list. |
|
|
3294
|
+
| └id | string | — | A unique identifier of a group. |
|
|
3295
|
+
| └name | string \| React.ReactNode | — | The name of a group. |
|
|
3296
|
+
| └position | 'last' | — | Can be set to "last" to enforce the last position in the tree. |
|
|
3297
|
+
| └disabled | boolean | — | Disallows the selection of the group itself. |
|
|
3298
|
+
| └icon | string | — | The rioglyph icon name for a group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
3299
|
+
| └expandedIcon | string | — | The rioglyph icon name for a expanded group. The prefix rioglyph- can be omitted. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
3300
|
+
| └className | string | — | Additional classes added to the group element. |
|
|
3301
|
+
| items | TreeItem[] | [] | The list of items. |
|
|
3302
|
+
| └id | string | — | A unique identifier of an item. |
|
|
3303
|
+
| └name | string \| TreeItemName | — | The name of an item. Either it is a plain string or an object composed of: firstName and lastName where lastName is mandatory. |
|
|
3304
|
+
| └info | string \| React.ReactNode | — | The subline of an item. This can e used to show additional information for that item. |
|
|
3305
|
+
| └type | string | — | The primary type of the item. This is also used as the fallback icon name and refers to the name of the respective rioglyph icon (excluding the rioglyph- prefix). |
|
|
3306
|
+
| └icon | string \| null | — | Optional icon override for the item. If set to a string (e.g. 'truck'), this icon will be used explicitly. If set to undefined, the type property will be used as the fallback icon. If set to null, no icon will be rendered, even if type is defined. This allows full control over the icon behavior while maintaining backward compatibility with type-based icons. For custom icons and logos, provide an image URL with one of these extensions: .png, .webp, .jpg, .jpeg, .svg. In this case, an img tag is rendered instead of the rioglyph. |
|
|
3307
|
+
| └subType | string | — | Optional sub-type of the item. This refers to the name of an additional rioglyph icon (excluding the rioglyph- prefix), typically used to render a secondary icon next to the primary one (Note: for fuel types better use the pairIcon prop). |
|
|
3308
|
+
| └pairIcon | string \| null \| undefined | — | Optional pair icon override for the subType. If set to a string (e.g. 'fuel-gas'), this icon will be used explicitly. If set to undefined, the subType property will be used as the fallback icon. If set to null, no icon will be rendered, even if subType is defined. This allows full control over the icon behavior while maintaining backward compatibility with subType-based icons. |
|
|
3309
|
+
| └groupIds | string[] | [] | List of group ids the items is associated with. |
|
|
3310
|
+
| └className | string | — | Additional classes added to the item element. |
|
|
3311
|
+
| selectedGroups | string[] | [] | List of selected group ids. |
|
|
3312
|
+
| selectedItems | string[] | [] | List of selected item ids. |
|
|
3313
|
+
| onSelectionChange | ({ items, groups }: SelectionChangeResponse) => void | — | Merged Callback for item and group selection changes. It responds with a selection object that contains the selected itemIds and groupIds: { items: [], groups: [] } |
|
|
3314
|
+
| hasMultiselect | boolean | true | Defines the selection behavior of the tree. |
|
|
3315
|
+
| showRadioButtons | boolean | false | Defines if the single selection should also show radios. |
|
|
3316
|
+
| hideSearch | boolean | false | Defines whether or not the built-in Search is shown. |
|
|
3317
|
+
| searchPlaceholder | string | — | The text used as placeholder for the search input. |
|
|
3318
|
+
| onSearchChange | (value: string) => void | — | Callback for when the search value changes. |
|
|
3319
|
+
| search | React.ReactNode | — | Used to define custom search component which replaces the built-in search. |
|
|
3320
|
+
| summary | React.ReactNode | — | Used to define custom asset type counter component which replaces the built-in summary. |
|
|
3321
|
+
| hideSummary | boolean | false | Defines whether a summary is shown. |
|
|
3322
|
+
| onTypeFilterChange | (currentTypes: string[]) => void | — | Callback triggered when the built-in asset type filter changes. This is only available when the default summary is used. |
|
|
3323
|
+
| hideTreeHead | boolean | false | Defines whether the entire area below the search field is shown or not. Note: Disabling the tree head will hide the select all checkbox and the tree options as well as the tree summary. |
|
|
3324
|
+
| treeHeaderContent | React.ReactElement | — | Additional custom content that is rendered at the top of the tree component. This can be used for nav pills. |
|
|
3325
|
+
| scrollHeight | number | — | Defines the max-height of the scrollable list. |
|
|
3326
|
+
| expandedGroups | string[] | — | List of group ids which are expanded. |
|
|
3327
|
+
| onExpandGroupsChange | (newExpandedGroups: string[]) => void | — | Callback function triggered when a group expands or collapses. |
|
|
3328
|
+
| showEmptyGroups | boolean | true | Defines whether empty groups are shown or not. |
|
|
3329
|
+
| treeOptions | React.ReactNode[] | — | Component to offer customization options for the tree. |
|
|
3330
|
+
| treeOptionsTooltip | React.ReactNode | — | Tooltip content for the tree options dropdown. |
|
|
3331
|
+
| disableAnimation | boolean | false | Disables animation when filtering or using search |
|
|
3332
|
+
| virtualizeThreshold | number | 50 | The number of items (including groups and children) used for virtualizing the tree. |
|
|
3333
|
+
| overscan | number | 5 | The number of items rendered beyond the visible area of a virtualized tree. |
|
|
3334
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
3335
|
+
|
|
2551
3336
|
## TreeSummary with assetCounts
|
|
2552
3337
|
|
|
2553
3338
|
### Example: Example 8
|
|
@@ -2618,6 +3403,37 @@ export default TreeSummaryExample;
|
|
|
2618
3403
|
</div>
|
|
2619
3404
|
```
|
|
2620
3405
|
|
|
3406
|
+
#### Props: TreeSummary
|
|
3407
|
+
|
|
3408
|
+
### TreeSummary
|
|
3409
|
+
|
|
3410
|
+
| Name | Type | Default | Description |
|
|
3411
|
+
| --- | --- | --- | --- |
|
|
3412
|
+
| assetCounts | TreeSummaryCounts | — | The object containing various asset type counter. |
|
|
3413
|
+
| └truck | number | — | The amount of trucks |
|
|
3414
|
+
| └trailer | number | — | The amount of trailers |
|
|
3415
|
+
| └bus | number | — | The amount of buses |
|
|
3416
|
+
| └van | number | — | The amount of vans |
|
|
3417
|
+
| └car | number | — | The amount of cars |
|
|
3418
|
+
| └driver | number | — | The amount of drivers |
|
|
3419
|
+
| gridCols | number | 4 | The number of grid columns used for the built-in TreeSummaryRow. |
|
|
3420
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
3421
|
+
|
|
3422
|
+
#### Props: TypeCounter
|
|
3423
|
+
|
|
3424
|
+
### TypeCounter
|
|
3425
|
+
|
|
3426
|
+
| Name | Type | Default | Description |
|
|
3427
|
+
| --- | --- | --- | --- |
|
|
3428
|
+
| type | string | — | The item type for that counter. This will be used as a return value for the onClick callback. |
|
|
3429
|
+
| icon | string | — | The icon name. Note, when using the built-in generic type counter, the icon name will the same as the item type. So make sure there is a corresponding icon for the defined type. |
|
|
3430
|
+
| isActive | boolean | — | Sets the active styling if active |
|
|
3431
|
+
| hasFilter | boolean | false | Should be set when there is a type filter set in the tree to style the counter accordingly. |
|
|
3432
|
+
| enableActivity | boolean | false | Allows for interactivity. Use this prop when you allow clicking on the counter. |
|
|
3433
|
+
| hideOnZero | boolean | false | Defines if the counter is rendered at all when the value is not defined ot 0. |
|
|
3434
|
+
| onClick | (type: string) => void | — | Callback function when the counter is clicked. It returns the type value. Make sure the "type" prop is defined to receive the value in the callback. |
|
|
3435
|
+
| value | string \| React.ReactNode \| number | — | A custom value to be shown in the counter. |
|
|
3436
|
+
|
|
2621
3437
|
## TreeSummary with TypeCounter
|
|
2622
3438
|
|
|
2623
3439
|
### Example: Example 9
|
|
@@ -2661,4 +3477,35 @@ export default TreeSummaryCustomExample;
|
|
|
2661
3477
|
<span class="TreeLabelCount label label-condensed label-muted label-filled">15</span>
|
|
2662
3478
|
</div>
|
|
2663
3479
|
</div>
|
|
2664
|
-
```
|
|
3480
|
+
```
|
|
3481
|
+
|
|
3482
|
+
#### Props: TreeSummary
|
|
3483
|
+
|
|
3484
|
+
### TreeSummary
|
|
3485
|
+
|
|
3486
|
+
| Name | Type | Default | Description |
|
|
3487
|
+
| --- | --- | --- | --- |
|
|
3488
|
+
| assetCounts | TreeSummaryCounts | — | The object containing various asset type counter. |
|
|
3489
|
+
| └truck | number | — | The amount of trucks |
|
|
3490
|
+
| └trailer | number | — | The amount of trailers |
|
|
3491
|
+
| └bus | number | — | The amount of buses |
|
|
3492
|
+
| └van | number | — | The amount of vans |
|
|
3493
|
+
| └car | number | — | The amount of cars |
|
|
3494
|
+
| └driver | number | — | The amount of drivers |
|
|
3495
|
+
| gridCols | number | 4 | The number of grid columns used for the built-in TreeSummaryRow. |
|
|
3496
|
+
| className | string | — | Additional classes added to the wrapping element. |
|
|
3497
|
+
|
|
3498
|
+
#### Props: TypeCounter
|
|
3499
|
+
|
|
3500
|
+
### TypeCounter
|
|
3501
|
+
|
|
3502
|
+
| Name | Type | Default | Description |
|
|
3503
|
+
| --- | --- | --- | --- |
|
|
3504
|
+
| type | string | — | The item type for that counter. This will be used as a return value for the onClick callback. |
|
|
3505
|
+
| icon | string | — | The icon name. Note, when using the built-in generic type counter, the icon name will the same as the item type. So make sure there is a corresponding icon for the defined type. |
|
|
3506
|
+
| isActive | boolean | — | Sets the active styling if active |
|
|
3507
|
+
| hasFilter | boolean | false | Should be set when there is a type filter set in the tree to style the counter accordingly. |
|
|
3508
|
+
| enableActivity | boolean | false | Allows for interactivity. Use this prop when you allow clicking on the counter. |
|
|
3509
|
+
| hideOnZero | boolean | false | Defines if the counter is rendered at all when the value is not defined ot 0. |
|
|
3510
|
+
| onClick | (type: string) => void | — | Callback function when the counter is clicked. It returns the type value. Make sure the "type" prop is defined to receive the value in the callback. |
|
|
3511
|
+
| value | string \| React.ReactNode \| number | — | A custom value to be shown in the counter. |
|