From 653ef8a0bac9794668f0383f90b22147af5b0f74 Mon Sep 17 00:00:00 2001 From: Jeremy Hamilton Date: Wed, 16 Dec 2020 14:41:51 -0800 Subject: [PATCH] update to version 3.0.0 --- package.json | 2 +- website/docs/input.md | 8 +- website/docs/searchbar.md | 2 +- website/docs/testing.md | 4 +- website/versioned_docs/version-1.2.0/input.md | 2 +- .../versioned_docs/version-1.2.0/searchbar.md | 2 +- .../versioned_docs/version-1.2.0/testing.md | 4 +- website/versioned_docs/version-2.0.4/badge.md | 243 ------- .../versioned_docs/version-2.0.4/button.md | 344 --------- .../version-2.0.4/button_group.md | 308 -------- website/versioned_docs/version-2.0.4/card.md | 236 ------- .../versioned_docs/version-2.0.4/checkbox.md | 295 -------- .../version-2.0.4/customization.md | 429 ----------- .../version-2.0.4/getting_started.md | 85 --- website/versioned_docs/version-2.0.4/icon.md | 271 ------- website/versioned_docs/version-2.0.4/image.md | 100 --- website/versioned_docs/version-2.0.4/input.md | 322 --------- .../versioned_docs/version-2.0.4/listitem.md | 667 ------------------ .../versioned_docs/version-2.0.4/rating.md | 306 -------- .../versioned_docs/version-2.0.4/slider.md | 262 ------- .../versioned_docs/version-2.0.4/testing.md | 48 -- website/versioned_docs/version-2.0.4/tile.md | 286 -------- .../versioned_docs/version-2.0.4/tooltip.md | 254 ------- .../versioned_docs/version-2.2.1/avatar.md | 412 ----------- .../version-2.2.1/bottomsheet.md | 121 ---- website/versioned_docs/version-2.2.1/card.md | 236 ------- .../version-2.2.1/contributing.md | 199 ------ .../versioned_docs/version-2.2.1/divider.md | 36 - .../versioned_docs/version-2.2.1/header.md | 308 -------- .../versioned_docs/version-2.2.1/labels.md | 126 ---- .../versioned_docs/version-2.2.1/listitem.md | 667 ------------------ .../versioned_docs/version-2.2.1/overlay.md | 136 ---- .../versioned_docs/version-2.2.1/overview.md | 33 - .../versioned_docs/version-2.2.1/pricing.md | 154 ---- .../versioned_docs/version-2.2.1/searchbar.md | 397 ----------- .../version-2.2.1/social_icons.md | 279 -------- website/versioned_docs/version-2.2.1/text.md | 127 ---- .../version-2.2.1/troubleshooting.md | 158 ----- .../versioned_docs/version-2.2.1/web_usage.md | 79 --- website/versioned_docs/version-2.3.2/input.md | 2 +- .../versioned_docs/version-2.3.2/searchbar.md | 2 +- .../versioned_docs/version-2.3.2/testing.md | 4 +- .../avatar.md | 122 ++-- .../{version-2.2.1 => version-3.0.0}/badge.md | 44 +- .../version-3.0.0/bottomsheet.md | 81 +++ .../button.md | 22 +- .../button_group.md | 6 +- website/versioned_docs/version-3.0.0/card.md | 123 ++++ .../checkbox.md | 208 +++--- .../contributing.md | 0 .../customization.md | 27 + .../divider.md | 0 .../getting_started.md | 1 - .../header.md | 108 +-- .../{version-2.2.1 => version-3.0.0}/icon.md | 72 +- .../{version-2.2.1 => version-3.0.0}/image.md | 66 +- .../{version-2.2.1 => version-3.0.0}/input.md | 110 +-- .../labels.md | 0 .../versioned_docs/version-3.0.0/listitem.md | 407 +++++++++++ .../overlay.md | 22 +- .../overview.md | 0 .../pricing.md | 118 ++-- .../rating.md | 112 +-- .../searchbar.md | 232 +++--- .../slider.md | 44 +- .../social_icons.md | 0 .../testing.md | 4 +- .../{version-2.0.4 => version-3.0.0}/text.md | 0 .../{version-2.2.1 => version-3.0.0}/tile.md | 22 +- .../tooltip.md | 139 ++-- .../troubleshooting.md | 0 .../web_usage.md | 0 .../version-2.0.4-sidebars.json | 39 - ...ebars.json => version-3.0.0-sidebars.json} | 62 +- website/versions.json | 3 +- 75 files changed, 1426 insertions(+), 8724 deletions(-) delete mode 100644 website/versioned_docs/version-2.0.4/badge.md delete mode 100644 website/versioned_docs/version-2.0.4/button.md delete mode 100644 website/versioned_docs/version-2.0.4/button_group.md delete mode 100644 website/versioned_docs/version-2.0.4/card.md delete mode 100644 website/versioned_docs/version-2.0.4/checkbox.md delete mode 100644 website/versioned_docs/version-2.0.4/customization.md delete mode 100644 website/versioned_docs/version-2.0.4/getting_started.md delete mode 100644 website/versioned_docs/version-2.0.4/icon.md delete mode 100644 website/versioned_docs/version-2.0.4/image.md delete mode 100644 website/versioned_docs/version-2.0.4/input.md delete mode 100644 website/versioned_docs/version-2.0.4/listitem.md delete mode 100644 website/versioned_docs/version-2.0.4/rating.md delete mode 100644 website/versioned_docs/version-2.0.4/slider.md delete mode 100644 website/versioned_docs/version-2.0.4/testing.md delete mode 100644 website/versioned_docs/version-2.0.4/tile.md delete mode 100644 website/versioned_docs/version-2.0.4/tooltip.md delete mode 100644 website/versioned_docs/version-2.2.1/avatar.md delete mode 100644 website/versioned_docs/version-2.2.1/bottomsheet.md delete mode 100644 website/versioned_docs/version-2.2.1/card.md delete mode 100644 website/versioned_docs/version-2.2.1/contributing.md delete mode 100644 website/versioned_docs/version-2.2.1/divider.md delete mode 100644 website/versioned_docs/version-2.2.1/header.md delete mode 100644 website/versioned_docs/version-2.2.1/labels.md delete mode 100644 website/versioned_docs/version-2.2.1/listitem.md delete mode 100644 website/versioned_docs/version-2.2.1/overlay.md delete mode 100644 website/versioned_docs/version-2.2.1/overview.md delete mode 100644 website/versioned_docs/version-2.2.1/pricing.md delete mode 100644 website/versioned_docs/version-2.2.1/searchbar.md delete mode 100644 website/versioned_docs/version-2.2.1/social_icons.md delete mode 100644 website/versioned_docs/version-2.2.1/text.md delete mode 100644 website/versioned_docs/version-2.2.1/troubleshooting.md delete mode 100644 website/versioned_docs/version-2.2.1/web_usage.md rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/avatar.md (86%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/badge.md (98%) create mode 100644 website/versioned_docs/version-3.0.0/bottomsheet.md rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/button.md (94%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/button_group.md (95%) create mode 100644 website/versioned_docs/version-3.0.0/card.md rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/checkbox.md (100%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/contributing.md (100%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/customization.md (93%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/divider.md (100%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/getting_started.md (99%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/header.md (100%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/icon.md (100%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/image.md (81%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/input.md (94%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/labels.md (100%) create mode 100644 website/versioned_docs/version-3.0.0/listitem.md rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/overlay.md (100%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/overview.md (100%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/pricing.md (100%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/rating.md (100%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/searchbar.md (98%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/slider.md (100%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/social_icons.md (100%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/testing.md (89%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/text.md (100%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/tile.md (100%) rename website/versioned_docs/{version-2.2.1 => version-3.0.0}/tooltip.md (92%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/troubleshooting.md (100%) rename website/versioned_docs/{version-2.0.4 => version-3.0.0}/web_usage.md (100%) delete mode 100644 website/versioned_sidebars/version-2.0.4-sidebars.json rename website/versioned_sidebars/{version-2.2.1-sidebars.json => version-3.0.0-sidebars.json} (58%) diff --git a/package.json b/package.json index ed80d89f3f..dadf83470b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "react-native-elements", - "version": "3.0.0-alpha.1", + "version": "3.0.0", "description": "React Native Elements & UI Toolkit", "main": "src/index.js", "files": [ diff --git a/website/docs/input.md b/website/docs/input.md index 3a964801fd..4861f50a2c 100644 --- a/website/docs/input.md +++ b/website/docs/input.md @@ -136,9 +136,9 @@ adds error message (optional) props to be passed to the React Native `Text` component used to display the error message (optional) -| Type | Default | -| :-----------------------------------------------------------------------------: | :-----: | -| {[...Text props](https://facebook.github.io/react-native/docs/text.html#props)} | none | +| Type | Default | +| :--------------------------------------------------------: | :-----: | +| {[...Text props](https://reactnative.dev/docs/text#props)} | none | --- @@ -299,7 +299,7 @@ styling for right Icon Component container Store a reference to the Input in your component by using the ref prop provided by React -([see docs](https://facebook.github.io/react/docs/refs-and-the-dom.html)): +([see docs](https://reactjs.org/docs/refs-and-the-dom.html)): ```js const input = React.createRef(); diff --git a/website/docs/searchbar.md b/website/docs/searchbar.md index 7ccd06a307..3064e77150 100644 --- a/website/docs/searchbar.md +++ b/website/docs/searchbar.md @@ -388,7 +388,7 @@ The value of the search field Store a reference to the SearchBar in your component by using the ref prop provided by React -([see docs](https://facebook.github.io/react/docs/refs-and-the-dom.html)): +([see docs](https://reactjs.org/docs/refs-and-the-dom.html)): ```js -
- Standard -
Standard
-
-
- Mini Badge -
Mini Badge
-
-
- Badge as Indicator -
Badge as Indicator
-
- - -### Mini Badge - -This type of badge shows when no `value` prop is provided. This form is -effective for showing statuses. - -### withBadge Higher-Order Component - -The withBadge HOC allows you to easily add badges to icons and other components. - -## Usage - -```js -import { Text, View } from 'react-native' -import { Avatar, Badge, Icon, withBadge } from 'react-native-elements' - -// Standard badge - -My Custom Badge} /> - -// Mini badge - - - - - -// Avatar with mini badge - - - - - - -// withBadge HOC - -const BadgedIcon = withBadge(1)(Icon) - - -// Using the decorator proposal -@connect(state => ({ - notifications: state.notifications, -})) -@withBadge(props => props.notifications.length) -export default class MyDecoratedIcon extends React.Component { - render() { - return ( - - ); - } -} -``` - ---- - -## Props - -- [`badgeStyle`](#badgestyle) -- [`containerStyle`](#containerstyle) -- [`onPress`](#onpress) -- [`status`](#status) -- [`textProps`](#textprops) -- [`textStyle`](#textstyle) -- [`value`](#value) -- [`Component`](#Component) - ---- - -## Reference - -### `badgeStyle` - -Additional styling for badge (background) view component (optional) - -| Type | Default | -| :-----------------: | :------------: | -| View style (object) | Internal Style | - ---- - -### `containerStyle` - -Style for the container (optional) - -| Type | Default | -| :-----------------: | :------------: | -| View style (object) | Internal Style | - ---- - -### `onPress` - -Function called when pressed on the badge - -| Type | Default | -| :------: | :-----: | -| function | none | - ---- - -### `status` - -Determines color of the indicator - -| Type | Default | -| :--------------------------------------: | :-----: | -| `primary`, `success`, `warning`, `error` | primary | - ---- - -### `textProps` - -Extra props for text component (optional) - -| Type | Default | -| :-----------------: | :-----: | -| Text props (object) | none | - ---- - -### `textStyle` - -Extra styling for icon component (optional) - -| Type | Default | -| :-----------------: | :------------: | -| Text style (object) | Internal Style | - ---- - -### `value` - -Text value to be displayed by badge, defaults to empty - -| Type | Default | -| :----------------------------------------: | :-----: | -| String OR Number OR React Native Component | none | - ---- - -### `Component` - -Custom component to replace the badge outer component - -| Type | Default | -| :--------------------: | :----------------------------------------: | -| React Native Component | View, if `onPress` then `TouchableOpacity` | - ---- - -## Props for withBadge - -- [`value`](#value) -- [`options`](#options) - ---- - -## Reference for withBadge - -### `value` - -Text value to be displayed by badge, defaults to empty - -| Type | Default | -| :-------------------------------------------------------------------------------------: | :-----: | -| String OR Number OR React Native Component OR Function, which returns one of the former | none | - ---- - -### `options` - -> Also receives all -> [Badge](https://reactnative.dev/docs/badge#props) props. - -Object with the following (optional) keys: - -#### `bottom` - -| Type | Default | -| :---------------: | :-------: | -| number (optional) | undefined | - -#### `left` - -| Type | Default | -| :---------------: | :-------: | -| number (optional) | undefined | - -#### `right` - -| Type | Default | -| :---------------: | :------------------------------------------: | -| number (optional) | -16 (-3 with MiniBadge aka. without `value`) | - -#### `top` - -| Type | Default | -| :---------------: | :-------------------: | -| number (optional) | -1 (3 with MiniBadge) | - -#### `hidden` - -| Type | Default | -| :----------------: | :-----: | -| boolean (optional) | false | - -#### `containerStyle` - -| Type | Default | -| :-----------------: | :------------: | -| View style (object) | Internal Style | - ---- diff --git a/website/versioned_docs/version-2.0.4/button.md b/website/versioned_docs/version-2.0.4/button.md deleted file mode 100644 index 74e618ecdd..0000000000 --- a/website/versioned_docs/version-2.0.4/button.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -id: button -title: Button ---- - -Buttons are touchable elements used to interact with the screen. They may -display text, icons, or both. Buttons can be styled with several props to look a -specific way. - -
-
- Solid Button -
Solid
-
-
- Clear Button -
Clear
-
-
- Outline Button -
Outline
-
-
- -## Usage - -```js -import { Button } from 'react-native-elements'; -import Icon from 'react-native-vector-icons/FontAwesome'; - -