From 7a28481c72efadf3df513ddeb58d6de3a319e517 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Tue, 15 Oct 2019 10:21:46 +0000 Subject: [PATCH] Deploy website Deploy website version based on ab56e17a8f8174e22769c619efbde50489ab06ac --- docs/0.59/asyncstorage.html | 4 ++-- docs/0.59/asyncstorage/index.html | 4 ++-- docs/0.59/imagestore.html | 4 ++-- docs/0.59/imagestore/index.html | 4 ++-- docs/0.59/scrollview.html | 12 ++++++------ docs/0.59/scrollview/index.html | 12 ++++++------ docs/0.59/text.html | 6 +++--- docs/0.59/text/index.html | 6 +++--- docs/0.59/textinput.html | 6 +++--- docs/0.59/textinput/index.html | 6 +++--- docs/0.59/view.html | 6 +++--- docs/0.59/view/index.html | 6 +++--- docs/0.60/imagestore.html | 4 ++-- docs/0.60/imagestore/index.html | 4 ++-- docs/imagestore.html | 4 ++-- docs/imagestore/index.html | 4 ++-- 16 files changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/0.59/asyncstorage.html b/docs/0.59/asyncstorage.html index 080ce5ff2e6..a729358a11a 100644 --- a/docs/0.59/asyncstorage.html +++ b/docs/0.59/asyncstorage.html @@ -71,10 +71,10 @@
Edit

AsyncStorage

Deprecated. Use react-native-community/react-native-async-storage instead.

-

AsyncStorage is a simple, unencrypted, asynchronous, persistent, key-value storage system that is global to the app. It should be used instead of LocalStorage.

+

AsyncStorage is an unencrypted, asynchronous, persistent, key-value storage system that is global to the app. It should be used instead of LocalStorage.

It is recommended that you use an abstraction on top of AsyncStorage instead of AsyncStorage directly for anything more than light usage since it operates globally.

On iOS, AsyncStorage is backed by native code that stores small values in a serialized dictionary and larger values in separate files. On Android, AsyncStorage will use either RocksDB or SQLite based on what is available.

-

The AsyncStorage JavaScript code is a simple facade that provides a clear JavaScript API, real Error objects, and simple non-multi functions. Each method in the API returns a Promise object.

+

The AsyncStorage JavaScript code is a facade that provides a clear JavaScript API, real Error objects, and non-multi functions. Each method in the API returns a Promise object.

Importing the AsyncStorage library:

import {AsyncStorage} from 'react-native';
diff --git a/docs/0.59/asyncstorage/index.html b/docs/0.59/asyncstorage/index.html index 080ce5ff2e6..a729358a11a 100644 --- a/docs/0.59/asyncstorage/index.html +++ b/docs/0.59/asyncstorage/index.html @@ -71,10 +71,10 @@
Edit

AsyncStorage

Deprecated. Use react-native-community/react-native-async-storage instead.

-

AsyncStorage is a simple, unencrypted, asynchronous, persistent, key-value storage system that is global to the app. It should be used instead of LocalStorage.

+

AsyncStorage is an unencrypted, asynchronous, persistent, key-value storage system that is global to the app. It should be used instead of LocalStorage.

It is recommended that you use an abstraction on top of AsyncStorage instead of AsyncStorage directly for anything more than light usage since it operates globally.

On iOS, AsyncStorage is backed by native code that stores small values in a serialized dictionary and larger values in separate files. On Android, AsyncStorage will use either RocksDB or SQLite based on what is available.

-

The AsyncStorage JavaScript code is a simple facade that provides a clear JavaScript API, real Error objects, and simple non-multi functions. Each method in the API returns a Promise object.

+

The AsyncStorage JavaScript code is a facade that provides a clear JavaScript API, real Error objects, and non-multi functions. Each method in the API returns a Promise object.

Importing the AsyncStorage library:

import {AsyncStorage} from 'react-native';
diff --git a/docs/0.59/imagestore.html b/docs/0.59/imagestore.html index df457a34433..c8080f23ab5 100644 --- a/docs/0.59/imagestore.html +++ b/docs/0.59/imagestore.html @@ -89,7 +89,7 @@

removeImageForTag()

static removeImageForTag(uri)
-

Delete an image from the ImageStore. Images are stored in memory and must be manually removed when you are finished with them, otherwise they will continue to use up RAM until the app is terminated. It is safe to call removeImageForTag() without first calling hasImageForTag(), it will simply fail silently. @platform ios

+

