@dcloudio/uni-app-x 0.5.0 → 0.5.2

package/types/native/Element.d.ts

@@ -0,0 +1,234 @@
+/// <reference path="./Event.d.ts" />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+interface Element {
+  /**
+   * 获取当前元素的的第一个子元素，如果元素是无子元素，则返回 null。
+   */
+  firstChild: Element | null
+
+  /**
+   * 获取当前元素的最后一个子元素，如果没有子元素，则返回 null。
+   */
+  lastChild: Element | null
+
+  /**
+   * 获取当前元素在 DOM 树中的父元素，如果没有父元素（如未添加到DOM树中），则返回null。
+   * @autodoc false
+   */
+  parentNode: Element | null
+  
+  /**
+   * 获取当前元素在 DOM 树中的父元素，如果没有父元素（如未添加到DOM树中），则返回null。
+   */
+  parentElement: Element | null
+
+  /**
+   * 获取当前元素的前一个同级元素，没有则返回null。
+   */
+  previousSibling: Element | null
+
+  /**
+   * 获取在 DOM 树中紧跟在其后面的同级元素，如果指定的元素为最后一个元素，则返回 null。
+   */
+  nextSibling: Element | null
+
+  /**
+   * 获取在 DOM 树中紧跟在其后面的同级元素，如果指定的元素为最后一个元素，则返回 null。
+   * @autodoc false
+   */
+  nextElementSibling: Element | null
+
+  /**
+   * 获取当前元素包含的子元素的集合
+   */
+  children: Element[]
+
+  /**
+   * 获取当前元素的标签名
+   */
+  tagName: string
+
+  /**
+   * 获取当前元素的元素名称
+   * @autodoc false
+   */
+  nodeName: string
+
+  /**
+   * 获取元素上自定义数据属性（data-*）的集合
+   */
+  dataset: Map<string, any | null>
+
+  /**
+   * 获取元素上所有属性元素的集合
+   */
+  attributes: Map<string, any | null>
+
+  /**
+   * 获取元素的CSS样式对象
+   */
+  style: CSSStyleDeclaration
+
+  /**
+   * 获取可滚动元素内容的总宽度，仅scroll-view、list-view组件支持，其他组件返回视图宽度
+   */
+  scrollWidth: number
+
+  /**
+   * 获取可滚动元素内容的总高度，仅scroll-view、list-view组件支持，其他组件返回视图高度
+   */
+  scrollHeight: number
+
+  /**
+    * 获取元素滚动条到元素左边的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0
+    */
+  scrollLeft: number
+
+  /**
+   * 获取元素滚动条到元素顶部的距离像素数，仅scroll-view、list-view组件支持。其他组件返回0
+   */
+  scrollTop: number
+
+  /**
+   * 元素的左边界偏移值 单位px
+   */
+  offsetLeft: number
+  
+  /**
+   * 元素的右边界偏移值 单位px
+   */
+  offsetTop: number
+  
+  /**
+   * 元素高度 单位px
+   */
+  offsetWidth: number
+  
+  /**
+   * 元素宽度 单位px
+   */
+  offsetHeight: number
+  
+  /**
+   * 扩展属性
+   */
+  ext: Map<string, any>
+
+  /**
+   * 获取元素标识。
+   * @autodoc false
+   */
+  getNodeId(): string
+
+  /**
+   * 将一个元素添加到指定父元素的子元素列表的末尾处。如果将被插入的元素已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。
+   * @param {Element} aChild 插入子元素对象
+   */
+  appendChild(aChild: Element): void
+
+  /**
+   * 在参考元素之前插入一个拥有指定父元素的子元素。如果给定的子元素是对文档中现有元素的引用，insertBefore() 会将其从当前位置移动到新位置。
+   * @param {Element} newChild 插入子元素对象
+   * @param {Element} refChild 已存在父元素的子元素对象
+   */
+  insertBefore(newChild: Element, refChild: Element): void
+
+  /**
+   * 设置指定元素上的某个属性值。如果设置的属性已经存在，则更新该属性值；否则使用指定的名称和值添加一个新的属性。
+   * @param {string} key 属性名称
+   * @param {any | null} value 属性值域 可为空
+   */
+  setAttribute(key: string, value: any | null): void
+
+  /**
+   * 获取元素指定的属性值，如果指定的属性不存在则返回null。
+   * @param {string} key 属性名称
+   */
+  getAttribute(key: string): any | null
+
+  /**
+   * 返回改元素是否包含有指定的属性，属性存在则返回true，否则返回false。
+   * @param {string} key 属性名称
+   */
+  hasAttribute(key: string): boolean
+
+  /**
+   * 从元素中删除一个属性，如果指定的属性不存在，则不做任何操作，也不会产生错误。
+   * @param {string} key 属性名称
+   */
+  removeAttribute(key: string): void
+
+  /**
+   * 更新元素的样式。
+   * @autodoc false
+   */
+  updateStyle(map: Map<string, any>): void
+
+  /**
+   * 获取元素的大小及其相对于窗口的位置信息。
+   */
+  getBoundingClientRect(): DOMRect
+
+  /**
+   * 获取组件的绘制对象，仅uvue页面中的 view 组件支持，其它组件不支持则返回null。
+   */
+  getDrawableContext(): DrawableContext | null
+
+  /**
+   * 将指定的监听器注册到元素对象上，当该对象触发指定的事件时，指定的回调函数就会被执行。
+   * @param {string} type 事件类型
+   * @param {(event: T) => R} callback 事件监听器 T表示event类型，R表示返回值类型
+   */
+  addEventListener<T extends Event, R>(type: string, callback: (event: T) => R): void
+
+  /**
+   * 删除使用 addEventListener 方法添加的事件监听器。
+   * @param {string} type 事件类型
+   */
+  removeEventListener(type: string): void
+
+  /**
+   * 从元素中删除一个子元素，返回删除的元素。
+   * @param {Element} aChild 被删除子元素对象
+   */
+  removeChild(aChild: Element): Element
+
+  /**
+   * 把元素对象从它所属的 DOM 树中删除。
+   */
+  remove(): void
+
+  /**
+   * 向一个指定的事件目标派发一个 Event，并以合适的顺序（同步地）调用此事件的监听器回调函数。
+   * @param {string} type 事件类型
+   * @param {Event} value 事件返回对象
+   */
+  dispatchEvent(type: string, value: Event): void
+
+  /**
+   * 使界面滚动到给定元素的指定坐标位置 仅scroll-view、list-view组件支持
+   * @param {number} x x轴要滚动到坐标位置(单位px)
+   * @param {number} y y轴要滚动到坐标位置(单位px)
+   */
+  scrollTo(x: number, y: number): void
+
+  /**
+   * 使得元素滚动一段特定距离 仅scroll-view、list-view组件支持
+   * @param {number} x x轴要滚动的距离(单位px)
+   * @param {number} y y轴要滚动的距离(单位px)
+   */
+  scrollBy(x: number, y: number): void
+  
+  /**
+   * 使元素获取焦点 仅input、Textarea组件支持
+   */
+  focus(): void
+  
+  /**
+   * 使元素丢失焦点 仅input、Textarea组件支持
+   */
+  blur(): void
+}

