Skip to content

Commit 7701125

Browse files
committed
Update dual-list-select docs
1 parent 950d21c commit 7701125

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

packages/react-renderer-demo/src/doc-components/examples-texts/pf4/dual-list.md renamed to packages/react-renderer-demo/src/doc-components/examples-texts/pf4/dual-list-select.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Dual list select is wrapped in a form group, so it accepts all [form group props
77
|Props|Type|Default|Description|
88
|-----|----|-------|-----------|
99
|options|array|[]|`[{label, value}]`|
10+
|label|node|FormLabel primary text|
1011
|leftTitle|String|'Options'|Title for options|
1112
|rightTitle|String|'Selected'|Title for selected items|
1213
|moveLeftTitle|String|'Move selected to left'|Tooltip for move to left button|
@@ -22,3 +23,39 @@ Dual list select is wrapped in a form group, so it accepts all [form group props
2223
|filterValueText|String|'Remove your filter to see all selected'|Placeholder for value when there is no filtered value|
2324
|filterOptionsText|String|'Remove your filter to see all options'|Placeholder for options when there is no filtered option|
2425
|renderStatus|function|'null'|A function that renders status text below the toolbar filter. For example, display how many items were selected: `({selected, options}) => "selected " + selected + " out of " + options`|
26+
27+
### Customization
28+
29+
MUI DualListSelect provides fully customization. When the props offers Right/Left variant, you can pass props to `RightXXX` or to `LeftXXX` props. Example: `ListGridProps` is Right/Left, so there are two more props: `RightListGridProps` and `LeftListGridProps`. These props overrides the standard props, except `className`, that are being combined. All these props are objects.
30+
31+
|Props|Right/Left variant|
32+
|-----|----|
33+
|FormGroupProps||
34+
|ListProps|yes|
35+
|ListItemProps|yes|
36+
|ToolbarProps|yes|
37+
|FilterFieldProps|yes|
38+
|SearchIconProps|yes|
39+
|SearchIconButtonProps|yes|
40+
|SortIconButtonProps|yes|
41+
|SortIconProps|yes|
42+
|InternalGridProps|yes|
43+
|ListGridProps|yes|
44+
|TitleProps|yes|
45+
|ButtonsGridProps||
46+
|ButtonsInternalFlexProps||
47+
|ButtonFlexProps||
48+
|ToRightFlexProps||
49+
|IconButtonProps||
50+
|ToRightIconButtonProps||
51+
|IconProps||
52+
|AllToRightFlexProps||
53+
|AllToRightIconButtonProps||
54+
|AllToLeftFlexProps||
55+
|AllToLeftIconButtonProps||
56+
|ToLeftFlexProps||
57+
|ToLeftIconButtonProps||
58+
|ToRightIconProps||
59+
|AllToRightIconProps||
60+
|AllToLeftIconProps||
61+
|ToLeftIconProps||

0 commit comments

Comments
 (0)