Skip to content

Commit e11d496

Browse files
hramosfacebook-github-bot
authored andcommitted
Additional markdown adjustments
Summary: Follow up to 9ec9567 Closes #16759 Differential Revision: D6285219 Pulled By: hramos fbshipit-source-id: 7012d257a5a6cff06cb2d94203a9379e4b7e3c4e
1 parent ae5ef65 commit e11d496

File tree

96 files changed

+2202
-1091
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+2202
-1091
lines changed

.circleci/config.yml

+13-6
Original file line numberDiff line numberDiff line change
@@ -239,17 +239,22 @@ jobs:
239239
command: |
240240
cd website
241241
npm install --no-package-lock --no-spin --no-progress
242+
# The CIRCLE_PROJECT_USERNAME and CIRCLE_PR_USERNAME checks below
243+
# ensure deploys only happen on projects owned by "facebook",
244+
# never on a forked PR build.
242245
- run:
243246
name: Build and Deploy Static Website
244247
command: |
245-
if [[ $CIRCLE_PROJECT_USERNAME == "facebook" && -z $CI_PULL_REQUEST && -z $CIRCLE_PR_USERNAME ]]; then
248+
if [[ $CIRCLE_PROJECT_USERNAME == "facebook" && -z $CIRCLE_PR_USERNAME ]]; then
246249
git config --global user.email "[email protected]"
247250
git config --global user.name "Website Deployment Script"
248251
echo "machine github.com login reactjs-bot password $GITHUB_TOKEN" > ~/.netrc
249252
echo "Deploying website..."
250253
cd website && GIT_USER=reactjs-bot npm run gh-pages
254+
elif [[ -n $CIRCLE_PR_USERNAME ]]; then
255+
echo "Skipping website deploy, this is a forked PR build."
251256
else
252-
echo "Skipping deploy."
257+
echo "Skipping website deploy."
253258
fi
254259
255260
# Build JavaScript bundle for Android tests
@@ -438,10 +443,12 @@ jobs:
438443
- checkout
439444
- restore-cache: *restore-cache-analysis
440445
- run: *install-node-dependencies
446+
# The CIRCLE_PR_NUMBER checks below ensure
447+
# code analysis only runs on forked PR builds.
441448
- run:
442449
name: Install Dependencies
443450
command: |
444-
if [ -n "$CIRCLE_PULL_REQUEST" ]; then
451+
if [ -n "$CIRCLE_PR_NUMBER" ]; then
445452
npm install [email protected]
446453
cd danger
447454
npm install --no-package-lock --no-spin --no-progress
@@ -453,17 +460,17 @@ jobs:
453460
- run:
454461
name: Analyze Pull Request
455462
command: |
456-
if [ -n "$CIRCLE_PULL_REQUEST" ]; then
463+
if [ -n "$CIRCLE_PR_NUMBER" ]; then
457464
cd danger && DANGER_GITHUB_API_TOKEN="e622517d9f1136ea8900""07c6373666312cdfaa69" npm run danger
458465
else
459466
echo "Skipping pull request analysis."
460467
fi
461468
when: always
462-
# Run eslint
469+
# Run eslint
463470
- run:
464471
name: Analyze Code
465472
command: |
466-
if [ -n "$CIRCLE_PULL_REQUEST" ]; then
473+
if [ -n "$CIRCLE_PR_NUMBER" && -n "$CIRCLE_PROJECT_USERNAME" && -n "$CIRCLE_PROJECT_REPONAME" ]; then
467474
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
468475
else
469476
echo "Skipping code analysis."

