Skip to content
This repository was archived by the owner on Mar 30, 2022. It is now read-only.

Commit 07de1ef

Browse files
committed
added list docs
1 parent 622f213 commit 07de1ef

File tree

2 files changed

+40
-13
lines changed

2 files changed

+40
-13
lines changed

README.md

Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ import Button from 'HSButton'
4545

4646
| prop | default | type | description |
4747
| ---- | ---- | ----| ---- |
48-
| buttonStyle | none | object | add additional styling for button component |
48+
| buttonStyle | none | object (style) | add additional styling for button component |
4949
| title | none | string | button title |
5050
| onPress | none | function | onPress method |
5151
| icon | none | object {name(string), color(string), size(number)} | [Material Icon Name](https://design.google.com/icons/) |
5252
| secondary | false | boolean | secondary button flag |
5353
| backgroundColor | primary color | string (color) | background color of button |
5454
| color | white | string(color) | font color |
55-
| textStyle | none | object | text styling |
55+
| textStyle | none | object (style) | text styling |
5656
| fontSize | 18 | number | font size |
5757
| underlayColor | transparent | string(color) | underlay color for button press |
5858
| raised | false | boolean | flag to add raised button styling |
@@ -83,8 +83,8 @@ import SocialIcon from 'HSSocialIcon'
8383
| type | none | social media type (facebook, twitter, google-plus-official, pinterest, linkedin, youtube, vimeo, tumblr, instagram, quora, foursquare, wordpress, stumbleupon) | social media type |
8484
| button | false | boolean | creates button |
8585
| onPress | none | funciton | onPress method |
86-
| iconStyle | none | object | extra styling for icon component ([React Native Vector Icons](https://github.com/oblador/react-native-vector-icons)) |
87-
| style | none | object | button styling |
86+
| iconStyle | none | object (style) | extra styling for icon component ([React Native Vector Icons](https://github.com/oblador/react-native-vector-icons)) |
87+
| style | none | object (style) | button styling |
8888
| iconColor | white | string | icon color |
8989
| title | none | string | title if made into a button |
9090

@@ -139,6 +139,33 @@ render () {
139139
140140
```
141141

142+
#### HSList Props
143+
144+
| prop | default | type | description |
145+
| ---- | ---- | ----| ---- |
146+
| containerStyle | none | object (style) | style the list container |
147+
148+
149+
#### HSListItem Props
150+
151+
| prop | default | type | description |
152+
| ---- | ---- | ----| ---- |
153+
| onPress | none | function | onPress method for link (optional) |
154+
| title | none | string | main title for list item (required) |
155+
| icon | none | object {name, color, style} | icon configuration for left icon (optional) |
156+
| rightIcon | chevron | string | right icon (optional) ([material icon name](https://design.google.com/icons/)) |
157+
| avatar | none | string | left avatar (optional) |
158+
| avatarStyle | none | object (style) | avatar styling (optional) |
159+
| underlayColor | white | string | define underlay color for TouchableHighlight (optional) |
160+
| subtitle | none | string | subtitle text (optional) |
161+
| subtitleStyle | none | object (style) | additional subtitle styling (optional ) |
162+
| containerStyle | none | object (style) | additional main container styling (optional) |
163+
| wrapperStyle | none | object (style) | additional wrapper styling (optional) |
164+
| titleStyle | none | object (style) | additional title styling (optional) |
165+
| hideChevron | false | boolean | set if you do not want a chevron (optional) |
166+
| chevronColor | #bdc6cf | string | set chevron color |
167+
| roundAvatar | false | boolan | make left avatar round |
168+
142169
## Forms
143170

144171
![Forms](http://i.imgur.com/9idGiXr.png)
@@ -157,15 +184,15 @@ import FormInput from 'HSFormInput'
157184

158185
| prop | default | type | description |
159186
| ---- | ---- | ----| ---- |
160-
| containerStyle | none | object | TextInput container styling |
161-
| inputStyle | none | object | TextInput styling |
187+
| containerStyle | none | object (style) | TextInput container styling |
188+
| inputStyle | none | object (style) | TextInput styling |
162189

163190
### FormLabel
164191

165192
| prop | default | type | description |
166193
| ---- | ---- | ----| ---- |
167-
| containerStyle | none | object | additional label container style |
168-
| labelStyle | none | object | additional label styling |
194+
| containerStyle | none | object (style) | additional label container style |
195+
| labelStyle | none | object (style) | additional label styling |
169196

170197
## Card
171198

@@ -185,9 +212,9 @@ import Card from 'HSCard'
185212
| prop | default | type | description |
186213
| ---- | ---- | ----| ---- |
187214
| flexDirection | column | string | flex direction (row or column) |
188-
| containerStyle | none | object | outer container style |
189-
| wrapperStyle | none | object | inner container style |
215+
| containerStyle | none | object (style) | outer container style |
216+
| wrapperStyle | none | object (style) | inner container style |
190217
| title | none | string | optional card title |
191-
| titleStyle | none | object | additional title styling (if title provided) |
192-
| dividerStyle | none | object | additional divider styling (if title provided) |
218+
| titleStyle | none | object (style) | additional title styling (if title provided) |
219+
| dividerStyle | none | object (style) | additional divider styling (if title provided) |
193220

src/components/list/ListItem.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ const ListItem = ({
3838
icon && icon.name && (
3939
<Icon
4040
size={28}
41-
style={styles.icon}
41+
style={[styles.icon, icon.style && icon.style]}
4242
name={icon.name}
4343
color={icon.color || colors.grey4}
4444
/>

0 commit comments

Comments
 (0)