Skip to content

Commit

Permalink
Fixed spacing for list readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@KerenChandran
KerenChandran committed Mar 25, 2016
1 parent e7a2622 commit 1a9fe24
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions components/list/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,38 +52,38 @@ Is used as a wrapper for the list. It can hold properties that affect to the who

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.

| Name | Type | Default | Description|
| Name | Type | Default | Description|
|:-----|:-----|:-----|:-----|
| `avatar` | `String` | | A string URL to specify an avatar in the left side of the item.|
| `caption` | `String` | | 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` | `Any` | | 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.|
| `onClick` | `Function` | | Callback the is invoked when the item is clicked if it's not disabled. |
| `rightIcon` | `Any` | | 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.|
| `ripple` | `Boolean` | `false` | If true, the item displays a ripple effect on click. By default it's inherited from the parent element.|
| `selectable` | `Boolean` | `false` | If true, the elements in the list will display a hover effect and a pointer cursor. Inherited from the parent.|
| `to` | `String` | | In case you want to provide the item as a link, you can pass this property to specify the href. |
| `avatar` | `String` | | A string URL to specify an avatar in the left side of the item.|
| `caption` | `String` | | 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` | `Any` | | 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.|
| `onClick` | `Function` | | Callback the is invoked when the item is clicked if it's not disabled. |
| `rightIcon` | `Any` | | 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.|
| `ripple` | `Boolean` | `false` | If true, the item displays a ripple effect on click. By default it's inherited from the parent element.|
| `selectable` | `Boolean` | `false` | If true, the elements in the list will display a hover effect and a pointer cursor. Inherited from the parent.|
| `to` | `String` | | In case you want to provide the item as a link, you can pass this property to specify the href. |

## List Checkbox

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.

| Name | Type | Default | Description|
| Name | Type | Default | Description|
|:-----|:-----|:-----|:-----|
| `caption` | `String` | | Main text of the item. Required.|
| `className` | `String` | | Set a class to give custom styles to Component.|
| `checked` | `Boolean` | `false` | If true the checkbox appears checked by default.|
| `disabled` | `String` | `false` | If true, the item is displayed as disabled and it's not clickable.|
| `legend` | `String` | | Secondary text to display under the caption.|
| `name` | `String` | | Name for the checkbox input item.|
| `onBlur` | `Function` | | Callback called when the input element is blurred.|
| `onChange` | `Function` | | Callback called when the input element is changed.|
| `onFocus` | `Function` | | Callback called when the input element is focused.|
| `caption` | `String` | | Main text of the item. Required.|
| `className` | `String` | | Set a class to give custom styles to Component.|
| `checked` | `Boolean` | `false` | If true the checkbox appears checked by default.|
| `disabled` | `String` | `false` | If true, the item is displayed as disabled and it's not clickable.|
| `legend` | `String` | | Secondary text to display under the caption.|
| `name` | `String` | | Name for the checkbox input item.|
| `onBlur` | `Function` | | Callback called when the input element is blurred.|
| `onChange` | `Function` | | Callback called when the input element is changed.|
| `onFocus` | `Function` | | Callback called when the input element is focused.|

## List Subheader

Expand Down

0 comments on commit 1a9fe24

Please sign in to comment.