Permalink
Browse files

Additional markdown adjustments

Summary:
Follow up to 9ec9567
Closes #16759

Differential Revision: D6285219

Pulled By: hramos

fbshipit-source-id: 7012d257a5a6cff06cb2d94203a9379e4b7e3c4e
  • Loading branch information...
hramos authored and facebook-github-bot committed Nov 9, 2017
1 parent ae5ef65 commit e11d496e9d907abb5bf58a8300c5a8f85aa03bbb
Showing with 2,202 additions and 1,091 deletions.
  1. +13 −6 .circleci/config.yml
  2. +5 −5 docs/accessibilityinfo.md
  3. +3 −3 docs/actionsheetios.md
  4. +1 −1 docs/activityindicator.md
  5. +1 −1 docs/alert.md
  6. +13 −13 docs/alertios.md
  7. +1 −0 docs/android-building-from-source.md
  8. +8 −0 docs/androiduiperformance.md
  9. +28 −2 docs/animated.md
  10. +12 −8 docs/appregistry.md
  11. +8 −35 docs/appstate.md
  12. +45 −58 docs/asyncstorage.md
  13. +4 −4 docs/backandroid.md
  14. +7 −11 docs/backhandler.md
  15. +1 −0 docs/building-for-apple-tv.md
  16. +2 −13 docs/cameraroll.md
  17. +1 −1 docs/checkbox.md
  18. +10 −4 docs/clipboard.md
  19. +1 −0 docs/communication-android.md
  20. +1 −0 docs/communication-ios.md
  21. +2 −1 docs/custom-webview-android.md
  22. +1 −0 docs/custom-webview-ios.md
  23. +3 −3 docs/datepickerandroid.md
  24. +1 −1 docs/datepickerios.md
  25. +17 −12 docs/dimensions.md
  26. +1 −1 docs/drawerlayoutandroid.md
  27. +465 −77 docs/flatlist.md
  28. +6 −6 docs/geolocation.md
  29. +1 −1 docs/headless-js-android.md
  30. +23 −20 docs/{imagestyleproptypes.md → image-style-props.md}
  31. +14 −83 docs/image.md
  32. +11 −10 docs/imageeditor.md
  33. +4 −4 docs/imagepickerios.md
  34. +4 −4 docs/imagestore.md
  35. +1 −1 docs/integration-with-existing-apps.md
  36. +14 −7 docs/interactionmanager.md
  37. +4 −4 docs/keyboard.md
  38. +2 −2 docs/keyboardavoidingview.md
  39. +1 −1 docs/layout-props.md
  40. +3 −3 docs/layoutanimation.md
  41. +1 −0 docs/linking-libraries-ios.md
  42. +9 −7 docs/linking.md
  43. +2 −2 docs/maskedviewios.md
  44. +1 −1 docs/modal.md
  45. +1 −0 docs/native-components-android.md
  46. +1 −0 docs/native-components-ios.md
  47. +1 −0 docs/native-modules-android.md
  48. +1 −0 docs/native-modules-ios.md
  49. +8 −0 docs/nativemethodsmixing.md
  50. +77 −53 docs/navigatorios.md
  51. +38 −44 docs/netinfo.md
  52. +24 −34 docs/panresponder.md
  53. +27 −60 docs/permissionsandroid.md
  54. +57 −0 docs/picker-item.md
  55. +32 −0 docs/picker-style-props.md
  56. +24 −31 docs/picker.md
  57. +4 −3 docs/pickerios.md
  58. +13 −33 docs/pixelratio.md
  59. +8 −8 docs/progressbarandroid.md
  60. +1 −1 docs/progressviewios.md
  61. +47 −30 docs/pushnotificationios.md
  62. +1 −1 docs/refreshcontrol.md
  63. +8 −0 docs/runningondeviceandroid.md
  64. +8 −0 docs/runningondeviceios.md
  65. +17 −22 docs/scrollview.md
  66. +342 −34 docs/sectionlist.md
  67. +1 −1 docs/segmentedcontrolios.md
  68. +4 −4 docs/settings.md
  69. +1 −1 docs/shadow-props.md
  70. +8 −10 docs/share.md
  71. +7 −7 docs/slider.md
  72. +2 −1 docs/snapshotviewios.md
  73. +21 −25 docs/statusbar.md
  74. +1 −9 docs/statusbarios.md
  75. +78 −15 docs/stylesheet.md
  76. +2 −8 docs/switch.md
  77. +20 −7 docs/systrace.md
  78. +5 −6 docs/tabbarios-item.md
  79. +6 −8 docs/tabbarios.md
  80. +23 −23 docs/{textstyleproptypes.md → text-style-props.md}
  81. +1 −0 docs/text.md
  82. +1 −1 docs/textinput.md
  83. +3 −3 docs/timepickerandroid.md
  84. +9 −6 docs/toastandroid.md
  85. +1 −1 docs/toolbarandroid.md
  86. +1 −1 docs/touchablehighlight.md
  87. +10 −16 docs/touchablenativefeedback.md
  88. +4 −6 docs/touchablewithoutfeedback.md
  89. +6 −8 docs/vibration.md
  90. +6 −10 docs/vibrationios.md
  91. +35 −35 docs/{viewproptypes.md → view-props.md}
  92. +31 −31 docs/{viewstyleproptypes.md → view-style-props.md}
  93. +6 −13 docs/view.md
  94. +9 −10 docs/viewpagerandroid.md
  95. +379 −48 docs/virtualizedlist.md
  96. +25 −7 docs/webview.md