Delete an image from the ImageStore. Images are stored in memory and must be manually removed when you are finished with them, otherwise they will continue to use up RAM until the app is terminated. It is safe to call removeImageForTag() without first calling hasImageForTag(), it will fail silently. @platform ios

addImageFromBase64()

static addImageFromBase64(base64ImageData, success, failure)
@@ -101,7 +101,7 @@
 
static getBase64ForTag(uri, success, failure)
 

 
Retrieves the base64-encoded data for an image in the ImageStore. If the specified URI does not match an image in the store, the failure callback will be called.

-
Note that it is very inefficient to transfer large quantities of binary data between JS and native code, so you should avoid calling this more than necessary. To display an image in the ImageStore, you can just pass the URI to an <Image/> component; there is no need to retrieve the base64 data.

+
Note that it is very inefficient to transfer large quantities of binary data between JS and native code, so you should avoid calling this more than necessary. To display an image in the ImageStore, you can pass the URI to an <Image/> component; there is no need to retrieve the base64 data.
← ImagePickerIOSImage Style Props →
Edit

ScrollView

Component that wraps platform ScrollView while providing integration with touch locking "responder" system.

-

Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes easy to debug.

+

Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector can help to debug.

Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.

<ScrollView> vs <FlatList> - which one to use?

-

ScrollView simply renders all its react child components at once. That makes it very easy to understand and use.

-

On the other hand, this has a performance downside. Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.

-

This is where FlatList comes into play. FlatList renders items lazily, just when they are about to appear, and removes items that scroll way off screen to save memory and processing time.

+

ScrollView renders all its react child components at once, but this has a performance downside.

+

Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.

+

This is where FlatList comes into play. FlatList renders items lazily, when they are about to appear, and removes items that scroll way off screen to save memory and processing time.

FlatList is also handy if you want to render separators between your items, multiple columns, infinite scroll loading, or any number of other features it supports out of the box.

