vitalif
/
react-toolbox
1
0
Fork 0
Code Issues Pull Requests Releases 12 Wiki Activity

fix #1611 (#1612) 

Added correct proptypes on `ListItemLayout` and updated documentation for ListItem's fields `legend` and `caption`.
old
TeoMatthew 2017-08-02 18:08:28 +02:00 committed by Javi Velasco
parent 0e299a65b1
commit df175e7f0d
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
components/list/ListItemLayout.js
View File

@ -43,7 +43,10 @@ const factory = (Avatar, ListItemContent, ListItemActions) => {
PropTypes.string,
PropTypes.element,
]),
caption: PropTypes.string,
caption: PropTypes.oneOfType([
PropTypes.string,
PropTypes.node,
]),
className: PropTypes.string,
disabled: PropTypes.bool,
itemContent: PropTypes.element,
@ -52,7 +55,10 @@ const factory = (Avatar, ListItemContent, ListItemActions) => {
PropTypes.string,
PropTypes.element,
]),
legend: PropTypes.string,
legend: PropTypes.oneOfType([
PropTypes.string,
PropTypes.node,
]),
rightActions: PropTypes.arrayOf(PropTypes.node),
rightIcon: PropTypes.oneOfType([
PropTypes.string,

4
components/list/readme.md
View File

@ -64,13 +64,13 @@ Represents a list item that can have avatar, icons, title, subtitle, etc. Note:
| Name | Type | Default | Description|
|:-----|:-----|:-----|:-----|
| `avatar` | `String` or `Element` | | A string URL to specify an avatar in the left side of the item.|
| `caption` | `String` | | Main text of the item.|
| `caption` | `String` or `Element` | | Main text of the item.|
| `className` | `String` | `''` | Set a class to give custom styles to the list item.|
| `disabled` | `String` | `false` | If true, the item is displayed as disabled and is not clickable.|
| `itemContent` | `Element` | | An element that will be displayed as the item. If set, this will override `caption` and `legend`.|
| `leftActions` | `Array of Elements` | | A list of elements that are placed on the left side of the item and after the avatar attribute.|
| `leftIcon` | `String` or `Element` | | A string key of a font icon or element to display an icon in the left side of the item. |
| `legend` | `String` | | Secondary text to display under the caption.|
| `legend` | `String` or `Element` | | Secondary text to display under the caption.|
| `onClick` | `Function` | | Callback the is invoked when the item is clicked if it's not disabled. |
| `rightIcon` | `String` or `Element` | | The same as the `leftIcon` but in this case the icon is displayed in the right side.|
| `rightActions` | `Array of Elements` | | A list of elements that are placed on the right side of the item and after the rightIcon attribute.|