Taro 3 React Native 相关文档补充 (#8118)

* docs: update rn-api * feat: components-rn 3.x * feat: config-detail * docs: RN端开发流程 3.x * docs: update RN端开发流程 3.x * docs: 开放文档（RN端开发流程） * docs: 开放文档（RN端开发流程） * docs: 补充 CocoaPods 安装说明 * feat: config-detail * feat: config-detail * feat(config-detail): modify rn config detail about the style config Co-authored-by: nickyefei <shoxvc2008@163.com> Co-authored-by: qiuz <zhu_anly@163.com> Co-authored-by: haojie <394692633@qq.com> Co-authored-by: iChengbo <chengbo_x@163.com> Co-authored-by: shinken008 <shinken008@gmail.com>
NervJS · Dec 2, 2020 · 80a8450 · 80a8450
1 parent 3fb47b8
commit 80a8450
Show file tree

Hide file tree

Showing 51 changed files with 502 additions and 192 deletions.
diff --git a/.gitignore b/.gitignore
@@ -19,4 +19,5 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 .now
-dist
+dist
+.history/
diff --git a/docs/apis/base/arrayBufferToBase64.md b/docs/apis/base/arrayBufferToBase64.md
@@ -43,4 +43,4 @@ const base64 = Taro.arrayBufferToBase64(arrayBuffer)
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.arrayBufferToBase64 | ✔️ | ✔️ | |
+| Taro.arrayBufferToBase64 | ✔️ | ✔️ | ✔️ |
diff --git a/docs/apis/base/base64ToArrayBuffer.md b/docs/apis/base/base64ToArrayBuffer.md
@@ -43,4 +43,4 @@ const arrayBuffer = Taro.base64ToArrayBuffer(base64)
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.base64ToArrayBuffer | ✔️ | ✔️ | |
+| Taro.base64ToArrayBuffer | ✔️ | ✔️ | ✔️ |
diff --git a/docs/apis/base/env/env.md b/docs/apis/base/env/env.md
@@ -15,4 +15,4 @@ typeof env
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.env | ✔️ | | |
+| Taro.env | ✔️ | | ✔️ |
diff --git a/docs/apis/device/accelerometer/offAccelerometerChange.md b/docs/apis/device/accelerometer/offAccelerometerChange.md
@@ -36,4 +36,4 @@ sidebar_label: offAccelerometerChange
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.offAccelerometerChange | ✔️ | | |
+| Taro.offAccelerometerChange | ✔️ | | ✔️ |
diff --git a/docs/apis/device/network/offNetworkStatusChange.md b/docs/apis/device/network/offNetworkStatusChange.md
@@ -36,4 +36,4 @@ sidebar_label: offNetworkStatusChange
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.offNetworkStatusChange | ✔️ | | |
+| Taro.offNetworkStatusChange | ✔️ | | ✔️ |
diff --git a/docs/apis/device/scan/scancode.md b/docs/apis/device/scan/scancode.md
@@ -248,4 +248,4 @@ Taro.scanCode({
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.scanCode | ✔️ | ✔️ | |
+| Taro.scanCode | ✔️ | ✔️ | ✔️ |
diff --git a/docs/apis/device/screen/getScreenBrightness.md b/docs/apis/device/screen/getScreenBrightness.md
@@ -74,4 +74,4 @@ sidebar_label: getScreenBrightness
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.getScreenBrightness | ✔️ | | |
+| Taro.getScreenBrightness | ✔️ | | ✔️ |
diff --git a/docs/apis/device/screen/setKeepScreenOn.md b/docs/apis/device/screen/setKeepScreenOn.md
@@ -86,4 +86,4 @@ Taro.setKeepScreenOn({
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.setKeepScreenOn | ✔️ | | |
+| Taro.setKeepScreenOn | ✔️ | | ✔️ |
diff --git a/docs/apis/files/getFileInfo.md b/docs/apis/files/getFileInfo.md
@@ -112,4 +112,4 @@ Taro.getFileInfo({
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.getFileInfo | ✔️ | | |
+| Taro.getFileInfo | ✔️ | | ✔️ |
diff --git a/docs/apis/files/getSavedFileInfo.md b/docs/apis/files/getSavedFileInfo.md
@@ -99,4 +99,4 @@ Taro.getSavedFileInfo({
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.getSavedFileInfo | ✔️ | | |
+| Taro.getSavedFileInfo | ✔️ | | ✔️ |
diff --git a/docs/apis/files/getSavedFileList.md b/docs/apis/files/getSavedFileList.md
@@ -117,4 +117,4 @@ Taro.getSavedFileList({
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.getSavedFileList | ✔️ | | |
+| Taro.getSavedFileList | ✔️ | | ✔️ |
diff --git a/docs/apis/files/removeSavedFile.md b/docs/apis/files/removeSavedFile.md
@@ -94,4 +94,4 @@ Taro.getSavedFileList({
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.removeSavedFile | ✔️ | | |
+| Taro.removeSavedFile | ✔️ | | ✔️ |
diff --git a/docs/apis/files/saveFile.md b/docs/apis/files/saveFile.md
@@ -123,4 +123,4 @@ Taro.chooseImage({
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.saveFile | ✔️ | | |
+| Taro.saveFile | ✔️ | | ✔️ |
diff --git a/docs/apis/location/getLocation.md b/docs/apis/location/getLocation.md
@@ -148,4 +148,4 @@ Taro.getLocation({
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.getLocation | ✔️ | | |
+| Taro.getLocation | ✔️ | | ✔️ |
diff --git a/docs/apis/media/audio/InnerAudioContext.md b/docs/apis/media/audio/InnerAudioContext.md
@@ -698,3 +698,32 @@ innerAudioContext.onError((res) => {
  console.log(res.errCode)
 })
 ```
+## API 支持度
+
+| API | 微信小程序 | H5 | React Native |
+| :---: | :---: | :---: | :---: |
+| InnerAudioContext.play | ✔️ | ✔️ | ✔️ |
+| InnerAudioContext.pause | ✔️ | ✔️ | ✔️ |
+| InnerAudioContext.stop | ✔️ | ✔️ | ✔️ |
+| InnerAudioContext.seek | ✔️ | ✔️ | ✔️ |
+| InnerAudioContext.destroy | ✔️ | ✔️ | |
+| InnerAudioContext.onCanplay | ✔️ | | ✔️ |
+| InnerAudioContext.onPlay | ✔️ | | ✔️ |
+| InnerAudioContext.onPause | ✔️ | | ✔️ |
+| InnerAudioContext.onStop | ✔️ | | ✔️ |
+| InnerAudioContext.onEnded | ✔️ | | ✔️ |
+| InnerAudioContext.onTimeUpdate | ✔️ | | ✔️ |
+| InnerAudioContext.onError | ✔️ | | ✔️ |
+| InnerAudioContext.onWaiting | ✔️ | | ✔️ |
+| InnerAudioContext.onSeeking | ✔️ | | ✔️ |
+| InnerAudioContext.onSeeked | ✔️ | | ✔️ |
+| InnerAudioContext.offCanplay | ✔️ | | ✔️ |
+| InnerAudioContext.offPlay | ✔️ | | ✔️ |
+| InnerAudioContext.offPause | ✔️ | | ✔️ |
+| InnerAudioContext.offStop | ✔️ | | ✔️ |
+| InnerAudioContext.offEnded | ✔️ | | ✔️ |
+| InnerAudioContext.offTimeUpdate | ✔️ | | ✔️ |
+| InnerAudioContext.offError | ✔️ | | ✔️ |
+| InnerAudioContext.offWaiting | ✔️ | | ✔️ |
+| InnerAudioContext.offSeeking | ✔️ | | ✔️ |
+| InnerAudioContext.offSeeked | ✔️ | | ✔️ |
diff --git a/docs/apis/media/audio/createInnerAudioContext.md b/docs/apis/media/audio/createInnerAudioContext.md
@@ -34,4 +34,4 @@ innerAudioContext.onError((res) => {
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.createInnerAudioContext | ✔️ | ✔️ | |
+| Taro.createInnerAudioContext | ✔️ | ✔️ | ✔️ |
diff --git a/docs/apis/media/camera/CameraContext.md b/docs/apis/media/camera/CameraContext.md
@@ -36,7 +36,7 @@ sidebar_label: CameraContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| CameraContext.startRecord | ✔️ | | |
+| CameraContext.startRecord | ✔️ | | ✔️ |
 
 ### stopRecord
 
@@ -67,7 +67,7 @@ sidebar_label: CameraContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| CameraContext.stopRecord | ✔️ | | |
+| CameraContext.stopRecord | ✔️ | | ✔️ |
 
 ### takePhoto
 
@@ -98,7 +98,7 @@ sidebar_label: CameraContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| CameraContext.takePhoto | ✔️ | | |
+| CameraContext.takePhoto | ✔️ | | ✔️ |
 
 ### onCameraFrame
 
@@ -441,7 +441,7 @@ listener.start()
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| CameraContext.startRecord | ✔️ | | |
-| CameraContext.stopRecord | ✔️ | | |
-| CameraContext.takePhoto | ✔️ | | |
+| CameraContext.startRecord | ✔️ | | ✔️ |
+| CameraContext.stopRecord | ✔️ | | ✔️ |
+| CameraContext.takePhoto | ✔️ | | ✔️ |
 | CameraContext.onCameraFrame | ✔️ | | |
diff --git a/docs/apis/media/camera/createCameraContext.md b/docs/apis/media/camera/createCameraContext.md
@@ -25,4 +25,4 @@ const cameraContext = Taro.createCameraContext()
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.createCameraContext | ✔️ | | |
+| Taro.createCameraContext | ✔️ | | ✔️ |
diff --git a/docs/apis/media/image/compressImage.md b/docs/apis/media/image/compressImage.md
@@ -97,4 +97,4 @@ Taro.compressImage({
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.compressImage | ✔️ | | |
+| Taro.compressImage | ✔️ | | ✔️ |
diff --git a/docs/apis/media/recorder/RecorderManager.md b/docs/apis/media/recorder/RecorderManager.md
@@ -40,7 +40,7 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.onError | ✔️ | | |
+| RecorderManager.onError | ✔️ | | ✔️ |
 
 ### onFrameRecorded
 
@@ -172,7 +172,7 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.onPause | ✔️ | | |
+| RecorderManager.onPause | ✔️ | | ✔️ |
 
 ### onResume
 
@@ -205,7 +205,7 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.onResume | ✔️ | | |
+| RecorderManager.onResume | ✔️ | | ✔️ |
 
 ### onStart
 
@@ -238,7 +238,7 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.onStart | ✔️ | | |
+| RecorderManager.onStart | ✔️ | | ✔️ |
 
 ### onStop
 
@@ -271,7 +271,7 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.onStop | ✔️ | | |
+| RecorderManager.onStop | ✔️ | | ✔️ |
 
 ### pause
 
@@ -287,7 +287,7 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.pause | ✔️ | | |
+| RecorderManager.pause | ✔️ | | ✔️ |
 
 ### resume
 
@@ -303,7 +303,7 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.resume | ✔️ | | |
+| RecorderManager.resume | ✔️ | | ✔️ |
 
 ### start
 
@@ -334,7 +334,7 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.start | ✔️ | | |
+| RecorderManager.start | ✔️ | | ✔️ |
 
 ### stop
 
@@ -350,7 +350,7 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.stop | ✔️ | | |
+| RecorderManager.stop | ✔️ | | ✔️ |
 
 ## 参数
 
@@ -706,15 +706,15 @@ sidebar_label: RecorderManager
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| RecorderManager.onError | ✔️ | | |
+| RecorderManager.onError | ✔️ | | ✔️ |
 | RecorderManager.onFrameRecorded | ✔️ | | |
 | RecorderManager.onInterruptionBegin | ✔️ | | |
 | RecorderManager.onInterruptionEnd | ✔️ | | |
-| RecorderManager.onPause | ✔️ | | |
-| RecorderManager.onResume | ✔️ | | |
-| RecorderManager.onStart | ✔️ | | |
-| RecorderManager.onStop | ✔️ | | |
-| RecorderManager.pause | ✔️ | | |
-| RecorderManager.resume | ✔️ | | |
-| RecorderManager.start | ✔️ | | |
-| RecorderManager.stop | ✔️ | | |
+| RecorderManager.onPause | ✔️ | | ✔️ |
+| RecorderManager.onResume | ✔️ | | ✔️ |
+| RecorderManager.onStart | ✔️ | | ✔️ |
+| RecorderManager.onStop | ✔️ | | ✔️ |
+| RecorderManager.pause | ✔️ | | ✔️ |
+| RecorderManager.resume | ✔️ | | ✔️ |
+| RecorderManager.start | ✔️ | | ✔️ |
+| RecorderManager.stop | ✔️ | | ✔️ |
diff --git a/docs/apis/media/recorder/getRecorderManager.md b/docs/apis/media/recorder/getRecorderManager.md
@@ -48,4 +48,4 @@ recorderManager.start(options)
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.getRecorderManager | ✔️ | | |
+| Taro.getRecorderManager | ✔️ | | ✔️ |
diff --git a/docs/apis/media/video/VideoContext.md b/docs/apis/media/video/VideoContext.md
@@ -19,7 +19,7 @@ sidebar_label: VideoContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| VideoContext.exitFullScreen | ✔️ | | |
+| VideoContext.exitFullScreen | ✔️ | | ✔️ |
 
 ### hideStatusBar
 
@@ -51,7 +51,7 @@ sidebar_label: VideoContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| VideoContext.pause | ✔️ | | |
+| VideoContext.pause | ✔️ | | ✔️ |
 
 ### play
 
@@ -67,7 +67,7 @@ sidebar_label: VideoContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| VideoContext.play | ✔️ | | |
+| VideoContext.play | ✔️ | | ✔️ |
 
 ### playbackRate
 
@@ -100,7 +100,7 @@ sidebar_label: VideoContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| VideoContext.playbackRate | ✔️ | | |
+| VideoContext.playbackRate | ✔️ | | ✔️ |
 
 ### requestFullScreen
 
@@ -131,7 +131,7 @@ sidebar_label: VideoContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| VideoContext.requestFullScreen | ✔️ | | |
+| VideoContext.requestFullScreen | ✔️ | | ✔️ |
 
 ### seek
 
@@ -164,7 +164,7 @@ sidebar_label: VideoContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| VideoContext.seek | ✔️ | | |
+| VideoContext.seek | ✔️ | | ✔️ |
 
 ### sendDanmu
 
@@ -229,7 +229,7 @@ sidebar_label: VideoContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| VideoContext.stop | ✔️ | | |
+| VideoContext.stop | ✔️ | | ✔️ |
 
 ## 参数
 
@@ -287,13 +287,13 @@ sidebar_label: VideoContext
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| VideoContext.exitFullScreen | ✔️ | | |
+| VideoContext.exitFullScreen | ✔️ | | ✔️ |
 | VideoContext.hideStatusBar | ✔️ | | |
-| VideoContext.pause | ✔️ | | |
-| VideoContext.play | ✔️ | | |
-| VideoContext.playbackRate | ✔️ | | |
-| VideoContext.requestFullScreen | ✔️ | | |
-| VideoContext.seek | ✔️ | | |
+| VideoContext.pause | ✔️ | | ✔️ |
+| VideoContext.play | ✔️ | | ✔️ |
+| VideoContext.playbackRate | ✔️ | | ✔️ |
+| VideoContext.requestFullScreen | ✔️ | | ✔️ |
+| VideoContext.seek | ✔️ | | ✔️ |
 | VideoContext.sendDanmu | ✔️ | | |
 | VideoContext.showStatusBar | ✔️ | | |
-| VideoContext.stop | ✔️ | | |
+| VideoContext.stop | ✔️ | | ✔️ |
diff --git a/docs/apis/media/video/createVideoContext.md b/docs/apis/media/video/createVideoContext.md
@@ -47,4 +47,4 @@ videoContext = Taro.createVideoContext('myVideo')
 
 | API | 微信小程序 | H5 | React Native |
 | :---: | :---: | :---: | :---: |
-| Taro.createVideoContext | ✔️ | ✔️ | |
+| Taro.createVideoContext | ✔️ | ✔️ | ✔️ |