Props

    @@ -559,8 +559,8 @@ const styles = StyleSheet.create({

    The style of the scroll indicators.

    • 'default' (the default), same as black.
      • -
    • 'black', scroll indicator is black. This style is good against a light background.
      • -
    • 'white', scroll indicator is white. This style is good against a dark background.
      • +
    • 'black', scroll indicator is black. This style is good against a light background.
      • +
    • 'white', scroll indicator is white. This style is good against a dark background.
    diff --git a/docs/0.59/scrollview/index.html b/docs/0.59/scrollview/index.html index 1df45b20f9a..496630a7f54 100644 --- a/docs/0.59/scrollview/index.html +++ b/docs/0.59/scrollview/index.html @@ -69,12 +69,12 @@ } });
    Edit

    ScrollView

    Component that wraps platform ScrollView while providing integration with touch locking "responder" system.

    -

    Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector makes easy to debug.

    +

    Keep in mind that ScrollViews must have a bounded height in order to work, since they contain unbounded-height children into a bounded container (via a scroll interaction). In order to bound the height of a ScrollView, either set the height of the view directly (discouraged) or make sure all parent views have bounded height. Forgetting to transfer {flex: 1} down the view stack can lead to errors here, which the element inspector can help to debug.

    Doesn't yet support other contained responders from blocking this scroll view from becoming the responder.

    <ScrollView> vs <FlatList> - which one to use?

    -

    ScrollView simply renders all its react child components at once. That makes it very easy to understand and use.

    -

    On the other hand, this has a performance downside. Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.

    -

    This is where FlatList comes into play. FlatList renders items lazily, just when they are about to appear, and removes items that scroll way off screen to save memory and processing time.

    +

    ScrollView renders all its react child components at once, but this has a performance downside.

    +

    Imagine you have a very long list of items you want to display, maybe several screens worth of content. Creating JS components and native views for everything all at once, much of which may not even be shown, will contribute to slow rendering and increased memory usage.

    +

    This is where FlatList comes into play. FlatList renders items lazily, when they are about to appear, and removes items that scroll way off screen to save memory and processing time.

    FlatList is also handy if you want to render separators between your items, multiple columns, infinite scroll loading, or any number of other features it supports out of the box.

    Props

      @@ -559,8 +559,8 @@ const styles = StyleSheet.create({

      The style of the scroll indicators.

      • 'default' (the default), same as black.
        • -
      • 'black', scroll indicator is black. This style is good against a light background.
        • -
      • 'white', scroll indicator is white. This style is good against a dark background.
        • +
      • 'black', scroll indicator is black. This style is good against a light background.
        • +
      • 'white', scroll indicator is white. This style is good against a dark background.
    diff --git a/docs/0.59/text.html b/docs/0.59/text.html index 1fe9c2dc4e8..d2e0de1237e 100644 --- a/docs/0.59/text.html +++ b/docs/0.59/text.html @@ -163,7 +163,7 @@ AppRegistry.registerComponent('AwesomeProject', 9-17: bold, red

    Containers

    -

    The <Text> element is special relative to layout: everything inside is no longer using the flexbox layout but using text layout. This means that elements inside of a <Text> are no longer rectangles, but wrap when they see the end of the line.

    +

    The <Text> element is unique relative to layout: everything inside is no longer using the flexbox layout but using text layout. This means that elements inside of a <Text> are no longer rectangles, but wrap when they see the end of the line.

    <Text>
   <Text>First part and </Text>
   <Text>second part</Text>
@@ -219,7 +219,7 @@ AppRegistry.registerComponent('AwesomeProject',
   <MyAppHeaderText>Text styled as a header</MyAppHeaderText>
 </View>
    -

    Assuming that MyAppText is a component that simply renders out its children into a Text component with styling, then MyAppHeaderText can be defined as follows:

    +

    Assuming that MyAppText is a component that only renders out its children into a Text component with styling, then MyAppHeaderText can be defined as follows:

    class MyAppHeaderText extends Component {
   render() {
     return (
@@ -281,7 +281,7 @@ AppRegistry.registerComponent('AwesomeProject',

    accessibilityHint

    -

    An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.

    +

    An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not clear from the accessibility label.

    diff --git a/docs/0.59/text/index.html b/docs/0.59/text/index.html index 1fe9c2dc4e8..d2e0de1237e 100644 --- a/docs/0.59/text/index.html +++ b/docs/0.59/text/index.html @@ -163,7 +163,7 @@ AppRegistry.registerComponent('AwesomeProject', 9-17: bold, red

    Containers

    -

    The <Text> element is special relative to layout: everything inside is no longer using the flexbox layout but using text layout. This means that elements inside of a <Text> are no longer rectangles, but wrap when they see the end of the line.

    +

    The <Text> element is unique relative to layout: everything inside is no longer using the flexbox layout but using text layout. This means that elements inside of a <Text> are no longer rectangles, but wrap when they see the end of the line.

    <Text>
   <Text>First part and </Text>
   <Text>second part</Text>
@@ -219,7 +219,7 @@ AppRegistry.registerComponent('AwesomeProject',
   <MyAppHeaderText>Text styled as a header</MyAppHeaderText>
 </View>
    -

    Assuming that MyAppText is a component that simply renders out its children into a Text component with styling, then MyAppHeaderText can be defined as follows:

    +

    Assuming that MyAppText is a component that only renders out its children into a Text component with styling, then MyAppHeaderText can be defined as follows:

    class MyAppHeaderText extends Component {
   render() {
     return (
@@ -281,7 +281,7 @@ AppRegistry.registerComponent('AwesomeProject',
    TypeRequired

    accessibilityHint

    -

    An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.

    +

    An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not clear from the accessibility label.

    diff --git a/docs/0.59/textinput.html b/docs/0.59/textinput.html index ae701430cc9..50274cb33eb 100644 --- a/docs/0.59/textinput.html +++ b/docs/0.59/textinput.html @@ -69,7 +69,7 @@ } });
    Edit

    TextInput

    A foundational component for inputting text into the app via a keyboard. Props provide configurability for several features, such as auto-correction, auto-capitalization, placeholder text, and different keyboard types, such as a numeric keypad.

    -

    The simplest use case is to plop down a TextInput and subscribe to the onChangeText events to read the user input. There are also other events, such as onSubmitEditing and onFocus that can be subscribed to. A simple example:

    +

    The most basic use case is to plop down a TextInput and subscribe to the onChangeText events to read the user input. There are also other events, such as onSubmitEditing and onFocus that can be subscribed to. A minimal example:

    TypeRequired

    defaultValue

    -

    Provides an initial value that will change when the user starts typing. Useful for simple use-cases where you do not want to deal with listening to events and updating the value prop to keep the controlled state in sync.

    +

    Provides an initial value that will change when the user starts typing. Useful for use-cases where you do not want to deal with listening to events and updating the value prop to keep the controlled state in sync.

    @@ -927,7 +927,7 @@ AppRegistry.registerComponent(
    TypeRequired

    value

    -

    The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses, this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to simply setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.

    +

    The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses, this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.

    diff --git a/docs/0.59/textinput/index.html b/docs/0.59/textinput/index.html index ae701430cc9..50274cb33eb 100644 --- a/docs/0.59/textinput/index.html +++ b/docs/0.59/textinput/index.html @@ -69,7 +69,7 @@ } });
    Edit

    TextInput

    A foundational component for inputting text into the app via a keyboard. Props provide configurability for several features, such as auto-correction, auto-capitalization, placeholder text, and different keyboard types, such as a numeric keypad.

    -

    The simplest use case is to plop down a TextInput and subscribe to the onChangeText events to read the user input. There are also other events, such as onSubmitEditing and onFocus that can be subscribed to. A simple example:

    +

    The most basic use case is to plop down a TextInput and subscribe to the onChangeText events to read the user input. There are also other events, such as onSubmitEditing and onFocus that can be subscribed to. A minimal example:

    TypeRequired

    defaultValue

    -

    Provides an initial value that will change when the user starts typing. Useful for simple use-cases where you do not want to deal with listening to events and updating the value prop to keep the controlled state in sync.

    +

    Provides an initial value that will change when the user starts typing. Useful for use-cases where you do not want to deal with listening to events and updating the value prop to keep the controlled state in sync.

    @@ -927,7 +927,7 @@ AppRegistry.registerComponent(
    TypeRequired

    value

    -

    The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses, this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to simply setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.

    +

    The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses, this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to setting the same value, either set editable={false}, or set/update maxLength to prevent unwanted edits without flicker.

    diff --git a/docs/0.59/view.html b/docs/0.59/view.html index ed72debddc5..a9152b687fe 100644 --- a/docs/0.59/view.html +++ b/docs/0.59/view.html @@ -162,7 +162,7 @@
    TypeRequired

    accessibilityHint

    -

    An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.

    +

    An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not clear from the accessibility label.

    @@ -414,7 +414,7 @@
    TypeRequired

    removeClippedSubviews

    -

    This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).

    +

    This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).

    @@ -528,7 +528,7 @@

    renderToHardwareTextureAndroid

    Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.

    -

    On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.

    +

    On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.

    TypeRequired
    diff --git a/docs/0.59/view/index.html b/docs/0.59/view/index.html index ed72debddc5..a9152b687fe 100644 --- a/docs/0.59/view/index.html +++ b/docs/0.59/view/index.html @@ -162,7 +162,7 @@
    TypeRequiredPlatform

    accessibilityHint

    -

    An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.

    +

    An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not clear from the accessibility label.

    @@ -414,7 +414,7 @@
    TypeRequired

    removeClippedSubviews

    -

    This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).

    +

    This is a reserved performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).

    @@ -528,7 +528,7 @@

    renderToHardwareTextureAndroid

    Whether this View should render itself (and all of its children) into a single hardware texture on the GPU.

    -

    On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.

    +

    On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.

    TypeRequired
    diff --git a/docs/0.60/imagestore.html b/docs/0.60/imagestore.html index 662e1fb2d51..bd318a6c6fe 100644 --- a/docs/0.60/imagestore.html +++ b/docs/0.60/imagestore.html @@ -33,7 +33,7 @@

    removeImageForTag()

    static removeImageForTag(uri)
    -

    Delete an image from the ImageStore. Images are stored in memory and must be manually removed when you are finished with them, otherwise they will continue to use up RAM until the app is terminated. It is safe to call removeImageForTag() without first calling hasImageForTag(), it will simply fail silently. @platform ios

    +

    Delete an image from the ImageStore. Images are stored in memory and must be manually removed when you are finished with them, otherwise they will continue to use up RAM until the app is terminated. It is safe to call removeImageForTag() without first calling hasImageForTag(), it will fail silently. @platform ios

    addImageFromBase64()

    static addImageFromBase64(base64ImageData, success, failure)
@@ -45,7 +45,7 @@
 
    static getBase64ForTag(uri, success, failure)
 
    
 
    Retrieves the base64-encoded data for an image in the ImageStore. If the specified URI does not match an image in the store, the failure callback will be called.
    
-
    Note that it is very inefficient to transfer large quantities of binary data between JS and native code, so you should avoid calling this more than necessary. To display an image in the ImageStore, you can just pass the URI to an <Image/> component; there is no need to retrieve the base64 data.
    
+
    Note that it is very inefficient to transfer large quantities of binary data between JS and native code, so you should avoid calling this more than necessary. To display an image in the ImageStore, you can pass the URI to an <Image/> component; there is no need to retrieve the base64 data.
    TypeRequiredPlatform