tmui-cli 2.0.3 → 2.0.5

package/data/uni-app-x-docs/api/contact.md

@@ -0,0 +1,37 @@
+<!-- UTSAPIJSON.addPhoneContact.name -->
+
+<!-- UTSAPIJSON.addPhoneContact.description -->
+
+<!-- UTSAPIJSON.addPhoneContact.compatibility -->
+
+<!-- UTSAPIJSON.addPhoneContact.param -->
+
+<!-- UTSAPIJSON.addPhoneContact.fileFormats -->
+
+<!-- UTSAPIJSON.addPhoneContact.returnValue -->
+
+<!-- UTSAPIJSON.addPhoneContact.example -->
+
+<!-- UTSAPIJSON.addPhoneContact.tutorial -->
+
+<!-- UTSAPIJSON.chooseContact.name -->
+
+<!-- UTSAPIJSON.chooseContact.description -->
+
+<!-- UTSAPIJSON.chooseContact.compatibility -->
+
+<!-- UTSAPIJSON.chooseContact.param -->
+
+<!-- UTSAPIJSON.chooseContact.fileFormats -->
+
+<!-- UTSAPIJSON.chooseContact.returnValue -->
+
+<!-- UTSAPIJSON.chooseContact.example -->
+
+<!-- UTSAPIJSON.chooseContact.tutorial -->
+
+<!-- UTSAPIJSON.contact.example -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-camera-context.md

@@ -0,0 +1,27 @@
+<!-- ## uni.createCameraContext() @createcameracontext -->
+
+<!-- UTSAPIJSON.createCameraContext.name -->
+
+<!-- UTSAPIJSON.createCameraContext.description -->
+
+通过本API，可操作摄像头组件进行拍照、录像。
+
+参考文档：
+- [camera组件文档](../component/camera.md)
+
+<!-- UTSAPIJSON.createCameraContext.compatibility -->
+
+<!-- UTSAPIJSON.createCameraContext.param -->
+
+<!-- UTSAPIJSON.createCameraContext.returnValue -->
+
+<!-- UTSAPIJSON.createCameraContext.example -->
+
+<!-- UTSAPIJSON.createCameraContext.tutorial -->
+
+示例代码另见 [camera组件文档](../component/camera.md)
+<!-- UTSAPIJSON.createCameraContext.example -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-canvas-context-async.md

@@ -0,0 +1,36 @@
+<!-- ## uni.createCanvasContextAsync(options) @createcanvascontextasync -->
+
+<!-- UTSAPIJSON.createCanvasContextAsync.name -->
+
+<!-- UTSAPIJSON.createCanvasContextAsync.description -->
+
+uni.createCanvasContextAsync 方法可以异步获取页面上指定id的canvas组件的上下文对象CanvasContext。
+
+因微信小程序获取CanvasContext只能异步，所以为了跨端，本API也被设计成了异步API，需要在回调中获取CanvasContext。
+
+获取到CanvasContext对象后，还需通过getContext("2d")方法获取[CanvasRenderingContext2D](./canvasrenderingcontext2d.md)对象。
+
+如果不考虑小程序，那么Web和App其实支持通过uni.getElementById方式同步获取[UniCanvasElement](../dom/unicanvaselement.md)。
+
+参考文档：
+- [canvas组件文档](../component/canvas.md)
+- [CanvasRenderingContext2D文档](./canvasrenderingcontext2d.md)
+
+<!-- UTSAPIJSON.createCanvasContextAsync.compatibility -->
+
+<!-- UTSAPIJSON.createCanvasContextAsync.param -->
+
+<!-- UTSAPIJSON.createCanvasContextAsync.returnValue -->
+
+<!-- UTSAPIJSON.createCanvasContextAsync.example -->
+
+<!-- UTSAPIJSON.createCanvasContextAsync.tutorial -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->
+
+
+### 注意事项
+
+- CanvasContext的toDataURL方法在 App-Android 平台暂不支持在页面的onLoad和组件的onMount生命周期中调用

package/data/uni-app-x-docs/api/create-editor-context-async.md