package/types/native/Event.d.ts

@@ -1,10 +1,21 @@
-/// <reference path='./INode.d.ts' />
+/// <reference path='./Element.d.ts' />
 
 /**
  * @package io.dcloud.uniapp.runtime
  */
 declare class Event {
+	/**
+	 * 创建一个新的事件对象
+	 * @param {string} type 事件的名称
+	 */
 	constructor (type: string)
+	
+	/**
+	 * 创建一个新的事件对象
+	 * @param {string} type 事件的名称
+	 * @param {string} eventInit 事件初始参数。支持字段：`bubbles`表明该事件是否冒泡。可选，默认为false；`cancelable`表明该事件是否可以被取消。可选，默认为false。
+	 */
+	constructor(type: string, eventInit: UTSJSONObject)
     /**
      * 事件类型
      */
@@ -12,11 +23,11 @@ declare class Event {
     /**
      * 触发事件的组件
      */
-    target: INode
+    target: Element
     /**
      * 当前组件
      */
-    currentTarget: INode
+    currentTarget: Element
     /**
      * 事件发生时的时间戳
      */

package/types/native/IDocument.d.ts

@@ -1,4 +1,4 @@
-/// <reference path='./INode.d.ts' />
+/// <reference path='./Element.d.ts' />
 /// <reference path='./ITabsNode.d.ts' />
 /// <reference path='./NodeData.d.ts' />
 
@@ -6,18 +6,18 @@
  * @package io.dcloud.uniapp.runtime
  * @autodoc false
  */
-interface IDocument extends INode {
-  body: INode
+interface IDocument extends Element {
+  body: Element
 
   getRealDomNodeById<T>(tag: string): ITabsNode | null
 
   startRender(): unknown
 
-  createElement(tagName: string): INode
+  createElement(tagName: string): Element
 
-  createElement(data: NodeData): INode
+  createElement(data: NodeData): Element
 
-  createComment(data: string): INode
+  createComment(data: string): Element
 
   notifyLayout(): void
 

package/types/native/IPage.d.ts

@@ -1,22 +1,38 @@
-/// <reference path='./INode.d.ts' />
 /// <reference path='./IDocument.d.ts' />
 
 /**
  * @package io.dcloud.uniapp.runtime
  * @autodoc false
  */
-interface IPage extends INode {
+interface IPage {
+  /**
+   * 页面id
+   */
   pageId: string
+  /**
+   * document对象
+   */
   document: IDocument
-
-  createDocument(data: unknown): IDocument
-
-  show(options: any, callback?: () => void): void
-
-  close(options: any, callback: () => void): void
-
+  /**
+   * 显示页面
+   * @param {Map<String, Any>} options 显示配置项
+   * @param {() => void} callback 显示完毕监听器
+   */
+  show(options?: any, callback?: () => void): void
+  /**
+   * 关闭页面
+   * @param {Map<String, Any>} options 关闭配置项
+   * @param {() => void} callback 关闭完毕监听器
+   */
+  close(options?: any, callback?: () => void): void
+  /**
+   * 开启排版渲染
+   * @param {() => void} callback 首次排版回调监听器
+   */
   startRender(callback?: () => void): void
-
+  /**
+   * 停止排版渲染
+   */
   stopRender(): void
 
   addPageEventListener(
@@ -50,4 +66,6 @@ interface IPage extends INode {
   stopPullDownRefresh(): void
 
   loadFontFace(options: LoadFontFaceOptions): void
+
+  updateStyle(style: Map<String, any | null>): void
 }

package/types/native/IPageManager.d.ts

@@ -6,8 +6,8 @@
  */
 declare class IPageManager {
   createPage(
-    pageUrl: String,
-    pageId: String,
+    pageUrl: string,
+    pageId: string,
     pageStyle: Map<string, any | null>
   ): IPage
 

package/types/native/ITabsNode.d.ts

@@ -1,17 +1,17 @@
-/// <reference path='./INode.d.ts' />
+/// <reference path='./Element.d.ts' />
 
 /**
  * @package io.dcloud.uniapp.runtime
  * @autodoc false
  */
-interface ITabsNode extends INode {
+interface ITabsNode extends Element {
   appendItem(pageId: string): void
 
-  appendItem(itemNode: INode): void
+  appendItem(itemNode: Element): void
 
   initTabBar(style: Map<string, any | null>): void
 
-  appendCustomTabBar(tabBar: INode, direction: string): void
+  appendCustomTabBar(tabBar: Element, direction: string): void
 
   switchSelect(pageId: string, index: Int): void
 

package/types/native/IUniError.d.ts

@@ -0,0 +1,20 @@
+/// <reference path="./AsyncApiResult.d.ts" />
+
+interface IUniError extends AsyncApiResult {
+	/**
+	 * 统一错误码
+	 */
+	errCode: number;
+	/**
+	 * 统一错误主题（模块）名称
+	 */
+	errSubject: string;
+	/**
+	 * 错误信息中包含的数据
+	 */
+	data: any | null;
+	/**
+	 * 源错误信息，可以包含多个错误，详见SourceError
+	 */
+	cause: Error | null;
+}

package/types/native/IWebViewNode.d.ts

@@ -1,10 +1,10 @@
-/// <reference path='./INode.d.ts' />
+/// <reference path='./Element.d.ts' />
 
 /**
  * @package io.dcloud.uniapp.runtime
  * @autodoc false
  */
-interface IWebViewNode extends INode {
+interface IWebViewNode extends Element {
   /**
    * 后退
    */

package/types/native/InputBlurEvent.d.ts

@@ -0,0 +1,13 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class InputBlurEvent extends Event {
+	detail : {
+		/**
+		 * 输入框内容
+		 */
+		value : string, 
+	}
+}

package/types/native/InputConfirmEvent.d.ts

@@ -0,0 +1,13 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class InputConfirmEvent extends Event {
+	detail : {
+		/**
+		 * 输入框内容
+		 */
+		value : string, 
+	}
+}

package/types/native/InputEvent.d.ts

@@ -0,0 +1,21 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class InputEvent extends Event {
+	detail : {
+		/**
+		 * 输入框内容
+		 */
+		value : string, 
+		/**
+		 * 光标的位置
+		 */
+		cursor : number, 
+		/**
+		 * 输入字符的Unicode值
+		 */
+		keyCode : number
+	}
+}

package/types/native/InputFocusEvent.d.ts

@@ -0,0 +1,17 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class InputFocusEvent extends Event {
+	detail : {
+		/**
+		 * 键盘高度
+		 */
+		height : number,
+		/**
+		 * 输入框内容
+		 */
+		value : string
+	}
+}

package/types/native/InputKeyboardHeightChangeEvent.d.ts

@@ -0,0 +1,17 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class InputKeyboardHeightChangeEvent extends Event {
+	detail : {
+		/**
+		 * 键盘高度
+		 */
+		height : number,
+		/**
+		 * 持续时间
+		 */
+		duration : number
+	}
+}

package/types/native/MouseEvent.d.ts

@@ -36,7 +36,19 @@ declare class MouseEvent extends Event {
      * 相对于屏幕顶部的距离
      */
     screenY : number
-	
+	
+	/**
+	 * 创建一个新的 MouseEvent 对象
+	 * @param {string} type 事件类型
+	 * @param {number} x 相对于页面可显示区域左边的距离
+	 * @param {number} y 相对于页面可显示区域顶部的距离
+	 * @param {number} clientX 相对于页面可显示区域左边的距离
+	 * @param {number} clientY 相对于页面可显示区域顶部的距离
+	 * @param {number} pageX 相对于文档顶部的距离
+	 * @param {number} pageY 相对于文档顶部的距离
+	 * @param {number} screenX 相对于屏幕左边距离
+	 * @param {number} screenY 相对于屏幕顶部的距离
+	 */
 	constructor (
 	  type: string,
 	  x: number,

package/types/native/NestedPreScrollEvent.d.ts

@@ -0,0 +1,23 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class NestedPreScrollEvent extends Event {
+	/**
+	 * x轴滚动距离
+	 */
+	deltaX: number
+	
+	/**
+	 * y轴滚动距离
+	 */
+	deltaY: number
+	
+	/**
+	 * 通知到子节点x,y轴滚动距离的消耗
+	 * @param {number} consumedX x轴消耗的滚动距离
+	 * @param {number} consumedY y轴消耗的滚动距离
+	 */
+	consumed(consumedX: number, consumedY: number): void
+}

package/types/native/ScrollToLowerEvent.d.ts

@@ -4,7 +4,10 @@
  * @package io.dcloud.uniapp.runtime
  */
 declare class ScrollToLowerEvent extends Event {
-  detail: {
+  detail: {
+	/**
+	 * 滚动方向 bottom 或 right
+	 */
     direction: string
   }
 }

package/types/native/ScrollToUpperEvent.d.ts

@@ -4,7 +4,10 @@
  * @package io.dcloud.uniapp.runtime
  */
 declare class ScrollToUpperEvent extends Event {
-  detail: {
-    direction: string
+  detail: {
+	/**
+	 * 滚动方向 top 或 left
+	 */
+	direction: string
   }
 }

package/types/native/StartNestedScrollEvent.d.ts

@@ -0,0 +1,12 @@
+/// <reference path='./Event.d.ts' />
+/// <reference path="./Element.d.ts" />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class StartNestedScrollEvent extends Event {
+	/**
+	 * 开始滚动子节点对象
+	 */
+	node: Element
+}

package/types/native/SwiperAnimationFinishEvent.d.ts

@@ -0,0 +1,11 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class SwiperAnimationFinishEvent extends Event {
+	detail: {
+	  current: number
+	  source: string
+	}
+}

package/types/native/SwiperChangeEvent.d.ts

@@ -0,0 +1,11 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class SwiperChangeEvent extends Event {
+	detail: {
+	  current: number
+	  source: string
+	}
+}

package/types/native/SwiperTransitionEvent.d.ts

@@ -0,0 +1,11 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class SwiperTransitionEvent extends Event {
+	detail: {
+	  dx: number
+	  dy: number
+	}
+}

package/types/native/TextareaBlurEvent.d.ts

@@ -0,0 +1,17 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class TextareaBlurEvent extends Event {
+	detail : {
+		/**
+		 * 输入框内容
+		 */
+		value : string,
+		/**
+		 * 选择区域的起始位置
+		 */
+		cursor : number
+	}
+}

package/types/native/TextareaFocusEvent.d.ts

@@ -0,0 +1,17 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class TextareaFocusEvent extends Event {
+	detail : {
+		/**
+		 * 键盘高度
+		 */
+		height : number,
+		/**
+		 * 输入框内容
+		 */
+		value : string
+	}
+}