Permalink
Browse files

Flatten jsdocs to markdown plaintext

Differential Revision: D6261799

fbshipit-source-id: 269e151c5d136c1d508d9f2a060c0c670d0fe0f2
  • Loading branch information...
hramos authored and facebook-github-bot committed Nov 8, 2017
1 parent 7df58e2 commit 9ec95673909beac7798f589e0e9821b4225f8fa9
Showing with 19,508 additions and 66 deletions.
  1. +3 −3 CONTRIBUTING.md
  2. +0 −7 docs/AndroidUIPerformance.md
  3. +1 −1 docs/Images.md
  4. +0 −7 docs/NativeMethodsMixin.md
  5. +0 −7 docs/RunningOnDeviceAndroid.md
  6. +0 −7 docs/RunningOnDeviceIOS.md
  7. 0 docs/StyleGuide.md
  8. +156 −0 docs/accessibilityinfo.md
  9. +96 −0 docs/actionsheetios.md
  10. +125 −0 docs/activityindicator.md
  11. +79 −0 docs/alert.md
  12. +220 −0 docs/alertios.md
  13. +0 −1 docs/{AndroidBuildingFromSource.md → android-building-from-source.md}
  14. +557 −0 docs/animated.md
  15. 0 docs/{TodayWidget.md → app-extensions.md}
  16. +227 −0 docs/appregistry.md
  17. +131 −0 docs/appstate.md
  18. +420 −0 docs/asyncstorage.md
  19. +56 −0 docs/backandroid.md
  20. +83 −0 docs/backhandler.md
  21. +0 −1 docs/{BuildingForAppleTV.md → building-for-apple-tv.md}
  22. +148 −0 docs/button.md
  23. +163 −0 docs/cameraroll.md
  24. +106 −0 docs/checkbox.md
  25. +64 −0 docs/clipboard.md
  26. +0 −1 docs/{CommunicationAndroid.md → communication-android.md}
  27. +0 −1 docs/{CommunicationIOS.md → communication-ios.md}
  28. 0 docs/{ComponentsAndAPIs.md → components-and-apis.md}
  29. +0 −1 docs/{CustomWebViewAndroid.md → custom-webview-android.md}
  30. +0 −1 docs/{CustomWebViewIOS.md → custom-webview-ios.md}
  31. +103 −0 docs/datepickerandroid.md
  32. +140 −0 docs/datepickerios.md
  33. +102 −0 docs/dimensions.md
  34. 0 docs/{DirectManipulation.md → direct-manipulation.md}
  35. +259 −0 docs/drawerlayoutandroid.md
  36. +361 −0 docs/easing.md
  37. +266 −0 docs/flatlist.md
  38. 0 docs/{LayoutWithFlexbox.md → flexbox.md}
  39. +162 −0 docs/geolocation.md
  40. 0 docs/{GestureResponderSystem.md → gesture-responder-system.md}
  41. +1 −0 docs/{GettingStarted.md → getting-started.md}
  42. 0 docs/{HandlingTextInput.md → handling-text-input.md}
  43. 0 docs/{HandlingTouches.md → handling-touches.md}
  44. +1 −2 docs/{HeadlessJSAndroid.md → headless-js-android.md}
  45. 0 docs/{HeightAndWidth.md → height-and-width.md}
  46. +540 −0 docs/image.md
  47. +44 −0 docs/imageeditor.md
  48. +66 −0 docs/imagepickerios.md
  49. +104 −0 docs/imagestore.md
  50. +233 −0 docs/imagestyleproptypes.md
  51. 0 docs/{ImprovingUserExperience.md → improvingux.md}
  52. +1 −2 docs/{IntegrationWithExistingApps.md → integration-with-existing-apps.md}
  53. +146 −0 docs/interactionmanager.md
  54. 0 docs/{JavaScriptEnvironment.md → javascript-environment.md}
  55. +146 −0 docs/keyboard.md
  56. +107 −0 docs/keyboardavoidingview.md
  57. +965 −0 docs/layout-props.md
  58. +116 −0 docs/layoutanimation.md
  59. +0 −1 docs/{LinkingLibraries.md → linking-libraries-ios.md}
  60. +254 −0 docs/linking.md
  61. +436 −0 docs/listview.md
  62. +290 −0 docs/listviewdatasource.md
  63. +72 −0 docs/maskedviewios.md
  64. +201 −0 docs/modal.md
  65. 0 docs/{MoreResources.md → more-resources.md}
  66. +0 −1 docs/{NativeComponentsAndroid.md → native-components-android.md}
  67. +0 −1 docs/{NativeComponentsIOS.md → native-components-ios.md}
  68. +0 −1 docs/{NativeModulesAndroid.md → native-modules-android.md}
  69. +0 −1 docs/{NativeModulesIOS.md → native-modules-ios.md}
  70. +550 −0 docs/navigatorios.md
  71. +226 −0 docs/netinfo.md
  72. 0 docs/{Networking.md → network.md}
  73. +161 −0 docs/panresponder.md
  74. +184 −0 docs/permissionsandroid.md
  75. +156 −0 docs/picker.md
  76. +66 −0 docs/pickerios.md
  77. +165 −0 docs/pixelratio.md
  78. 0 docs/{PlatformSpecificInformation.md → platform-specific-code.md}
  79. +139 −0 docs/progressbarandroid.md
  80. +110 −0 docs/progressviewios.md
  81. +534 −0 docs/pushnotificationios.md
  82. +216 −0 docs/refreshcontrol.md
  83. +0 −1 docs/{RunningOnDevice.md → running-on-device.md}
  84. +0 −1 docs/{RunningOnSimulatorIOS.md → running-on-simulator-ios.md}
  85. +863 −0 docs/scrollview.md
  86. +170 −0 docs/sectionlist.md
  87. +145 −0 docs/segmentedcontrolios.md
  88. +74 −0 docs/settings.md
  89. +83 −0 docs/shadow-props.md
  90. +98 −0 docs/share.md
  91. +0 −1 docs/{SignedAPKAndroid.md → signed-apk-android.md}
  92. +327 −0 docs/slider.md
  93. +52 −0 docs/snapshotviewios.md
  94. +327 −0 docs/statusbar.md
  95. +19 −0 docs/statusbarios.md
  96. +124 −0 docs/stylesheet.md
  97. +134 −0 docs/switch.md
  98. +195 −0 docs/systrace.md
  99. +188 −0 docs/tabbarios-item.md
  100. +144 −0 docs/tabbarios.md
  101. +605 −0 docs/text.md
  102. +986 −0 docs/textinput.md
  103. +281 −0 docs/textstyleproptypes.md
  104. +101 −0 docs/timepickerandroid.md
  105. +102 −0 docs/toastandroid.md
  106. +282 −0 docs/toolbarandroid.md
  107. +228 −0 docs/touchablehighlight.md
  108. +157 −0 docs/touchablenativefeedback.md
  109. +172 −0 docs/touchableopacity.md
  110. +254 −0 docs/touchablewithoutfeedback.md
  111. +78 −0 docs/transforms.md
  112. +0 −1 docs/{UnderstandingCLI.md → understanding-cli.md}
  113. 0 docs/{UsingAListView.md → using-a-listview.md}
  114. 0 docs/{UsingAScrollView.md → using-a-scrollview.md}
  115. +95 −0 docs/vibration.md
  116. +47 −0 docs/vibrationios.md
  117. +719 −0 docs/view.md
  118. +221 −0 docs/viewpagerandroid.md
  119. +657 −0 docs/viewproptypes.md
  120. +391 −0 docs/viewstyleproptypes.md
  121. +310 −0 docs/virtualizedlist.md
  122. +565 −0 docs/webview.md
  123. +0 −12 website/server/convert.js
  124. +56 −3 website/src/react-native/css/react-native.css
