Skip to content

Commit

Permalink
fix 2.0.4 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeremy Hamilton authored and flyingcircle committed Jul 31, 2020
1 parent d85ba8e commit b16e081
Show file tree
Hide file tree
Showing 12 changed files with 141 additions and 119 deletions.
2 changes: 1 addition & 1 deletion website/versioned_docs/version-2.0.4/card.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import { Card, ListItem, Button, Icon } from 'react-native-elements'
key={i}
roundAvatar
title={u.name}
avatar={{uri:u.avatar}}
leftAvatar={{ source: { uri: u.avatar } }}
/>
);
})
Expand Down
46 changes: 43 additions & 3 deletions website/versioned_docs/version-2.0.4/checkbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ type of icon set. [Supported sets here](icon.md#available-icon-sets).
| :----: | :----------: |
| string | font-awesome |

---

### `Component`

Specify React Native component for main button (optional)
Expand All @@ -100,6 +102,8 @@ Specify React Native component for main button (optional)
| :--------------------: | :--------------: |
| React Native Component | TouchableOpacity |

---

### `checked`

Flag for checking the icon (required)
Expand All @@ -108,6 +112,8 @@ Flag for checking the icon (required)
| :-----: | :-----: |
| boolean | false |

---

### `size`

Size of the checkbox
Expand All @@ -116,6 +122,8 @@ Size of the checkbox
| :----: | :-----: |
| number | 24 |

---

### `iconRight`

Moves icon to right of text (optional)
Expand All @@ -124,6 +132,8 @@ Moves icon to right of text (optional)
| :-----: | :-----: |
| boolean | false |

---

### `right`

Aligns checkbox to right (optional)
Expand All @@ -132,6 +142,8 @@ Aligns checkbox to right (optional)
| :-----: | :-----: |
| boolean | false |

---

### `center`

Aligns checkbox to center (optional)
Expand All @@ -140,13 +152,17 @@ Aligns checkbox to center (optional)
| :-----: | :-----: |
| boolean | false |

---

### `title`

Title of checkbox

| Type | Default |
| :----: | :-----: |
| string | none |
| Type | Default |
| :------------------------------: | :-----: |
| string OR React Native Component | none |

---

### `titleProps`

Expand All @@ -156,6 +172,8 @@ Additional props for the title Text component (optional)
| :--------------------------------------------------------------------------: | :-----: |
| {[...Text props](https://facebook.github.io/react-native/docs/text#props-1)} | none |

---

### `containerStyle`

Style of main container (optional)
Expand All @@ -164,6 +182,8 @@ Style of main container (optional)
| :------------: | :-----: |
| object (style) | none |

---

### `textStyle`

Style of text (optional)
Expand All @@ -172,6 +192,8 @@ Style of text (optional)
| :------------: | :-----: |
| object (style) | none |

---

### `onLongPress`

onLongPress function for checkbox (optional)
Expand All @@ -180,6 +202,8 @@ onLongPress function for checkbox (optional)
| :------: | :-----: |
| function | none |

---

### `onLongIconPress`

onLongPress function for checkbox (optional)
Expand All @@ -188,6 +212,8 @@ onLongPress function for checkbox (optional)
| :------: | :-----: |
| function | none |

---

### `onPress`

onPress function for container (optional)
Expand All @@ -196,6 +222,8 @@ onPress function for container (optional)
| :------: | :-----: |
| function | none |

---

### `onIconPress`

onPress function for checkbox (required)
Expand All @@ -204,6 +232,8 @@ onPress function for checkbox (required)
| :------: | :-----: |
| function | none |

---

### `checkedIcon`

Default checked icon ([Font Awesome Icon](http://fontawesome.io/icons/))
Expand All @@ -213,6 +243,8 @@ Default checked icon ([Font Awesome Icon](http://fontawesome.io/icons/))
| :------------------------------: | :------------: |
| string OR React Native Component | check-square-o |

---

### `uncheckedIcon`

Default checked icon ([Font Awesome Icon](http://fontawesome.io/icons/))
Expand All @@ -222,6 +254,8 @@ Default checked icon ([Font Awesome Icon](http://fontawesome.io/icons/))
| :------------------------------: | :------: |
| string OR React Native Component | square-o |

---

### `checkedColor`

Default checked color (optional)
Expand All @@ -230,6 +264,8 @@ Default checked color (optional)
| :----: | :-----: |
| string | green |

---

### `uncheckedColor`

Default unchecked color (optional)
Expand All @@ -238,6 +274,8 @@ Default unchecked color (optional)
| :----: | :-----: |
| string | #bfbfbf |

---

### `checkedTitle`

Specify a custom checked message (optional)
Expand All @@ -246,6 +284,8 @@ Specify a custom checked message (optional)
| :----: | :-----: |
| string | none |

---

### `fontFamily`

Specify different font family
Expand Down
44 changes: 26 additions & 18 deletions website/versioned_docs/version-2.0.4/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,27 @@ Here are some of some of ways you can help:

## Reporting Bugs

React Native Elements is used by many people, in fact they're over 9000 persons
using it in their projects. With that many use cases, bugs are sure to come up
from time to time. We release almost every two weeks, so sometimes we may
accidentally miss something along the way. When you think you've found a bug
here's what to do:

1. Check your version. Most of the time, a fix has been made and released in new
a new version. However, you may still be on an old version. The easiest way
to validate this, it to update your version of react-native-elements to the
React Native Elements has over 9000 users actively developing and using this
library in their projects. With that many use cases, bugs are sure to come up
from time to time. When you think you've found a bug, here's what to do:

1. Check your version. A fix may have already been released in new
a newer version. Update your version of react-native-elements to the
latest.

2. Search the existing
[issues](https://github.com/react-native-elements/react-native-elements/issues)
and
[pull requests](https://github.com/react-native-elements/react-native-elements/pulls)
for one like what you're seeing. If you see one, add a 👍 reaction (please no
[pull requests](https://github.com/react-native-elements/react-native-elements/pulls).
If you see one, add a 👍 reaction (please no
+1 comments). Read through the comments and see if you can provide anymore
valuable information to the thread. The more use cases we have, the easier it
is to solve the issue.

3. If there are no other issues like yours then create a new one. New issues
3. If there are no other issues like yours, then create a new one. New issues
come with a issue template, so make sure to fill out as much information as
possible.
possible. If possible, please also provide a [snack](https://snack.expo.io/)
demonstrating the issue.

If this is your first open source contribution, please take a look at
[this](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
Expand All @@ -65,7 +63,7 @@ A few things to consider/add:
When someone posts an issue, a maintainer might not be able to respond right
away. Or a person may post and issue that has incomplete information. As a
contributor you can help by answering the issue yourself if you know the cause
of it, or help the maintainers by making sure that all the information necessary
of it, or help the maintainers by making sure all the information necessary
to validate the issue is there.

## Improving the Documentation
Expand Down Expand Up @@ -157,8 +155,8 @@ For all issues that are bugs check

Improvements are separated into two categories:

- [New components](https://github.com/react-native-elements/react-native-elements/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3A%22💡New+Component%22+-label%3A%22✅+Fixed+-+Next+Release%22+-label%3A%22📥+PR+Submitted%22+).
- [Enhancements](https://github.com/react-native-elements/react-native-elements/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3A%22✨Enhancement%22+-label%3A%22✅+Fixed+-+Next+Release%22+-label%3A%22📥+PR+Submitted%22).
- [New components](https://github.com/react-native-elements/react-native-elements/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3A%22💡New+Component%22+-label%3A%22✅+Fixed+-+Next+Release%22+-label%3A%22📥+PR+Submitted%22+)
- [Enhancements](https://github.com/react-native-elements/react-native-elements/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3A%22✨Enhancement%22+-label%3A%22✅+Fixed+-+Next+Release%22+-label%3A%22📥+PR+Submitted%22)

Check out the [Labels guide](labels.md) for a more descriptive info on our usage
of labels.
Expand All @@ -178,8 +176,8 @@ setup on your local machine:
- `yarn install` OR `npm install`
- `npm test`

One you have done this, create a new branch with a name that loosely describes
the issue on which you will be working. Once you think you have the addressed
Now create a new branch with a name that loosely describes
the issue on which you will be working. Once you think you have addressed
the issue in question, submit a pull request to the `next` branch.

### Committing and Pushing Changes
Expand All @@ -189,3 +187,13 @@ to the repo. This helps tremendously when sifting through the commit history to
find a particular changeset. A useful guide for creating meaningful commit
messages can be found
[here.](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#specification)

### Branching Strategy

There are 3 main branches:

- `master` is the branch with the most recent deployed version
- `next` is the main development branch. For new features and enhancements, base the
changes off this branch.
- `patch` is a branch for working on patch releases. If you have a bug fix
that requires a fast release, use this branch.
4 changes: 2 additions & 2 deletions website/versioned_docs/version-2.0.4/listitem.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,8 +230,8 @@ import LinearGradient from 'react-native-linear-gradient'; // Only if no expo
activeScale={0.95} //
linearGradientProps={{
colors: ['#FF9800', '#F44336'],
start: [1, 0],
end: [0.2, 0],
start: { x: 1, y: 0 },
end: { x: 0.2, y: 0 },
}}
ViewComponent={LinearGradient} // Only if no expo
leftAvatar={{ rounded: true, source: { uri: avatar_url } }}
Expand Down
Loading

0 comments on commit b16e081

Please sign in to comment.