docs/accessibilityinfo.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ class ScreenReaderStatusExample extends React.Component {
7878
### `fetch()`
7979

8080
```javascript
81-
static fetch()
81+
AccessibilityInfo.fetch()
8282
```
8383

8484

@@ -94,7 +94,7 @@ and `false` otherwise.
9494
### `addEventListener()`
9595

9696
```javascript
97-
static addEventListener(eventName, handler)
97+
AccessibilityInfo.addEventListener(eventName, handler)
9898
```
9999

100100

@@ -117,7 +117,7 @@ Add an event handler. Supported events:
117117
### `setAccessibilityFocus()`
118118

119119
```javascript
120-
static setAccessibilityFocus(reactTag)
120+
AccessibilityInfo.setAccessibilityFocus(reactTag)
121121
```
122122

123123

@@ -131,7 +131,7 @@ iOS-Only. Set accessibility focus to a react component.
131131
### `announceForAccessibility()`
132132

133133
```javascript
134-
static announceForAccessibility(announcement)
134+
AccessibilityInfo.announceForAccessibility(announcement)
135135
```
136136

137137

@@ -145,7 +145,7 @@ iOS-Only. Post a string to be announced by the screen reader.
145145
### `removeEventListener()`
146146

147147
```javascript
148-
static removeEventListener(eventName, handler)
148+
AccessibilityInfo.removeEventListener(eventName, handler)
149149
```
150150

151151

docs/actionsheetios.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ next: alert
88
previous: accessibilityinfo
99
---
1010

11-
11+
Display action sheets and share sheets on iOS.
1212

1313
### Methods
1414

@@ -27,7 +27,7 @@ previous: accessibilityinfo
2727
### `showActionSheetWithOptions()`
2828

2929
```javascript
30-
static showActionSheetWithOptions(options, callback)
30+
ActionSheetIOS.showActionSheetWithOptions(options, callback)
3131
```
3232

3333

@@ -65,7 +65,7 @@ ActionSheetIOS.showActionSheetWithOptions({
6565
### `showShareActionSheetWithOptions()`
6666

6767
```javascript
68-
static showShareActionSheetWithOptions(options, failureCallback, successCallback)
68+
ActionSheetIOS.showShareActionSheetWithOptions(options, failureCallback, successCallback)
6969
```
7070

7171

docs/activityindicator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ AppRegistry.registerComponent('App', () => App)
5151

5252
### Props
5353

54-
* [ViewPropTypes props...](docs/viewproptypes.html#props)
54+
- [View props...](docs/view-props.html)
5555
- [`animating`](docs/activityindicator.html#animating)
5656
- [`color`](docs/activityindicator.html#color)
5757
- [`size`](docs/activityindicator.html#size)

docs/alert.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Alert.alert(
7272
### `alert()`
7373

7474
```javascript
75-
static alert(title, message?, buttons?, options?, type?)
75+
Alert.alert(title, message?, buttons?, options?, type?)
7676
```
7777
7878

docs/alertios.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ cross-platform support if you don't need to create iOS-only prompts.
5656
### `alert()`
5757

5858
```javascript
59-
static alert(title: string, [message]: string, [callbackOrButtons]: ?(() => void), ButtonsArray, [type]: AlertType): [object Object]
59+
AlertIOS.alert(title: string, [message]: string, [callbackOrButtons]: ?(() => void), ButtonsArray, [type]: AlertType): [object Object]
6060
```
6161

6262
Create and display a popup alert.
@@ -65,10 +65,10 @@ Create and display a popup alert.
6565

6666
| Name | Type | Required | Description |
6767
| - | - | - | - |
68-
| title | string | No | The dialog's title. Passing null or '' will hide the title. |
69-
| message | string | Yes | An optional message that appears below the dialog's title. |
70-
| 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'. |
71-
| type | [AlertType](docs/alertios.html#alerttype) | Yes | Deprecated, do not use. |
68+
| title | string | Yes | The dialog's title. Passing null or '' will hide the title. |
69+
| message | string | No | An optional message that appears below the dialog's title. |
70+
| 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'. |
71+
| type | [AlertType](docs/alertios.html#alerttype) | No | Deprecated, do not use. |
7272

7373

7474

@@ -93,7 +93,7 @@ AlertIOS.alert(
9393
### `prompt()`
9494

9595
```javascript
96-
static prompt(title: string, [message]: string, [callbackOrButtons]: ?((text: string) => void), ButtonsArray, [type]: AlertType, [defaultValue]: string, [keyboardType]: string): [object Object]
96+
AlertIOS.prompt(title: string, [message]: string, [callbackOrButtons]: ?((text: string) => void), ButtonsArray, [type]: AlertType, [defaultValue]: string, [keyboardType]: string): [object Object]
9797
```
9898

9999
Create and display a prompt to enter some text.
@@ -102,12 +102,12 @@ Create and display a prompt to enter some text.
102102

103103
| Name | Type | Required | Description |
104104
| - | - | - | - |
105-
| title | string | No | The dialog's title. |
106-
| message | string | Yes | An optional message that appears above the text input. |
107-
| 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'. |
108-
| type | [AlertType](docs/alertios.html#alerttype) | Yes | This configures the text input. One of 'plain-text', 'secure-text' or 'login-password'. |
109-
| defaultValue | string | Yes | The default text in text input. |
110-
| 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'. |
105+
| title | string | Yes | The dialog's title. |
106+
| message | string | No | An optional message that appears above the text input. |
107+
| 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'. |
108+
| type | [AlertType](docs/alertios.html#alerttype) | No | This configures the text input. One of 'plain-text', 'secure-text' or 'login-password'. |
109+
| defaultValue | string | No | The default text in text input. |
110+
| 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'. |
111111

112112

113113

@@ -191,7 +191,7 @@ An Alert button style
191191

192192
### ButtonsArray
193193

194-
Array or buttons
194+
Array of buttons
195195

196196
| Type |
197197
| - |

docs/android-building-from-source.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ title: Building React Native from source
44
layout: docs
55
category: Guides (Android)
66
permalink: docs/android-building-from-source.html
7+
banner: ejected
78
next: communication-android
89
previous: android-ui-performance
910
---

docs/androiduiperformance.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
id: android-ui-performance
3+
title: Profiling Android UI Performance
4+
layout: redirect
5+
permalink: docs/android-ui-performance.html
6+
destinationUrl: performance.html
7+
---
8+
Redirecting...

docs/animated.md

+28-2
Original file line numberDiff line numberDiff line change
@@ -533,25 +533,51 @@ static unforkEvent(event, listener)
533533
534534
## Properties
535535
536+
### Value
536537
538+
Standard value class for driving animations. Typically initialized with `new Animated.Value(0);`
537539
538-
---
540+
See also `AnimatedValue.js`.
539541
540542
543+
| Type |
544+
| - |
545+
| AnimatedValue |
541546
542547
---
543548
549+
### ValueXY
544550
551+
2D value class for driving 2D animations, such as pan gestures.
545552
546-
---
553+
See also `AnimatedValueXY.js`.
554+
555+
| Type |
556+
| - |
557+
| AnimatedValueXY |
547558
548559
549560
550561
---
551562
563+
### Interpolation
564+
565+
Exported to use the Interpolation type in flow
566+
567+
See also `AnimatedInterpolation.js`.
552568
569+
| Type |
570+
| - |
571+
| AnimatedInterpolation |
553572
554573
---
555574
575+
### Node
576+
577+
Exported for ease of type checking. All animated values derive from this class.
578+
579+
| Type |
580+
| - |
581+
| AnimatedNode |
556582
557583

docs/appregistry.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -199,12 +199,13 @@ static registerHeadlessTask(taskKey, task)
199199
200200
201201
Register a headless task. A headless task is a bit of code that runs without a UI.
202-
@param taskKey the key associated with this task
203-
@param task a promise returning function that takes some data passed from the native side as
204-
the only argument; when the promise is resolved or rejected the native side is
205-
notified of this event and it may decide to destroy the JS context.
206202
203+
**Parameters:**
207204
205+
| Name | Type | Required | Description |
206+
| - | - | - | - |
207+
| taskKey | string | No | The key associated with this task. |
208+
| 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. |
208209
209210
210211
---
@@ -215,12 +216,15 @@ Register a headless task. A headless task is a bit of code that runs without a U
215216
static startHeadlessTask(taskId, taskKey, data)
216217
```
217218
218-
219219
Only called from native code. Starts a headless task.
220220
221-
@param taskId the native id for this task instance to keep track of its execution
222-
@param taskKey the key for the task to start
223-
@param data the data to pass to the task
221+
**Parameters:**
222+
223+
| Name | Type | Required | Description |
224+
| - | - | - | - |
225+
| taskId | number | No | The native id for this task instance to keep track of its execution |
226+
| taskKey | string | No | The key for the task to start |
227+
| data | any | No | The data to pass to the task |
224228
225229
226230

0 commit comments

Comments
 (0)