You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/list/readme.md
+25-25Lines changed: 25 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -52,38 +52,38 @@ Is used as a wrapper for the list. It can hold properties that affect to the who
52
52
53
53
Represents a list item that can have avatar, icons, title, subtitle, etc. Note: you have to set it as an inmediate child of `List` component.
54
54
55
-
| Name | Type | Default | Description|
55
+
| Name | Type | Default| Description|
56
56
|:-----|:-----|:-----|:-----|
57
-
|`avatar`|`String`|| A string URL to specify an avatar in the left side of the item.|
58
-
|`caption`|`String`|| Main text of the item.|
59
-
|`className`|`String`|`''`| Set a class to give custom styles to the list item.|
60
-
|`disabled`|`String`|`false`| If true, the item is displayed as disabled and is not clickable.|
61
-
|`itemContent`|`Element`|| An element that will be displayed as the item. If set, this will override `caption` and `legend`.|
62
-
|`leftActions`|`Array of Elements`|| A list of elements that are placed on the left side of the item and after the avatar attribute.|
63
-
|`leftIcon`|`Any`|| A string key of a font icon or element to display an icon in the left side of the item. |
64
-
|`legend`|`String`|| Secondary text to display under the caption.|
65
-
|`onClick`|`Function`|| Callback the is invoked when the item is clicked if it's not disabled. |
66
-
|`rightIcon`|`Any`|| The same as the `leftIcon` but in this case the icon is displayed in the right side.|
67
-
|`rightActions`|`Array of Elements`|| A list of elements that are placed on the right side of the item and after the rightIcon attribute.|
68
-
|`ripple`|`Boolean`|`false`| If true, the item displays a ripple effect on click. By default it's inherited from the parent element.|
69
-
|`selectable`|`Boolean`|`false`| If true, the elements in the list will display a hover effect and a pointer cursor. Inherited from the parent.|
70
-
|`to`|`String`|| In case you want to provide the item as a link, you can pass this property to specify the href. |
57
+
|`avatar`|`String`|| A string URL to specify an avatar in the left side of the item.|
58
+
|`caption`|`String`|| Main text of the item.|
59
+
|`className`|`String`|`''`| Set a class to give custom styles to the list item.|
60
+
|`disabled`|`String`|`false`| If true, the item is displayed as disabled and is not clickable.|
61
+
|`itemContent`|`Element`|| An element that will be displayed as the item. If set, this will override `caption` and `legend`.|
62
+
|`leftActions`|`Array of Elements`|| A list of elements that are placed on the left side of the item and after the avatar attribute.|
63
+
|`leftIcon`|`Any`|| A string key of a font icon or element to display an icon in the left side of the item. |
64
+
|`legend`|`String`|| Secondary text to display under the caption.|
65
+
|`onClick`|`Function`|| Callback the is invoked when the item is clicked if it's not disabled. |
66
+
|`rightIcon`|`Any`|| The same as the `leftIcon` but in this case the icon is displayed in the right side.|
67
+
|`rightActions`|`Array of Elements`|| A list of elements that are placed on the right side of the item and after the rightIcon attribute.|
68
+
|`ripple`|`Boolean`|`false`| If true, the item displays a ripple effect on click. By default it's inherited from the parent element.|
69
+
|`selectable`|`Boolean`|`false`| If true, the elements in the list will display a hover effect and a pointer cursor. Inherited from the parent.|
70
+
|`to`|`String`|| In case you want to provide the item as a link, you can pass this property to specify the href. |
71
71
72
72
## List Checkbox
73
73
74
74
A special type of item that has a checkbox control on the left side. It implements similar methods to the `ListItem` component and some additional to control the checkbox.
75
75
76
-
| Name | Type | Default | Description|
76
+
| Name | Type | Default| Description|
77
77
|:-----|:-----|:-----|:-----|
78
-
|`caption`|`String`|| Main text of the item. Required.|
79
-
|`className`|`String`|| Set a class to give custom styles to Component.|
80
-
|`checked`|`Boolean`|`false`| If true the checkbox appears checked by default.|
81
-
|`disabled`|`String`|`false`| If true, the item is displayed as disabled and it's not clickable.|
82
-
|`legend`|`String`|| Secondary text to display under the caption.|
83
-
|`name`|`String`|| Name for the checkbox input item.|
84
-
|`onBlur`|`Function`|| Callback called when the input element is blurred.|
85
-
|`onChange`|`Function`|| Callback called when the input element is changed.|
86
-
|`onFocus`|`Function`|| Callback called when the input element is focused.|
78
+
|`caption`|`String`|| Main text of the item. Required.|
79
+
|`className`|`String`|| Set a class to give custom styles to Component.|
80
+
|`checked`|`Boolean`|`false`| If true the checkbox appears checked by default.|
81
+
|`disabled`|`String`|`false`| If true, the item is displayed as disabled and it's not clickable.|
82
+
|`legend`|`String`|| Secondary text to display under the caption.|
83
+
|`name`|`String`|| Name for the checkbox input item.|
84
+
|`onBlur`|`Function`|| Callback called when the input element is blurred.|
85
+
|`onChange`|`Function`|| Callback called when the input element is changed.|
86
+
|`onFocus`|`Function`|| Callback called when the input element is focused.|
0 commit comments