From 6821006aa737706e6c50a2e7f078b426c8da7b54 Mon Sep 17 00:00:00 2001 From: DCloud_LXH <283700113@qq.com> Date: Tue, 26 Dec 2023 17:40:52 +0800 Subject: [PATCH] =?UTF-8?q?fix:=20=E9=94=99=E8=AF=AF=E9=93=BE=E6=8E=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/README.md | 2 +- docs/api/_sidebar.md | 296 +++++++++--------- docs/api/lifecycle.md | 4 +- docs/api/location/map.md | 2 +- docs/api/media/file.md | 2 +- docs/api/media/video.md | 2 +- docs/api/plugins/login.md | 2 +- docs/api/router.md | 6 +- docs/api/ui/animation.md | 2 +- docs/api/ui/prompt.md | 8 +- docs/api/ui/scroll.md | 8 +- docs/api/window/subNVues.md | 8 +- docs/collocation/_sidebar.md | 18 +- docs/collocation/manifest.md | 4 +- docs/collocation/pages.md | 4 +- docs/component/README.md | 2 +- docs/component/_sidebar.md | 250 +++++++-------- docs/component/map.md | 2 +- docs/component/scroll-view.md | 10 +- docs/component/text.md | 2 +- docs/plugin/README.md | 4 +- docs/plugin/_sidebar.md | 16 +- docs/plugin/native-plugin.md | 12 +- docs/quickstart.md | 18 +- docs/release-archive.md | 2 +- docs/tutorial/README.md | 2 +- docs/tutorial/_sidebar.md | 244 +++++++-------- docs/tutorial/android-store.md | 12 +- docs/tutorial/app-android-abifilters.md | 50 +-- docs/tutorial/app-disagreemode.md | 32 +- docs/tutorial/app-geolocation.md | 26 +- docs/tutorial/app-icons.md | 38 ++- docs/tutorial/app-maps.md | 62 ++-- docs/tutorial/app-oauth-apple.md | 42 +-- docs/tutorial/app-oauth-facebook.md | 48 +-- docs/tutorial/app-oauth-google.md | 44 +-- docs/tutorial/app-oauth-qq.md | 44 +-- docs/tutorial/app-oauth-weibo.md | 56 ++-- docs/tutorial/app-oauth-weixin.md | 64 ++-- docs/tutorial/app-oauth.md | 6 +- docs/tutorial/app-payment.md | 14 +- docs/tutorial/app-privacy-android.md | 172 +++++----- docs/tutorial/app-sec-android.md | 81 +++-- docs/tutorial/app-share-qq.md | 42 +-- docs/tutorial/app-share-weibo.md | 52 +-- docs/tutorial/app-share-weixin.md | 40 +-- docs/tutorial/app-share.md | 8 +- docs/tutorial/app-splashscreen.md | 12 +- docs/tutorial/debug/debug-web-via-hx.md | 2 +- docs/tutorial/nvue-outline.md | 6 +- docs/tutorial/page.md | 14 +- docs/tutorial/run/run-app.md | 76 ++--- docs/tutorial/run/uts-development-android.md | 6 +- docs/tutorial/syntax-css.md | 4 +- docs/tutorial/vue-basics.md | 177 ++++++----- docs/tutorial/vue3-basics.md | 216 ++++++------- docs/unipush-v2.md | 8 +- docs/worktile/_sidebar.md | 18 +- .../auto/hbuilderx-extension/index.md | 8 +- docs/worktile/auto/quick-start.md | 6 +- docs/worktile/auto/uniapp-cli-project.md | 14 +- docs/worktile/running-env.md | 2 +- 62 files changed, 1208 insertions(+), 1226 deletions(-) diff --git a/docs/api/README.md b/docs/api/README.md index 7918b073d..18d8af2ad 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -669,7 +669,7 @@ uni.addInterceptor({ | API | 说明 | | :-------------------------------------------------------------------------- | :---------------- | -| [uni.requireNativePlugin](/api/extend/native-plugin?id=requirenativeplugin) | 引入 App 原生插件 | +| [uni.requireNativePlugin](/plugin/native-plugin.md#requirenativeplugin) | 引入 App 原生插件 | ### 其他 diff --git a/docs/api/_sidebar.md b/docs/api/_sidebar.md index 58a1d606d..e37ec8c6e 100644 --- a/docs/api/_sidebar.md +++ b/docs/api/_sidebar.md @@ -1,161 +1,161 @@ -* [概述](api/README.md) +* [概述](README.md) * 基础 - * [日志打印](api/log.md) - * [定时器](api/timer.md) - * [uni.base64ToArrayBuffer](api/base64ToArrayBuffer.md) - * [uni.arrayBufferToBase64](api/arrayBufferToBase64.md) + * [日志打印](log.md) + * [定时器](timer.md) + * [uni.base64ToArrayBuffer](base64ToArrayBuffer.md) + * [uni.arrayBufferToBase64](arrayBufferToBase64.md) * 启动 - * [uni.getLaunchOptionsSync](api/getLaunchOptionsSync.md) - * [uni.getEnterOptionsSync](api/getEnterOptionsSync.md) - * [应用级事件](api/application.md) - * [拦截器](api/interceptor.md) - * [全局API](api/global.md) - * [uni.canIUse](api/caniuse.md) + * [uni.getLaunchOptionsSync](getLaunchOptionsSync.md) + * [uni.getEnterOptionsSync](getEnterOptionsSync.md) + * [应用级事件](application.md) + * [拦截器](interceptor.md) + * [全局API](global.md) + * [uni.canIUse](caniuse.md) * 网络 - * [发起请求](api/request/request.md) - * [上传、下载](api/request/network-file.md) - * [WebSocket](api/request/websocket.md) - * [SocketTask](api/request/socket-task.md) - * [mDNS](api/request/mDNS.md) - * [UDP 通信](api/request/UDP.md) -* [页面和路由](/api/router) - * [uni.navigateTo](/api/router?id=navigateto) - * [uni.redirectTo](/api/router?id=redirectto) - * [uni.reLaunch](/api/router?id=relaunch) - * [uni.switchTab](/api/router?id=switchtab) - * [uni.navigateBack](/api/router?id=navigateback) - * [EventChannel](/api/router#event-channel) - * [uni.preloadPage](/api/preload-page) - * [窗口动画](/api/router?id=animation) - * [页面](api/window/window.md) - * [页面通讯](api/window/communication.md) - * [subNVue原生子窗体](api/window/subNVues.md) -* [数据缓存](/api/storage/storage) - * [uni.setStorage](/api/storage/storage?id=setstorage) - * [uni.setStorageSync](/api/storage/storage?id=setstoragesync) - * [uni.getStorage](/api/storage/storage?id=getstorage) - * [uni.getStorageSync](/api/storage/storage?id=getstoragesync) - * [uni.getStorageInfo](/api/storage/storage?id=getstorageinfo) - * [uni.getStorageInfoSync](/api/storage/storage?id=getstorageinfosync) - * [uni.removeStorage](/api/storage/storage?id=removestorage) - * [uni.removeStorageSync](/api/storage/storage?id=removestoragesync) - * [uni.clearStorage](/api/storage/storage?id=clearstorage) - * [uni.clearStorageSync](/api/storage/storage?id=clearstoragesync) + * [发起请求](request/request.md) + * [上传、下载](request/network-file.md) + * [WebSocket](request/websocket.md) + * [SocketTask](request/socket-task.md) + * [mDNS](request/mDNS.md) + * [UDP 通信](request/UDP.md) +* [页面和路由](router.md) + * [uni.navigateTo](router.md#navigateto) + * [uni.redirectTo](router.md#redirectto) + * [uni.reLaunch](router.md#relaunch) + * [uni.switchTab](router.md#switchtab) + * [uni.navigateBack](router.md#navigateback) + * [EventChannel](router.md#event-channel) + * [uni.preloadPage](preload-page) + * [窗口动画](router.md#animation) + * [页面](window/window.md) + * [页面通讯](window/communication.md) + * [subNVue原生子窗体](window/subNVues.md) +* [数据缓存](storage/storage.md) + * [uni.setStorage](storage/storage.md#setstorage) + * [uni.setStorageSync](storage/storage.md#setstoragesync) + * [uni.getStorage](storage/storage.md#getstorage) + * [uni.getStorageSync](storage/storage.md#getstoragesync) + * [uni.getStorageInfo](storage/storage.md#getstorageinfo) + * [uni.getStorageInfoSync](storage/storage.md#getstorageinfosync) + * [uni.removeStorage](storage/storage.md#removestorage) + * [uni.removeStorageSync](storage/storage.md#removestoragesync) + * [uni.clearStorage](storage/storage.md#clearstorage) + * [uni.clearStorageSync](storage/storage.md#clearstoragesync) * 位置 - * [获取位置](api/location/location.md) - * [查看位置](api/location/open-location.md) - * [位置更新](api/location/location-change.md) - * [地图组件控制](api/location/map.md) + * [获取位置](location/location.md) + * [查看位置](location/open-location.md) + * [位置更新](location/location-change.md) + * [地图组件控制](location/map.md) * 媒体 - * [图片](api/media/image.md) - * [文件](api/media/file.md) - * [录音管理](api/media/record-manager.md) - * [背景音频播放管理](api/media/background-audio-manager.md) - * [音频组件控制](api/media/audio-context.md) - * [视频](api/media/video.md) - * [视频组件控制](api/media/video-context.md) - * [相机组件控制](api/media/camera-context.md) - * [直播组件控制](api/media/live-player-context.md) - * [富文本](api/media/editor-context.md) - * [音视频合成](api/media/media-container.md) + * [图片](media/image.md) + * [文件](media/file.md) + * [录音管理](media/record-manager.md) + * [背景音频播放管理](media/background-audio-manager.md) + * [音频组件控制](media/audio-context.md) + * [视频](media/video.md) + * [视频组件控制](media/video-context.md) + * [相机组件控制](media/camera-context.md) + * [直播组件控制](media/live-player-context.md) + * [富文本](media/editor-context.md) + * [音视频合成](media/media-container.md) * 设备 * 系统 - * [uni.getSystemInfo](api/system/info.md) - * [uni.getDeviceInfo](api/system/getDeviceInfo.md) - * [uni.getWindowInfo](api/system/getWindowInfo.md) - * [uni.getAppBaseInfo](api/system/getAppBaseInfo.md) - * [uni.getAppAuthorizeSetting](api/system/getappauthorizesetting.md) - * [uni.getSystemSetting](api/system/getsystemsetting.md) - * [uni.openAppAuthorizeSetting](api/system/openappauthorizesetting.md) - * [内存](api/system/memory.md) - * [网络状态](api/system/network.md) - * [系统主题](api/system/theme.md) - * [加速度计](api/system/accelerometer.md) - * [罗盘](api/system/compass.md) - * [陀螺仪](api/system/gyroscope.md) - * [拨打电话](api/system/phone.md) - * [扫码](api/system/barcode.md) - * [剪贴板](api/system/clipboard.md) - * [屏幕亮度](api/system/brightness.md) - * [用户截屏事件](api/system/capture-screen.md) - * [振动](api/system/vibrate.md) - * [手机联系人](api/system/contact.md) - * [蓝牙](api/system/bluetooth.md) - * [低功耗蓝牙](api/system/ble.md) - * [iBeacon](api/system/ibeacon.md) - * [Wi-Fi](api/system/wifi.md) - * [电量](api/system/batteryInfo.md) - * [NFC](api/system/nfc.md) - * [设备方向](api/system/deviceMotion.md) - * [生物认证](api/system/authentication.md) -* [Worker](api/worker.md) -* [键盘](/api/key) - * [uni.hideKeyboard](/api/key?id=hidekeyboard) - * [uni.onKeyboardHeightChange](/api/key?id=onkeyboardheightchange) - * [uni.offKeyboardHeightChange](/api/key?id=offkeyboardheightchange) - * [uni.getSelectedTextRange](/api/key?id=getselectedtextrange) + * [uni.getSystemInfo](system/info.md) + * [uni.getDeviceInfo](system/getDeviceInfo.md) + * [uni.getWindowInfo](system/getWindowInfo.md) + * [uni.getAppBaseInfo](system/getAppBaseInfo.md) + * [uni.getAppAuthorizeSetting](system/getappauthorizesetting.md) + * [uni.getSystemSetting](system/getsystemsetting.md) + * [uni.openAppAuthorizeSetting](system/openappauthorizesetting.md) + * [内存](system/memory.md) + * [网络状态](system/network.md) + * [系统主题](system/theme.md) + * [加速度计](system/accelerometer.md) + * [罗盘](system/compass.md) + * [陀螺仪](system/gyroscope.md) + * [拨打电话](system/phone.md) + * [扫码](system/barcode.md) + * [剪贴板](system/clipboard.md) + * [屏幕亮度](system/brightness.md) + * [用户截屏事件](system/capture-screen.md) + * [振动](system/vibrate.md) + * [手机联系人](system/contact.md) + * [蓝牙](system/bluetooth.md) + * [低功耗蓝牙](system/ble.md) + * [iBeacon](system/ibeacon.md) + * [Wi-Fi](system/wifi.md) + * [电量](system/batteryInfo.md) + * [NFC](system/nfc.md) + * [设备方向](system/deviceMotion.md) + * [生物认证](system/authentication.md) +* [Worker](worker.md) +* [键盘](key.md) + * [uni.hideKeyboard](key.md#hidekeyboard) + * [uni.onKeyboardHeightChange](key.md#onkeyboardheightchange) + * [uni.offKeyboardHeightChange](key.md#offkeyboardheightchange) + * [uni.getSelectedTextRange](key.md#getselectedtextrange) * 界面 - * [交互反馈](api/ui/prompt.md) - * [设置导航条](api/ui/navigationbar.md) - * [设置TabBar](api/ui/tabbar.md) - * [背景](api/ui/bgcolor.md) - * [动画](api/ui/animation) - * [滚动](api/ui/scroll) - * [窗口](api/ui/window.md) - * [宽屏适配](api/ui/adapt.md) - * [字体](api/ui/font.md) - * [下拉刷新](api/ui/pulldown.md) - * [节点信息](api/ui/nodes-info.md) - * [节点布局相交状态](api/ui/intersection-observer.md) - * [媒体查询](api/ui/media-query-observer.md) - * [自定义组件](api/ui/nextTick.md) - * [菜单](api/ui/menuButton.md) - * [语言](api/ui/locale.md) -* [文件](/api/file/file) - * [uni.saveFile](/api/file/file?id=savefile) - * [uni.getSavedFileList](/api/file/file?id=getsavedfilelist) - * [uni.getSavedFileInfo](/api/file/file?id=getsavedfileinfo) - * [uni.removeSavedFile](/api/file/file?id=removesavedfile) - * [uni.getFileInfo](/api/file/file?id=getfileinfo) - * [uni.openDocument](/api/file/file?id=opendocument) - * [uni.getFileSystemManager](/api/file/getFileSystemManager) + * [交互反馈](ui/prompt.md) + * [设置导航条](ui/navigationbar.md) + * [设置TabBar](ui/tabbar.md) + * [背景](ui/bgcolor.md) + * [动画](ui/animation) + * [滚动](ui/scroll) + * [窗口](ui/window.md) + * [宽屏适配](ui/adapt.md) + * [字体](ui/font.md) + * [下拉刷新](ui/pulldown.md) + * [节点信息](ui/nodes-info.md) + * [节点布局相交状态](ui/intersection-observer.md) + * [媒体查询](ui/media-query-observer.md) + * [自定义组件](ui/nextTick.md) + * [菜单](ui/menuButton.md) + * [语言](ui/locale.md) +* [文件](file/file.md) + * [uni.saveFile](file/file.md#savefile) + * [uni.getSavedFileList](file/file.md#getsavedfilelist) + * [uni.getSavedFileInfo](file/file.md#getsavedfileinfo) + * [uni.removeSavedFile](file/file.md#removesavedfile) + * [uni.getFileInfo](file/file.md#getfileinfo) + * [uni.openDocument](file/file.md#opendocument) + * [uni.getFileSystemManager](file/getFileSystemManager.md) * 绘画 - * [uni.createOffscreenCanvas](api/canvas/createOffscreenCanvas.md) - * [uni.createCanvasContext](api/canvas/createCanvasContext.md) - * [uni.canvasToTempFilePath](api/canvas/canvasToTempFilePath.md) - * [uni.canvasPutImageData](api/canvas/canvasPutImageData.md) - * [uni.canvasGetImageData](api/canvas/canvasGetImageData.md) - * [CanvasContext](api/canvas/CanvasContext.md) - * [CanvasGradient](api/canvas/CanvasGradient.md) + * [uni.createOffscreenCanvas](canvas/createOffscreenCanvas.md) + * [uni.createCanvasContext](canvas/createCanvasContext.md) + * [uni.canvasToTempFilePath](canvas/canvasToTempFilePath.md) + * [uni.canvasPutImageData](canvas/canvasPutImageData.md) + * [uni.canvasGetImageData](canvas/canvasGetImageData.md) + * [CanvasContext](canvas/CanvasContext.md) + * [CanvasGradient](canvas/CanvasGradient.md) * 广告 - * [激励视频广告](api/a-d/rewarded-video.md) - * [全屏视频广告](api/a-d/full-screen-video.md) - * [内容联盟广告](api/a-d/content-page.md) - * [插屏广告](api/a-d/interstitial.md) + * [激励视频广告](a-d/rewarded-video.md) + * [全屏视频广告](a-d/full-screen-video.md) + * [内容联盟广告](a-d/content-page.md) + * [插屏广告](a-d/interstitial.md) * 第三方服务 - * [获取服务供应商](api/plugins/provider.md) - * [登录](api/plugins/login.md) - * [分享](api/plugins/share.md) - * [支付](api/plugins/payment.md) - * [推送](api/plugins/push.md) - * [语音](api/plugins/voice.md) - * [实人认证](api/plugins/facialRecognitionVerify.md) - * [一键生成iOS通用链接](api/plugins/universal-links.md) -* [uniCloud](api/uniCloud.md) + * [获取服务供应商](plugins/provider.md) + * [登录](plugins/login.md) + * [分享](plugins/share.md) + * [支付](plugins/payment.md) + * [推送](plugins/push.md) + * [语音](plugins/voice.md) + * [实人认证](plugins/facialRecognitionVerify.md) + * [一键生成iOS通用链接](plugins/universal-links.md) +* [uniCloud](uniCloud.md) * 其他 - * [授权](api/other/authorize.md) - * [设置](api/other/setting.md) - * [收货地址](api/other/choose-address.md) - * [获取发票抬头](api/other/invoice-title.md) - * [小程序跳转](api/other/open-miniprogram.md) - * [账号信息](api/other/getAccountInfoSync.md) - * [环境信息](api/other/getEnvInfoSync.md) - * [运动(计步器)](api/other/sport.md) - * [统计](api/other/report.md) - * [卡券](api/other/card.md) - * [模板消息](api/other/template.md) - * [订阅消息](api/other/requestSubscribeMessage.md) - * [小程序更新](api/other/update.md) - * [调试](api/other/set-enable-debug.md) - * [获取第三方平台数据](api/other/get-extconfig.md) + * [授权](other/authorize.md) + * [设置](other/setting.md) + * [收货地址](other/choose-address.md) + * [获取发票抬头](other/invoice-title.md) + * [小程序跳转](other/open-miniprogram.md) + * [账号信息](other/getAccountInfoSync.md) + * [环境信息](other/getEnvInfoSync.md) + * [运动(计步器)](other/sport.md) + * [统计](other/report.md) + * [卡券](other/card.md) + * [模板消息](other/template.md) + * [订阅消息](other/requestSubscribeMessage.md) + * [小程序更新](other/update.md) + * [调试](other/set-enable-debug.md) + * [获取第三方平台数据](other/get-extconfig.md) * [uni ext api](extapi.md) diff --git a/docs/api/lifecycle.md b/docs/api/lifecycle.md index 7abc0c192..c43693ce0 100644 --- a/docs/api/lifecycle.md +++ b/docs/api/lifecycle.md @@ -1,7 +1,7 @@ ### 应用生命周期 -``uni-app`` 支持 onLaunch、onShow、onHide 等应用生命周期函数，详情请参考[应用生命周期](/collocation/frame/lifecycle?id=app) +``uni-app`` 支持 onLaunch、onShow、onHide 等应用生命周期函数，详情请参考[应用生命周期](/collocation/App.md#applifecycle) ### 页面生命周期 -``uni-app`` 支持 onLoad、onShow、onReady 等生命周期函数，详情请参考[页面生命周期](/collocation/frame/lifecycle?id=page) \ No newline at end of file +``uni-app`` 支持 onLoad、onShow、onReady 等生命周期函数，详情请参考[页面生命周期](/tutorial/page.md#lifecycle) \ No newline at end of file diff --git a/docs/api/location/map.md b/docs/api/location/map.md index d7d7eefd8..e6a102519 100644 --- a/docs/api/location/map.md +++ b/docs/api/location/map.md @@ -20,7 +20,7 @@ mapContext |方法|参数|说明|平台差异说明| |:-|:-|:-|:-| -|getCenterLocation|OBJECT|获取当前地图中心的经纬度，返回的是 gcj02 坐标系，可以用于 [uni.openLocation](api/location/location?id=getlocation)|| +|getCenterLocation|OBJECT|获取当前地图中心的经纬度，返回的是 gcj02 坐标系，可以用于 [uni.openLocation](/api/location/location.md#getlocation)|| |moveToLocation|OBJECT|将地图中心移动到当前定位点，需要配合map组件的show-location使用|| |translateMarker|OBJECT|平移marker，带动画|app-nvue 2.1.5+、微信小程序带动画、抖音、支付宝、京东、百度、QQ小程序| |includePoints|OBJECT|缩放视野展示所有经纬度|app-nvue 2.1.5+、微信、抖音、支付宝、京东、百度、快手、QQ小程序| diff --git a/docs/api/media/file.md b/docs/api/media/file.md index b3291fbdd..79f97b23a 100644 --- a/docs/api/media/file.md +++ b/docs/api/media/file.md @@ -34,7 +34,7 @@ - sourceType 值在 H5 平台根据浏览器的不同而表现不同，一般不可限制仅使用相册，部分浏览器也无法限制是否使用相机。 - extension暂只支持文件后缀名，例如`['.zip','.exe','.js']`，不支持`application/msword`等类似值 -**注：文件的临时路径，在应用本次启动期间可以正常使用，如需持久保存，需在主动调用 [uni.saveFile](api/file/file?id=savefile)，在应用下次启动时才能访问得到。** +**注：文件的临时路径，在应用本次启动期间可以正常使用，如需持久保存，需在主动调用 [uni.saveFile](/api/file/file.md#savefile)，在应用下次启动时才能访问得到。** **OBJECT.type 的合法值** diff --git a/docs/api/media/video.md b/docs/api/media/video.md index 9286b03b5..58b959183 100644 --- a/docs/api/media/video.md +++ b/docs/api/media/video.md @@ -37,7 +37,7 @@ **注意：** * sourceType 值在 H5 平台根据浏览器的不同而表现不同，一般不可限制仅使用相册，部分浏览器也无法限制是否使用相机。 * app安卓端选择的视频最大只支持180MB，如需突破该限制请使用原生插件https://ext.dcloud.net.cn/search?q=%E6%96%87%E4%BB%B6%E9%80%89%E6%8B%A9 -* 文件的临时路径，在应用本次启动期间可以正常使用，如需持久保存，需在主动调用 [uni.saveFile](api/file/file?id=savefile)，在应用下次启动时才能访问得到。 +* 文件的临时路径，在应用本次启动期间可以正常使用，如需持久保存，需在主动调用 [uni.saveFile](/api/file/file.md#savefile)，在应用下次启动时才能访问得到。 * camera 部分 Android 手机下由于系统 ROM 不支持无法生效，打开拍摄界面后可操作切换 * 可以通过用户授权API来判断用户是否给应用授予相册或摄像头的访问权限[https://uniapp.dcloud.io/api/other/authorize](https://uniapp.dcloud.io/api/other/authorize) * App下如需进一步压缩视频大小，可以在插件市场搜索[视频压缩](http://ext.dcloud.net.cn/search?q=%E8%A7%86%E9%A2%91%E5%8E%8B%E7%BC%A9)插件 diff --git a/docs/api/plugins/login.md b/docs/api/plugins/login.md index 289bc0d87..f8714fc2c 100644 --- a/docs/api/plugins/login.md +++ b/docs/api/plugins/login.md @@ -18,7 +18,7 @@ uni.login是一个客户端API，统一封装了各个平台的各种常见的 - [苹果登录（Sign in with Apple）](/tutorial/app-oauth-apple.md) - [微信登录](/tutorial/app-oauth-weixin.md) - [QQ登录](/tutorial/app-oauth-qq.md) -- [新浪微博登录](/tutorial/app-oauth-sina.md) +- [新浪微博登录](/tutorial/app-oauth-weibo.md) - [Google登录](/tutorial/app-oauth-google.md) - [Facebook登录](/tutorial/app-oauth-facebook.md) diff --git a/docs/api/router.md b/docs/api/router.md index 5feb479d8..5c607489c 100644 --- a/docs/api/router.md +++ b/docs/api/router.md @@ -7,7 +7,7 @@ |参数|类型|必填|默认值|说明|平台差异说明| |:-|:-|:-|:-|:-|:-| |url|String|是||需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数。参数与路径之间使用?分隔，参数键与参数值用=相连，不同参数用&分隔；如 'path?key=value&key2=value2'，path为下一个页面的路径，下一个页面的onLoad函数可得到传递的参数| | -|animationType|String|否|pop-in|窗口显示的动画效果，详见：[窗口动画](api/router?id=animation)|App| +|animationType|String|否|pop-in|窗口显示的动画效果，详见：[窗口动画](#animation)|App| |animationDuration|Number|否|300|窗口动画持续时间，单位为 ms|App| |events|Object|否||页面间通信接口，用于监听被打开页面发送到当前页面的数据。2.8.9+ 开始支持。|| |success|Function|否||接口调用成功的回调函数|| @@ -22,7 +22,7 @@ |属性|类型|说明| |:-|:-|:-| -|eventChannel|[EventChannel](api/router?id=event-channel)|和被打开页面进行通信| +|eventChannel|[EventChannel](#event-channel)|和被打开页面进行通信| **示例** @@ -200,7 +200,7 @@ uni.switchTab({ |参数|类型|必填|默认值|说明|平台差异说明| |:-|:-|:-|:-|:-|:-| |delta|Number|否|1|返回的页面数，如果 delta 大于现有页面数，则返回到首页。|| -|animationType|String|否|pop-out|窗口关闭的动画效果，详见：[窗口动画](api/router?id=animation)|App| +|animationType|String|否|pop-out|窗口关闭的动画效果，详见：[窗口动画](#animation)|App| |animationDuration|Number|否|300|窗口关闭动画的持续时间，单位为 ms|App| |success|Function|否||接口调用成功的回调函数|| |fail|Function|否||接口调用失败的回调函数|| diff --git a/docs/api/ui/animation.md b/docs/api/ui/animation.md index 53583e2f0..d948eb472 100644 --- a/docs/api/ui/animation.md +++ b/docs/api/ui/animation.md @@ -43,7 +43,7 @@ var animation = uni.createAnimation({ ``` -**animation** +#### animation 动画实例可以调用以下方法来描述动画，调用结束后会返回自身，支持链式调用的写法。 diff --git a/docs/api/ui/prompt.md b/docs/api/ui/prompt.md index ee18e1ad4..0050e9ee9 100644 --- a/docs/api/ui/prompt.md +++ b/docs/api/ui/prompt.md @@ -59,9 +59,9 @@ uni.hideToast(); ``` -### uni.showLoading(OBJECT) +### uni.showLoading(OBJECT)@showloading -显示 loading 提示框, 需主动调用 [uni.hideLoading](api/ui/prompt?id=hideloading) 才能关闭提示框。 +显示 loading 提示框, 需主动调用 [uni.hideLoading](#hideloading) 才能关闭提示框。 **OBJECT参数说明** @@ -81,7 +81,7 @@ uni.showLoading({ }); ``` -### uni.hideLoading() +### uni.hideLoading()@hideloading 隐藏 loading 提示框。 @@ -97,7 +97,7 @@ setTimeout(function () { }, 2000); ``` -### uni.showModal(OBJECT) +### uni.showModal(OBJECT)@showmodal 显示模态弹窗，可以只有一个确定按钮，也可以同时有确定和取消按钮。类似于一个API整合了 html 中：alert、confirm。 diff --git a/docs/api/ui/scroll.md b/docs/api/ui/scroll.md index ccaa45bfe..772ce16af 100644 --- a/docs/api/ui/scroll.md +++ b/docs/api/ui/scroll.md @@ -33,10 +33,10 @@ selector类似于 CSS 的选择器，但仅支持下列语法。 ## uni-app x 注意事项 -1. app-uvue支持的选择器较少，不支持ID选择器，[详见](uni-app-x/css/README.md#选择器) -2. app-uvue的页面滚动，是由页面最外层的scroll-view模拟的，如果页面最外层不是scroll-view，无法使用本api。[详见](uni-app-x/css/README.md#pagescroll) -3. app-uvue的scroll-view滚动时，如需动画，则需要在scroll-view的属性中配置 `scroll-with-animation="true"`，[详见](component/scroll-view.md) -4. scroll-view的滚动，设置其scrollTop即可。[详见](component/scroll-view.md) +1. app-uvue支持的选择器较少，不支持ID选择器，[详见](https://doc.dcloud.net.cn/uni-app-x/css/#%E9%80%89%E6%8B%A9%E5%99%A8) +2. app-uvue的页面滚动，是由页面最外层的scroll-view模拟的，如果页面最外层不是scroll-view，无法使用本api。[详见](https://doc.dcloud.net.cn/uni-app-x/css/#pagescroll) +3. app-uvue的scroll-view滚动时，如需动画，则需要在scroll-view的属性中配置 `scroll-with-animation="true"`，[详见](/component/scroll-view.md) +4. scroll-view的滚动，设置其scrollTop即可。[详见](/component/scroll-view.md) **示例** diff --git a/docs/api/window/subNVues.md b/docs/api/window/subNVues.md index e80b5d7c5..ae3511ef3 100644 --- a/docs/api/window/subNVues.md +++ b/docs/api/window/subNVues.md @@ -116,9 +116,9 @@ subNVue.setStyle({ ``` -### subNVue.postMessage(OBJECT) +### subNVue.postMessage(OBJECT) -发送消息，此通讯方式已过时，请使用`uni.$emit`进行通讯，[参考](/collocation/frame/communication?id=emit) +发送消息，此通讯方式已过时，请使用`uni.$emit`进行通讯，[参考](/tutorial/page.md#emit) **代码示例** @@ -131,9 +131,9 @@ subNvue.postMessage({ }) ``` -### subNVue.onMessage(CallBack) +### subNVue.onMessage(CallBack) -监听消息，此通讯方式已过时，请使用`uni.$on`进行通讯，[参考](/collocation/frame/communication?id=on) +监听消息，此通讯方式已过时，请使用`uni.$on`进行通讯，[参考](/tutorial/page.md#on) **代码示例** diff --git a/docs/collocation/_sidebar.md b/docs/collocation/_sidebar.md index ad9904446..a04541298 100644 --- a/docs/collocation/_sidebar.md +++ b/docs/collocation/_sidebar.md @@ -1,11 +1,11 @@ -* [pages.json 页面路由](collocation/pages.md) -* [manifest.json 应用配置](collocation/manifest.md) - * [App 完整manifest.json](collocation/manifest-app.md) +* [pages.json 页面路由](pages.md) +* [manifest.json 应用配置](manifest.md) + * [App 完整manifest.json](manifest-app.md) * [AndroidManifest.xml（安卓原生配置）](/tutorial/app-nativeresource-android.md) * [Info.plist（iOS原生配置）](/tutorial/app-nativeresource-ios.md) -* [App.vue/uvue](collocation/App.md) -* [main.js/uts](collocation/main.md) -* [uni.scss](collocation/uni-scss.md) -* [package.json](collocation/package.md) -* [vue.config.js](collocation/vue-config.md) -* [vite.config.js](collocation/vite-config.md) +* [App.vue/uvue](App.md) +* [main.js/uts](main.md) +* [uni.scss](uni-scss.md) +* [package.json](package.md) +* [vue.config.js](vue-config.md) +* [vite.config.js](vite-config.md) diff --git a/docs/collocation/manifest.md b/docs/collocation/manifest.md index e2602e61e..4c554b275 100644 --- a/docs/collocation/manifest.md +++ b/docs/collocation/manifest.md @@ -92,7 +92,7 @@ splash（启动封面）是App必然存在的、不可取消的。 |autoclose|Boolean|true|是否自动关闭启动界面，仅当alwaysShowBeforeRender设置为false时生效，如果需要[手动关闭](https://www.html5plus.org/doc/zh_cn/navigator.html#plus.navigator.closeSplashscreen)启动界面，需将 alwaysShowBeforeRender 及 autoclose 均设置为 false。|| |waiting|Boolean|true|是否在程序启动界面显示等待圈或雪花|| -alwaysShowBeforeRender和autoclose属性组合设置，可配置以下三种关闭启动界面（splash）策略，[详见](tutorial/app-splashscreen) +alwaysShowBeforeRender和autoclose属性组合设置，可配置以下三种关闭启动界面（splash）策略，[详见](../tutorial/app-splashscreen.md) **注意** @@ -100,7 +100,7 @@ alwaysShowBeforeRender和autoclose属性组合设置，可配置以下三种关 - splash只能是标准png，不要用jpg改名为png。也不支持gif等动画 - 相关改动，云打包生效，真机运行不生效。本地打包需自行在原生工程中配置 - App启动图中iOS的MAX等大屏设备的splash图若不配，会导致iOS认为此App没有为MAX优化，App将无法全屏，四周会有黑边 -- Android的splash支持.9.png，[详见](tutorial/app-splashscreen?id=9png) +- Android的splash支持.9.png，[详见](../tutorial/app-splashscreen.md#9png) #### App Modules@modules diff --git a/docs/collocation/pages.md b/docs/collocation/pages.md index 75370dfdc..12cbf2a12 100644 --- a/docs/collocation/pages.md +++ b/docs/collocation/pages.md @@ -486,7 +486,7 @@ uni-app 2.9+ 新增 leftWindow, topWindow, rightWindow 配置。用于解决宽 - `titleNView` 的 `type` 值为 `transparent` 时，导航栏为滚动透明渐变导航栏，默认只有button，滚动后标题栏底色和title文字会渐变出现，不支持自定义按钮设置color属性； `type` 为 `float` 时，导航栏为悬浮标题栏，此时页面内容上顶到了屏幕顶部，包括状态栏，但导航栏悬浮盖在页面上方，一般这种场景会同时设置导航栏的背景色为rgba半透明颜色。 - `titleNView` 的 `type` 值为 `transparent` 时，App-nvue 2.4.4+ 支持 - 在 `titleNView` 配置 `buttons` 后，监听按钮的点击事件，vue 页面及 nvue 的weex编译模式参考：[uni.onNavigationBarButtonTap](/tutorial/nvue-outline?id=onnavigationbarbuttontap) -- 在 `titleNView` 配置 `searchInput` 后，相关的事件监听参考：[onNavigationBarSearchInputChanged 等](/collocation/frame/lifecycle?id=页面生命周期) +- 在 `titleNView` 配置 `searchInput` 后，相关的事件监听参考：[onNavigationBarSearchInputChanged 等](/tutorial/page.md#lifecycle) - 可通过 `[(/component/navigation-bar)]` 配置 - App下原生导航栏的按钮如果使用字体图标，注意检查字体库的名字（font-family）是否使用了默认的 iconfont，这个名字是保留字，不能作为外部引入的字体库的名字，需要调整为自定义的名称，否则无法显示。 - 想了解各种导航栏的开发方法，请详读[导航栏开发指南](https://ask.dcloud.net.cn/article/34921) @@ -932,7 +932,7 @@ h5 平台下拉刷新动画，只有 circle 类型。 ┌─components │ └─comp-a │ └─comp-a.vue 符合easycom规范的组件 -└─uni_modules [uni_module](/uni_modules)中符合easycom规范的组件 +└─uni_modules [uni_module](/plugin/uni_modules.md)中符合easycom规范的组件 └─uni_modules └─uni-list └─components diff --git a/docs/component/README.md b/docs/component/README.md index a4c5cf366..0b34d8d61 100644 --- a/docs/component/README.md +++ b/docs/component/README.md @@ -63,7 +63,7 @@ |属性名|类型|描述|注解| |:-|:-|:-|:-| |id|String|组件的唯一标示|一般用于获取组件上下文对象（如：[VideoContext](/api/media/video-context)），需要保持整个页面唯一| -|ref|String|vue中组件的唯一标示|用来给子组件注册引用信息，详见 [Vue 文档](/vue-components?id=ref)| +|ref|String|vue中组件的唯一标示|用来给子组件注册引用信息，详见 [Vue 文档](/tutorial/vue-components?id=ref)| |class|String|组件的样式类|在对应的 css 中定义的样式类| |style|String|组件的内联样式|可以动态设置的内联样式| |hidden|Boolean|组件是否隐藏|所有组件默认是显示的| diff --git a/docs/component/_sidebar.md b/docs/component/_sidebar.md index 1c94d8505..7c793abe7 100644 --- a/docs/component/_sidebar.md +++ b/docs/component/_sidebar.md @@ -1,130 +1,130 @@ -* [组件概述](component/) +* [组件概述](README.md) * 内置组件 - * [uni-app 组件](component/view.md) - * [视图容器](component/view.md) - * [view](component/view.md) - * [scroll-view](component/scroll-view.md) - * [swiper](component/swiper.md) - * [match-media](component/match-media.md) - * [movable-area](component/movable-area.md) - * [movable-view](component/movable-view.md) - * [cover-view](/component/cover-view.md) - * [cover-image](/component/cover-image.md) - * [基础内容](component/icon.md) - * [icon](component/icon.md) - * [text](component/text.md) - * [rich-text](component/rich-text.md) - * [progress](component/progress.md) - * [表单组件](component/button.md) - * [button](component/button.md) - * [checkbox](component/checkbox.md) - * [editor](component/editor.md) - * [form](component/form.md) - * [input](component/input.md) - * [label](component/label.md) - * [picker](component/picker.md) - * [picker-view](component/picker-view.md) - * [radio](component/radio.md) - * [slider](component/slider.md) - * [switch](component/switch.md) - * [textarea](component/textarea.md) - * [路由与页面跳转](component/navigator.md) - * [navigator](component/navigator.md) - * [媒体组件](component/audio.md) - * [animation-view](component/animation-view.md) - * [audio](component/audio.md) - * [camera](component/camera.md) - * [image](component/image.md) - * [video](component/video.md) - * [live-player](component/live-player.md) - * [live-pusher](component/live-pusher.md) - * [地图](component/map.md) - * [map](component/map.md) - * [画布](component/canvas.md) - * [canvas](component/canvas.md) - * [webview](component/web-view.md) - * [web-view](component/web-view.md) - * [广告](component/ad.md) - * [信息流(Banner)](component/ad.md) - * [激励视频广告](component/ad-rewarded-video.md) - * [uniMP激励视频广告](component/uni-ad-unimp.md) - * [全屏视频广告](component/ad-fullscreen-video.md) - * [插屏广告](component/ad-interstitial.md) - * [Draw视频信息流广告](component/ad-draw.md) - * [短视频内容联盟广告](component/ad-content-page.md) - * [互动广告](component/ad-interactive.md) - * [微信小程序](component/ad-weixin.md) - * [微信小程序格子广告](component/ad-grid.md) - * [广告错误码](component/ad-error-code.md) + * [uni-app 组件](view.md) + * [视图容器](view.md) + * [view](view.md) + * [scroll-view](scroll-view.md) + * [swiper](swiper.md) + * [match-media](match-media.md) + * [movable-area](movable-area.md) + * [movable-view](movable-view.md) + * [cover-view](cover-view.md) + * [cover-image](cover-image.md) + * [基础内容](icon.md) + * [icon](icon.md) + * [text](text.md) + * [rich-text](rich-text.md) + * [progress](progress.md) + * [表单组件](button.md) + * [button](button.md) + * [checkbox](checkbox.md) + * [editor](editor.md) + * [form](form.md) + * [input](input.md) + * [label](label.md) + * [picker](picker.md) + * [picker-view](picker-view.md) + * [radio](radio.md) + * [slider](slider.md) + * [switch](switch.md) + * [textarea](textarea.md) + * [路由与页面跳转](navigator.md) + * [navigator](navigator.md) + * [媒体组件](audio.md) + * [animation-view](animation-view.md) + * [audio](audio.md) + * [camera](camera.md) + * [image](image.md) + * [video](video.md) + * [live-player](live-player.md) + * [live-pusher](live-pusher.md) + * [地图](map.md) + * [map](map.md) + * [画布](canvas.md) + * [canvas](canvas.md) + * [webview](web-view.md) + * [web-view](web-view.md) + * [广告](ad.md) + * [信息流(Banner)](ad.md) + * [激励视频广告](ad-rewarded-video.md) + * [uniMP激励视频广告](uni-ad-unimp.md) + * [全屏视频广告](ad-fullscreen-video.md) + * [插屏广告](ad-interstitial.md) + * [Draw视频信息流广告](ad-draw.md) + * [短视频内容联盟广告](ad-content-page.md) + * [互动广告](ad-interactive.md) + * [微信小程序](ad-weixin.md) + * [微信小程序格子广告](ad-grid.md) + * [广告错误码](ad-error-code.md) * [uniCloud-db云数据库](https://doc.dcloud.net.cn/uniCloud/unicloud-db.html) - * [页面属性配置节点](component/page-meta.md) - * [page-meta](component/page-meta.md) - * [navigation-bar](component/navigation-bar.md) - * [custom-tab-bar](component/custom-tab-bar.md) - * [基础组件中原生组件说明](component/native-component.md) - * [Vue 组件](component/vue-component.md) - * [NVUE 组件](component/barcode.md) - * [barcode](component/barcode.md) - * [list](component/list.md) - * [cell](component/cell.md) - * [recycle-list](component/recycle-list.md) - * [waterfall](component/waterfall.md) - * [refresh](component/refresh.md) - * [小程序组件](component/official-account.md) - * [official-account](component/official-account.md) - * [open-data](component/open-data.md) + * [页面属性配置节点](page-meta.md) + * [page-meta](page-meta.md) + * [navigation-bar](navigation-bar.md) + * [custom-tab-bar](custom-tab-bar.md) + * [基础组件中原生组件说明](native-component.md) + * [Vue 组件](vue-component.md) + * [NVUE 组件](barcode.md) + * [barcode](barcode.md) + * [list](list.md) + * [cell](cell.md) + * [recycle-list](recycle-list.md) + * [waterfall](waterfall.md) + * [refresh](refresh.md) + * [小程序组件](official-account.md) + * [official-account](official-account.md) + * [open-data](open-data.md) * 扩展组件（uni-ui） - * [介绍](component/uniui/uni-ui.md) - * [开始使用](component/uniui/quickstart.md) - * [色彩说明](component/uniui/color.md) - * [uni-sass 辅助样式](component/uniui/uni-sass.md) - * [uni-badge 数字角标](component/uniui/uni-badge.md) - * [uni-breadcrumb 面包屑](component/uniui/uni-breadcrumb.md) - * [uni-calendar 日历](component/uniui/uni-calendar.md) - * [uni-card 卡片](component/uniui/uni-card.md) - * [uni-collapse 折叠面板](component/uniui/uni-collapse.md) - * [uni-combox 组合框](component/uniui/uni-combox.md) - * [uni-countdown 倒计时](component/uniui/uni-countdown.md) - * [uni-data-checkbox 数据选择器](component/uniui/uni-data-checkbox.md) - * [uni-data-picker 级联选择器](component/uniui/uni-data-picker.md) - * [uni-data-select 下拉框](component/uniui/uni-data-select.md) - * [uni-dateformat 日期格式化](component/uniui/uni-dateformat.md) - * [uni-datetime-picker 日期选择器](component/uniui/uni-datetime-picker.md) - * [uni-drawer 抽屉](component/uniui/uni-drawer.md) - * [uni-easyinput 增强输入框](component/uniui/uni-easyinput.md) - * [uni-fab 悬浮按钮](component/uniui/uni-fab.md) - * [uni-fav 收藏按钮](component/uniui/uni-fav.md) - * [uni-file-picker 文件选择上传](component/uniui/uni-file-picker.md) - * [uni-forms 表单](component/uniui/uni-forms.md) - * [uni-goods-nav 商品导航](component/uniui/uni-goods-nav.md) - * [uni-grid 宫格](component/uniui/uni-grid.md) - * [uni-group 分组](component/uniui/uni-group.md) - * [uni-icons 图标](component/uniui/uni-icons.md) - * [uni-indexed-list 索引列表](component/uniui/uni-indexed-list.md) - * [uni-link 超链接](component/uniui/uni-link.md) - * [uni-list 列表](component/uniui/uni-list.md) - * [uni-load-more 加载更多](component/uniui/uni-load-more.md) - * [uni-nav-bar 自定义导航栏](component/uniui/uni-nav-bar.md) - * [uni-notice-bar 通告栏](component/uniui/uni-notice-bar.md) - * [uni-number-box 数字输入框](component/uniui/uni-number-box.md) - * [uni-pagination 分页器](component/uniui/uni-pagination.md) - * [uni-popup 弹出层](component/uniui/uni-popup.md) - * [uni-rate 评分](component/uniui/uni-rate.md) - * [uni-row 布局-行](component/uniui/uni-row.md) - * [uni-search-bar 搜索栏](component/uniui/uni-search-bar.md) - * [uni-section 标题栏](component/uniui/uni-section.md) - * [uni-segmented-control 分段器](component/uniui/uni-segmented-control.md) - * [uni-steps 步骤条](component/uniui/uni-steps.md) - * [uni-swipe-action 滑动操作](component/uniui/uni-swipe-action.md) - * [uni-swiper-dot 轮播图指示点](component/uniui/uni-swiper-dot.md) - * [uni-table 表格](component/uniui/uni-table.md) - * [uni-tag 标签](component/uniui/uni-tag.md) - * [uni-title 章节标题](component/uniui/uni-title.md) - * [uni-tooltip 文字提示](component/uniui/uni-tooltip.md) - * [uni-transition 过渡动画](component/uniui/uni-transition.md) + * [介绍](uniui/uni-ui.md) + * [开始使用](uniui/quickstart.md) + * [色彩说明](uniui/color.md) + * [uni-sass 辅助样式](uniui/uni-sass.md) + * [uni-badge 数字角标](uniui/uni-badge.md) + * [uni-breadcrumb 面包屑](uniui/uni-breadcrumb.md) + * [uni-calendar 日历](uniui/uni-calendar.md) + * [uni-card 卡片](uniui/uni-card.md) + * [uni-collapse 折叠面板](uniui/uni-collapse.md) + * [uni-combox 组合框](uniui/uni-combox.md) + * [uni-countdown 倒计时](uniui/uni-countdown.md) + * [uni-data-checkbox 数据选择器](uniui/uni-data-checkbox.md) + * [uni-data-picker 级联选择器](uniui/uni-data-picker.md) + * [uni-data-select 下拉框](uniui/uni-data-select.md) + * [uni-dateformat 日期格式化](uniui/uni-dateformat.md) + * [uni-datetime-picker 日期选择器](uniui/uni-datetime-picker.md) + * [uni-drawer 抽屉](uniui/uni-drawer.md) + * [uni-easyinput 增强输入框](uniui/uni-easyinput.md) + * [uni-fab 悬浮按钮](uniui/uni-fab.md) + * [uni-fav 收藏按钮](uniui/uni-fav.md) + * [uni-file-picker 文件选择上传](uniui/uni-file-picker.md) + * [uni-forms 表单](uniui/uni-forms.md) + * [uni-goods-nav 商品导航](uniui/uni-goods-nav.md) + * [uni-grid 宫格](uniui/uni-grid.md) + * [uni-group 分组](uniui/uni-group.md) + * [uni-icons 图标](uniui/uni-icons.md) + * [uni-indexed-list 索引列表](uniui/uni-indexed-list.md) + * [uni-link 超链接](uniui/uni-link.md) + * [uni-list 列表](uniui/uni-list.md) + * [uni-load-more 加载更多](uniui/uni-load-more.md) + * [uni-nav-bar 自定义导航栏](uniui/uni-nav-bar.md) + * [uni-notice-bar 通告栏](uniui/uni-notice-bar.md) + * [uni-number-box 数字输入框](uniui/uni-number-box.md) + * [uni-pagination 分页器](uniui/uni-pagination.md) + * [uni-popup 弹出层](uniui/uni-popup.md) + * [uni-rate 评分](uniui/uni-rate.md) + * [uni-row 布局-行](uniui/uni-row.md) + * [uni-search-bar 搜索栏](uniui/uni-search-bar.md) + * [uni-section 标题栏](uniui/uni-section.md) + * [uni-segmented-control 分段器](uniui/uni-segmented-control.md) + * [uni-steps 步骤条](uniui/uni-steps.md) + * [uni-swipe-action 滑动操作](uniui/uni-swipe-action.md) + * [uni-swiper-dot 轮播图指示点](uniui/uni-swiper-dot.md) + * [uni-table 表格](uniui/uni-table.md) + * [uni-tag 标签](uniui/uni-tag.md) + * [uni-title 章节标题](uniui/uni-title.md) + * [uni-tooltip 文字提示](uniui/uni-tooltip.md) + * [uni-transition 过渡动画](uniui/uni-transition.md) * [更新日志](https://ext.dcloud.net.cn/plugin?id=55&update_log) * [更多插件市场的组件](https://ext.dcloud.net.cn/?cat1=2) -* [ui 设计资源](component/uniui/resource.md) -* [datacom 组件规范](component/datacom.md) -* [小程序自定义组件](/tutorial/miniprogram-subject.md) -* [组件库选型指南](component/component-selection.md) +* [ui 设计资源](uniui/resource.md) +* [datacom 组件规范](datacom.md) +* [小程序自定义组件](tutorial/miniprogram-subject.md) +* [组件库选型指南](component-selection.md) diff --git a/docs/component/map.md b/docs/component/map.md index e3b15d881..8564c1b37 100644 --- a/docs/component/map.md +++ b/docs/component/map.md @@ -296,7 +296,7 @@ export default { |arrowIconPath|更换箭头图标 |已支持 |Android不支持 iOS支持 | -**map 组件相关操作的 JS API**：[uni.createMapContext](api/location/map?id=createmapcontext) +**map 组件相关操作的 JS API**：[uni.createMapContext](../api/location/map.md#createmapcontext) nvue map 更换箭头图标格式参考: [https://ask.dcloud.net.cn/article/37901](https://ask.dcloud.net.cn/article/37901) diff --git a/docs/component/scroll-view.md b/docs/component/scroll-view.md index cfc436c69..87f9c7cdc 100644 --- a/docs/component/scroll-view.md +++ b/docs/component/scroll-view.md @@ -34,7 +34,7 @@ |@refresherabort |EventHandle| |自定义下拉刷新被中止|H5、app-vue 2.5.12+,微信小程序基础库2.10.1+| 使用竖向滚动时，需要给 ```` 一个固定高度，通过 css 设置 height；使用横向滚动时，需要给````添加``white-space: nowrap;``样式。 - + ## 示例 [查看演示](https://hellouniapp.dcloud.net.cn/pages/component/scroll-view/scroll-view) @@ -63,7 +63,7 @@ 点击这里返回顶部 - + Horizontal Scroll \n横向滚动 @@ -203,7 +203,7 @@ ``` ::: - + ## webview中使用scroll-view的注意@webviewtips - 原生组件嵌套问题 @@ -214,10 +214,10 @@ * 如果您一定要在webview中实现区域长列表，建议使用三方如better-scroll组件，或者插件市场搜索 [虚拟列表](https://ext.dcloud.net.cn/search?q=%E8%99%9A%E6%8B%9F%E5%88%97%E8%A1%A8)，这些专业组件实现了dom复用，即便列表很长也不会创建很多dom。 - 下拉刷新问题 * webview渲染时，建议使用页面级的原生下拉刷新，性能更好。如一定要在webview中自定义下拉刷新，建议插件市场搜索[虚拟列表](https://ext.dcloud.net.cn/search?q=%E4%B8%8B%E6%8B%89%E5%88%B7%E6%96%B0)，这些专业组件使用wxs、renderjs等技术避免通信阻塞。 -- scroll-view是区域滚动，不会触发页面滚动，无法触发pages.json配置的下拉刷新、页面触底onReachBottomDistance、titleNView的transparent透明渐变。但在app-uvue下，scroll-view如果是页面顶级节点，则等同于页面滚动。[详见](uni-app-x/css/README.md#pagescroll) +- scroll-view是区域滚动，不会触发页面滚动，无法触发pages.json配置的下拉刷新、页面触底onReachBottomDistance、titleNView的transparent透明渐变。但在app-uvue下，scroll-view如果是页面顶级节点，则等同于页面滚动。[详见](https://doc.dcloud.net.cn/uni-app-x/css/#pagescroll) - webview渲染时，scroll-view的滚动条设置，可通过css的-webkit-scrollbar自定义，包括隐藏滚动条。 -在app-uvue中，其实没有页面级滚动，scroll-view也不存在原生组件层级、下拉刷新性能问题。但app-uvue里使用长列表，请务必使用list-view组件，这个组件内置了recycle-view机制，不管列表多长，都可以通过回收不显示的列表来保证高性能。[详见](list-view.md) +在app-uvue中，其实没有页面级滚动，scroll-view也不存在原生组件层级、下拉刷新性能问题。但app-uvue里使用长列表，请务必使用list-view组件，这个组件内置了recycle-view机制，不管列表多长，都可以通过回收不显示的列表来保证高性能。[详见](list.md) ## 其他注意事项 - scroll-into-view 的优先级高于 scroll-top。 diff --git a/docs/component/text.md b/docs/component/text.md index d5dde042f..7b7c538e3 100644 --- a/docs/component/text.md +++ b/docs/component/text.md @@ -4,7 +4,7 @@ 在app-uvue和app-nvue中，文本只能写在text中，而不能写在view的text区域。 -虽然app-uvue中写在view的text区域的文字，也会被编译器自动包裹一层text组件，看起来也可以使用。但这样会造成无法修改该text文字的样式，详见uvue的[样式不继承](uni-app-x/css/README.md#stylenoextends)章节 +虽然app-uvue中写在view的text区域的文字，也会被编译器自动包裹一层text组件，看起来也可以使用。但这样会造成无法修改该text文字的样式，详见uvue的[样式不继承](https://doc.dcloud.net.cn/uni-app-x/css/#stylenoextends)章节 ## 属性说明 diff --git a/docs/plugin/README.md b/docs/plugin/README.md index 734b74dd7..5d5da0374 100644 --- a/docs/plugin/README.md +++ b/docs/plugin/README.md @@ -28,10 +28,10 @@ uni-app内置了`weex`，`weex`的原生插件或ui库均可使用。注意`weex （但为了全端使用，仍然建议减少对dom库的依赖，在`uni-app`的插件市场可寻找全端兼容的库来替代） - App端支持各种调用原生能力的方式 -1. 支持 原生[混合开发](hybrid) +1. 支持 原生[混合开发](/hybrid.md) 2. 支持 比小程序能力更多的[plus JSAPI](http://www.html5plus.org/doc/h5p.html) 3. 支持 [Native.js](https://ask.dcloud.net.cn/docs/#//ask.dcloud.net.cn/article/88) 直接调用原生api -4. 支持 [uts插件](uts-plugin.md) +4. 支持 [uts插件](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-plugin.html) 5. 支持 [原生语言插件](native-plugin.md) diff --git a/docs/plugin/_sidebar.md b/docs/plugin/_sidebar.md index 9391c2b67..cf6fcafd7 100644 --- a/docs/plugin/_sidebar.md +++ b/docs/plugin/_sidebar.md @@ -1,6 +1,6 @@ -* [插件全景描述](/plugin/README.md) -* [插件市场介绍](/plugin/plugin-ext-introduction.md) -* [uni_modules](/plugin/uni_modules.md) +* [插件全景描述](README.md) +* [插件市场介绍](plugin-ext-introduction.md) +* [uni_modules](uni_modules.md) * uts插件 * [uts插件开发入门](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-plugin.html) * [uts页面组件开发入门](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-component.html) @@ -8,9 +8,9 @@ * [Android平台uts开发指南](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-for-android.html) * [iOS平台uts开发指南](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-for-ios.html) * [使用CocoaPods依赖](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-ios-cocoapods.html) -* [原生语言插件](/plugin/native-plugin.md) +* [原生语言插件](native-plugin.md) * 插件作者专区 - * [发布插件](/plugin/publish.md) - * [销售变现](/plugin/sell.md) - * [支持多语言](/plugin/language.md) - * [oath开放平台](/plugin/oath.md) + * [发布插件](publish.md) + * [销售变现](sell.md) + * [支持多语言](language.md) + * [oath开放平台](oath.md) diff --git a/docs/plugin/native-plugin.md b/docs/plugin/native-plugin.md index 26119e75f..843b41809 100644 --- a/docs/plugin/native-plugin.md +++ b/docs/plugin/native-plugin.md @@ -1,6 +1,6 @@ uni-app在App侧的原生扩展插件，支持使用java、object-c等原生语言编写。 -从HBuilderX 3.6起，新增支持了使用uts来开发原生插件。文档另见[uts插件](uts-plugin.md) +从HBuilderX 3.6起，新增支持了使用uts来开发原生插件。文档另见[uts插件](https://doc.dcloud.net.cn/uni-app-x/plugin/uts-plugin.html) 为了和uts插件区别，之前的`App原生插件`，改名为`App原生语言插件`。 @@ -14,7 +14,7 @@ uni-app在App侧的原生扩展插件，支持使用java、object-c等原生语 自 HBuilderX 1.4 版本起，uni-app 支持引入原生插件，使用方式如下： -```js +```js const PluginName = uni.requireNativePlugin(PluginName); // PluginName 为原生插件名称 ``` @@ -37,7 +37,7 @@ uni-app在App侧的原生扩展插件，支持使用java、object-c等原生语 ``` html ``` @@ -224,7 +224,7 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 相比Web平台， Vue.js 在 `uni-app` 中使用差异主要集中在两个方面： - 新增：`uni-app` 除了支持 Vue 实例的组件生命周期，还拥有[应用生命周期](/collocation/App.md#applifecycle)及[页面的生命周期](/tutorial/page.md#lifecycle)。 -- 受限：相比 Web 平台，在小程序和 App 端部分功能支持不完善，具体见[兼容性列表](/vue3-api)。 +- 受限：相比 Web 平台，在小程序和 App 端部分功能支持不完善，具体见[兼容性列表](./vue3-api)。 @@ -367,7 +367,7 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 > - `Set` > - `JSON` > - `Intl` -> +> > 你不应该在模板表达式中试图访问用户定义的全局变量。 @@ -398,10 +398,10 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 - + - + ``` @@ -416,7 +416,7 @@ v-on 指令，它用于监听 DOM 事件。v-on缩写为‘ @ ’，下文简称 ```html - 点击 + 点击 点击 ``` @@ -1351,7 +1351,7 @@ v-for 指令可以实现基于一个数组来渲染一个列表。 每一个计算属性都包含一个 `getter` 和一个 `setter` ，默认是利用 `getter` 来读取。所有 `getter` 和 `setter` 的 `this` 上下文自动地绑定为 Vue 实例。 -#### 计算属性的 getter +#### 计算属性的 getter 在模板中绑定表达式是非常便利的，但是它们实际上只用于简单的操作。在模板中放入太多的逻辑会让模板过重且难以维护。例如： @@ -1549,8 +1549,11 @@ Vue 提供了一种更通用的方式来观察和响应 Vue 实例上的数据 ### 侦听器watch -- 类型：{ [key: string]: string%20%7C%20Function%20%7C%20Object%20%7C%20Array%20%7D +- 类型 + ```ts + interface Watch { [key: string]: string | Function | Object | Array } + ``` - 一个对象，键是需要观察的表达式，值是对应回调函数。值也可以是方法名，或者包含选项的对象。Vue 实例将会在实例化时调用 `$watch()` ，遍历 `watch` 对象的每一个 `property` 。 diff --git a/docs/tutorial/vue3-basics.md b/docs/tutorial/vue3-basics.md index 8d80f315f..d063d8c3f 100644 --- a/docs/tutorial/vue3-basics.md +++ b/docs/tutorial/vue3-basics.md @@ -2,7 +2,7 @@ > 已经了解 Vue2，只想了解 Vue3 新功能可以参阅[vue3新功能](https://v3.cn.vuejs.org/guide/migration/introduction.html#%E6%A6%82%E8%A7%88)！ -> +> > 已经有 Vue2 项目，需要适配 Vue3 的可参阅[vue2 项目迁移 vue3](https://uniapp.dcloud.io/tutorial/migration-to-vue3)！ @@ -57,18 +57,18 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 - 以前一个 `html` 大节点，里面有 `script` 和 `style` 节点； ```html - - - - - - - - - - + + + + + + + + + + ``` @@ -76,16 +76,16 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 - 现在 `template` 是一级节点，用于写tag组件， `script` 和 `style` 是并列的一级节点，也就是有3个一级节点。这个叫[vue单文件组件规范sfc](vue3-components.md)。 ```html - - - ``` @@ -95,7 +95,7 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 - 以前通过script src、link href引入外部的js和css； ```html - + ``` @@ -108,20 +108,20 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 ```html - ``` 而在这个 `util.js` 里，要把之前的 `function` 封装为模块（module）的方法并导出（exports）。只有被导出的方法和属性才能被外部调用，不导出的属于模块内部函数和变量。这是es6的模块规范。 ```js - function formatTime(time) { - return time;//这里没写逻辑 - } - module.exports = { - formatTime: formatTime + function formatTime(time) { + return time;//这里没写逻辑 + } + module.exports = { + formatTime: formatTime } ``` @@ -129,21 +129,21 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 当然还有一些高级的用法，比如在导出时可以重命名 ```js - // 直接使用js模块的属性。在hello uni-app有示例 - var dateUtils = require('../../../common/util.js').dateUtils; + // 直接使用js模块的属性。在hello uni-app有示例 + var dateUtils = require('../../../common/util.js').dateUtils; // 将js导入并重命名为echarts，然后使用echarts.来继续执行方法。在hello uni-app有示例 - import * as echarts from '/components/echarts/echarts.simple.min.js'; + import * as echarts from '/components/echarts/echarts.simple.min.js'; ``` **css外部文件导入**。全局样式，在根目录下的 `app.vue` 里写入，每个页面都会加载 `app.vue` 里的样式。 ```html - ``` @@ -166,12 +166,12 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 - 以前script里随便写js变量和function ```html - + ``` - 现在script里默认有export default，在里面写data、事件和method @@ -183,33 +183,33 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 * 模板里要调用的方法，都需要写在`methods`下面。每个方法也需要用逗号分隔。不需要再使用`function`声明，只要写在`methods`下的函数，都可以在template里调用。同样，HBuilderX里敲`vmethods`代码块，也可以生成相应结构。 ```html - ``` @@ -218,22 +218,22 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 - 以前的 DOM 操作，如果你想改变某个 DOM 元素的显示内容，比如一个view的显示文字：给view设id，然后js里通过选择器获取 DOM 元素，进一步通过js进行赋值操作，修改 DOM 元素的属性或值。 ```html - - - - - - 123 - - - + + + + + + 123 + + + ``` @@ -243,29 +243,29 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 ```html - - ``` @@ -280,7 +280,7 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 相比Web平台， Vue.js 在 `uni-app` 中使用差异主要集中在两个方面： - 新增：`uni-app` 除了支持 Vue 实例的组件生命周期，还拥有[应用生命周期](/collocation/App.md#applifecycle)及[页面的生命周期](/tutorial/page.md#lifecycle)。 -- 受限：相比 Web 平台，在小程序和 App 端部分功能支持不完善，具体见[兼容性列表](/vue3-api)。 +- 受限：相比 Web 平台，在小程序和 App 端部分功能支持不完善，具体见[兼容性列表](./vue3-api)。 [uni-app 项目支持 vue 3.0介绍，及升级指南](https://ask.dcloud.net.cn/article/37834) @@ -442,7 +442,7 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 > - `JSON` > - `Intl` > - `BigInt` -> +> > 你不应该在模板表达式中试图访问用户定义的全局变量。 @@ -465,7 +465,7 @@ vue 是单页面应用，使页面局部刷新，不用每次跳转页面都要 - + ``` @@ -480,7 +480,7 @@ v-on 指令，它用于监听 `DOM` 事件。v-on缩写为‘ @ ’，下文简 ```html - 点击 + 点击 点击 ``` @@ -1060,7 +1060,7 @@ v-for 指令可以实现基于一个数组来渲染一个列表。 - 有相同父元素的子元素必须有独特的 key。重复的 key 会造成渲染错误。 > 不要使用对象或数组之类的非基本类型值作为 v-for 的 key。请用字符串或数值类型的值。 -> +> > 如不提供 :key，会报一个 `warning`， 如果明确知道该列表是静态，或者不必关注其顺序，可以选择忽略。 示例： @@ -1522,7 +1522,7 @@ v-for 指令可以实现基于一个数组来渲染一个列表。 每一个计算属性都包含一个 `getter` 函数和一个 `setter`函数 ，默认是利用 `getter` 函数来读取。所有 `getter` 和 `setter` 函数的 `this` 上下文自动地绑定为 Vue 实例。 -#### 计算属性的 getter +#### 计算属性的 getter 模板内的表达式非常便利，但是设计它们的初衷是用于简单运算的。在模板中放入太多的逻辑会让模板过重且难以维护。例如，有一个嵌套数组对象： diff --git a/docs/unipush-v2.md b/docs/unipush-v2.md index 638c49ebf..b6b8d6bf0 100644 --- a/docs/unipush-v2.md +++ b/docs/unipush-v2.md @@ -199,7 +199,7 @@ uni-push产品有2个入口： 以上两种方案各有优劣，方案一更加灵活；比如：客服功能，客户端接收到聊天消息时，应用如果已经打开聊天对话页面，就直接将监听到的推送内容，渲染到页面。如果应用未打开聊天页，则调用api创建“通知栏消息”提醒用户；此时你还可以执行一些其他逻辑，比如将tabBar的消息中心加红点等。方案二比较简便，客户端无需额外编写代码，自动创建通知栏消息；但仅适用于不关心客户端行为就创建“通知栏消息”的场景，如广告营销内容的推送等。 -#### 客户端类型@getuiPhoneType +#### 客户端类型@getuiPhoneType 个推的客户端类型是仅根据使用的sdk类型来判断的，分为两类： 1. native sdk（在`manifest.json`->`APP 模块配置`->`uniPush 2.0`配置界面勾选离线推送时启用的 sdk），获取到的 cid 的 phoneType 为 APP 类型。 2. jssdk（`manifest.json`->`APP 模块配置`->`uniPush 2.0`配置界面，仅勾选在线推送，未勾选离线推送时启用的 sdk），获取到的 cid 的 phoneType 均为小程序，而不管实际上你的客户端是 APP、小程序还是 web。 @@ -349,10 +349,10 @@ exports.main = async (event, context) => { 如果项目使用[uni-id-pages](https://ext.dcloud.net.cn/plugin?id=8577)或 [uni-id-pages-x](https://ext.dcloud.net.cn/plugin?name=uni-id-pages-x)，即可直接指定基于uni-id的user_id、user_tag，并可筛选设备的平台、登录信息是否有效等，执行推送消息。 -uni-id-pages/uni-id-pages-x 已经内置了：在登录账号、退出账号、切换账号、token续期、注销账号5个时机，管理uni-id-device表、opendb-device表与user_id、push_clientid、platform、os_name等字段的映射关系。[详情参考](./uniCloud/uni-cloud-push/mate.md) +uni-id-pages/uni-id-pages-x 已经内置了：在登录账号、退出账号、切换账号、token续期、注销账号5个时机，管理uni-id-device表、opendb-device表与user_id、push_clientid、platform、os_name等字段的映射关系。[详情参考](https://doc.dcloud.net.cn/uniCloud/uni-cloud-push/mate.html) -::: warning 注意 - 以上内置逻辑，在uni-id-pages下，会自动判断是否启用push模块自动执行；但uni-id-pages-x下，需手动在:`/uni_modules/uni-id-pages-x/init.uts`导入 autoReportPushClientId 模块。 +::: warning 注意 + 以上内置逻辑，在uni-id-pages下，会自动判断是否启用push模块自动执行；但uni-id-pages-x下，需手动在:`/uni_modules/uni-id-pages-x/init.uts`导入 autoReportPushClientId 模块。 ::: 此外uni-push2.0 还提供了uni-admin中的web控制台[uni-push-admin](https://ext.dcloud.net.cn/plugin?name=uni-push-admin)。包含消息推送、推送统计等功能，而且是开源的，可自定义。如图： diff --git a/docs/worktile/_sidebar.md b/docs/worktile/_sidebar.md index a7de8b665..5541cd2b4 100644 --- a/docs/worktile/_sidebar.md +++ b/docs/worktile/_sidebar.md @@ -1,9 +1,9 @@ -* [Git/SVN](/worktile/git-svn.md) -* [cli 脚手架](/worktile/CLI.md) -* [编译运行环境](/worktile/running-env.md) -* [自动化测试](/worktile/auto/quick-start.md) - * [快速开始](/worktile/auto/quick-start.md) - * [API](/worktile/auto/api.md) - * [HBuilderX自动化测试插件](/worktile/auto/hbuilderx-extension/index.md) - * [CLI项目自动化测试](/worktile/auto/uniapp-cli-project.md) -* [持续集成](/worktile/CI.md) \ No newline at end of file +* [Git/SVN](git-svn.md) +* [cli 脚手架](CLI.md) +* [编译运行环境](running-env.md) +* [自动化测试](auto/quick-start.md) + * [快速开始](auto/quick-start.md) + * [API](auto/api.md) + * [HBuilderX自动化测试插件](auto/hbuilderx-extension/index.md) + * [CLI项目自动化测试](auto/uniapp-cli-project.md) +* [持续集成](CI.md) \ No newline at end of file diff --git a/docs/worktile/auto/hbuilderx-extension/index.md b/docs/worktile/auto/hbuilderx-extension/index.md index 4015ceccf..7bccc8c7e 100644 --- a/docs/worktile/auto/hbuilderx-extension/index.md +++ b/docs/worktile/auto/hbuilderx-extension/index.md @@ -16,7 +16,7 @@ 1. 本插件支持`uni-app普通项目`和`uniapp-cli项目`。uniapp-cli项目，运行自动化测试，需要在当前项目下安装自动化测试依赖。 2. Windows电脑不支持运行测试到`ios手机`。 3. MacOSX电脑，仅支持运行测试到`iOS模拟器`，不支持ios真机，测试iOS模拟器，需要电脑装安装XCode。 -4. 运行测试到H5，仅支持`chrome`浏览器，不支持其它浏览器。 +4. 运行测试到H5，仅支持`chrome`浏览器，不支持其它浏览器。 5. 运行测试到Android手机，如果HBuilderX仅检测到一个android设备，`直接`运行测试到当前已连接设备。`多个`设备时，会弹窗要求选择手机。 6. node: 当本机未安装node时，将使用HBuilderX`内置node`运行测试。反之，本机安装了node，则使用本机的node。 7. 运行测试到微信小程序，必须在manifest.json内，配置微信小程序 appid。如果微信开发者工具无法成功打开项目，首次请手动打开。 @@ -33,7 +33,7 @@ ## 测试环境安装@env -**插件依赖：** +**插件依赖：** - H5、微信、ios、android自动化测试依赖`puppeteer`、`adbkit`、`node-simctl`、`jest`、`playwright`，运行插件时，如果未安装此依赖，将会弹窗自动安装。 - `注意`：本插件0.0.3版本及以下，node: 当本机未安装node时，将使用HBuilderX内置的node运行测试。反之，本机安装了node，则使用本机的node。 @@ -50,7 +50,7 @@ uni-app普通项目，`初始化测试环境`或`运行测试`时，如果未安 如下图所示，项目管理器，选中项目，右键菜单【初始化测试环境】 -注意：安装环境依赖时，如果检测到项目下不存在测试配置文件[env.js](/docs/file/env)和[jest.config.js](../../auto/quick-start?id=jestconfigjs)，则会自动创建测试配置文件。 +注意：安装环境依赖时，如果检测到项目下不存在测试配置文件 `env.js` 和[jest.config.js](../../auto/quick-start?id=jestconfigjs)，则会自动创建测试配置文件。 @@ -92,7 +92,7 @@ uni-app项目，pages页面，右键菜单，创建测试用例 ### 选择设备@select-devices -> 如果无法获取到设备信息，请[参考](tutorial/run/run-app-faq.md) +> 如果无法获取到设备信息，请[参考](/tutorial/run/run-app-faq.md) diff --git a/docs/worktile/auto/quick-start.md b/docs/worktile/auto/quick-start.md index e40da7520..997d8a7ea 100644 --- a/docs/worktile/auto/quick-start.md +++ b/docs/worktile/auto/quick-start.md @@ -1,13 +1,13 @@ # uni-app自动化测试@about -uni-app提供了一批[API](/collocation/auto/api)，这些API可以操控uni-app应用，包括运行、跳转页面、触发点击等，并可以获取页面元素状态、进行截图，从而实现对uni-app项目进行自动化测试的目的。 +uni-app提供了一批[API](./api.md)，这些API可以操控uni-app应用，包括运行、跳转页面、触发点击等，并可以获取页面元素状态、进行截图，从而实现对uni-app项目进行自动化测试的目的。 本功能使用到了业内常见的测试库如jest（MIT协议）。 推荐使用方式：研发提交源码到版本库后，持续集成系统自动拉取源码，自动运行自动化测试。 ### 特性@features -开发者可以利用[API](/collocation/auto/api)做以下事情： +开发者可以利用[API](./api.md)做以下事情： * 控制跳转到指定页面 * 获取页面数据 @@ -23,7 +23,7 @@ uni-app提供了一批[API](/collocation/auto/api)，这些API可以操控uni-ap ### CLI -如果您想在`终端命令行`进行自动化测试、或使用持续集成进行测试，请使用uni-app [CLI](https://uniapp.dcloud.net.cn/quickstart?id=_2-通过vue-cli命令行) 工程，[CLI项目自动化测试教程](/collocation/auto/uniapp-cli-project) +如果您想在`终端命令行`进行自动化测试、或使用持续集成进行测试，请使用uni-app [CLI](https://uniapp.dcloud.net.cn/quickstart?id=_2-通过vue-cli命令行) 工程，[CLI项目自动化测试教程](uniapp-cli-project.md) ### 测试插件@descriptions diff --git a/docs/worktile/auto/uniapp-cli-project.md b/docs/worktile/auto/uniapp-cli-project.md index 305b12a6b..342cd1aad 100644 --- a/docs/worktile/auto/uniapp-cli-project.md +++ b/docs/worktile/auto/uniapp-cli-project.md @@ -55,14 +55,14 @@ npm install puppeteer@14.0.0 --save-dev 2. 根据API编写测试的js代码，参考测试用例 API文档见：[https://uniapp.dcloud.io/collocation/auto/api](https://uniapp.dcloud.io/collocation/auto/api) -测试文件目录配置见 [jest.config.js](collocation/auto/quick-start?id=jestconfigjs) +测试文件目录配置见 [jest.config.js](./quick-start.md#jestconfigjs) -3. 运行测试 +1. 运行测试 ```shell npm run test:h5 ``` -4. 测试结果 +1. 测试结果 ```js >> cross-env UNI_PLATFORM=h5 jest -i ... @@ -72,14 +72,14 @@ Snapshots: 0 total Time: 14.995s, estimated 16s ``` -更多配置参考 [jest.config.js](collocation/auto/quick-start?id=jestconfigjs) +更多配置参考 [jest.config.js](./quick-start.md#jestconfigjs) ### App-Android测试流程 1. 配置全局 `adb` 环境变量 -2. 配置 `Hbuilder` 调试基座/自定义基座 `android_base.apk` 目录，参考 [jest.config.js](collocation/auto/quick-start?id=jestconfigjs) +2. 配置 `Hbuilder` 调试基座/自定义基座 `android_base.apk` 目录，参考 [jest.config.js](./quick-start.md#jestconfigjs) 3. 创建 `cli` 工程/现有 `cli` 工程 切换到工程目录，安装依赖包 `adbkit` @@ -104,9 +104,9 @@ npm run test:android npm install node-simctl --save-dev ``` -2. 配置模拟器id，参考 [jest.config.js](collocation/auto/quick-start?id=jestconfigjs) +2. 配置模拟器id，参考 [jest.config.js](./quick-start.md#jestconfigjs) -3. 配置 `Hbuilder` 调试基座/自定义基座 `Pandora_simulator.app` 目录，参考 [jest.config.js](collocation/auto/quick-start?id=jestconfigjs) +3. 配置 `Hbuilder` 调试基座/自定义基座 `Pandora_simulator.app` 目录，参考 [jest.config.js](./quick-start.md#jestconfigjs) 4. 编写测试代码，参考测试用例 diff --git a/docs/worktile/running-env.md b/docs/worktile/running-env.md index 5440be950..529318669 100644 --- a/docs/worktile/running-env.md +++ b/docs/worktile/running-env.md @@ -41,7 +41,7 @@ if (process.env.NODE_ENV === 'production') { 平台判断有 2 种场景，一种是在编译期判断，一种是在运行期判断。 - 编译期判断 - 编译期判断，即条件编译，不同平台在编译出包后已经是不同的代码。详见：[条件编译](/platform) + 编译期判断，即条件编译，不同平台在编译出包后已经是不同的代码。详见：[条件编译](/tutorial/platform.md) ```javascript // #ifdef H5 -- GitLab