Skip to content

Commit cfb54f0

Browse files
rvsiaHyperkid123
authored andcommitted
Add docs for blueprint dual list select
1 parent 9090a1d commit cfb54f0

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

packages/react-renderer-demo/src/doc-components/dual-list-select.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import React from 'react';
22
import PropTypes from 'prop-types';
33
import MuiDualListSelect from './examples-texts/mui/mui-dual-list-select.md';
44
import SuirDualListSelect from './examples-texts/suir/suir-dual-list-select.md';
5+
import BlueprintDualListSelect from './examples-texts/blueprint/blueprint-dual-list-select.md';
56
import GenericMuiComponent from '../helpers/generic-mui-component';
67

78
const DualListSelect = ({ activeMapper }) => {
@@ -13,6 +14,10 @@ const DualListSelect = ({ activeMapper }) => {
1314
return <SuirDualListSelect />;
1415
}
1516

17+
if (activeMapper === 'blueprint') {
18+
return <BlueprintDualListSelect />;
19+
}
20+
1621
return <GenericMuiComponent activeMapper={activeMapper} component="dual-list-select" />;
1722
};
1823

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
This a custom component with a custom design.
2+
3+
**Props**
4+
5+
Dual list select is wrapped in a form group, so it accepts all [form group props](/renderer/component-api#formgroupwrappedcomponents).
6+
7+
|Props|Type|Default|Description|
8+
|-----|----|-------|-----------|
9+
|options|array|[]|`[{label, value, ...props}]` *see below*|
10+
|leftTitle|String|'Options'|Title for options|
11+
|rightTitle|String|'Selected'|Title for selected items|
12+
|moveLeftTitle|String|'Move selected to left'|Tooltip for move to left button|
13+
|moveRightTitle|String|'Move selected to right'|Tooltip for move to right button|
14+
|moveAllLeftTitle|String|'Move all to left'|Tooltip for move all to left button|
15+
|moveAllRightTitle|String|'Move all to right'|Tooltip for move all to right button|
16+
|allToLeft|Boolean|true|Hides all to left button|
17+
|allToRight|Boolean|true|Hides all to right button|
18+
|noValueTitle|String|'No selected'|Placeholder for empty value|
19+
|noOptionsTitle|String|'No available options'|Placeholder for empty options|
20+
|filterOptionsTitle|String|'Filter options'|Placeholder for options filter input|
21+
|filterValueTitle|String|'Filter selected value'|Placeholder for value filter input|
22+
|filterValueText|String|'Remove your filter to see all selected'|Placeholder for value when there is no filtered value|
23+
|filterOptionsText|String|'Remove your filter to see all options'|Placeholder for options when there is no filtered option|
24+
25+
**Options**
26+
27+
|Props|Type|Description|
28+
|-----|----|-----------|
29+
|value|string|Value of the option|
30+
|label|node|ListItemText primary text|
31+
|MenuItemProps|object|Props passed to MenuItem|
32+
33+
**Customization**
34+
35+
|Props|
36+
|-----|
37+
|LeftWrapperProps|
38+
|RightWrapperProps|
39+
|ButtonGroupProps|
40+
|ToRightButtonProps|
41+
|AllToRightButtonProps|
42+
|AllToLeftButtonProps|
43+
|ToLeftButtonProps|
44+
|LeftControlGroupProps|
45+
|LeftInputGroupProps|
46+
|LeftButtonProps|
47+
|RightControlGroupProps|
48+
|RightInputGroupProps|
49+
|RightButtonProps|
50+
|LeftMenuProps|
51+
|LeftMenuItemProps|
52+
|RightMenuProps|
53+
|RightMenuItemProps|

0 commit comments

Comments
 (0)