View
@@ -239,17 +239,22 @@ jobs:
command: |
cd website
npm install --no-package-lock --no-spin --no-progress
# The CIRCLE_PROJECT_USERNAME and CIRCLE_PR_USERNAME checks below
# ensure deploys only happen on projects owned by "facebook",
# never on a forked PR build.
- run:
name: Build and Deploy Static Website
command: |
if [[ $CIRCLE_PROJECT_USERNAME == "facebook" && -z $CI_PULL_REQUEST && -z $CIRCLE_PR_USERNAME ]]; then
if [[ $CIRCLE_PROJECT_USERNAME == "facebook" && -z $CIRCLE_PR_USERNAME ]]; then
git config --global user.email "reactjs-bot@users.noreply.github.com"
git config --global user.name "Website Deployment Script"
echo "machine github.com login reactjs-bot password $GITHUB_TOKEN" > ~/.netrc
echo "Deploying website..."
cd website && GIT_USER=reactjs-bot npm run gh-pages
elif [[ -n $CIRCLE_PR_USERNAME ]]; then
echo "Skipping website deploy, this is a forked PR build."
else
echo "Skipping deploy."
echo "Skipping website deploy."
fi
# Build JavaScript bundle for Android tests
@@ -438,10 +443,12 @@ jobs:
- checkout
- restore-cache: *restore-cache-analysis
- run: *install-node-dependencies
# The CIRCLE_PR_NUMBER checks below ensure
# code analysis only runs on forked PR builds.
- run:
name: Install Dependencies
command: |
if [ -n "$CIRCLE_PULL_REQUEST" ]; then
if [ -n "$CIRCLE_PR_NUMBER" ]; then
npm install github@0.2.4
cd danger
npm install --no-package-lock --no-spin --no-progress
@@ -453,17 +460,17 @@ jobs:
- run:
name: Analyze Pull Request
command: |
if [ -n "$CIRCLE_PULL_REQUEST" ]; then
if [ -n "$CIRCLE_PR_NUMBER" ]; then
cd danger && DANGER_GITHUB_API_TOKEN="e622517d9f1136ea8900""07c6373666312cdfaa69" npm run danger
else
echo "Skipping pull request analysis."
fi
when: always
# Run eslint
# Run eslint
- run:
name: Analyze Code
command: |
if [ -n "$CIRCLE_PULL_REQUEST" ]; then
if [ -n "$CIRCLE_PR_NUMBER" && -n "$CIRCLE_PROJECT_USERNAME" && -n "$CIRCLE_PROJECT_REPONAME" ]; then
cat <(echo eslint; npm run lint --silent -- --format=json; echo flow; npm run flow --silent -- check --json) | GITHUB_TOKEN="af6ef0d15709bc91d""06a6217a5a826a226fb57b7" CI_USER=$CIRCLE_PROJECT_USERNAME CI_REPO=$CIRCLE_PROJECT_REPONAME PULL_REQUEST_NUMBER=$CIRCLE_PR_NUMBER node bots/code-analysis-bot.js
else
echo "Skipping code analysis."
View
@@ -78,7 +78,7 @@ class ScreenReaderStatusExample extends React.Component {
### `fetch()`
```javascript
static fetch()
AccessibilityInfo.fetch()
```
@@ -94,7 +94,7 @@ and `false` otherwise.
### `addEventListener()`
```javascript
static addEventListener(eventName, handler)
AccessibilityInfo.addEventListener(eventName, handler)
```
@@ -117,7 +117,7 @@ Add an event handler. Supported events:
### `setAccessibilityFocus()`
```javascript
static setAccessibilityFocus(reactTag)
AccessibilityInfo.setAccessibilityFocus(reactTag)
```
@@ -131,7 +131,7 @@ iOS-Only. Set accessibility focus to a react component.
### `announceForAccessibility()`
```javascript
static announceForAccessibility(announcement)
AccessibilityInfo.announceForAccessibility(announcement)
```
@@ -145,7 +145,7 @@ iOS-Only. Post a string to be announced by the screen reader.
### `removeEventListener()`
```javascript
static removeEventListener(eventName, handler)
AccessibilityInfo.removeEventListener(eventName, handler)
```
View
@@ -8,7 +8,7 @@ next: alert
previous: accessibilityinfo
---
Display action sheets and share sheets on iOS.
### Methods
@@ -27,7 +27,7 @@ previous: accessibilityinfo
### `showActionSheetWithOptions()`
```javascript
static showActionSheetWithOptions(options, callback)
ActionSheetIOS.showActionSheetWithOptions(options, callback)
```
@@ -65,7 +65,7 @@ ActionSheetIOS.showActionSheetWithOptions({
### `showShareActionSheetWithOptions()`
```javascript
static showShareActionSheetWithOptions(options, failureCallback, successCallback)
ActionSheetIOS.showShareActionSheetWithOptions(options, failureCallback, successCallback)
```
@@ -51,7 +51,7 @@ AppRegistry.registerComponent('App', () => App)
### Props
* [ViewPropTypes props...](docs/viewproptypes.html#props)
- [View props...](docs/view-props.html)
- [`animating`](docs/activityindicator.html#animating)
- [`color`](docs/activityindicator.html#color)
- [`size`](docs/activityindicator.html#size)
View
@@ -72,7 +72,7 @@ Alert.alert(
### `alert()`
```javascript
static alert(title, message?, buttons?, options?, type?)
Alert.alert(title, message?, buttons?, options?, type?)
```
View
@@ -56,7 +56,7 @@ cross-platform support if you don't need to create iOS-only prompts.
### `alert()`
```javascript
static alert(title: string, [message]: string, [callbackOrButtons]: ?(() => void), ButtonsArray, [type]: AlertType): [object Object]
AlertIOS.alert(title: string, [message]: string, [callbackOrButtons]: ?(() => void), ButtonsArray, [type]: AlertType): [object Object]
```
Create and display a popup alert.
@@ -65,10 +65,10 @@ Create and display a popup alert.
| Name | Type | Required | Description |
| - | - | - | - |
| title | string | No | The dialog's title. Passing null or '' will hide the title. |
| message | string | Yes | An optional message that appears below the dialog's title. |
| callbackOrButtons | ?(() => void),[ButtonsArray](docs/alertios.html#buttonsarray) | Yes | This optional argument should be either a single-argument function or an array of buttons. If passed a function, it will be called when the user taps 'OK'. If passed an array of button configurations, each button should include a `text` key, as well as optional `onPress` and `style` keys. `style` should be one of 'default', 'cancel' or 'destructive'. |
| type | [AlertType](docs/alertios.html#alerttype) | Yes | Deprecated, do not use. |
| title | string | Yes | The dialog's title. Passing null or '' will hide the title. |
| message | string | No | An optional message that appears below the dialog's title. |
| callbackOrButtons | ?(() => void),[ButtonsArray](docs/alertios.html#buttonsarray) | No | This optional argument should be either a single-argument function or an array of buttons. If passed a function, it will be called when the user taps 'OK'. If passed an array of button configurations, each button should include a `text` key, as well as optional `onPress` and `style` keys. `style` should be one of 'default', 'cancel' or 'destructive'. |
| type | [AlertType](docs/alertios.html#alerttype) | No | Deprecated, do not use. |
@@ -93,7 +93,7 @@ AlertIOS.alert(
### `prompt()`
```javascript
static prompt(title: string, [message]: string, [callbackOrButtons]: ?((text: string) => void), ButtonsArray, [type]: AlertType, [defaultValue]: string, [keyboardType]: string): [object Object]
AlertIOS.prompt(title: string, [message]: string, [callbackOrButtons]: ?((text: string) => void), ButtonsArray, [type]: AlertType, [defaultValue]: string, [keyboardType]: string): [object Object]
```
Create and display a prompt to enter some text.
@@ -102,12 +102,12 @@ Create and display a prompt to enter some text.
| Name | Type | Required | Description |
| - | - | - | - |
| title | string | No | The dialog's title. |
| message | string | Yes | An optional message that appears above the text input. |
| callbackOrButtons | ?((text: string) => void),[ButtonsArray](docs/alertios.html#buttonsarray) | Yes | This optional argument should be either a single-argument function or an array of buttons. If passed a function, it will be called with the prompt's value when the user taps 'OK'. If passed an array of button configurations, each button should include a `text` key, as well as optional `onPress` and `style` keys (see example). `style` should be one of 'default', 'cancel' or 'destructive'. |
| type | [AlertType](docs/alertios.html#alerttype) | Yes | This configures the text input. One of 'plain-text', 'secure-text' or 'login-password'. |
| defaultValue | string | Yes | The default text in text input. |
| keyboardType | string | Yes | The keyboard type of first text field(if exists). One of 'default', 'email-address', 'numeric', 'phone-pad', 'ascii-capable', 'numbers-and-punctuation', 'url', 'number-pad', 'name-phone-pad', 'decimal-pad', 'twitter' or 'web-search'. |
| title | string | Yes | The dialog's title. |
| message | string | No | An optional message that appears above the text input. |
| callbackOrButtons | ?((text: string) => void),[ButtonsArray](docs/alertios.html#buttonsarray) | No | This optional argument should be either a single-argument function or an array of buttons. If passed a function, it will be called with the prompt's value when the user taps 'OK'. If passed an array of button configurations, each button should include a `text` key, as well as optional `onPress` and `style` keys (see example). `style` should be one of 'default', 'cancel' or 'destructive'. |
| type | [AlertType](docs/alertios.html#alerttype) | No | This configures the text input. One of 'plain-text', 'secure-text' or 'login-password'. |
| defaultValue | string | No | The default text in text input. |
| keyboardType | string | No | The keyboard type of first text field(if exists). One of 'default', 'email-address', 'numeric', 'phone-pad', 'ascii-capable', 'numbers-and-punctuation', 'url', 'number-pad', 'name-phone-pad', 'decimal-pad', 'twitter' or 'web-search'. |
@@ -191,7 +191,7 @@ An Alert button style
### ButtonsArray
Array or buttons
Array of buttons
| Type |
| - |
@@ -4,6 +4,7 @@ title: Building React Native from source
layout: docs
category: Guides (Android)
permalink: docs/android-building-from-source.html
banner: ejected
next: communication-android
previous: android-ui-performance
---
@@ -0,0 +1,8 @@
---
id: android-ui-performance
title: Profiling Android UI Performance
layout: redirect
permalink: docs/android-ui-performance.html
destinationUrl: performance.html
---
Redirecting...
View
@@ -533,25 +533,51 @@ static unforkEvent(event, listener)
## Properties
### Value
Standard value class for driving animations. Typically initialized with `new Animated.Value(0);`
---
See also `AnimatedValue.js`.
| Type |
| - |
| AnimatedValue |
---
### ValueXY
2D value class for driving 2D animations, such as pan gestures.
---
See also `AnimatedValueXY.js`.
| Type |
| - |
| AnimatedValueXY |
---
### Interpolation
Exported to use the Interpolation type in flow
See also `AnimatedInterpolation.js`.
| Type |
| - |
| AnimatedInterpolation |
---
### Node
Exported for ease of type checking. All animated values derive from this class.
| Type |
| - |
| AnimatedNode |
View
@@ -199,12 +199,13 @@ static registerHeadlessTask(taskKey, task)
Register a headless task. A headless task is a bit of code that runs without a UI.
@param taskKey the key associated with this task
@param task a promise returning function that takes some data passed from the native side as
the only argument; when the promise is resolved or rejected the native side is
notified of this event and it may decide to destroy the JS context.
**Parameters:**
| Name | Type | Required | Description |
| - | - | - | - |
| taskKey | string | No | The key associated with this task. |
| task | function | No | A promise returning function that takes some data passed from the native side as the only argument; when the promise is resolved or rejected the native side is notified of this event and it may decide to destroy the JS context. |
---
@@ -215,12 +216,15 @@ Register a headless task. A headless task is a bit of code that runs without a U
static startHeadlessTask(taskId, taskKey, data)
```
Only called from native code. Starts a headless task.
@param taskId the native id for this task instance to keep track of its execution
@param taskKey the key for the task to start
@param data the data to pass to the task
**Parameters:**
| Name | Type | Required | Description |
| - | - | - | - |
| taskId | number | No | The native id for this task instance to keep track of its execution |
| taskKey | string | No | The key for the task to start |
| data | any | No | The data to pass to the task |
Oops, something went wrong.

0 comments on commit e11d496

Please sign in to comment.