From 2d4d3f9370807c1e4a8f964af2384be99e694fa3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=8E=8B=E4=BA=9A=E7=90=AA?= Date: Fri, 1 Jul 2022 15:12:57 +0800 Subject: [PATCH] docs: revert docs modification --- .gitignore | 3 +- docs/api/README.md | 8 +- docs/api/plugins/getEnterOptionsSync.md | 31 +- docs/api/plugins/getLaunchOptionsSync.md | 31 +- docs/collocation/App.md | 4 +- docs/collocation/manifest.md | 639 ----------------------- docs/component/image.md | 2 +- docs/tutorial/app-push-unipush.md | 94 ++++ docs/unipush-custom-icon.md | 58 +- docs/unipush.md | 2 +- docs/worktile/auto/quick-start.md | 101 ++-- docs/worktile/auto/uniapp-cli-project.md | 17 +- 12 files changed, 277 insertions(+), 713 deletions(-) diff --git a/.gitignore b/.gitignore index 0e997e4c5..c5f6e0af6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ node_modules docs/.vuepress/dist .DS_Store -root/sitemap.xml \ No newline at end of file +root/sitemap.xml +dist \ No newline at end of file diff --git a/docs/api/README.md b/docs/api/README.md index d678fcfc4..fa3273a10 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -6,13 +6,13 @@ uni-app 基于 ECMAScript 扩展了 uni 对象，并且 API 命名与小程序 ## 标准 js 和浏览器 js 的区别 -`uni-app`的 js 代码，h5 端运行于浏览器中。非 h5 端（包含小程序和 App），Android 平台运行在 v8 引擎中，iOS 平台运行在 iOS 自带的 jscore 引擎中，都没有运行在浏览器或 webview 里。 +`uni-app`的 js 代码，web端运行于浏览器中。非web端（包含小程序和 App），Android 平台运行在 v8 引擎中，iOS 平台运行在 iOS 自带的 jscore 引擎中，都没有运行在浏览器或 webview 里。 -非 H5 端，虽然不支持 window、document、navigator 等浏览器的 js API，但也支持标准 ECMAScript。 +非web端，虽然不支持 window、document、navigator 等浏览器的 js API，但也支持标准 ECMAScript。 -请注意不要把浏览器里的 js 扩展对象等价于标准 js。 +请注意不要把浏览器里的 js 等价于标准 js。 -所以 uni-app 的非 H5 端，一样支持标准 js，支持 if、for 等语法，支持字符串、数字、时间、布尔值、数组、自定义对象等变量类型及各种处理方法。仅仅是不支持 window、document、navigator 等浏览器专用对象。 +所以 uni-app 的web端，一样支持标准 js，支持 if、for 等语法，支持字符串、数字、时间、布尔值、数组、自定义对象等变量类型及各种处理方法。仅仅是不支持 window、document、navigator 等浏览器专用对象。 ## 各端特色 API 调用 diff --git a/docs/api/plugins/getEnterOptionsSync.md b/docs/api/plugins/getEnterOptionsSync.md index 0b605b529..d2304e2f4 100644 --- a/docs/api/plugins/getEnterOptionsSync.md +++ b/docs/api/plugins/getEnterOptionsSync.md @@ -14,15 +14,42 @@ |scene|Number|启动时的场景值，具体值含义请查看各平台文档说明|其他平台均支持，`字节小程序(1.12.0)`| |query|Object|启动时的 query 参数|其他平台均支持，`字节小程序(1.12.0)`| |referrerInfo|Object|来源信息。如果没有则返回 `{}`|其他平台均支持，`字节小程序(1.15.0)`| +|channel|String|如果应用没有设置渠道标识，则返回空字符串。取值如下|`仅 App 支持`| +|launcher|String|应用启动来源。取值如下|`仅 App 支持`| |forwardMaterials|Array.\|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`微信小程序`| |chatType|number|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`仅微信小程序`| |apiCategory|string|API 类别|`仅微信小程序(2.20.0)`| |showFrom|number|唤起小程序的方式，目前取值固定为 10，表示通过 schema 唤起|`仅字节小程序(1.90.0)`| -|mode|'default' | 'halfPage'|启动小程序的模式|`仅快手小程序`| +|mode|'default' \| 'halfPage'|启动小程序的模式|`仅快手小程序`| **Object referrerInfo** |属性|类型|说明|平台差异说明| |:-|:-|:-|:-| |appId|String|来源小程序 appId |其他平台均支持，`字节小程序(1.15.0)`| -|extraData|Object|来源小程序传过来的数据。|其他平台均支持，`字节小程序(1.15.0)`| \ No newline at end of file +|extraData|Object|来源小程序传过来的数据。|其他平台均支持，`字节小程序(1.15.0)`| + +**channel 取值** +> 默认提供 `7` 个渠道（`Google`、`360`、`小米`、`华为`、`应用宝`、`vivo`、`oppo`），更多可以在`manifest.json`文件中【源码视图】进行配置，[详情](https://ask.dcloud.net.cn/article/35974) + +| 默认渠道 | 渠道标识ID | +| ------------ | -------- | +| GooglePlay | google | +| 应用宝 | yyb | +| 360应用市场 | 360 | +| 华为应用商店 | huawei | +| 小米应用商店 | xiaomi | +| vivo应用商店 | vivo| +| oppo应用商店 | oppo | + +**launcher 取值** + +| 值 | 说明 | +| ------------ | -------- | +| default | 默认启动方式，通常表示应用列表启动（360手助中搜索启动） | +| scheme | 通过urlscheme方式触发启动 | +| push | 通过点击系统通知方式触发启动 | +| uniLink | 通过通用链接（universal link）启动应用 | +| miniProgram | 通过微信小程序启动应用 | +| shortcut | 通过快捷方式启动，iOS平台表示通过3D Touch快捷方式，Android平台表示通过桌面快捷方式启动 | +| barcode | 通过二维码扫描启动| \ No newline at end of file diff --git a/docs/api/plugins/getLaunchOptionsSync.md b/docs/api/plugins/getLaunchOptionsSync.md index 104aa63f2..3c9b6623b 100644 --- a/docs/api/plugins/getLaunchOptionsSync.md +++ b/docs/api/plugins/getLaunchOptionsSync.md @@ -14,12 +14,14 @@ |scene|Number|启动时的场景值，具体值含义请查看各平台文档说明。钉钉小程序在 IDE 恒为0000，真机不支持。|其他平台均支持，`字节小程序(1.12.0)`| |query|Object|启动时的 query 参数|其他平台均支持，`字节小程序(1.12.0)`| |referrerInfo|Object|来源信息。如果没有则返回 `{}`|其他平台均支持，`字节小程序(1.15.0)`，`飞书小程序不支持`，`钉钉小程序不支持`| +|channel|String|如果应用没有设置渠道标识，则返回空字符串。取值如下|`仅 App 支持`| +|launcher|String|应用启动来源。取值如下|`仅 App 支持`| |forwardMaterials|Array.\|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`微信小程序`、`QQ小程序`| |entryDataHash|string|群入口信息，通过群应用商店打开、群分享卡片打开的小程序可获得|`仅QQ小程序`| |chatType|number|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`仅微信小程序`| |apiCategory|string|API 类别|`仅微信小程序(2.20.0)`| |showFrom|number|唤起小程序的方式，目前取值固定为 10，表示通过 schema 唤起|`仅字节小程序(1.90.0)`| -|mode|'default' | 'halfPage'|启动小程序的模式|`仅快手小程序`| +|mode|'default' \| 'halfPage'|启动小程序的模式|`仅快手小程序`| |subScene|string|子场景值(定义待补充)|`仅飞书小程序`| **Object referrerInfo** @@ -27,4 +29,29 @@ |属性|类型|说明|平台差异说明| |:-|:-|:-|:-| |appId|String|来源小程序 appId |其他平台均支持，`字节小程序(1.15.0)`| -|extraData|Object|来源小程序传过来的数据|其他平台均支持，`字节小程序(1.15.0)`| \ No newline at end of file +|extraData|Object|来源小程序传过来的数据|其他平台均支持，`字节小程序(1.15.0)`| + +**channel 取值** +> 默认提供 `7` 个渠道（`Google`、`360`、`小米`、`华为`、`应用宝`、`vivo`、`oppo`），更多可以在`manifest.json`文件中【源码视图】进行配置，[详情](https://ask.dcloud.net.cn/article/35974) + +| 默认渠道 | 渠道标识ID | +| ------------ | -------- | +| GooglePlay | google | +| 应用宝 | yyb | +| 360应用市场 | 360 | +| 华为应用商店 | huawei | +| 小米应用商店 | xiaomi | +| vivo应用商店 | vivo| +| oppo应用商店 | oppo | + +**launcher 取值** + +| 值 | 说明 | +| ------------ | -------- | +| default | 默认启动方式，通常表示应用列表启动（360手助中搜索启动） | +| scheme | 通过urlscheme方式触发启动 | +| push | 通过点击系统通知方式触发启动 | +| uniLink | 通过通用链接（universal link）启动应用 | +| miniProgram | 通过微信小程序启动应用 | +| shortcut | 通过快捷方式启动，iOS平台表示通过3D Touch快捷方式，Android平台表示通过桌面快捷方式启动 | +| barcode | 通过二维码扫描启动| \ No newline at end of file diff --git a/docs/collocation/App.md b/docs/collocation/App.md index 4861d190a..b31d1d3aa 100644 --- a/docs/collocation/App.md +++ b/docs/collocation/App.md @@ -1,8 +1,9 @@ -`App.vue`是uni-app的主组件，所有页面都是在`App.vue`下进行切换的，是页面入口文件。但`App.vue`本身不是页面，这里不能编写视图元素。 +`App.vue`是uni-app的主组件，所有页面都是在`App.vue`下进行切换的，是页面入口文件。但`App.vue`本身不是页面，这里不能编写视图元素，也就是没有`