@@ -0,0 +1,23 @@
+<!-- UTSAPIJSON.createEditorContextAsync.name -->
+
+<!-- UTSAPIJSON.createEditorContextAsync.description -->
+
+本API是 [editor组件](../component/editor.md) 的上下文对象。
+
+<!-- UTSAPIJSON.createEditorContextAsync.compatibility -->
+
+<!-- UTSAPIJSON.createEditorContextAsync.param -->
+
+<!-- UTSAPIJSON.createEditorContextAsync.fileFormats -->
+
+<!-- UTSAPIJSON.createEditorContextAsync.returnValue -->
+
+<!-- UTSAPIJSON.createEditorContextAsync.example -->
+
+<!-- UTSAPIJSON.createEditorContextAsync.tutorial -->
+
+<!-- UTSAPIJSON.createEditorContextAsync.example -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-inner-audio-context.md

@@ -0,0 +1,67 @@
+<!-- ## uni.createInnerAudioContext() @createinneraudiocontext -->
+
+<!-- UTSAPIJSON.createInnerAudioContext.name -->
+
+<!-- UTSAPIJSON.createInnerAudioContext.description -->
+
+:::warning 注意
+使用完后，必须调用 destroy 方法将资源进行释放
+:::
+
+**支持格式**
+
+|格式	|Android|iOS|HarmonyOS|
+|:-		|:-			|:-	|:-	|
+|mp3	|√			|√	|√|
+|mp4	|√			|√	|x|
+|m4a	|√			|√	|√|
+|wav	|√			|√	|√|
+|aac	|√			|√	|√|
+|flac	|√			|√	|x|
+|aiff	|x			|√	|x|
+|amr	|√			|x	|√|
+|ape	|√			|x	|x|
+|caf	|x			|√	|x|
+|ogg	|√			|x	|√|
+|wma	|√			|x	|x|
+
+- web平台的支持取决于浏览器的实现，一般浏览器上述音频格式均支持
+- 小程序平台支持的格式见各家小程序的文档
+- HarmonyOS 平台使用 [AudioPlayer](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-media#audioplayerdeprecated?ha_source=Dcloud&ha_sourceId=89000448) 实现
+
+**缓存说明**
+
+- App-Android 平台播放的网络音频，默认会缓存到应用cache目录的uni-audio文件夹下，默认大小为100M，超过后会根据最近最少使用的缓存算法自动进行清除；
+- 4.51 版本以上 App-iOS 平台支持Cache功能，缓存路径、默认大小和自动清理机制和 Android 一样；
+
+<!-- UTSAPIJSON.createInnerAudioContext.compatibility -->
+
+<!-- UTSAPIJSON.createInnerAudioContext.param -->
+
+<!-- UTSAPIJSON.createInnerAudioContext.returnValue -->
+
+<!-- UTSAPIJSON.createInnerAudioContext.tutorial -->
+
+<!-- UTSAPIJSON.createInnerAudioContext.example -->
+
+
+<!-- ## uni.setInnerAudioOption() @setinneraudiooption -->
+
+<!-- UTSAPIJSON.setInnerAudioOption.name -->
+
+<!-- UTSAPIJSON.setInnerAudioOption.description -->
+
+<!-- UTSAPIJSON.setInnerAudioOption.compatibility -->
+
+<!-- UTSAPIJSON.setInnerAudioOption.param -->
+
+<!-- UTSAPIJSON.setInnerAudioOption.returnValue -->
+
+<!-- UTSAPIJSON.setInnerAudioOption.tutorial -->
+
+<!-- UTSAPIJSON.setInnerAudioOption.example -->
+
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-intersection-observer.md

@@ -0,0 +1,17 @@
+## uni.createIntersectionObserver(component, options) @createintersectionobserver
+
+<!-- UTSAPIJSON.createIntersectionObserver.description -->
+
+<!-- UTSAPIJSON.createIntersectionObserver.compatibility -->
+
+<!-- UTSAPIJSON.createIntersectionObserver.param -->
+
+<!-- UTSAPIJSON.createIntersectionObserver.returnValue -->
+
+<!-- UTSAPIJSON.createIntersectionObserver.example -->
+
+<!-- UTSAPIJSON.createIntersectionObserver.tutorial -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-interstitial-ad.md

@@ -0,0 +1,43 @@
+## uni.createInterstitialAd(option) @createinterstitialad
+
+<!-- UTSAPIJSON.createInterstitialAd.description -->
+
+插屏是一种弹出在屏幕中间的、带有关闭按钮的广告。大部分插屏广告是半屏的，个别广告会全屏。这取决于广告聚合渠道的设置。
+
+- uni-ad的业务介绍：[详见](https://uniapp.dcloud.net.cn/uni-ad/intro.html)
+
+上述文档是uni-app和uni-app x的通用文档，如遇到uni-app x不一致的文档，需以uni-app x文档为准。
+
+开通插屏广告，需在 [https://uniad.dcloud.net.cn/](https://uniad.dcloud.net.cn/) 管理后台开通。
+
+开通时需要进行开发者认证和应用资质审核。
+
+2. 获取和使用广告位id
+
+开通uni-ad后，在[uni-ad后台](https://uniad.dcloud.net.cn/)给应用创建插屏广告位后，需要拿到广告位id（adpid），传入下面的api `createInterstitialAd`中。
+
+3. 配置广告模块
+
+App平台在manifest中配置添加三方广告SDK。具体配置可参考[文档](../collocation/manifest-modules.md#uni-ad)。
+
+打正式包或自定义基座后可生效。标准基座包含的是测试广告位，无法为你产生收益。
+
+
+<!-- UTSAPIJSON.createInterstitialAd.compatibility -->
+
+<!-- UTSAPIJSON.createInterstitialAd.param -->
+
+<!-- UTSAPIJSON.createInterstitialAd.returnValue -->
+
+## Tips
+
++ uni-app x 标准基座插屏广告测试广告位id为`1111111113`。正式开发需配置自己的广告位id，并且打包自定义基座后生效。
++ 插屏广告目前仅支持API形式，暂不支持组件形式。
+
+<!-- UTSAPIJSON.createInterstitialAd.example -->
+
+<!-- UTSAPIJSON.createInterstitialAd.tutorial -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-live-player-context.md

@@ -0,0 +1,26 @@
+<!-- ## uni.createLivePlayerContext() @createliveplayercontext -->
+
+<!-- UTSAPIJSON.createLivePlayerContext.name -->
+
+<!-- UTSAPIJSON.createLivePlayerContext.description -->
+
+参考文档：
+[live-player组件文档](../component/live-player.md)
+
+<!-- UTSAPIJSON.createLivePlayerContext.compatibility -->
+
+<!-- UTSAPIJSON.createLivePlayerContext.param -->
+
+<!-- UTSAPIJSON.createLivePlayerContext.returnValue -->
+
+<!-- UTSAPIJSON.createLivePlayerContext.example -->
+
+<!-- UTSAPIJSON.createLivePlayerContext.tutorial -->
+
+示例代码另见[live-player组件文档](../component/live-player.md)
+
+<!-- UTSAPIJSON.createLivePlayerContext.example -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-live-pusher-context.md

@@ -0,0 +1,26 @@
+<!-- ## uni.createLivePusherContext() @createlivepushercontext -->
+
+<!-- UTSAPIJSON.createLivePusherContext.name -->
+
+<!-- UTSAPIJSON.createLivePusherContext.description -->
+
+参考文档：
+[live-pusher组件文档](../component/live-pusher.md)
+
+<!-- UTSAPIJSON.createLivePusherContext.compatibility -->
+
+<!-- UTSAPIJSON.createLivePusherContext.param -->
+
+<!-- UTSAPIJSON.createLivePusherContext.returnValue -->
+
+<!-- UTSAPIJSON.createLivePusherContext.example -->
+
+<!-- UTSAPIJSON.createLivePusherContext.tutorial -->
+
+示例代码另见[live-pusher组件文档](../component/live-pusher.md)
+
+<!-- UTSAPIJSON.createLivePusherContext.example -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-map-context.md

@@ -0,0 +1,13 @@
+## uni.createMapContext(mapId, component?) @createmapcontext
+
+<!-- UTSAPIJSON.createMapContext.description -->
+
+参考：[Map组件](../component/map.md)
+
+<!-- UTSAPIJSON.createMapContext.compatibility -->
+
+<!-- UTSAPIJSON.createMapContext.param -->
+
+<!-- UTSAPIJSON.createMapContext.returnValue -->
+
+<!-- UTSAPIJSON.createMapContext.tutorial -->

package/data/uni-app-x-docs/api/create-request-permission-listener.md

@@ -0,0 +1,37 @@
+<!-- ## uni.createRequestPermissionListener() @createrequestpermissionlistener -->
+
+<!-- UTSAPIJSON.createRequestPermissionListener.name -->
+
+<!-- UTSAPIJSON.createRequestPermissionListener.description -->
+
+<!-- UTSAPIJSON.createRequestPermissionListener.compatibility -->
+
+app-android平台，可使用本API监听应用权限申请确认框的弹出和关闭。不管是哪处的业务代码在申请权限，当弹出和关闭权限申请确认框时均会触发本监听事件。
+
+华为应用市场审核时要求：`APP在调用终端权限时，应同步告知用户申请该权限的目的`。此时即可使用本API，在app.uvue里全局监听。
+
+创建监听对象后，返回RequestPermissionListener，然后调起其的onConfirm和onComplete。
+
+- 当权限申请的确认框在手机端弹出时，会触发onConfirm
+- 当权限申请的确认框被用户关闭后，会触发onComplete
+
+<!-- UTSAPIJSON.createRequestPermissionListener.param -->
+
+<!-- UTSAPIJSON.createRequestPermissionListener.returnValue -->
+
+<!-- UTSAPIJSON.createRequestPermissionListener.example -->
+
+<!-- UTSAPIJSON.createRequestPermissionListener.tutorial -->
+
+## Tips
+
+- 如果权限已经申请并且允许之后，`onConfirm`不会触发。
+- 如果同时申请多个权限时，`onComplete`可能会触发多次。
+- uni-app x 中如果请求一个已经被永久拒绝的权限，可能会触发`onConfirm`。
+- 权限监听仅支持通过调用[uni.requestSystemPermission](https://doc.dcloud.net.cn/uni-app-x/api/request-system-permission.html)和[UTSAndroid.requestSystemPermission](https://doc.dcloud.net.cn/uni-app-x/uts/utsandroid.html#requestsystempermission)申请的权限。
+- 权限列表参考：[https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#permissions)
+- 全局监听权限申请可参考插件[uni-registerRequestPermissionTips](https://ext.dcloud.net.cn/plugin?name=uni-registerRequestPermissionTips)。
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-rewarded-video-ad.md

@@ -0,0 +1,58 @@
+## uni.createRewardedVideoAd(option) @createrewardedvideoad
+
+<!-- UTSAPIJSON.createRewardedVideoAd.description -->
+
+激励视频，顾名思义，播放一段视频广告，手机用户看完广告后需向其发放奖励。
+
+激励视频是一种播放时间较长、CPM单价较高的广告类型，是广告变现中的优质工具。
+
+1. 开通激励视频，需在 [https://uniad.dcloud.net.cn/](https://uniad.dcloud.net.cn/) 管理后台开通。
+
+uni-ad是DCloud提供的聚合广告平台，激励视频的广告来源主要来自于聚合的优量汇、穿山甲、快手、百度、sigmob，通过竞价模型优先展示出价高的广告。
+
+开通时需要进行开发者认证和应用资质审核。
+
+- uni-ad的业务介绍：[详见](https://uniapp.dcloud.net.cn/uni-ad/)
+- 激励视频的业务：[详见](https://uniapp.dcloud.net.cn/uni-ad/ad-rewarded-video.html)
+
+上述文档是uni-app和uni-app x的通用文档，如遇到uni-app x不一致的文档，需以uni-app x文档为准。
+
+1. 获取和使用广告位id
+
+开通uni-ad后，在[uni-ad后台](https://uniad.dcloud.net.cn/)给App创建激励视频广告位后，需要拿到广告位id（adpid），传入下面的api `createRewardedVideoAd `中。
+
+3. 配置广告模块
+
+App平台在manifest中配置添加三方广告SDK。具体配置可参考[文档](../collocation/manifest-modules.md#uni-ad)。
+
+打正式包或自定义基座后可生效。标准基座包含的是测试广告位，无法为你产生收益。
+
+4. 发放奖励
+
+激励视频播放完毕后，需给手机用户发放奖励。一般是虚拟权益，如游戏道具、查看优质内容（小说、代码、图片、音视频）的资质、vip会员时长。
+
+如果手机用户未看完视频广告，中途退出广告，则不发放奖励。
+
+但为了防止客户端伪造看完广告的凭据，播放完毕广告是由服务器来做回调的。这是业内通行的安全方案，包括支付也是服务器回调。
+
+由uniCloud服务器从各家广告平台接受到视频播放完毕后，通知业务服务进行奖励发放。[详见](https://uniapp.dcloud.net.cn/uni-ad/ad-rewarded-video.html#callback)
+
+<!-- UTSAPIJSON.createRewardedVideoAd.compatibility -->
+
+<!-- UTSAPIJSON.createRewardedVideoAd.param -->
+
+<!-- UTSAPIJSON.createRewardedVideoAd.returnValue -->
+
+## Tips
+
++ uni-app x 标准基座激励视频广告测试广告位id为`1507000689`。正式开发需配置自己的广告位id，并且打包自定义基座后生效。
++ 激励视频广告目前仅支持API形式，暂不支持组件形式。
++ 部分广告渠道不支持模拟器，最终效果及服务器回调应以真机为准。
+
+<!-- UTSAPIJSON.createRewardedVideoAd.example -->
+
+<!-- UTSAPIJSON.createRewardedVideoAd.tutorial -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-selector-query.md

@@ -0,0 +1,161 @@
+<!-- ## uni.createSelectorQuery() @createselectorquery -->
+
+<!-- UTSAPIJSON.createSelectorQuery.name -->
+
+<!-- UTSAPIJSON.createSelectorQuery.description -->
+
+createSelectorQuery是小程序的API，因小程序未开放DOM，且视图层和逻辑层分离，于是提供了一个异步的API，可以在逻辑层有限的获取一些DOM能力。
+
+该API返回的类型为NodeRef。它和DOM的Element有区别。
+
+大多数组件的属性和样式操作，是通过绑定vue的响应式变量data来实现的。一般不使用本API。
+
+本API的主要用途是小程序下获取元素计算后的样式。如果您的应用不适配小程序，那么在Web和App上有更强大的[UniElement](../dom/README.md)。
+
+小程序下有时用本API获取部分组件的上下文context，但这个写法不跨平台。跨平台的获取组件context，应该使用uni.createXXContext()。
+
+<!-- UTSAPIJSON.createSelectorQuery.compatibility -->
+
+<!-- UTSAPIJSON.createSelectorQuery.param -->
+
+**selector 说明：**
+
+``selector`` 类似于 CSS 的选择器，但仅支持下列语法。
+- ID选择器：``#the-id``
+- class选择器：``.a-class``
+
+<!-- UTSAPIJSON.createSelectorQuery.returnValue -->
+
+##### NodeInfo 属性值
+
+|属性		|类型		|说明							|
+|---		|---		|---							|
+|id			|String	|节点的 ID				|
+|dataset|Object	|节点的 dataset		|
+|left		|Number	|节点的左边界坐标	|
+|right	|Number	|节点的右边界坐标	|
+|top		|Number	|节点的上边界坐标	|
+|bottom	|Number	|节点的下边界坐标	|
+|width	|Number	|节点的宽度				|
+|height	|Number	|节点的高度				|
+
+<!-- UTSAPIJSON.createSelectorQuery.tutorial -->
+
+组件内使用
+
+```html
+<template>
+  <view>
+    <button @click="getNodeInfo">getNodeInfo</button>
+    <view class="rect-1-2">
+      <view class="rect rect1"></view>
+      <view class="rect rect2"></view>
+    </view>
+  </view>
+</template>
+
+<script setup lang="uts">
+  const instance = getCurrentInstance()!.proxy!
+  const nodeInfoList = ref<NodeInfo[]>([])
+
+  const getNodeInfo = () => {
+    uni.createSelectorQuery().in(instance).select('.rect1').boundingClientRect().exec((ret) => {
+      nodeInfoList.value.length = 0
+      nodeInfoList.value.push(ret[0] as NodeInfo)
+    })
+  }
+</script>
+```
+
+<!-- UTSAPIJSON.createSelectorQuery.example -->
+
+**exec 示例说明：**
+
+`exec()` 返回所有动作的集合，每一项的数据类型取决于查询动作，结果排序按照调用动作顺序
+
+示例：
+
+```js
+uni.createSelectorQuery().select('.rect1').boundingClientRect((res) => {
+  // 共返回 1 条结果，第一项数据类型为 NodeInfo
+  // res = [ {} ]
+
+  const nodeInfoArray = res as NodeInfo[]
+  const nodeInfoArrayItem = nodeInfoArray[0]
+  console.log('info', nodeInfoArrayItem.width, nodeInfoArrayItem.height)
+}).exec()
+```
+
+```js
+uni.createSelectorQuery().selectAll('.rect1').boundingClientRect((res) => {
+  // 共返回 1 条结果，第一项数据类型为 NodeInfo[]
+  // res = [ [{},{}] ]
+
+  const nodeInfoArray = res as NodeInfo[]
+  const nodeInfoArrayItem = nodeInfoArray[0]
+  nodeInfoArrayItem.foreach((item: NodeInfo) => {
+    console.log('item', item.width, item.height)
+  })
+}).exec()
+```
+
+```js
+uni.createSelectorQuery().select('.rect1').selectAll('.rect2').boundingClientRect((res) => {
+  // 共返回 2 条结果，第一项数据类型为 NodeInfo，第二项数据类型为 NodeInfo[]
+  // res = [ {}, [{},{}] ]
+
+  const nodeInfoArray = res as NodeInfo[]
+
+  const nodeInfoItem0 = nodeInfoArray[0]
+  console.log('nodeInfoItem0', nodeInfoItem0.width, nodeInfoItem0.height)
+
+  const nodeInfoItem1 = nodeInfoArray[1]
+  nodeInfoItem1.foreach((item: NodeInfo) => {
+    console.log('item', item.width, item.height)
+  })
+}).exec()
+```
+
+
+通过id查询组件内多节点
+
+和单根节点组件有所不同，有着多个根节点的组件需要透传 attribute
+
+页面
+
+```html
+<template>
+  <view>
+    <custom-component1 id="custom-component1"></custom-component1>
+
+    <button @click="query">query</button>
+  </view>
+</template>
+<script setup lang="uts">
+  const instance = getCurrentInstance()!.proxy!
+
+  const query = () => {
+    uni.createSelectorQuery().in(instance).select('#custom-component1').boundingClientRect().exec((ret) => {
+      console.log(ret)
+    })
+  }
+</script>
+```
+
+组件 custom-component1
+
+```html
+<template>
+  <text>1</text>
+  <text v-bind="$attrs">2</text>
+  <text>3</text>
+</template>
+```
+
+**注意事项：**
+
+1. Web 平台 `<template>` 下如果存在多个节点，如果是在组件内部查询，可能会导致查询到其他组件或页面的元素
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->

package/data/uni-app-x-docs/api/create-video-context.md

@@ -0,0 +1,46 @@
+<!-- ## uni.createVideoContext(videoId, component?) @createvideocontext -->
+
+<!-- UTSAPIJSON.createVideoContext.name -->
+
+<!-- UTSAPIJSON.createVideoContext.description -->
+
+参考：[video组件](../component/video.md)
+
+<!-- UTSAPIJSON.createVideoContext.compatibility -->
+
+<!-- UTSAPIJSON.createVideoContext.param -->
+
+在video组件上设置id属性，即可通过本API获取该组件的上下文对象（videoContext ）。
+
+在不传入第2个component参数时，默认从页面栈顶的页面来查找这个video。
+```js
+let v1 = uni.createVideoContext("video1")
+```
+
+但在页面、组件，可能出现id重复的情况，还可能因为调用时机的不同，想定位不同页面的video id。此时就需要传入第2个参数component。
+
+所有vue组件都有ComponentPublicInstance实例，页面上也有组件实例。
+
+如果传入组件实例，就从这个组件中查询指定的id。这样查找范围更小、查找速度也更快。
+
+在选项式和组合式中，获取组件实例略有差别。
+
+- 选项式中，this代表当前vue实例。如果是在页面的export default内、函数外使用this，即代表该页面的组件实例。
+```js
+let v1 = uni.createVideoContext("video1", this)
+```
+- 组合式中，通过getCurrentInstance()!.proxy! 获取当前页面的组件实例。
+```js
+let v1 = uni.createVideoContext("video1", getCurrentInstance()!.proxy!)
+```
+<!-- UTSAPIJSON.createVideoContext.returnValue -->
+
+<!-- UTSAPIJSON.createVideoContext.example -->
+
+<!-- UTSAPIJSON.createVideoContext.tutorial -->
+
+<!-- UTSAPIJSON.general_type.name -->
+
+<!-- UTSAPIJSON.general_type.param -->
+
+示例代码另见[video组件](../component/video.md)