@dcloudio/uni-app-x 0.5.5 → 0.5.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcloudio/uni-app-x",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "description": "uni-app x types",
   "typings": "index.d.ts",
   "author": "DCloud",

package/types/app.d.ts

@@ -137,6 +137,7 @@ interface AppInstance<T extends AnyObject = {}> {
   /**
    * 全局对象
    * 文档：[https://uniapp.dcloud.io/collocation/App?id=globaldata](https://uniapp.dcloud.io/collocation/App?id=globaldata)
+   * @autodoc false
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -205,6 +206,7 @@ interface AppInstance<T extends AnyObject = {}> {
    * 应用初始化完成时触发，全局只触发一次。
    *
    * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @autodoc false
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -266,13 +268,14 @@ interface AppInstance<T extends AnyObject = {}> {
    *  }
    *}
    */
-  onLaunch?(options?: OnLaunchOptions): void;
+  onLaunch?(options: OnLaunchOptions): void;
   /**
    * 生命周期回调 监听应用显示
    *
    * 应用启动，或从后台进入前台显示时触发
    *
    * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @autodoc false
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -334,13 +337,14 @@ interface AppInstance<T extends AnyObject = {}> {
    *  }
    *}
    */
-  onShow?(options?: OnShowOptions): void;
+  onShow?(options: OnShowOptions): void;
   /**
    * 生命周期回调 监听应用隐藏
    *
    * 应用从前台进入后台时触发
    *
    * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @autodoc false
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -409,6 +413,7 @@ interface AppInstance<T extends AnyObject = {}> {
    * @param error 错误信息，包含堆栈
    *
    * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @autodoc false
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -481,6 +486,7 @@ interface AppInstance<T extends AnyObject = {}> {
    * 2. 如果 `onPageNotFound` 回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再回调 `onPageNotFound`。
    *
    * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @autodoc false
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -617,9 +623,9 @@ interface AppInstance<T extends AnyObject = {}> {
    *  }
    *}
    */
-    
+
     //   onUnhandledRejection?(options: UniNamespace.OnUnhandledRejectionCallbackResult): void;
-    
+
   /**
    * 监听系统主题变化
    *
@@ -696,13 +702,14 @@ interface AppInstance<T extends AnyObject = {}> {
    */
 
     //   onThemeChange?(options: UniNamespace.OnThemeChangeCallbackResult): void;
-    
+
   /**
    * 监听 nvue 页面消息
    *
    * nvue 页面使用 `uni.postMessage` 发送消息时触发
    *
    * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @autodoc false
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -778,6 +785,7 @@ interface AppInstance<T extends AnyObject = {}> {
    * 监听应用退出。app-uvue-android 3.9+
    *
    * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @autodoc false
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -853,6 +861,7 @@ interface AppInstance<T extends AnyObject = {}> {
    * 最后一个页面按下Android back键，常用于自定义退出。app-uvue-android 3.9+
    *
    * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @autodoc false 
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -932,9 +941,9 @@ type AppConstructor = <T extends AnyObject & AppInstance>(
 
 
 /**
- * `getApp()` 函数用于获取当前应用实例。
- * @tutorial https://uniapp.dcloud.net.cn/uni-app-x/api/getapp.html#getapp
+ * `getApp()` 函数用于获取当前应用实例，可通过应用实例调用 App.uvue methods 中定义的方法。
+ * @tutorial https://uniapp.dcloud.net.cn/tutorial/page.html#getapp
  */
-type GetApp = <T extends AnyObject>() => AppInstance<T> & T;
+type GetApp = () => AppInstance;
 
 declare const getApp: GetApp;

package/types/native/AsyncApiResult.d.ts

@@ -2,6 +2,6 @@
  * @package io.dcloud.uniapp
  * @autodoc false
  */
-interface AsyncApiResult {
+declare interface AsyncApiResult {
   errMsg: string
 }

package/types/native/CSSStyleDeclaration.d.ts

@@ -9,12 +9,12 @@ declare class CSSStyleDeclaration {
  * @param name CSS样式名称
  * @param value 要设置的新CSS样式值
  */
-  setProperty(name: string|HBuilderX.cssPropertyString, value: any|null): void
+  setProperty(name: string|string.cssPropertyString, value: any|null): void
 
 /**
  * 获取CSS指定的样式值，如果指定的样式不存在则返回null。
  * @param property 要获取的CSS样式名称
  */
-  getPropertyValue(property: string|HBuilderX.cssPropertyString): any|null
+  getPropertyValue(property: string|string.cssPropertyString): any|null
 
 }

package/types/native/DrawableContext.d.ts

@@ -12,7 +12,7 @@ declare class DrawableContext {
 	 * 设置填充颜色
 	 * @defaultValue #000 (黑色)
 	 */
-	fillStyle : string
+	fillStyle : string.ColorString
 	/**
 	 * 指定如何绘制每一条线条末端的属性，可选值：`butt`线段末端以方形结束；`round`线段末端以圆形结束；`square`线段末端以方形结束，但是会增加一个一半宽度的矩形区域。
 	 * @defaultValue butt
@@ -36,7 +36,7 @@ declare class DrawableContext {
 	 * 设置边框的颜色
 	 * @defaultValue #000 (黑色)
 	 */
-	strokeStyle : string
+	strokeStyle : string.ColorString
 	/**
 	 * 设置文本的对齐方式，可取值：`left`左对齐；`center`居中对齐；`right`右对齐。
 	 * @defaultValue left

package/types/native/Element.d.ts

@@ -1,9 +1,11 @@
 /// <reference path="./Event.d.ts" />
+/// <reference path='./SnapshotOptions.d.ts' />
 
 /**
+ * UVUE DOM 元素对象，描述了 UVUE DOM 元素所普通具有的属性和方法。
  * @package io.dcloud.uniapp.runtime
  */
-interface Element {
+declare interface Element {
   /**
    * 获取当前元素的的第一个子元素，如果元素是无子元素，则返回 null。
    */
@@ -32,12 +34,12 @@ interface Element {
 
   /**
    * 获取在 DOM 树中紧跟在其后面的同级元素，如果指定的元素为最后一个元素，则返回 null。
+   * @autodoc false
    */
   nextSibling: Element | null
 
   /**
    * 获取在 DOM 树中紧跟在其后面的同级元素，如果指定的元素为最后一个元素，则返回 null。
-   * @autodoc false
    */
   nextElementSibling: Element | null
 
@@ -45,6 +47,11 @@ interface Element {
    * 获取当前元素包含的子元素的集合
    */
   children: Element[]
+
+  /**
+   * 获取当前节点包含的子节点的集合
+   * @autodoc false
+   */
   childNodes: Element[]
 
   /**
@@ -124,6 +131,29 @@ interface Element {
    */
   getNodeId(): string
 
+
+  /**
+   * 对当前组件进行截图，调用此方法会将当前组件（包含子节点）渲染结果导出成图片
+   * 成功会返回图片对应的临时文件路径，目前默认png格式
+   *
+   * @param options 组件截图的参数对象
+   * @uniPlatform {
+   *    "app": {
+   *        "android": {
+   *            "osVer": "5.0",
+   *            "uniVer": "x",
+   *            "unixVer": "3.93"
+   *        },
+   *        "ios": {
+   *            "osVer": "x",
+   *            "uniVer": "x",
+   *            "unixVer": "x"
+   *   	  }
+   *    }
+   * }
+   */
+  takeSnapshot(options: TakeSnapshotOptions):void
+
   /**
    * 将一个元素添加到指定父元素的子元素列表的末尾处。如果将被插入的元素已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。
    * @param {Element} aChild 插入子元素对象
@@ -140,15 +170,15 @@ interface Element {
   /**
    * 设置指定元素上的某个属性值。如果设置的属性已经存在，则更新该属性值；否则使用指定的名称和值添加一个新的属性。
    * @param {string} key 属性名称
-   * @param {any | null} value 属性值域 可为空
+   * @param {string} value 属性值域
    */
-  setAttribute(key: string, value: any | null): void
+  setAttribute(key: string, value: string): void
 
   /**
    * 获取元素指定的属性值，如果指定的属性不存在则返回null。
    * @param {string} key 属性名称
    */
-  getAttribute(key: string): any | null
+  getAttribute(key: string): string | null
 
   /**
    * 返回改元素是否包含有指定的属性，属性存在则返回true，否则返回false。
@@ -236,3 +266,4 @@ interface Element {
 }
 
 type INode = Element
+

package/types/native/IDocument.d.ts

@@ -1,15 +1,14 @@
 /// <reference path='./Element.d.ts' />
-/// <reference path='./ITabsNode.d.ts' />
 /// <reference path='./NodeData.d.ts' />
 
 /**
  * @package io.dcloud.uniapp.runtime
  * @autodoc false
  */
-interface IDocument extends Element {
+declare interface IDocument extends Element {
   body: Element
 
-  getRealDomNodeById<T>(tag: string): ITabsNode | null
+  getRealDomNodeById<T>(tag: string): T | null
 
   startRender(): unknown
 

package/types/native/IPage.d.ts

@@ -5,7 +5,7 @@
  * @package io.dcloud.uniapp.runtime
  * @autodoc false
  */
-interface IPage {
+declare interface IPage {
   /**
    * 页面id
    */

package/types/native/IUniError.d.ts

@@ -1,6 +1,6 @@
 /// <reference path="./AsyncApiResult.d.ts" />
 
-interface IUniError extends AsyncApiResult {
+declare interface IUniError extends AsyncApiResult {
 	/**
 	 * 统一错误码
 	 */

package/types/native/NodeData.d.ts

@@ -2,7 +2,7 @@
  * @package io.dcloud.uniapp.interfaces
  * @autodoc false
  */
-interface INodeData {
+declare interface INodeData {
   id: string
   name: string
   attrs?: Map<string, any | null>

package/types/native/SnapshotOptions.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 组件截图成功的返回数据
+ */
+declare type TakeSnapshotSuccess = {
+  /**
+   * 截图保存的临时文件路径
+   */
+  tempFilePath: string
+}
+
+/**
+ * 组件截图失败的返回数据
+ */
+declare type TakeSnapshotFail = {
+  errMsg: string
+}
+
+
+/**
+ * 成功回调函数定义
+ */
+declare type TakeSnapshotSuccessCallback = (res: TakeSnapshotSuccess) => void
+/**
+ * 失败回调函数定义
+ */
+declare type TakeSnapshotFailCallback = (res: TakeSnapshotFail) => void
+/**
+ * 完成回调函数定义
+ */
+declare type TakeSnapshotCompleteCallback = (res: any) => void
+
+/**
+ * 组件截图的参数配置选项
+ */
+declare class TakeSnapshotOptions{
+
+  /**
+   * 截图导出类型，目前仅支持 'file' 保存到临时文件目录
+   * @default "file"
+   */
+  type : string
+  /**
+   * 截图文件格式，目前仅支持 'png'
+   * @default "png"
+   */
+  format : string
+
+  /**
+   * 接口调用成功的回调函数
+   */
+  success?: TakeSnapshotSuccessCallback | null
+  /**
+   * 接口调用失败的回调函数
+   */
+  fail?: TakeSnapshotFailCallback | null
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
+  complete?: TakeSnapshotCompleteCallback | null
+
+}
+
+

package/types/native/UniAppManager.d.ts

@@ -8,7 +8,7 @@ declare const UniAppManager: {
   getCurrentApp(): CurrentApp
 }
 
-interface CurrentApp {
+declare interface CurrentApp {
   pageManager: {
     createPage(url: string, id: unknown, styles: unknown): IPage
   }

package/types/native/UniElement.d.ts

@@ -0,0 +1,97 @@
+/// <reference path='./Element.d.ts' />
+
+/**
+ * view元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniElement extends Element {
+}
+
+/**
+ * view元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniViewElement extends UniElement {
+}
+
+/**
+ * scroll-view元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniScrollViewElement extends UniElement {
+}
+
+/**
+ * list-view元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniListViewElement extends UniScrollViewElement{
+}
+
+/**
+ * list-item元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniListItemElement extends UniElement {
+}
+
+/**
+ * swiper元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniSwiperElement extends UniElement {
+}
+
+/**
+ * swiper-item元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniSwiperItemElement extends UniElement {
+}
+
+/**
+ * image元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniImageElement extends UniElement {
+}
+
+/**
+ * input元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniInputElement extends UniElement {
+}
+
+/**
+ * textarea元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniTextareaElement extends UniElement {
+}
+
+/**
+ * rich-text元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniRichTextElement extends UniElement {
+}
+
+/**
+ * sticky-header元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniStickyHeaderElement extends UniElement {
+}

package/types/native/UniTabsElement.d.ts

@@ -0,0 +1,86 @@
+/// <reference path='./UniElement.d.ts' />
+
+/**
+ * tabs元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniTabsElement extends UniElement {
+  /**
+   * 添加item
+   * @param pageId 页面id
+   */
+  appendItem(pageId: string): void
+
+  /**
+   * 添加item
+   * @param itemElement item的元素对象
+   */
+  appendItem(itemElement: Element): void
+
+  /**
+   * 初始化tabBar
+   */
+  initTabBar(style: Map<string, any | null>): void
+
+  /**
+   * 添加自定义tabBar
+   * @param tabBar tabBar元素
+   * @param direction 排列方向
+   */
+  appendCustomTabBar(tabBar: Element, direction: string): void
+
+  /**
+   * item选中高亮
+   * @param 被选中页面id
+   * @index item下标
+   */
+  switchSelect(pageId: string, index: number): void
+
+  /**
+   * 隐藏TabBar
+   */
+  hideTabBar(op: Map<string, any | null>): void
+
+  /**
+   * 显示tabBar
+   */
+  showTabBar(op: Map<string, any | null>): void
+
+  /**
+   * 为 tabBar 某一项的右上角添加文本
+   */
+  setTabBarBadge(op: Map<string, any | null>): void
+
+  /**
+   * 移除 tabBar 某一项右上角的文本
+   */
+  removeTabBarBadge(op: Map<string, any | null>): void
+
+  /**
+   * 显示 tabBar 某一项的右上角的红点
+   */
+  showTabBarRedDot(op: Map<string, any | null>): void
+
+  /**
+   * 隐藏 tabBar 某一项的右上角的红点
+   */
+  hideTabBarRedDot(op: Map<string, any | null>): void
+
+  /**
+   * 动态设置 tabBar 的整体样式
+   */
+  setTabBarStyle(op: Map<string, any | null>): void
+
+  /**
+   * 动态设置 tabBar 某一项的内容
+   */
+  setTabBarItem(op: Map<string, any | null>): void
+  /**
+   * tabBar是否隐藏
+   */
+  isTabBarVisible: boolean
+  currentItemId: string | null
+}
+
+type ITabsNode = UniTabsElement

package/types/native/UniTextElement.d.ts

@@ -0,0 +1,13 @@
+/// <reference path='./UniElement.d.ts' />
+
+/**
+ * text元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniTextElement extends UniElement {
+  /**
+   * text元素的文案内容
+   */
+  value: string
+}

package/types/native/UniVideoElement.d.ts

@@ -0,0 +1,70 @@
+/// <reference path='./Element.d.ts' />
+
+/**
+ * video元素对象
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+declare interface UniVideoElement extends Element {
+  /**
+   * 播放
+   */
+  play(): void
+  /**
+   * 暂停
+   */
+  pause(): void
+  /**
+   * 跳转到指定位置
+   * @param {number} position 跳转到指定位置(秒)
+   */
+  seek(position: number): void
+  /**
+   * 停止视频
+   */
+  stop(): void
+  /**
+   * 发送弹幕
+   * @param {Danmu} danmu 弹幕数据
+   */
+  sendDanmu(danmu: Danmu): void
+  /**
+   * 设置倍速播放
+   * @param {number} rate 支持倍率 0.5/0.8/1.0/1.25/1.5
+   */
+  playbackRate(rate: number): void
+  /**
+   * 进入全屏
+   * @param {RequestFullScreenOptions} direction 0|正常竖向, 90|屏幕逆时针90度, -90|屏幕顺时针90度
+   */
+  requestFullScreen(direction: RequestFullScreenOptions | null): void
+  /**
+   * 退出全屏
+   */
+  exitFullScreen(): void
+}
+
+declare type Danmu = {
+  /**
+   * 弹幕文字
+   */
+  text: string | null
+  /**
+   * 弹幕颜色
+   */
+  color: string | null
+  /**
+   * 显示时刻
+   */
+  time: number | null
+}
+
+declare type RequestFullScreenOptions = {
+  /**
+   * direction
+   * - 0: 正常竖向
+   * - 90: 屏幕逆时针90度
+   * - -90: 屏幕顺时针90度
+   */
+  direction: number | null
+}

package/types/native/{IWebViewNode.d.ts → UniWebViewElement.d.ts}

@@ -1,10 +1,11 @@
-/// <reference path='./Element.d.ts' />
+/// <reference path='./UniElement.d.ts' />
 
 /**
+ * web-view元素对象
  * @package io.dcloud.uniapp.runtime
  * @autodoc false
  */
-interface IWebViewNode extends Element {
+declare interface UniWebViewElement extends UniElement {
   /**
    * 后退
    */
@@ -26,3 +27,5 @@ interface IWebViewNode extends Element {
    */
   evalJS(js: string): void
 }
+
+type IWebViewNode = UniWebViewElement