From 13f5536c90835a87a4152624411fb9f9c84055a9 Mon Sep 17 00:00:00 2001 From: wanganxp Date: Wed, 13 Dec 2023 07:08:16 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E5=A4=8D=E9=94=99=E8=AF=AF=E8=B7=AF?= =?UTF-8?q?=E5=BE=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/facial-recognition-verify.md | 2 +- docs/api/get-univerify-manager.md | 2 +- docs/api/push.md | 4 ++-- docs/api/uni-verify.md | 2 +- docs/api/unicloud/database.md | 2 +- docs/collocation/app.md | 14 +++++++------- docs/collocation/manifest-modules.md | 16 +++++++++------- docs/collocation/manifest-splashscreen.md | 11 +++++++---- docs/collocation/manifest.md | 4 ++-- docs/collocation/pagesjson.md | 6 +++--- docs/readme.md | 8 ++++---- 11 files changed, 38 insertions(+), 33 deletions(-) diff --git a/docs/api/facial-recognition-verify.md b/docs/api/facial-recognition-verify.md index 637f50f4..eb475aa9 100644 --- a/docs/api/facial-recognition-verify.md +++ b/docs/api/facial-recognition-verify.md @@ -2,7 +2,7 @@ uni实人认证是DCloud与合作伙伴共同推出的金融级实人认证服务，通过对比人脸、活体检测、姓名和身份证号码，来确认用户身份的有效性。 -该业务的完整业务介绍另见：[实人认证](https://uniapp.dcloud.net.cn/uniCloud/frv/intro.html) +该业务的完整业务介绍另见：[实人认证](https://doc.dcloud.net.cn/uniCloud/frv/intro.html) 本文是 uni-app x 中涉及该业务的API的介绍。 diff --git a/docs/api/get-univerify-manager.md b/docs/api/get-univerify-manager.md index 288a312c..2105b514 100644 --- a/docs/api/get-univerify-manager.md +++ b/docs/api/get-univerify-manager.md @@ -9,7 +9,7 @@ App一键登陆是替代短信验证码登录的更优选择：对开发者而 一键登陆涉及业务开通和付费，涉及客户端和服务器交互，有较多文档： 1. 业务介绍：介绍业务流程、开通和付费。[详见](https://uniapp.dcloud.net.cn/univerify.html) 2. 客户端API，即本文 -3. 服务器API，[详见](https://uniapp.dcloud.net.cn/uniCloud/uni-login/dev.html) +3. 服务器API，[详见](https://doc.dcloud.net.cn/uniCloud/uni-login/dev.html) diff --git a/docs/api/push.md b/docs/api/push.md index fe1e3f25..e655122b 100644 --- a/docs/api/push.md +++ b/docs/api/push.md @@ -9,7 +9,7 @@ uni-push是DCloud与合作伙伴个推共同推出的统一推送服务。用于 它是一个云端一体的业务，涉及多份文档： 1. 业务介绍：对于未使用过uni-push的新用户，本文必读：[uni-push业务介绍](https://uniapp.dcloud.net.cn/unipush-v2.html) 2. 客户端API，即本文 -3. 服务器API，[另见](https://uniapp.dcloud.net.cn/uniCloud/uni-cloud-push/api) +3. 服务器API，[另见](https://doc.dcloud.net.cn/uniCloud/uni-cloud-push/api) ## uni.getPushClientId(options) @getpushclientid @@ -73,7 +73,7 @@ uni-push是DCloud与合作伙伴个推共同推出的统一推送服务。用于 - [vivo](https://dev.vivo.com.cn/documentCenter/doc/359) 开通自分类权益后，需要客户端创建channel，因此客户端提供了`setPushChannel`来进行channel的创建，通过此Api来创建渠道进行推送。 - 客户端创建渠道成功后，即可通过云函数进行推送，[uni-push2服务端文档](https://uniapp.dcloud.net.cn/uniCloud/uni-cloud-push/api.html)。 + 客户端创建渠道成功后，即可通过云函数进行推送，[uni-push2服务端文档](https://doc.dcloud.net.cn/uniCloud/uni-cloud-push/api.html)。 * 由于Android通知渠道的机制问题，一旦通知渠道建立，便不能修改此渠道的配置，即使删除渠道后再次创建同channelId名称的渠道，也不会改变原先渠道的配置（除非删除应用），最明显的现象就是铃声动态修改失败，比如调用`setPushChannel`时，第一次的设置参数是`{"channelId":"test","soundName":"pushsound"}` , 这时你想切换铃音，你的channelId就不能再叫test了，而应该为`{"channelId":"test2","soundName":"ring"}` ，此时会新建一个渠道。 diff --git a/docs/api/uni-verify.md b/docs/api/uni-verify.md index 9fd005ab..0694e1a5 100644 --- a/docs/api/uni-verify.md +++ b/docs/api/uni-verify.md @@ -9,7 +9,7 @@ App一键登陆是替代短信验证码登录的更优选择：对开发者而 一键登陆涉及业务开通和付费，涉及客户端和服务器交互，有较多文档： 1. 业务介绍：介绍业务流程、开通和付费。[详见](https://uniapp.dcloud.net.cn/univerify.html) 2. 客户端API，即本文 -3. 服务器API，[详见](https://uniapp.dcloud.net.cn/uniCloud/uni-login/dev.html) +3. 服务器API，[详见](https://doc.dcloud.net.cn/uniCloud/uni-login/dev.html) diff --git a/docs/api/unicloud/database.md b/docs/api/unicloud/database.md index 17c6057b..9961bddd 100644 --- a/docs/api/unicloud/database.md +++ b/docs/api/unicloud/database.md @@ -3,7 +3,7 @@ **和uni-app项目接口差异** - uni-app x项目内数据库的客户端接口仅支持databaseForJQL不再支持database方法。 -- action云函数因为安全问题已经不再推荐使用。开发者应使用[数据库触发器](https://uniapp.dcloud.net.cn/uniCloud/jql-schema-ext.html)来实现相关功能。 +- action云函数因为安全问题已经不再推荐使用。开发者应使用[数据库触发器](https://doc.dcloud.net.cn/uniCloud/jql-schema-ext.html)来实现相关功能。 - 暂不支持multiSend diff --git a/docs/collocation/app.md b/docs/collocation/app.md index 020ab2c0..9ee4825a 100644 --- a/docs/collocation/app.md +++ b/docs/collocation/app.md @@ -14,8 +14,8 @@ |函数名|说明|平台兼容| |:-|:-|:-| -|onLaunch|当`uni-app-x` 初始化完成时触发（全局只触发一次），参数为应用启动参数，同 [uni.getLaunchOptionsSync](https://uniapp.dcloud.net.cn/api/getLaunchOptionsSync.html#getlaunchoptionssync) 的返回值|| -|onShow|当 `uni-app-x` 启动，或从后台进入前台显示，参数为应用启动参数，同 [uni.getLaunchOptionsSync](https://uniapp.dcloud.net.cn/api/getLaunchOptionsSync.html#getlaunchoptionssync) 的返回值|| +|onLaunch|当`uni-app-x` 初始化完成时触发（全局只触发一次），参数为应用启动参数，同 [uni.getLaunchOptionsSync](../api/get-launch-options-sync.md#getlaunchoptionssync) 的返回值|| +|onShow|当 `uni-app-x` 启动，或从后台进入前台显示，参数为应用启动参数，同 [uni.getLaunchOptionsSync](../api/get-launch-options-sync.md#getlaunchoptionssync) 的返回值|| |onHide|当 `uni-app-x` 从前台进入后台|| |onLastPageBackPress|最后一个页面按下Android back键，常用于自定义退出|app-uvue-android 3.9+| |onExit|监听应用退出|app-uvue-android 3.9+| @@ -45,14 +45,14 @@ **注意** - **应用生命周期仅可在`App.uvue`中监听，在其它页面监听无效**。 -- 应用启动参数，可以在API `uni.getLaunchOptionsSync`获取，[详见](https://uniapp.dcloud.net.cn/api/getLaunchOptionsSync.html#getlaunchoptionssync) +- 应用启动参数，可以在API `uni.getLaunchOptionsSync`获取，[详见](../api/get-launch-options-sync.md#getlaunchoptionssync) ## globalData -小程序有 globalData，这是一种简单的全局变量机制。这套机制在 uni-app-x 里也可以使用，并且全端通用。 +> HBuilderX 3.99+ -当然 vue 框架的全局变量，另有其他方式定义。 +小程序有 globalData，这是一种简单的全局变量机制。这套机制在 uni-app-x 里也可以使用，并且全端通用。 **以下是 App.uvue 中定义globalData的相关配置：** @@ -88,9 +88,9 @@ **注意：** `uni-app x` 中 `globalData` 的数据结构与类型通过 `App.uvue` 中的 `globalData` 初始值定义，后续只能读取或修改，不能新增或删除。 -globalData是简单的全局变量，其他状态管理方式，可参考文档[全局变量和状态管理](/uni-app-x/tutorial/store.md)。 +globalData是简单的全局变量，其他状态管理方式，可参考文档[全局变量和状态管理](../tutorial/store.md)。 ## 全局样式 -在`App.uvue`中，可以定义一些全局通用样式，例如需要加一个通用的背景色，首屏页面渲染的动画等都可以写在App.uvue中。 +在`App.uvue`中，可以定义一些全局通用样式，这里定义的class，每个页面都可以直接使用。 diff --git a/docs/collocation/manifest-modules.md b/docs/collocation/manifest-modules.md index 547fa728..98ead28f 100644 --- a/docs/collocation/manifest-modules.md +++ b/docs/collocation/manifest-modules.md @@ -21,30 +21,30 @@ HBuilderX3.93版本起，编译器支持扫描代码，摇树treeShaking，自 ### App端支持摇树的内置模块列表@utsmodules - uni-network - 网络请求（文件上传/下载）模块，包括API：[uni.downloadFile](./api/download-file.md)、[uni.request](./api/request.md)、[uni.uploadFile](./api/upload-file.md) + 网络请求（文件上传/下载）模块，包括API：[uni.downloadFile](../api/download-file.md)、[uni.request](../api/request.md)、[uni.uploadFile](../api/upload-file.md) 依赖的模块：无 - uni-getLocation-system - 系统定位模块，包括API：[uni.getLocation](./api/get-location.md) + 系统定位模块，包括API：[uni.getLocation](../api/get-location.md) 依赖的模块：无 - uni-video - [video视频组件](./component/video.md)模块，包括内置组件：[video](./component/video.md)；包括API：[uni.createVideoContext](./api/create-video-context.md) + [video视频组件](../component/video.md)模块，包括内置组件：[video](../component/video.md)；包括API：[uni.createVideoContext](../api/create-video-context.md) - uni-media - 多媒体相关API模块，包括API：[uni.chooseImage](./api/choose-image.md)、[uni.previewImage](./api/preview-image.md)、[uni.saveImageToPhotosAlbum](./api/save-image-to-photos-album.md) + 多媒体相关API模块，包括API：[uni.chooseImage](../api/choose-image.md)、[uni.previewImage](../api/preview-image.md)、[uni.saveImageToPhotosAlbum](../api/save-image-to-photos-album.md) 依赖的模块：无 - uni-cloud-client - 调用uniCloud[云函数/云对象](../uniCloud/cf-functions.md)模块，包括API：[uniCloud.importObject](../uniCloud/cloud-obj.md#%E5%AE%A2%E6%88%B7%E7%AB%AF%E8%B0%83%E7%94%A8)、[uniCloud.callFunction](../uniCloud/cf-callfunction.md#callfunction%E6%96%B9%E6%B3%95) + 调用uniCloud[云函数/云对象](https://doc.dcloud.net.cn/uniCloud/cf-functions.html)模块，包括API：[uniCloud.importObject](https://doc.dcloud.net.cn/uniCloud/cloud-obj.html#%E5%AE%A2%E6%88%B7%E7%AB%AF%E8%B0%83%E7%94%A8)、[uniCloud.callFunction](https://doc.dcloud.net.cn/uniCloud/cf-callfunction.html#callfunction%E6%96%B9%E6%B3%95) 依赖的模块：uni-media、uni-network - uni-push - [uni-push统一推送](../unipush-v2.md)模块（`HBuilderX3.97+`），包括API：[uni.createPushMessage](../api/plugins/push.md#createpushmessage)、[uni.getPushClientId](../api/plugins/push.md#getpushclientid)、[uni.offPushMessage](../api/plugins/push.md#offpushmessage)、[uni.onPushMessage](../api/plugins/push.md#onpushmessage) + [uni-push统一推送](https://uniapp.dcloud.net.cn/unipush-v2.html)模块（`HBuilderX3.97+`），包括API：[uni.createPushMessage](../api/push.md#createpushmessage)、[uni.getPushClientId](../api/push.md#getpushclientid)、[uni.offPushMessage](../api/push.md#offpushmessage)、[uni.onPushMessage](../api/push.md#onpushmessage) 依赖的模块：无 - uni-facialRecognitionVerify - [uni实人认证](../uniCloud/frv/intro.md)模块，包括API：[uni.getFacialRecognitionMetaInfo](../api/plugins/facialRecognitionVerify.md#getfacialrecognitionmetainfo)、[uni.startFacialRecognitionVerify](../api/plugins/facialRecognitionVerify.md#startfacialrecognitionverify) + [uni实人认证](https://doc.dcloud.net.cn/uniCloud/frv/intro.html)模块，包括API：[uni.getFacialRecognitionMetaInfo](../api/facial-recognition-verify.md#getfacialrecognitionmetainfo)、[uni.startFacialRecognitionVerify](../api/facial-recognition-verify.md#startfacialrecognitionverify) 依赖的模块：无 再次强调，以上模块不属于ext组件或api，是内置模块。但如果你的代码中没有使用这些组件和api，打正式包或自定义基座时会被摇掉。 @@ -67,3 +67,5 @@ modules:{ } } ``` + +如果没有相应的节点，则该sdk不会被打包到最终应用中。 \ No newline at end of file diff --git a/docs/collocation/manifest-splashscreen.md b/docs/collocation/manifest-splashscreen.md index ba233435..cf71f9ed 100644 --- a/docs/collocation/manifest-splashscreen.md +++ b/docs/collocation/manifest-splashscreen.md @@ -1,9 +1,11 @@ +## splash + +> HBuilderX 3.99+ + App启动时，系统加载应用渲染首页需要一定的时间，为了避免用户等待，手机操作系统提供了特殊的启动界面设计，让用户先看到一个简单的界面，等应用加载完成后正式进入应用首页。 这个界面，即被称为启动界面，也成称为 splash 或 lauch screen。 ->HBuilderX3.99+版本支持App启动界面配置 - ### Android平台启动界面配置 打开项目的manifest.json文件，在“App启动界面配置”中的“Android启动界面设置”项下配置各设备分辨率启动图： @@ -25,7 +27,7 @@ splash关闭时机可控制，打开项目的manifest.json文件，选择源码 配置示例： -``` +```json "app" : { "splashScreen" : { "autoClose" : "onReady" @@ -42,6 +44,7 @@ splash关闭时机可控制，打开项目的manifest.json文件，选择源码 #### Android平台使用.9.png启动图@9png 目前HBuilderX中仅定义几种标准分辨率的启动图配置，而实际上存在很多不同分辨率的手机，导致启动图在一些不常见的设备会进行拉伸或压缩引起变形，Android平台为了解决此问题就出现了可以适配各种尺寸的一种图片格式“.9.png”。这是一种特殊的图片格式，它可以指定特定的区域进行拉伸而不失真。 + **使用.9.png的优点** 1. 避免在非标准分辨率手机上缩放变形 2. 可以只配置1张或多张图片适配更多分辨率，减少apk的体积（推荐至少配置1080P高分屏启动图片） @@ -51,7 +54,7 @@ splash关闭时机可控制，打开项目的manifest.json文件，选择源码 2. 使用.9.png图片后，整个图片应该是包裹着你想要显示的内容的，而没有使用的话整个图片将会被拉伸 **制作.9.png图片** -1. 在Android sdk目录下的tools目录下，有一个叫做draw9patch.bat的文件，双击打开就可以使用（最新android SDK该文件已经不存在，若电脑不没有安装android studio，可下载附件工具编辑.9.png图片） +1. 在Android sdk目录下的tools目录下，有一个叫做draw9patch.bat的文件，双击打开就可以使用（最新android SDK该文件已经不存在，若电脑没有安装android studio，可下载附件工具编辑.9.png图片） 2. 使用android studio，因为android studio已经集成.9.png制作工具，只需选中需要生成的png文件，然后右键，点击create 9-patch file 选项 详细制作步骤可参考链接：[Android中.9图片的含义及制作教程](https://www.jianshu.com/p/3fd048644e3f?tdsourcetag=s_pctim_aiomsg) diff --git a/docs/collocation/manifest.md b/docs/collocation/manifest.md index 5c67af4e..f1aebe28 100644 --- a/docs/collocation/manifest.md +++ b/docs/collocation/manifest.md @@ -33,9 +33,9 @@ uni-app x 不再提供内置模块选择，而是提供了摇树机制自动选 #### Android权限配置@permissions -uni-app x 的权限配置，移入了[AndroidManifest.xml](../tutorial/app-nativeresource-android.md#permissions)中。 +uni-app x 的权限配置，移入了[AndroidManifest.xml](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions)中。 -使用[uni内置模块](#utsmodules)时，云端打包会自动添加模块需要的Android权限，不需要在[AndroidManifest.xml](../tutorial/app-nativeresource-android.md#permissions)中配置。 +使用[uni内置模块](#utsmodules)时，云端打包会自动添加模块需要的Android权限，不需要在[AndroidManifest.xml](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.md#permissions)中配置。 HBuilderX3.97+版本标准基座已经包含了所有Android权限，在 uvue 页面中直接通过 uts 调用需要权限的 Android 系统 API 时，使用标准基座真机运行可直接通过[UTSAndroid.requestSystemPermission](../uts/utsandroid.md#requestSystemPermission)申请；使用自定义基座则需要在项目的[AndroidManifest.xml](../tutorial/app-nativeresource-android.md#permissions)中配置要使用的权限，重新提交云端打包。 diff --git a/docs/collocation/pagesjson.md b/docs/collocation/pagesjson.md index 08b6eb3e..469231ee 100644 --- a/docs/collocation/pagesjson.md +++ b/docs/collocation/pagesjson.md @@ -108,11 +108,11 @@ pages节点里注册页面，数据格式是数组，数组每个项都是一个 - 状态栏 * 手机顶部状态栏的背景色、前景色(white/black)与navigationBarBackgroundColor和navigationBarTextStyle相同 * 当navigationStyle设为custom时，原生导航栏不显示。此时尤其需注意顶部状态栏的问题。 - * 如需动态设置状态栏颜色，使用api [uni.setNavigationBarColor](./api/set-navigation-bar-color.md) - * 注意不同手机的状态栏高度并不相同，如需获取本机的状态栏高度，使用api [uni.getWindowInfo](./api/get-window-info.md) + * 如需动态设置状态栏颜色，使用api [uni.setNavigationBarColor](../api/set-navigation-bar-color.md) + * 注意不同手机的状态栏高度并不相同，如需获取本机的状态栏高度，使用api [uni.getWindowInfo](../api/get-window-info.md) - 下拉刷新 * pages.json中下拉刷新是页面级配置，方便使用但灵活度有限。 - * 如需自定义下拉刷新，请使用[scroll-view](./component/scroll-view.md)或[list-view](./component/list-view.md)的下拉刷新。 + * 如需自定义下拉刷新，请使用[scroll-view](../component/scroll-view.md)或[list-view](../component/list-view.md)的下拉刷新。 **style示例** ```javascript diff --git a/docs/readme.md b/docs/readme.md index dc8b4e22..fe6df7e8 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -42,7 +42,7 @@ uts 全称 uni type script，是一门跨平台的、高性能的、强类型的 > * Android平台，编译为Kotlin > * iOS平台，编译Swift -uts和ts很相似，但为了跨端，uts进行了一些约束和特定平台的增补。详见 [uts语言介绍](../uts/README.md) +uts和ts很相似，但为了跨端，uts进行了一些约束和特定平台的增补。详见 [uts语言介绍](./uts/README.md) 该语言在2022年9月推出，起初用于原生插件扩展开发。 @@ -136,7 +136,7 @@ uni-app js引擎版，支持 plus API 和 weex API。但 uni-app x 中，不再 uni-app x支持的API包括： -1. uts的api [详见](/uts/buildin-object-api/global.md) +1. uts的api [详见](./uts/buildin-object-api/global.md) 2. 全局api，前面不需要加`uni.`。如[getApp](./api/get-app.md)、[getCurrentPages](./api/get-current-pages.md) 3. uni.xxx的内置api。数量较多，[详见](./api/README.md) 4. uniCloud.xxx的内置api。[详见](./api/unicloud/README.md) @@ -177,7 +177,7 @@ uni.的api，大多是uts开发的，它们会陆续开源在[uni-api](https://g - AndroidManifest.xml 与原生开发相同。注意Android权限配置在这里配置，而不是在manifest.json中 [详见](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html) - app.uvue [详见](https://uniapp.dcloud.net.cn/collocation/App.html) - pages.json 不支持app-plus的内容。[详见](./collocation/pagesjson.md) -- uni.scss 正常支持。但注意uvue仅能使用[css子集](css/README.md) +- uni.scss 正常支持。但注意uvue仅能使用[css子集](./css/README.md) ## 6. 插件生态 @@ -297,7 +297,7 @@ uni-app x 毕竟是原生应用，内嵌flutter、rn这些没有任何问题， - uni-app x开源吗？ uni-app x的组件和API实现都会开源，会陆续发布在项目[uni-component](https://gitcode.net/dcloud/uni-component)和[uni-api](https://gitcode.net/dcloud/uni-api)下。\ - 开发者可以了解组件和API的实现，直接修改或优化源码，修改后的代码以[ext api](../api/extapi.md)或组件的方式下载到项目中，即可实现在本项目中替换掉官方组件和API。 + 开发者可以了解组件和API的实现，直接修改或优化源码，修改后的代码以[ext api](https://uniapp.dcloud.net.cn/api/extapi.html)或组件的方式下载到项目中，即可实现在本项目中替换掉官方组件和API。 - 未来 uni-app js引擎版还维护吗？ 维护。服务js开发者仍然是DCloud的重点。但nvue和5+将不再维护。不再维护不是下线，而是没有重大问题的话（如新手机不兼容）不会再更新了。 -- GitLab