@@ -96,11 +96,11 @@ Please make sure the following is done when submitting a pull request:
1. Fork [the repository](https://github.com/facebook/react-native) and create your branch from `master`.
2. Add the copyright notice to the top of any new files you've added.
3. Describe your [**test plan**](/react-native/docs/contributing.html#test-plan) in your pull request description. Make sure to [test your changes](/react-native/docs/testing.html)!
3. Describe your [**test plan**](https://facebook.github.io/react-native/docs/contributing.html#test-plan) in your pull request description. Make sure to [test your changes](https://facebook.github.io/react-native/docs/testing.html)!
4. Make sure your code lints (`npm run lint`).
5. If you haven't already, [sign the CLA](https://code.facebook.com/cla).
All pull requests should be opened against the `master` branch. After opening your pull request, ensure [**all tests pass**](/react-native/docs/contributing.html#contrinuous-integration-tests) on Circle CI. If a test fails and you believe it is unrelated to your change, leave a comment on the pull request explaining why.
All pull requests should be opened against the `master` branch. After opening your pull request, ensure [**all tests pass**](https://facebook.github.io/react-native/docs/contributing.html#contrinuous-integration-tests) on Circle CI. If a test fails and you believe it is unrelated to your change, leave a comment on the pull request explaining why.
> **Note:** It is not necessary to keep clicking `Merge master to your branch` on the PR page. You would want to merge master if there are conflicts or tests are failing. The Facebook-GitHub-Bot ultimately squashes all commits to a single one before merging your PR.
@@ -116,7 +116,7 @@ See [What is a Test Plan?](https://medium.com/@martinkonicek/what-is-a-test-plan
#### Continuous integration tests
Make sure all **tests pass** on [Circle CI][circle]. PRs that break tests are unlikely to be merged. Learn more about [testing your changes here](/react-native/docs/testing.html).
Make sure all **tests pass** on [Circle CI][circle]. PRs that break tests are unlikely to be merged. Learn more about [testing your changes here](https://facebook.github.io/react-native/docs/testing.html).
[circle]: http://circleci.com/gh/facebook/react-native

This file was deleted.

Oops, something went wrong.
@@ -4,7 +4,7 @@ title: Images
layout: docs
category: Guides
permalink: docs/images.html
next: animations
next: animations
previous: navigation
---

This file was deleted.

Oops, something went wrong.

This file was deleted.

Oops, something went wrong.

This file was deleted.

Oops, something went wrong.
No changes.
@@ -0,0 +1,156 @@
---
id: accessibilityinfo
title: AccessibilityInfo
layout: docs
category: APIs
permalink: docs/accessibilityinfo.html
next: actionsheetios
previous: webview
---
Sometimes it's useful to know whether or not the device has a screen reader that is currently active. The
`AccessibilityInfo` API is designed for this purpose. You can use it to query the current state of the
screen reader as well as to register to be notified when the state of the screen reader changes.
Here's a small example illustrating how to use `AccessibilityInfo`:
```javascript
class ScreenReaderStatusExample extends React.Component {
state = {
screenReaderEnabled: false,
}
componentDidMount() {
AccessibilityInfo.addEventListener(
'change',
this._handleScreenReaderToggled
);
AccessibilityInfo.fetch().done((isEnabled) => {
this.setState({
screenReaderEnabled: isEnabled
});
});
}
componentWillUnmount() {
AccessibilityInfo.removeEventListener(
'change',
this._handleScreenReaderToggled
);
}
_handleScreenReaderToggled = (isEnabled) => {
this.setState({
screenReaderEnabled: isEnabled,
});
}
render() {
return (
<View>
<Text>
The screen reader is {this.state.screenReaderEnabled ? 'enabled' : 'disabled'}.
</Text>
</View>
);
}
}
```
### Methods
- [`fetch`](docs/accessibilityinfo.html#fetch)
- [`addEventListener`](docs/accessibilityinfo.html#addeventlistener)
- [`setAccessibilityFocus`](docs/accessibilityinfo.html#setaccessibilityfocus)
- [`announceForAccessibility`](docs/accessibilityinfo.html#announceforaccessibility)
- [`removeEventListener`](docs/accessibilityinfo.html#removeeventlistener)
---
# Reference
## Methods
### `fetch()`
```javascript
static fetch()
```
Query whether a screen reader is currently enabled. Returns a promise which
resolves to a boolean. The result is `true` when a screen reader is enabled
and `false` otherwise.
---
### `addEventListener()`
```javascript
static addEventListener(eventName, handler)
```
Add an event handler. Supported events:
- `change`: Fires when the state of the screen reader changes. The argument
to the event handler is a boolean. The boolean is `true` when a screen
reader is enabled and `false` otherwise.
- `announcementFinished`: iOS-only event. Fires when the screen reader has
finished making an announcement. The argument to the event handler is a dictionary
with these keys:
- `announcement`: The string announced by the screen reader.
- `success`: A boolean indicating whether the announcement was successfully made.
---
### `setAccessibilityFocus()`
```javascript
static setAccessibilityFocus(reactTag)
```
iOS-Only. Set accessibility focus to a react component.
---
### `announceForAccessibility()`
```javascript
static announceForAccessibility(announcement)
```
iOS-Only. Post a string to be announced by the screen reader.
---
### `removeEventListener()`
```javascript
static removeEventListener(eventName, handler)
```
Remove an event handler.
@@ -0,0 +1,96 @@
---
id: actionsheetios
title: ActionSheetIOS
layout: docs
category: APIs
permalink: docs/actionsheetios.html
next: alert
previous: accessibilityinfo
---
### Methods
- [`showActionSheetWithOptions`](docs/actionsheetios.html#showactionsheetwithoptions)
- [`showShareActionSheetWithOptions`](docs/actionsheetios.html#showshareactionsheetwithoptions)
---
# Reference
## Methods
### `showActionSheetWithOptions()`
```javascript
static showActionSheetWithOptions(options, callback)
```
Display an iOS action sheet. The `options` object must contain one or more
of:
- `options` (array of strings) - a list of button titles (required)
- `cancelButtonIndex` (int) - index of cancel button in `options`
- `destructiveButtonIndex` (int) - index of destructive button in `options`
- `title` (string) - a title to show above the action sheet
- `message` (string) - a message to show below the title
The 'callback' function takes one parameter, the zero-based index
of the selected item.
Minimal example:
```
ActionSheetIOS.showActionSheetWithOptions({
options: ['Remove', 'Cancel'],
destructiveButtonIndex: 1,
cancelButtonIndex: 0,
},
(buttonIndex) => {
if (buttonIndex === 1) { // destructive action }
});
```
---
### `showShareActionSheetWithOptions()`
```javascript
static showShareActionSheetWithOptions(options, failureCallback, successCallback)
```
Display the iOS share sheet. The `options` object should contain
one or both of `message` and `url` and can additionally have
a `subject` or `excludedActivityTypes`:
- `url` (string) - a URL to share
- `message` (string) - a message to share
- `subject` (string) - a subject for the message
- `excludedActivityTypes` (array) - the activities to exclude from the ActionSheet
NOTE: if `url` points to a local file, or is a base64-encoded
uri, the file it points to will be loaded and shared directly.
In this way, you can share images, videos, PDF files, etc.
The 'failureCallback' function takes one parameter, an error object.
The only property defined on this object is an optional `stack` property
of type `string`.
The 'successCallback' function takes two parameters:
- a boolean value signifying success or failure
- a string that, in the case of success, indicates the method of sharing
Oops, something went wrong.

0 comments on commit 9ec9567

Please sign in to comment.